Package com.xebialabs.deployit.plugin.api.udm

Class Environment

java.lang.Object

com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem

com.xebialabs.deployit.plugin.api.udm.Environment

All Implemented Interfaces:

ConfigurationItem, Serializable, Comparable<BaseConfigurationItem>

@Metadata(description="Groups infrastructure CIs and dictionaries and serves as a target for deployment.",
          root=ENVIRONMENTS)
@TypeIcon("icons/types/udm.Environment.svg")
public class Environment
extends BaseConfigurationItem

An Environment is a grouping of Container CIs (such as hosts, servers, clusters, etc.) and Dictionary items.

An Environment is used as the target of a deployment, allowing Deployables to be mapped to members of the environment.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem

id, syntheticProperties, type

Fields inherited from interface com.xebialabs.deployit.plugin.api.udm.ConfigurationItem

SYNTHETIC_PROPERTIES_FIELD, TYPE_FIELD

Constructor Summary

Constructors

Constructor	Description
Environment()
Environment(Container... members)

Method Summary

Modifier and Type	Method	Description
void	addMember(Container member)	Adds a Container as a member of this environment.
List<IDictionary>	getDictionaries()	The dictionaries providing placeholder values.
String	getDirectoryPath()
Set<Container>	getMembers()
<T extends Serializable> Set<T>	getMembersOfType(Class<T> classType)
List<com.xebialabs.deployit.plugin.api.udm.transformer.PatchDictionary>	getPatchDictionaries()
boolean	isFailOnMissingCiRefs()
void	setDictionaries(List<IDictionary> dictionaries)	The dictionaries providing placeholder values.
void	setDirectoryPath(String directoryPath)
void	setFailOnMissingCiRefs(boolean failOnMissingCiRefs)
void	setMembers(Set<Container> members)
void	setPatchDictionaries(List<com.xebialabs.deployit.plugin.api.udm.transformer.PatchDictionary> patchDictionaries)

Methods inherited from class com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem

compareTo, equals, get$ciAttributes, get$directoryReference, get$externalProperties, get$internalId, get$referenceId, get$securedCi, get$securedDirectoryReference, get$token, get$validationMessages, getId, getName, getProperty, getPropertyDescriptor, getType, hashCode, hasProperty, set$ciAttributes, set$directoryReference, set$externalProperties, set$internalId, set$referenceId, set$securedCi, set$securedDirectoryReference, set$token, set$validationMessages, setId, setProperty, setType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Environment

public Environment()

Environment

public Environment(Container... members)

Method Details

getMembers

public Set<Container> getMembers()

Returns:

The set of Containers that are members of this environment.

getMembersOfType

public <T extends Serializable> Set<T> getMembersOfType(Class<T> classType)

Type Parameters:

T - The type against which to match the members.

Parameters:

classType - An instance of the given type.

Returns:

Only the members that matches the given type.

setMembers

public void setMembers(Set<Container> members)

Parameters:

members - The set of Containers that are members of this environment.

addMember

public void addMember(Container member)

Adds a Container as a member of this environment.

getDictionaries

public List<IDictionary> getDictionaries()

The dictionaries providing placeholder values. If the same entry exists in multiple dictionaries, the first one in the list is taken.

Returns:

The list of IDictionarys associated with this environment.

setDictionaries

public void setDictionaries(List<IDictionary> dictionaries)

The dictionaries providing placeholder values. If the same entry exists in multiple dictionaries, the first one in the list is taken.

Parameters:

dictionaries - The list of IDictionarys associated with this environment.

getPatchDictionaries

public List<com.xebialabs.deployit.plugin.api.udm.transformer.PatchDictionary> getPatchDictionaries()

setPatchDictionaries

public void setPatchDictionaries(List<com.xebialabs.deployit.plugin.api.udm.transformer.PatchDictionary> patchDictionaries)

getDirectoryPath

public String getDirectoryPath()

setDirectoryPath

public void setDirectoryPath(String directoryPath)

isFailOnMissingCiRefs

public boolean isFailOnMissingCiRefs()

setFailOnMissingCiRefs

public void setFailOnMissingCiRefs(boolean failOnMissingCiRefs)