oracle.fmwplatform.envspec.model.topology

Class MigratableTargetBinding

java.lang.Object

oracle.fmwplatform.envspec.model.topology.MigratableTargetBinding

All Implemented Interfaces:

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

public class MigratableTargetBinding
extends Object
implements oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.ContainerAware<Domain>, oracle.fmwplatform.envspec.common.Tunable<Domain>

This class represents a WebLogic Server Migratable Target. A migratable target represents a service that can move between managed servers in a cluster at runtime.

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESERVED_TOKEN_MIGRATABLE

Constructor Summary

Constructors

Constructor and Description
MigratableTargetBinding()

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 ServerBinding.
oracle.fmwplatform.envspec.lookup.data.AliasCategory	getAliasCategory()
String	getClusterRef() Get the cluster to which this migratable target is associated.
List<String>	getConstrainedCandidateServers() Return the list of server refs that this migratable target is constrained to use
String	getDestinationServerRef() Get the destination server reference.
String	getHostingServerRef() Get the hosting server reference.
String	getId() Get the ID of the model object.
String	getMigratableTargetRef() Get the migratable target id with which this binding is associated
String	getName() Get the name of the migratable target.
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 tuning parameters.
String	getUserPreferredServerRef() Get the user preferred server.
String	getVariableValue(String key) Returns the variable value assigned to the specified key.
MigratableTargetBinding	setClusterRef(String clusterRef) Set the cluster to which this migratable target is associated.
MigratableTargetBinding	setConstrainedCandidateServers(List<String> serverRefs) Set the list of server refs that this migratable target is constrained to sue
MigratableTargetBinding	setDestinationServerRef(String destinationServerRef) Set the destination server reference.
MigratableTargetBinding	setHostingServerRef(String hostingServerRef) Set the hosting server reference.
MigratableTargetBinding	setId(String id) Set the ID of the model object.
MigratableTargetBinding	setMigratableTargetRef(String migratableTargetRef) Set the migratable target id with which this binding is associated
MigratableTargetBinding	setName(String name) Set the name of the migtatable target.
MigratableTargetBinding	setParent(Domain domain) Sets the container object that contains this.
MigratableTargetBinding	setTuningParameters(TuningParameters tuningParameters) Sets the TuningParameters for this MigratableTargetBinding or null if no TuningParameters.
MigratableTargetBinding	setUserPreferredServerRef(String userPreferredServerRef) Set the user preferred server.
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_MIGRATABLE

public static final String RESERVED_TOKEN_MIGRATABLE

See Also:

Constant Field Values

Constructor Detail

MigratableTargetBinding

public MigratableTargetBinding()

Method Detail

getId

public String getId()

Get the ID of the model object.

Specified by:

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

Returns:

the ID of the model object

setId

public MigratableTargetBinding setId(String id)

Set the ID of the 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:

the current MigratableTarget object

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

setParent

public MigratableTargetBinding setParent(Domain domain)

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:

domain - 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

getClusterRef

public String getClusterRef()

Get the cluster to which this migratable target is associated.

Returns:

the cluster ID

setClusterRef

public MigratableTargetBinding setClusterRef(String clusterRef)

Set the cluster to which this migratable target is associated.

Parameters:

clusterRef - the cluster ID to use

Returns:

the current MigratableTarget object

getMigratableTargetRef

public String getMigratableTargetRef()

Get the migratable target id with which this binding is associated

Returns:

migratable target id in the domain profile

setMigratableTargetRef

public MigratableTargetBinding setMigratableTargetRef(String migratableTargetRef)

Set the migratable target id with which this binding is associated

Parameters:

migratableTargetRef - in the domain profile

Returns:

MigratableTargetBinding that encapsulates this ref

getDestinationServerRef

public String getDestinationServerRef()

Get the destination server reference.

Returns:

the destination server reference

setDestinationServerRef

public MigratableTargetBinding setDestinationServerRef(String destinationServerRef)

Set the destination server reference.

Parameters:

destinationServerRef - the new destination server reference

Returns:

the current MigratableTargetBinding object

getHostingServerRef

public String getHostingServerRef()

Get the hosting server reference.

Returns:

the hosting server reference

setHostingServerRef

public MigratableTargetBinding setHostingServerRef(String hostingServerRef)

Set the hosting server reference.

Parameters:

hostingServerRef - the new hosting server reference

Returns:

the current MigratableTargetBinding object

getName

public String getName()

Get the name of the migratable target.

Specified by:

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

Returns:

the name

setName

public MigratableTargetBinding setName(String name)

Set the name of the migtatable target.

Parameters:

name - the new name

Returns:

the current MigratableTarget object

getUserPreferredServerRef

public String getUserPreferredServerRef()

Get the user preferred server.

Returns:

the user preferred server ID

setUserPreferredServerRef

public MigratableTargetBinding setUserPreferredServerRef(String userPreferredServerRef)

Set the user preferred server.

Parameters:

userPreferredServerRef - the new value of the user preferred server

Returns:

the current MigratableTarget object

getConstrainedCandidateServers

public List<String> getConstrainedCandidateServers()

Return the list of server refs that this migratable target is constrained to use

Returns:

list of server refs

setConstrainedCandidateServers

public MigratableTargetBinding setConstrainedCandidateServers(List<String> serverRefs)

Set the list of server refs that this migratable target is constrained to sue

Parameters:

serverRefs - for this migratable target

Returns:

MigratableTargetBinding that contains this list

setTuningParameters

public MigratableTargetBinding setTuningParameters(TuningParameters tuningParameters)

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

Specified by:

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

Parameters:

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

Returns:

the current Tunable object

getAliasCategory

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

Specified by:

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

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

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

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

getTuningParameters

public TuningParameters getTuningParameters()

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

Returns the tuning parameters. May be null.

Specified by:

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

Returns:

tuning parameters