NodeManager (Oracle® Fusion Middleware Java API Reference for the Lifecycle Management Environment Specification)

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NodeManager.ConnectionType
Represents the role used to connect to the database, e.g. SYSDBA.

Nested Classes
Modifier and Type	Class and Description
`static class`	`NodeManager.ConnectionType` Represents the role used to connect to the database, e.g. SYSDBA.

Field Summary

Fields
Modifier and Type Field and Description

static String RESERVED_TOKEN_NODE_MANAGER

Fields
Modifier and Type	Field and Description
`static String`	`RESERVED_TOKEN_NODE_MANAGER`

Constructor Summary

Constructors
Constructor and Description

NodeManager()

Constructors
Constructor and Description
`NodeManager()`

Method Summary

All Methods Instance Methods Concrete Methods
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`	`getAddress()` Return the address where the node manager is located
`oracle.fmwplatform.envspec.lookup.data.AliasCategory`	`getAliasCategory()`
`String`	`getCredentialRef()` Returns the CredentialReference for the Credential that is required to connect to this NodeManager.
`String`	`getId()` Get the ID.
`String`	`getName()` Returns the name of this NodeManager.
`Topology`	`getParent()` Returns the object that contains this entity
`String`	`getPort()` Return the port where the node manager listens
`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
`NodeManager.ConnectionType`	`getType()` Return the type of connection for the node manager
`String`	`getVariableValue(String key)` Returns the variable value assigned to the specified key.
`NodeManager`	`setAddress(String address)` Set the address of where the node manager is located
`NodeManager`	`setCredentialRef(String credentialRef)` Sets the Credential reference for the Credential that is required to connect to this NodeManager.
`NodeManager`	`setId(String id)` Set the ID.
`NodeManager`	`setName(String name)` Sets the name of the NodeManager.
`NodeManager`	`setParent(Topology containerTopology)` Sets the container object that contains this.
`NodeManager`	`setPort(String port)` Set the port where the node manager listens
`NodeManager`	`setTuningParameters(TuningParameters tuningParameters)` Sets the TuningParameters for this NodeManager or null if no TuningParameters.
`NodeManager`	`setType(NodeManager.ConnectionType type)` Set the enum value for the node manager connection type
`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_NODE_MANAGER
```
public static final String RESERVED_TOKEN_NODE_MANAGER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NodeManager
```
public NodeManager()
```
- Method Detail
  - getId
```
public String getId()
```
    Get the ID.
    
    Specified by:
    
    getId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Returns:
    
    the ID
  - setId
```
public NodeManager setId(String id)
```
    Set the ID.
    
    Specified by:
    
    setId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Parameters:
    
    id - the id to be used when referencing this model object
    
    Returns:
    
    the current NodeManager object
  - getName
```
public String getName()
```
    Returns the name of this NodeManager.
    
    Specified by:
    
    getName in interface oracle.fmwplatform.envspec.common.Tunable<Topology>
    
    Returns:
    
    name of this NodeManager
  - setName
```
public NodeManager setName(String name)
```
    Sets the name of the NodeManager.
    
    Parameters:
    
    name - the name of the NodeManager
    
    Returns:
    
    NodeManager that encapsulates this name
  - getAddress
```
public String getAddress()
```
    Return the address where the node manager is located
    
    Returns:
    
    address of node manager
  - setAddress
```
public NodeManager setAddress(String address)
```
    Set the address of where the node manager is located
    
    Parameters:
    
    address - of node manager
    
    Returns:
    
    NodeManager that encapsulates this address
  - getPort
```
public String getPort()
```
    Return the port where the node manager listens
    
    Returns:
    
    node manager port
  - setPort
```
public NodeManager setPort(String port)
```
    Set the port where the node manager listens
    
    Parameters:
    
    port - of node manager
    
    Returns:
    
    NodeManager that encapsulates this port
  - getType
```
public NodeManager.ConnectionType getType()
```
    Return the type of connection for the node manager
    
    Returns:
    
    enum of connection type
  - setType
```
public NodeManager setType(NodeManager.ConnectionType type)
```
    Set the enum value for the node manager connection type
    
    Parameters:
    
    type - of connection
    
    Returns:
    
    NodeManager that encapsulates this type
  - 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
  - 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:
    
    NodeManager encapsulating this credentialRef
  - 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:
    
    whether or not the setting was added
  - getTuningParameters
```
public TuningParameters getTuningParameters()
```
    Returns the tuning parameters
    
    Specified by:
    
    getTuningParameters in interface oracle.fmwplatform.envspec.common.Tunable<Topology>
    
    Returns:
    
    tuning parameters
  - 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:
    
    the current Tunable object
  - 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:
    
    parent container
  - setParent
```
public NodeManager setParent(Topology containerTopology)
```
    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<Topology>
    
    Parameters:
    
    containerTopology - the parent container
    
    Returns:
    
    the current container-aware object
  - 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
  - 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
  - getAliasCategory
```
public oracle.fmwplatform.envspec.lookup.data.AliasCategory getAliasCategory()
```
    Specified by:
    
    getAliasCategory in interface oracle.fmwplatform.envspec.common.Tunable<Topology>
  - 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

Class NodeManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RESERVED_TOKEN_NODE_MANAGER

Constructor Detail

NodeManager

Method Detail

getId

setId

getName

setName

getAddress

setAddress

getPort

setPort

getType

setType

getCredentialRef

setCredentialRef

addSetting

getTuningParameters

setTuningParameters

getParent

setParent

getReservedKeywords

getVariableValue

substitute

getAliasCategory

toXmlCompactString

toXmlString

toJsonCompactString

toJsonString

toCompactString

toString