oracle.fmwplatform.envspec.model.topology

Class ClusterBinding

java.lang.Object

oracle.fmwplatform.envspec.model.topology.ClusterBinding

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.ContainerAware<Domain>, oracle.fmwplatform.envspec.common.ReservedKeywordProvider, oracle.fmwplatform.envspec.common.Substitutable, oracle.fmwplatform.envspec.common.Tunable<Domain>

public class ClusterBinding
extends Object
implements oracle.fmwplatform.envspec.common.Tunable<Domain>

ClusterBinding represents a realized instance of a Cluster and is associated to the Cluster by the Cluster's id.

Since:

12.2.1

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESERVED_TOKEN_CLUSTER

Constructor Summary

Constructors

Constructor and Description
ClusterBinding()

Method Summary

Modifier and Type	Method and Description
boolean	addSetting(String alias, String value) Convenience method to add a setting with the given alias and value, to the tuning parameters for this ClusterBinding.
oracle.fmwplatform.envspec.lookup.data.AliasCategory	getAliasCategory()
String	getClusterRef() Returns the id of the Cluster associated with this ClusterBinding.
List<ServerBinding>	getMembers() Returns the list of servers for this cluster.
String	getName() Returns the name of the Cluster.
Domain	getParent() Returns the object that contains this entity
Map<String,String>	getReservedKeywords() Returns a map containing any reserved keywords and values for variable substitution for this entity
TuningParameters	getTuningParameters() Returns the TuningParameters for this ClusterBinding or null if no TuningParameters are available.
String	getVariableValue(String key) Returns the variable value assigned to the specified key.
boolean	isDynamicCluster()
ClusterBinding	setClusterRef(String clusterRef) Sets the Cluster id associated with this ClusterBinding.
ClusterBinding	setName(String name) Sets the name of this ClusterBinding.
ClusterBinding	setParent(Domain containerDomain) Sets the container object that contains this.
ClusterBinding	setTuningParameters(TuningParameters tuningParameters) Set the tuning parameters.
String	substitute(String text) Replaces substitution keys in the specified text with their corresponding values.
String	toCompactString() Returns a compact string representation of the object in XML format.
String	toJsonCompactString() Returns a compact string representation of the object in JSON format.
String	toJsonString() Returns a string representation of the object in JSON format.
String	toString() Returns a string representation of the object in XML format.
String	toXmlCompactString() Returns a compact string representation of the object in XML format.
String	toXmlString() Returns a string representation of the object in XML format.

Methods inherited from class java.lang.Object

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

Field Detail

RESERVED_TOKEN_CLUSTER

public static final String RESERVED_TOKEN_CLUSTER

See Also:

Constant Field Values

Constructor Detail

ClusterBinding

public ClusterBinding()

Method Detail

addSetting

public boolean addSetting(String alias,
                          String value)

Convenience method to add a setting with the given alias and value, to the tuning parameters for this ClusterBinding.

Specified by:

addSetting in interface oracle.fmwplatform.envspec.common.Tunable<Domain>

Parameters:

alias - the alias of a Setting

value - the value of a Setting

Returns:

whether or not the setting was added

getClusterRef

public String getClusterRef()

Returns the id of the Cluster associated with this ClusterBinding.

Returns:

the id of the Cluster associated with this ClusterBinding

getName

public String getName()

Returns the name of the Cluster.

Specified by:

getName in interface oracle.fmwplatform.envspec.common.Tunable<Domain>

Returns:

the name of the Cluster

getParent

public Domain getParent()

Description copied from interface: oracle.fmwplatform.envspec.common.ContainerAware

Returns the object that contains this entity

Specified by:

getParent in interface oracle.fmwplatform.envspec.common.ContainerAware<Domain>

Returns:

parent container

getReservedKeywords

public Map<String,String> getReservedKeywords()

Description copied from interface: oracle.fmwplatform.envspec.common.ReservedKeywordProvider

Returns a map containing any reserved keywords and values for variable substitution for this entity

Specified by:

getReservedKeywords in interface oracle.fmwplatform.envspec.common.ReservedKeywordProvider

Returns:

the map of reserved keywords and their values

getMembers

public List<ServerBinding> getMembers()
                               throws FMWEnvSpecException

Returns the list of servers for this cluster. This method obtains the relationship of the servers from its parent domain. The cluster members are obtained from the domain profile in that parent domain, and used to lookup the corresponding ServerBindings.

Returns:

list of servers belonging to this cluster

Throws:

FMWEnvSpecException - if an error is encountered

getTuningParameters

public TuningParameters getTuningParameters()

Returns the TuningParameters for this ClusterBinding or null if no TuningParameters are available.

Specified by:

getTuningParameters in interface oracle.fmwplatform.envspec.common.Tunable<Domain>

Returns:

the TuningParameters for this ClusterBinding or null if no TuningParameters are available

setTuningParameters

public ClusterBinding setTuningParameters(TuningParameters tuningParameters)

Set the tuning parameters.

Specified by:

setTuningParameters in interface oracle.fmwplatform.envspec.common.Tunable<Domain>

Parameters:

tuningParameters - the tuning parameters to set

Returns:

the current ClusterBinding object

getAliasCategory

public oracle.fmwplatform.envspec.lookup.data.AliasCategory getAliasCategory()

Specified by:

getAliasCategory in interface oracle.fmwplatform.envspec.common.Tunable<Domain>

setClusterRef

public ClusterBinding setClusterRef(String clusterRef)

Sets the Cluster id associated with this ClusterBinding.

Parameters:

clusterRef - the Cluster id associated with this ClusterBinding

Returns:

the current ClusterBinding object

setName

public ClusterBinding setName(String name)

Sets the name of this ClusterBinding.

Parameters:

name - the name of this ClusterBinding

Returns:

the current ClusterBinding object

setParent

public ClusterBinding setParent(Domain containerDomain)

Description copied from interface: oracle.fmwplatform.envspec.common.ContainerAware

Sets the container object that contains this. The container object has variables in it that are used in this.

Specified by:

setParent in interface oracle.fmwplatform.envspec.common.ContainerAware<Domain>

Parameters:

containerDomain - the parent container

Returns:

the current container-aware object

isDynamicCluster

public boolean isDynamicCluster()

getVariableValue

public String getVariableValue(String key)

Returns the variable value assigned to the specified key.

Specified by:

getVariableValue in interface oracle.fmwplatform.envspec.common.Substitutable

Parameters:

key - the key of the variable to be checked

Returns:

the variable value, or null if not found

substitute

public String substitute(String text)

Replaces substitution keys in the specified text with their corresponding values.

Specified by:

substitute in interface oracle.fmwplatform.envspec.common.Substitutable

Parameters:

text - the original text

Returns:

the text with substitution keys replaced

toXmlCompactString

public String toXmlCompactString()

Returns a compact string representation of the object in XML format.

Returns:

a compact string representation of the object in XML format

toXmlString

public String toXmlString()

Returns a string representation of the object in XML format.

Returns:

a string representation of the object in XML format

toJsonCompactString

public String toJsonCompactString()

Returns a compact string representation of the object in JSON format.

Returns:

a compact string representation of the object in JSON format

toJsonString

public String toJsonString()

Returns a string representation of the object in JSON format.

Returns:

a string representation of the object in JSON format

toCompactString

public String toCompactString()

Returns a compact string representation of the object in XML format.

Returns:

a compact string representation of the object in XML format

toString

public String toString()

Returns a string representation of the object in XML format.

Overrides:

toString in class Object

Returns:

a string representation of the object in XML format