oracle.fmwplatform.envspec.model.topology.jms

Class DistributedQueueMemberBinding

java.lang.Object

oracle.fmwplatform.envspec.model.topology.jms.DistributedQueueMemberBinding

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.ContainerAware<DistributedQueueBinding>, oracle.fmwplatform.envspec.common.ReservedKeywordProvider, oracle.fmwplatform.envspec.common.Substitutable, oracle.fmwplatform.envspec.common.Tunable<DistributedQueueBinding>, oracle.fmwplatform.util.validation.ValidationParticipant

public class DistributedQueueMemberBinding
extends Object
implements oracle.fmwplatform.envspec.common.Tunable<DistributedQueueBinding>, oracle.fmwplatform.util.validation.ValidationParticipant, oracle.fmwplatform.envspec.common.ContainerAware<DistributedQueueBinding>

Distributed Queue Member Binding exists to hold Tuning Parameters.

Constructor Summary

Constructors

Constructor and Description
DistributedQueueMemberBinding()

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 DistributedQueueMemberBinding.
oracle.fmwplatform.envspec.lookup.data.AliasCategory	getAliasCategory()
Map<String,String>	getCombinedParameters()
String	getDistributedQueueMemberRef()
String	getName()
DistributedQueueBinding	getParent() Returns the object that contains this entity
Map<String,String>	getReservedKeywords() Get the reserved keyword map.
String	getResourceRef()
TuningParameters	getTuningParameters() Returns the TuningParameters.
String	getVariableValue(String key) Returns the variable value assigned to the specified key.
DistributedQueueMemberBinding	setCombinedParameters(Map<String,String> combinedParameters)
DistributedQueueMemberBinding	setDistributedQueueMemberRef(String distributedQueueMemberRef)
DistributedQueueMemberBinding	setName(String name)
DistributedQueueMemberBinding	setParent(DistributedQueueBinding containerDistributedQueueBinding) Sets the container object that contains this.
DistributedQueueMemberBinding	setTuningParameters(TuningParameters tuningParameters) Sets the TuningParameters for this DistributedQueueMemberBinding 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.
void	validate(oracle.fmwplatform.util.validation.Validate validate) Validate this binding using the specified Validate instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DistributedQueueMemberBinding

public DistributedQueueMemberBinding()

Method Detail

getCombinedParameters

public Map<String,String> getCombinedParameters()

setCombinedParameters

public DistributedQueueMemberBinding setCombinedParameters(Map<String,String> combinedParameters)

getName

public String getName()

Specified by:

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

setName

public DistributedQueueMemberBinding setName(String name)

getDistributedQueueMemberRef

public String getDistributedQueueMemberRef()

setDistributedQueueMemberRef

public DistributedQueueMemberBinding setDistributedQueueMemberRef(String distributedQueueMemberRef)

getParent

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

Returns:

parent container

setParent

public DistributedQueueMemberBinding setParent(DistributedQueueBinding containerDistributedQueueBinding)

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

Parameters:

containerDistributedQueueBinding - the parent container

Returns:

the current container-aware object

getResourceRef

public String getResourceRef()

validate

public void validate(oracle.fmwplatform.util.validation.Validate validate)

Validate this binding using the specified Validate instance.

Specified by:

validate in interface oracle.fmwplatform.util.validation.ValidationParticipant

Parameters:

validate - the Validate instance performing the validation

getTuningParameters

public TuningParameters getTuningParameters()

Returns the TuningParameters.

Specified by:

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

Returns:

the TuningParameters

setTuningParameters

public DistributedQueueMemberBinding setTuningParameters(TuningParameters tuningParameters)

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

Specified by:

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

Parameters:

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

Returns:

the current DistributedQueueMemberBinding object

getAliasCategory

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

Specified by:

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

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

Specified by:

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

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

getReservedKeywords

public Map<String,String> getReservedKeywords()

Get the reserved keyword map.

Specified by:

getReservedKeywords in interface oracle.fmwplatform.envspec.common.ReservedKeywordProvider

Returns:

the reserved keyword map

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