oracle.fmwplatform.envspec.model.topology

Class DataSourceBinding

java.lang.Object

oracle.fmwplatform.envspec.model.topology.DataSourceBinding

All Implemented Interfaces:

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

Direct Known Subclasses:

GenericDataSourceBinding, GridLinkDataSourceBinding, MultiDataSourceBinding

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

Base class for data source classes, generic, multi, and active gridlink.

Since:

12.2.1

See Also:

GenericDataSourceBinding, MultiDataSourceBinding

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESERVED_TOKEN_DATASOURCE

Constructor Summary

Constructors

Constructor and Description
DataSourceBinding()
DataSourceBinding(DataSourceBinding original) Create a new DataSourceBinding by copying an existing DataSourceBinding

Method Summary

Modifier and Type	Method and Description
boolean	addSetting(String alias, String value) Add a setting with the given alias and value, to the tuning parameters for this datasource.
oracle.fmwplatform.envspec.lookup.data.AliasCategory	getAliasCategory()
String	getDataSourceName() Returns the name of this DataSource.
String	getId() Returns the id used to reference this binding.
abstract JDBCConnectInfo	getJDBCConnectInfo() Return the JDBC connection information for this data source.
String	getName()
Domain	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.
DataSourceBinding	setDataSourceName(String dataSourceName) Sets the name of this DataSourceBinding.
DataSourceBinding	setId(String id) Sets id to be used when referencing this binding.
DataSourceBinding	setParent(Domain container) Sets the container object that contains this.
DataSourceBinding	setTuningParameters(TuningParameters tuningParameters) Sets the TuningParameters for this DataSourceBinding or null if no TuningParameters.
String	substitute(String text) Replaces substitution keys in the specified text with their corresponding values.
abstract String	toCompactString() Returns a compact string representation of the object in XML format.
abstract String	toJsonCompactString() Returns a compact string representation of the object in JSON format.
abstract String	toJsonString() Returns a string representation of the object in JSON format.
abstract String	toString() Returns a string representation of the object in XML format.
abstract String	toXmlCompactString() Returns a compact string representation of the object in XML format.
abstract 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()

DataSourceBinding

public DataSourceBinding(DataSourceBinding original)

Create a new DataSourceBinding by copying an existing DataSourceBinding

Parameters:

original - the existing DataSourceBinding to be copied

Method Detail

getId

public String getId()

Returns the id used to reference this binding.

Returns:

the id used to reference this binding

setId

public DataSourceBinding setId(String id)

Sets id to be used when referencing this binding.

Parameters:

id - the id to be used when referencing this binding

Returns:

the id of this entity

addSetting

public boolean addSetting(String alias,
                          String value)

Add a setting with the given alias and value, to the tuning parameters for this datasource.

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

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

Returns:

parent container

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:

the map of reserved keywords and their values

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

Returns:

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

getDataSourceName

public String getDataSourceName()

Returns the name of this DataSource.

Returns:

the name of this DataSource

setDataSourceName

public DataSourceBinding setDataSourceName(String dataSourceName)

Sets the name of this DataSourceBinding.

Parameters:

dataSourceName - the name to be set for this DataSourceBinding

Returns:

the data source binding

setParent

public DataSourceBinding setParent(Domain container)

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

Parameters:

container - the parent container

Returns:

the current container-aware object

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

Parameters:

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

Returns:

the current DataSourceBinding object

getAliasCategory

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

Specified by:

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

getJDBCConnectInfo

public abstract JDBCConnectInfo getJDBCConnectInfo()

Return the JDBC connection information for this data source.

Returns:

connection information

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 abstract 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 abstract String toXmlString()

Returns a string representation of the object in XML format.

Returns:

a string representation of the object in XML format

toJsonCompactString

public abstract 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 abstract String toJsonString()

Returns a string representation of the object in JSON format.

Returns:

a string representation of the object in JSON format

toCompactString

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

getName

public String getName()

Specified by:

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