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, java.io.Serializable, java.lang.Comparable<BaseConfigurationItem>

@Metadata(description="Groups infrastructure CIs and dictionaries and serves as a target for deployment.",
          root=ENVIRONMENTS)
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 and Description
Environment()
Environment(Container... members)

Method Summary

Methods

Modifier and Type	Method and Description
void	addMember(Container member) Adds a Container as a member of this environment.
java.util.List<Dictionary>	getDictionaries() The dictionaries providing placeholder values.
java.util.Set<Container>	getMembers()
<T extends java.io.Serializable> java.util.Set<T>	getMembersOfType(java.lang.Class<T> classType)
void	setDictionaries(java.util.List<Dictionary> dictionaries) The dictionaries providing placeholder values.
void	setMembers(java.util.Set<Container> members)

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

compareTo, equals, get$ciAttributes, get$token, getId, getName, getProperty, getPropertyDescriptor, getSyntheticProperties, getSyntheticProperty, getType, hashCode, hasProperty, hasSyntheticProperty, putSyntheticProperties, putSyntheticProperty, set$ciAttributes, set$token, setId, setProperty, setSyntheticProperties, setType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Environment

public Environment()

Environment

public Environment(Container... members)

Method Detail

getMembers

public java.util.Set<Container> getMembers()

Returns:

The set of Containers that are members of this environment.

getMembersOfType

public <T extends java.io.Serializable> java.util.Set<T> getMembersOfType(java.lang.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(java.util.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 java.util.List<Dictionary> 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 Dictionarys associated with this environment.

setDictionaries

public void setDictionaries(java.util.List<Dictionary> 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 Dictionarys associated with this environment.