oracle.fmwplatform.envspec.model.topology.jms

Class JMSSessionPoolBinding

java.lang.Object

oracle.fmwplatform.envspec.model.topology.jms.JMSSessionPoolBinding

All Implemented Interfaces:

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

public class JMSSessionPoolBinding
extends Object
implements oracle.fmwplatform.envspec.common.Tunable<JMSServerBinding>, oracle.fmwplatform.envspec.common.ContainerAware<JMSServerBinding>, oracle.fmwplatform.envspec.common.ParentContainerWithVariables, oracle.fmwplatform.util.validation.ValidationParticipant

JMS Session Pool Binding holds JMS Connection Consumer bindings and Tuning Parameters.

Constructor Summary

Constructors

Constructor and Description
JMSSessionPoolBinding()

Method Summary

Modifier and Type	Method and Description
boolean	addConnectionConsumerBinding(JMSConnectionConsumerBinding binding)
boolean	addSetting(String alias, String value) Convenience method to add a setting with the given alias and value, to the tuning parameters for this JMSSessionPoolBinding.
oracle.fmwplatform.envspec.lookup.data.AliasCategory	getAliasCategory()
Map<String,String>	getCombinedParameters()
JMSConnectionConsumerBinding	getConnectionConsumerBinding(String name)
JMSConnectionConsumerBinding	getConnectionConsumerBindingByResourceReference(String refName)
List<JMSConnectionConsumerBinding>	getConnectionConsumerBindings()
Map<String,String>	getEffectiveVariables() Returns the variables from the tuning parameters of this binding, as well as from its containing JMSServer binding.
String	getName()
JMSServerBinding	getParent() Get the parent container domain.
Map<String,String>	getReservedKeywords() Get the reserved keyword map.
String	getResourceRef() Get the resource reference for this binding.
String	getSessionPoolRef()
TuningParameters	getTuningParameters() Returns the TuningParameters.
String	getVariableValue(String key) Returns the variable value assigned to the specified key.
JMSSessionPoolBinding	setCombinedParameters(Map<String,String> combinedParameters)
JMSSessionPoolBinding	setName(String name)
JMSSessionPoolBinding	setParent(JMSServerBinding parentJmsServerBinding) Set the parent container JMSServerBinding.
JMSSessionPoolBinding	setSessionPoolRef(String sessionPoolRef)
JMSSessionPoolBinding	setTuningParameters(TuningParameters tuningParameters) Sets the TuningParameters for this JMSSessionPoolBinding 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

JMSSessionPoolBinding

public JMSSessionPoolBinding()

Method Detail

getResourceRef

public String getResourceRef()

Get the resource reference for this binding.

Returns:

the resource reference for this binding

getSessionPoolRef

public String getSessionPoolRef()

setSessionPoolRef

public JMSSessionPoolBinding setSessionPoolRef(String sessionPoolRef)

getName

public String getName()

Specified by:

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

setName

public JMSSessionPoolBinding setName(String name)

addConnectionConsumerBinding

public boolean addConnectionConsumerBinding(JMSConnectionConsumerBinding binding)

getConnectionConsumerBinding

public JMSConnectionConsumerBinding getConnectionConsumerBinding(String name)

getConnectionConsumerBindingByResourceReference

public JMSConnectionConsumerBinding getConnectionConsumerBindingByResourceReference(String refName)

getConnectionConsumerBindings

public List<JMSConnectionConsumerBinding> getConnectionConsumerBindings()

getParent

public JMSServerBinding getParent()

Get the parent container domain.

Specified by:

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

Returns:

the parent container domain

setParent

public JMSSessionPoolBinding setParent(JMSServerBinding parentJmsServerBinding)

Set the parent container JMSServerBinding.

Specified by:

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

Parameters:

parentJmsServerBinding - the parent container JMSServerBinding

Returns:

the current JMSSessionPoolBinding object

getCombinedParameters

public Map<String,String> getCombinedParameters()

setCombinedParameters

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

getTuningParameters

public TuningParameters getTuningParameters()

Returns the TuningParameters.

Specified by:

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

Returns:

the TuningParameters

setTuningParameters

public JMSSessionPoolBinding setTuningParameters(TuningParameters tuningParameters)

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

Specified by:

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

Parameters:

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

Returns:

the current JMSSessionPoolBinding object

getAliasCategory

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

Specified by:

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

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

Specified by:

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

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

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

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

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