oracle.fmwplatform.envspec.model.topology

Class DataSourceBinding

java.lang.Object

oracle.fmwplatform.envspec.model.topology.DataSourceBinding

All Implemented Interfaces:

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

Direct Known Subclasses:

GenericDataSourceBinding, MultiDataSourceBinding

public class DataSourceBinding
extends Object
implements oracle.fmwplatform.envspec.common.Tunable<Schema>

Binding information for a data source.

Since:

12.2.1

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESERVED_TOKEN_DATASOURCE

Constructor Summary

Constructors

Constructor and Description
DataSourceBinding()

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 DataSourceBinding.
List<String>	getConnectStrings() Returns the Connect Strings for each of the Nodes contained in this Database.
Database	getDatabase() Returns the Database from the Schema attached to this DataSourceBinding.
String	getDataSourceName() Returns the name of this DataSource.
Schema	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 TuningParameters for this DataSourceBinding or null if no TuningParameters are available.
String	getVariableValue(String key) Returns the variable value assigned to the specified key.
boolean	isXA() Returns if an XA driver must be used.
DataSourceBinding	setDataSourceName(String dataSourceName) Sets the name of this DataSourceBinding.
DataSourceBinding	setParent(Schema containerSchema) Sets the container object that contains this.
DataSourceBinding	setTuningParameters(TuningParameters tuningParameters) Sets the TuningParameters for this DataSourceBinding or null if no TuningParameters.
DataSourceBinding	setXA(boolean xa) Sets if an XA driver must be used.
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 JSON format.
String	toString() Returns a string representation of the object in JSON 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_DATASOURCE

public static final String RESERVED_TOKEN_DATASOURCE

See Also:

Constant Field Values

Constructor Detail

DataSourceBinding

public DataSourceBinding()

Method Detail

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

Specified by:

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

Parameters:

alias - the alias of a Setting

value - the value of a Setting

Returns:

true if the data is successfully added to the list

getConnectStrings

public List<String> getConnectStrings()

Returns the Connect Strings for each of the Nodes contained in this Database.

Returns:

the Connect Strings for each of the Nodes contained in this Database

getDatabase

public Database getDatabase()

Returns the Database from the Schema attached to this DataSourceBinding.

Returns:

he Database from the Schema attached to this DataSourceBinding

getDataSourceName

public String getDataSourceName()

Returns the name of this DataSource.

Returns:

the name of this DataSource

getParent

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

Returns:

the object that contains this entity

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:

a Map with key value pairs for the reserved keywords

getTuningParameters

public TuningParameters getTuningParameters()

Returns the TuningParameters for this DataSourceBinding or null if no TuningParameters are available.

Specified by:

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

Returns:

the TuningParameters for this DataSourceBinding or null if no TuningParameters are available

isXA

public boolean isXA()

Returns if an XA driver must be used.

Returns:

if an XA driver must be used

setDataSourceName

public DataSourceBinding setDataSourceName(String dataSourceName)

Sets the name of this DataSourceBinding.

Parameters:

dataSourceName - the name to be set for this DataSourceBinding

Returns:

this DataSourceBinding object (for method chaining)

setParent

public DataSourceBinding setParent(Schema containerSchema)
                            throws IllegalArgumentException

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

Parameters:

containerSchema - the parent container

Returns:

the ContainerAware parent object

Throws:

IllegalArgumentException

setTuningParameters

public DataSourceBinding setTuningParameters(TuningParameters tuningParameters)

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

Specified by:

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

Parameters:

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

Returns:

this DataSourceBinding object (for method chaining)

setXA

public DataSourceBinding setXA(boolean xa)

Sets if an XA driver must be used.

Parameters:

xa - true for XA driver, otherwise false

Returns:

this DataSourceBinding object (for method chaining)

getVariableValue

public String getVariableValue(String key)

Returns the variable value assigned to the specified key. Reserved keywords are checked first, then tuning parameters and parent topology.

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

toCompactString

public String toCompactString()

Returns a compact string representation of the object in JSON format.

Returns:

a compact string representation of the object in JSON format

toString

public String toString()

Returns a string representation of the object in JSON format.

Overrides:

toString in class Object

Returns:

a string representation of the object in JSON format