oracle.fmwplatform.envspec.model.topology

Class NodeManager

java.lang.Object

oracle.fmwplatform.envspec.model.topology.NodeManager

All Implemented Interfaces:

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

public class NodeManager
extends Object
implements oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.Tunable<Topology>

Represents a NodeManager.

Since:

12.2.1

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESERVED_TOKEN_NODE_MANAGER Token used by discovery as a variable to be replaced by node manager name.

Constructor Summary

Constructors

Constructor and Description
NodeManager()

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 NodeManager.
String	getCredentialRef() Returns the CredentialReference for the Credential that is required to connect to this NodeManager.
String	getId() Returns the id used to reference this model object.
String	getName() Returns the name of this NodeManager.
Topology	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 tuning parameters
String	getVariableValue(String key) Returns the variable value assigned to the specified key.
NodeManager	setCredentialRef(String credentialRef) Sets the Credential reference for the Credential that is required to connect to this NodeManager.
NodeManager	setId(String id) Sets the id used to reference this model object.
NodeManager	setName(String name) Sets the name of the NodeManager.
NodeManager	setParent(Topology containerTopology) Sets the parent of this object.
NodeManager	setTuningParameters(TuningParameters tuningParameters) Sets the TuningParameters for this NodeManager or null if no TuningParameters.
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 JSON format.
String	toString() Returns a string representation of the object in JSON 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_NODE_MANAGER

public static final String RESERVED_TOKEN_NODE_MANAGER

Token used by discovery as a variable to be replaced by node manager name.

See Also:

Constant Field Values

Constructor Detail

NodeManager

public NodeManager()

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 NodeManager.

Specified by:

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

Parameters:

alias - the alias of a Setting

value - the value of a Setting

Returns:

true if the data is successfully added to the list

getCredentialRef

public String getCredentialRef()

Returns the CredentialReference for the Credential that is required to connect to this NodeManager.

Returns:

the CredentialReference for the Credential that is required to connect to this NodeManager

getId

public String getId()

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

Returns the id used to reference this model object.

Specified by:

getId in interface oracle.fmwplatform.envspec.common.EntityWithId

Returns:

the id used to reference this model object

getName

public String getName()

Returns the name of this NodeManager.

Returns:

name of this NodeManager

getParent

public Topology 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<Topology>

Returns:

the object that contains this entity

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:

a Map with key value pairs for the reserved keywords

getTuningParameters

public TuningParameters getTuningParameters()

Returns the tuning parameters

Specified by:

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

Returns:

tuning parameters

setCredentialRef

public NodeManager setCredentialRef(String credentialRef)

Sets the Credential reference for the Credential that is required to connect to this NodeManager.

Parameters:

credentialRef - the reference id for the Credential to be associated to this NodeManager

Returns:

this NodeManager object (for method chaining)

setId

public NodeManager setId(String id)

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

Sets the id used to reference this model object.

Specified by:

setId in interface oracle.fmwplatform.envspec.common.EntityWithId

Parameters:

id - the id to be used when referencing this model object

Returns:

this (for method chaining)

setName

public NodeManager setName(String name)

Sets the name of the NodeManager.

Parameters:

name - the name of the NodeManager

Returns:

this NodeManager object (for method chaining)

setParent

public NodeManager setParent(Topology containerTopology)
                      throws IllegalArgumentException

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

Sets the parent of this object. The container object has variables in it that are used by child objects.

Specified by:

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

Parameters:

containerTopology - the parent container

Returns:

the ContainerAware parent object

Throws:

IllegalArgumentException

setTuningParameters

public NodeManager setTuningParameters(TuningParameters tuningParameters)

Sets the TuningParameters for this NodeManager or null if no TuningParameters.

Specified by:

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

Parameters:

tuningParameters - the TuningParameters for this NodeManager or null if no TuningParameters

Returns:

this NodeManager object (for method chaining)

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:

String

toXmlString

public String toXmlString()

Returns a string representation of the object in XML format.

Returns:

String

toCompactString

public String toCompactString()

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

Returns:

String

toString

public String toString()

Returns a string representation of the object in JSON format.

Overrides:

toString in class Object

Returns:

String