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

java.lang.Object
- oracle.fmwplatform.envspec.model.topology.SystemComponent

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 SystemComponent
extends Object
implements oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.Tunable<Topology>
```
Represents a SystemComponent. A system component is a manageable process that is not deployed in a Java application container. Oracle HTTP Server is an example of a system component.

Since:

12.2.1.3.0

Field Summary

Fields
Modifier and Type Field and Description

static String RESERVED_TOKEN_SYSTEM_COMPONENT

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

Constructor Summary

Constructors
Constructor and Description

SystemComponent()
Creates an instance of SystemComponent.

Constructors
Constructor and Description
`SystemComponent()` Creates an instance of SystemComponent.

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 SystemComponent.
`oracle.fmwplatform.envspec.lookup.data.AliasCategory`	`getAliasCategory()`
`String`	`getComponentType()` Return the ComponentType.
`String`	`getId()` Returns the id used to reference this model object.
`NodeManager`	`getMachine()` Return the `NodeManager` associated with this SystemComponent.
`String`	`getName()` Returns the name of this SystemComponent.
`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.
`SystemComponent`	`setComponentType(String componentType)` Set the componentType attribute.Examples of types may include "OHS", "Coherence"
`SystemComponent`	`setId(String id)` Set the ID.
`SystemComponent`	`setMachine(NodeManager machine)` Set the `NodeManager` associated with this SystemComponent.
`SystemComponent`	`setName(String name)` Sets the name of the SystemComponent.
`SystemComponent`	`setParent(Topology containerTopology)` Sets the container object that contains this.
`SystemComponent`	`setTuningParameters(TuningParameters tuningParameters)` Sets the TuningParameters for this SystemComponent 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 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_SYSTEM_COMPONENT
```
public static final String RESERVED_TOKEN_SYSTEM_COMPONENT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SystemComponent
```
public SystemComponent()
```
    Creates an instance of SystemComponent.
- Method Detail
  - 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
  - setId
```
public SystemComponent 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 SystemComponent object
  - getName
```
public String getName()
```
    Returns the name of this SystemComponent.
    
    Specified by:
    
    getName in interface oracle.fmwplatform.envspec.common.Tunable<Topology>
    
    Returns:
    
    name of this SystemComponent
  - setName
```
public SystemComponent setName(String name)
```
    Sets the name of the SystemComponent.
    
    Parameters:
    
    name - the name of the SystemComponent
    
    Returns:
    
    SystemComponent that encapsulates this name
  - getMachine
```
public NodeManager getMachine()
```
    Return the NodeManager associated with this SystemComponent.
    
    Returns:
    
    machine address of SystemComponent
  - setMachine
```
public SystemComponent setMachine(NodeManager machine)
```
    Set the NodeManager associated with this SystemComponent.
    
    Parameters:
    
    machine - address of SystemComponent
    
    Returns:
    
    SystemComponent that encapsulates this machine
  - getComponentType
```
public String getComponentType()
```
    Return the ComponentType.
    
    Returns:
    
    componentType attribute of SystemComponent
  - setComponentType
```
public SystemComponent setComponentType(String componentType)
```
    Set the componentType attribute.Examples of types may include "OHS", "Coherence"
    
    Parameters:
    
    componentType - to set
    
    Returns:
    
    SystemComponent that encapsulates this port
  - 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 SystemComponent.
    
    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 SystemComponent setTuningParameters(TuningParameters tuningParameters)
```
    Sets the TuningParameters for this SystemComponent or null if no TuningParameters.
    
    Specified by:
    
    setTuningParameters in interface oracle.fmwplatform.envspec.common.Tunable<Topology>
    
    Parameters:
    
    tuningParameters - the TuningParameters for this SystemComponent 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 SystemComponent 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 SystemComponent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RESERVED_TOKEN_SYSTEM_COMPONENT

Constructor Detail

SystemComponent

Method Detail

getId

setId

getName

setName

getMachine

setMachine

getComponentType

setComponentType

addSetting

getTuningParameters

setTuningParameters

getParent

setParent

getReservedKeywords

getVariableValue

substitute

getAliasCategory

toXmlCompactString

toXmlString

toJsonCompactString

toJsonString

toCompactString

toString