Package io.wcm.devops.conga.generator

Class ContextProperties

java.lang.Object

io.wcm.devops.conga.generator.ContextProperties

public final class ContextProperties
extends Object

Default configuration property names implicitly set by the configuration generator. The keys can also be used as placeholders with syntax ${key} in filename patterns. These names should not be used inside custom configuration sections of roles or environments.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENVIRONMENT	Environment name
static final String	MULTIPLY_INDEX	File index (starting with 0) if a multiply plugin is used.
static final String	NODE	Current node name
static final String	NODES	List of all nodes.
static final String	NODES_BY_ROLE	Map with node roles with each entry containing a list of all nodes with this role.
static final String	NODES_BY_ROLE_VARIANT	Map with node roles with each entry containing a map with node role variants each entry containing a list of all nodes with this role and variant.
static final String	ROLE	Current node role name
static final String	ROLE_VARIANT	Current node role variant name.
static final String	ROLE_VARIANTS	List of current node role variant names.
static final String	TENANT	Current tenant name.
static final String	TENANT_ROLES	List of current tenant's role names This is only set if the TenantMultiply plugin is used.
static final String	TENANTS	List of all tenants.
static final String	TENANTS_BY_ROLE	Map with tenant roles with each entry containing a list of all tenants with this role.
static final String	VERSION	Environment version

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

VERSION

public static final String VERSION

Environment version

See Also:

• Constant Field Values

ROLE

public static final String ROLE

Current node role name

See Also:

• Constant Field Values

ROLE_VARIANT

public static final String ROLE_VARIANT

Current node role variant name. This is only set, if the node role has only one variant assigned.

See Also:

• Constant Field Values

ROLE_VARIANTS

public static final String ROLE_VARIANTS

List of current node role variant names. Empty if no variant is assigned. Single element if exactly one variant is assigned. List if multiples are assigned.

See Also:

• Constant Field Values

ENVIRONMENT

public static final String ENVIRONMENT

Environment name

See Also:

• Constant Field Values

NODE

public static final String NODE

Current node name

See Also:

• Constant Field Values

NODES

public static final String NODES

List of all nodes. Each node has properties as defined in Node.

See Also:

• Constant Field Values

NODES_BY_ROLE

public static final String NODES_BY_ROLE

Map with node roles with each entry containing a list of all nodes with this role. Each node has properties as defined in Node.

See Also:

• Constant Field Values

NODES_BY_ROLE_VARIANT

public static final String NODES_BY_ROLE_VARIANT

Map with node roles with each entry containing a map with node role variants each entry containing a list of all nodes with this role and variant. Each node has properties as defined in Node.

See Also:

• Constant Field Values

TENANTS

public static final String TENANTS

List of all tenants. Each tenant has properties as defined in Tenant.

See Also:

• Constant Field Values

TENANTS_BY_ROLE

public static final String TENANTS_BY_ROLE

Map with tenant roles with each entry containing a list of all tenants with this role. Each tenant has properties as defined in Tenant.

See Also:

• Constant Field Values

TENANT

public static final String TENANT

Current tenant name. This is only set if the TenantMultiply plugin is used.

See Also:

• Constant Field Values

TENANT_ROLES

public static final String TENANT_ROLES

List of current tenant's role names This is only set if the TenantMultiply plugin is used.

See Also:

• Constant Field Values

MULTIPLY_INDEX

public static final String MULTIPLY_INDEX

File index (starting with 0) if a multiply plugin is used.

See Also:

• Constant Field Values