oracle.fmwplatform.envspec.model.topology.jms

Class JMSBinding

java.lang.Object

oracle.fmwplatform.envspec.model.topology.jms.JMSBinding

All Implemented Interfaces:

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

Direct Known Subclasses:

JMSBridgeDestinationBinding, JMSMessagingBridgeBinding, JMSModuleBinding, JMSServerBinding, PathServiceBinding, SAFAgentBinding

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

JMSBinding is the parent class for JMS-related Bindings in the Domain.

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
JMSBinding()

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 JMSBinding.
Map<String,String>	getEffectiveVariables() Returns the variables from the tuning parameters of this binding, as well as from its containing domain.
abstract String	getName()
Domain	getParent() Get the parent container domain object.
abstract String	getResourceRef()
TuningParameters	getTuningParameters() Returns the TuningParameters.
String	getVariableValue(String key) Returns the variable value assigned to the specified key.
JMSBinding	setParent(Domain parentDomain) Set the parent container domain object.
JMSBinding	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.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

JMSBinding

public JMSBinding()

Method Detail

getName

public abstract String getName()

Specified by:

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

getResourceRef

public abstract String getResourceRef()

getTuningParameters

public TuningParameters getTuningParameters()

Returns the TuningParameters.

Specified by:

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

Returns:

the TuningParameters

setTuningParameters

public JMSBinding setTuningParameters(TuningParameters tuningParameters)

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

Specified by:

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

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

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

getParent

public Domain getParent()

Get the parent container domain object.

Specified by:

getParent in interface oracle.fmwplatform.envspec.common.ContainerAware<Domain>

Returns:

the parent parentContainer domain object

setParent

public JMSBinding setParent(Domain parentDomain)

Set the parent container domain object.

Specified by:

setParent in interface oracle.fmwplatform.envspec.common.ContainerAware<Domain>

Parameters:

parentDomain - the parent parentContainer domain

Returns:

the current object

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 domain. Any variables defined within the tuning parameters of this binding overrides the ones from domain.

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