oracle.fmwplatform.envspec.model.topology.jms

Class JMSModuleComponentBinding

java.lang.Object

oracle.fmwplatform.envspec.model.topology.jms.JMSModuleComponentBinding

All Implemented Interfaces:

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

Direct Known Subclasses:

DestinationKeyBinding, DistributedQueueBinding, DistributedTopicBinding, ForeignServerBinding, JMSTemplateBinding, QueueBinding, QuotaBinding, SAFErrorHandlingBinding, SAFImportedDestinationBinding, SAFRemoteContextBinding, TopicBinding, UniformDistributedQueueBinding, UniformDistributedTopicBinding

public abstract class JMSModuleComponentBinding
extends Object
implements oracle.fmwplatform.envspec.common.Tunable<JMSModuleBinding>, oracle.fmwplatform.envspec.common.ContainerAware<JMSModuleBinding>, oracle.fmwplatform.envspec.common.ParentContainerWithVariables, oracle.fmwplatform.util.validation.ValidationParticipant

Super class for JMS Module component binding types.

Field Summary

Fields

Modifier and Type	Field and Description
protected static oracle.fmwplatform.util.logging.PlatformLogger	log
protected TuningParameters	tuningParameters

Constructor Summary

Constructors

Constructor and Description
JMSModuleComponentBinding()

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 JMSModuleComponentBinding.
Map<String,String>	getEffectiveVariables() Returns the variables from the tuning parameters of this binding, as well as from its containing JMSModule binding.
abstract String	getName() Get the name of the binding.
abstract String	getResourceRef() Get the resource reference for this binding.
TuningParameters	getTuningParameters() Returns the TuningParameters.
String	getVariableValue(String key) Returns the variable value assigned to the specified key.
JMSModuleComponentBinding	setTuningParameters(TuningParameters tuningParameters) Sets the TuningParameters for this JMSBinding or null if no TuningParameters.
String	substitute(String text) Replaces substitution keys in the specified text with their corresponding values.

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.fmwplatform.envspec.common.Tunable

getAliasCategory

Methods inherited from interface oracle.fmwplatform.envspec.common.ContainerAware

getParent, setParent

Methods inherited from interface oracle.fmwplatform.envspec.common.ReservedKeywordProvider

getReservedKeywords

Methods inherited from interface oracle.fmwplatform.util.validation.ValidationParticipant

validate

Field Detail

log

protected static final oracle.fmwplatform.util.logging.PlatformLogger log

tuningParameters

protected TuningParameters tuningParameters

Constructor Detail

JMSModuleComponentBinding

public JMSModuleComponentBinding()

Method Detail

getName

public abstract String getName()

Get the name of the binding.

Specified by:

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

Returns:

the name of the binding

getResourceRef

public abstract String getResourceRef()

Get the resource reference for this binding.

Returns:

the resource reference for this binding

getTuningParameters

public TuningParameters getTuningParameters()

Returns the TuningParameters.

Specified by:

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

Returns:

the TuningParameters

setTuningParameters

public JMSModuleComponentBinding setTuningParameters(TuningParameters tuningParameters)

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

Specified by:

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

Parameters:

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

Returns:

the current JMSBinding object

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

Specified by:

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

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

getEffectiveVariables

public Map<String,String> getEffectiveVariables()
                                         throws FMWEnvSpecException

Returns the variables from the tuning parameters of this binding, as well as from its containing JMSModule binding. Any variables defined within the tuning parameters of this binding overrides the ones from JMSModule.

Specified by:

getEffectiveVariables in interface oracle.fmwplatform.envspec.common.ParentContainerWithVariables

Returns:

the variables from the tuning parameters of this binding, as well as its domain and the topology

Throws:

FMWEnvSpecException - When any tuning parameters references cannot be read