Package io.wcm.devops.conga.model.role

Class Role

java.lang.Object

io.wcm.devops.conga.model.shared.AbstractModel

io.wcm.devops.conga.model.shared.AbstractConfigurable

io.wcm.devops.conga.model.role.Role

All Implemented Interfaces:

Configurable, Serializable

public final class Role
extends AbstractConfigurable

Defines a role with a set of configuration files to generate. The filename of the role YAML file is the role name, it's not included in the model.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Role()

Method Summary

Modifier and Type	Method	Description
List<RoleFile>	getFiles()	Defines the files that should be generated for this role.
List<RoleInherit>	getInherits()	Defines inheritance relations for this role.
List<String>	getSensitiveConfigParameters()	List of configuration parameter names that contain sensitive data (like passwords) that should be encrypted on serialization e.g. in model export files.
String	getTemplateDir()	Defines the directory where the role template files are located.
List<RoleVariant>	getVariants()	Defines the role variants available for this role.
void	setFiles(List<RoleFile> files)
void	setInherits(List<RoleInherit> inherits)
void	setSensitiveConfigParameters(List<String> sensitiveProperties)
void	setTemplateDir(String templateDirectory)
void	setVariants(List<RoleVariant> variants)

Methods inherited from class io.wcm.devops.conga.model.shared.AbstractConfigurable

getConfig, setConfig

Methods inherited from class io.wcm.devops.conga.model.shared.AbstractModel

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Role

public Role()

Method Detail

getInherits

public List<RoleInherit> getInherits()

Defines inheritance relations for this role.

Returns:

List of inheritance relations

setInherits

public void setInherits(List<RoleInherit> inherits)

getVariants

public List<RoleVariant> getVariants()

Defines the role variants available for this role. Role variants can be used to apply a slightly different set of configuration templates or values to a node based on a variant.

Returns:

List of role variant definitions

setVariants

public void setVariants(List<RoleVariant> variants)

getTemplateDir

public String getTemplateDir()

Defines the directory where the role template files are located. The path is relative to the tempaltes root directory. If missing the files are searched within the templates root directory.

Returns:

Relative path to template files

setTemplateDir

public void setTemplateDir(String templateDirectory)

getFiles

public List<RoleFile> getFiles()

Defines the files that should be generated for this role.

Returns:

List of file definitions.

setFiles

public void setFiles(List<RoleFile> files)

getSensitiveConfigParameters

public List<String> getSensitiveConfigParameters()

List of configuration parameter names that contain sensitive data (like passwords) that should be encrypted on serialization e.g. in model export files.

Returns:

List of configuration parameter names (with "." as hierarchy separator)

setSensitiveConfigParameters

public void setSensitiveConfigParameters(List<String> sensitiveProperties)