public class SystemComponent extends Object implements oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.Tunable<Topology>
Modifier and Type | Field and Description |
---|---|
static String |
RESERVED_TOKEN_SYSTEM_COMPONENT |
Constructor and Description |
---|
SystemComponent()
Creates an instance of SystemComponent.
|
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.
|
public static final String RESERVED_TOKEN_SYSTEM_COMPONENT
public String getId()
oracle.fmwplatform.envspec.common.EntityWithId
getId
in interface oracle.fmwplatform.envspec.common.EntityWithId
public SystemComponent setId(String id)
setId
in interface oracle.fmwplatform.envspec.common.EntityWithId
id
- the id to be used when referencing this model objectpublic String getName()
getName
in interface oracle.fmwplatform.envspec.common.Tunable<Topology>
public SystemComponent setName(String name)
name
- the name of the SystemComponentpublic NodeManager getMachine()
NodeManager
associated with this SystemComponent.public SystemComponent setMachine(NodeManager machine)
NodeManager
associated with this SystemComponent.machine
- address of SystemComponentpublic String getComponentType()
public SystemComponent setComponentType(String componentType)
componentType
- to setpublic boolean addSetting(String alias, String value)
addSetting
in interface oracle.fmwplatform.envspec.common.Tunable<Topology>
alias
- the alias of a Settingvalue
- the value of a Settingpublic TuningParameters getTuningParameters()
getTuningParameters
in interface oracle.fmwplatform.envspec.common.Tunable<Topology>
public SystemComponent setTuningParameters(TuningParameters tuningParameters)
setTuningParameters
in interface oracle.fmwplatform.envspec.common.Tunable<Topology>
tuningParameters
- the TuningParameters for this SystemComponent or null if no TuningParameterspublic Topology getParent()
oracle.fmwplatform.envspec.common.ContainerAware
getParent
in interface oracle.fmwplatform.envspec.common.ContainerAware<Topology>
public SystemComponent setParent(Topology containerTopology)
oracle.fmwplatform.envspec.common.ContainerAware
setParent
in interface oracle.fmwplatform.envspec.common.ContainerAware<Topology>
containerTopology
- the parent containerpublic Map<String,String> getReservedKeywords()
oracle.fmwplatform.envspec.common.ReservedKeywordProvider
getReservedKeywords
in interface oracle.fmwplatform.envspec.common.ReservedKeywordProvider
public String getVariableValue(String key)
getVariableValue
in interface oracle.fmwplatform.envspec.common.Substitutable
key
- the key of the variable to be checkedpublic String substitute(String text)
substitute
in interface oracle.fmwplatform.envspec.common.Substitutable
text
- the original textpublic oracle.fmwplatform.envspec.lookup.data.AliasCategory getAliasCategory()
getAliasCategory
in interface oracle.fmwplatform.envspec.common.Tunable<Topology>
public String toXmlCompactString()
public String toXmlString()
public String toJsonCompactString()
public String toJsonString()
public String toCompactString()