oracle.fmwplatform.envspec.model.topology

Class Database

java.lang.Object

oracle.fmwplatform.envspec.model.topology.Database

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.ContainerAware<Topology>, oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.ParentContainerWithVariables, oracle.fmwplatform.envspec.common.Substitutable

public class Database
extends Object
implements oracle.fmwplatform.envspec.common.ContainerAware<Topology>, oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.ParentContainerWithVariables

Represents a Database.

Since:

12.2.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Database.Role Represents the role used to connect to the database, e.g. SYSDBA.
static class	Database.Vendor The database vendor.

Constructor Summary

Constructors

Constructor and Description
Database()

Method Summary

Modifier and Type	Method and Description
boolean	addAllNodes(List<Node> nodes) Adds a list of Nodes to this Database's list of Nodes.
boolean	addNode(Node node) Adds a single Node to this Database's list of Nodes.
Node	addNode(String id) Creates a new Cluster Node and add it to this Database.
List<String>	getConnectStrings() Returns the Connect Strings for each of the Nodes contained in this Database.
String	getDbaCredentialRef() Returns the DBA Credential Reference or null if one has not been set
Database.Role	getDbaRole() Returns the DBA role.
String	getDriverClass() Returns the fully qualified Java class name of the non-XA JDBC driver.
Map<String,String>	getEffectiveVariables() Returns the derived map of variables for this element.
String	getId() Returns the id used to reference this model object.
List<Node>	getNodes() Returns the Nodes in this Database.
Topology	getParent() Returns the object that contains this entity
String	getRcuConnectString() Returns the RCU connect string.
String	getVariableValue(String key) Returns the variable value assigned to the specified key.
Database.Vendor	getVendor() Returns the vendor for the Database.
String	getXaDriverClass() Returns the fully qualified Java class name of the XA JDBC driver.
Database	setDbaCredentialRef(String dbaCredentialRef) Sets the DBA Credential reference which may be null.
Database	setDbaRole(Database.Role dbaRole) Sets the DBA role.
Database	setDriverClass(String driverClass) Sets the fully qualified Java class name of the non-XA JDBC driver.
Database	setId(String id) Sets the id used to reference this model object.
Database	setNodes(List<Node> nodes) Sets the Nodes in this Database.
Database	setParent(Topology containerTopology) Sets the container object that contains this.
Database	setRcuConnectString(String rcuConnectString) Sets the RCU connect string.
Database	setVendor(Database.Vendor vendor) Sets the vendor of this Database.
Database	setXaDriverClass(String xaDriverClass) Sets the fully qualified Java class name of the XA JDBC driver.
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

Constructor Detail

Database

public Database()

Method Detail

getParent

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

Returns:

the object that contains this entity

setParent

public Database setParent(Topology containerTopology)
                   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<Topology>

Parameters:

containerTopology - the parent container

Returns:

the ContainerAware parent object

Throws:

IllegalArgumentException

addNode

public boolean addNode(Node node)
                throws IllegalArgumentException

Adds a single Node to this Database's list of Nodes.

Parameters:

node - the Node to be added to this Database's list of Nodes

Returns:

true if the list changed as a result of this call

Throws:

IllegalArgumentException

addAllNodes

public boolean addAllNodes(List<Node> nodes)
                    throws IllegalArgumentException

Adds a list of Nodes to this Database's list of Nodes.

Parameters:

nodes - the Node to be added to this Database's list of Nodes

Returns:

true if the list changed as a result of this call

Throws:

IllegalArgumentException

addNode

public Node addNode(String id)
             throws IllegalArgumentException

Creates a new Cluster Node and add it to this Database.

Parameters:

id - the id to use for the new Cluster Node

Returns:

the cluster node added

Throws:

IllegalArgumentException

getConnectStrings

public List<String> getConnectStrings()

Returns the Connect Strings for each of the Nodes contained in this Database. This is a convenience method, there is no corresponding set or remove method. To remove the connection stings, the removeNodes method would need to be called.

Returns:

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

getDbaCredentialRef

public String getDbaCredentialRef()

Returns the DBA Credential Reference or null if one has not been set

Returns:

the DBA Credential Reference or null if one has not been set

getDbaRole

public Database.Role getDbaRole()

Returns the DBA role.

Returns:

the DBA role

getDriverClass

public String getDriverClass()

Returns the fully qualified Java class name of the non-XA JDBC driver.

Returns:

the fully qualified Java class name of the non-XA JDBC driver

getId

public String getId()

Description copied from interface: oracle.fmwplatform.envspec.common.EntityWithId

Returns the id used to reference this model object.

Specified by:

getId in interface oracle.fmwplatform.envspec.common.EntityWithId

Returns:

the id used to reference this model object

getNodes

public List<Node> getNodes()

Returns the Nodes in this Database.

Returns:

the Nodes in this Database

getRcuConnectString

public String getRcuConnectString()

Returns the RCU connect string. This is the Database connect string for RCU usage – this should be in the format ‘server:port/service’ without JDBC decoration, and must be for a single Node if the Database is a Cluster.

Returns:

RCU connect string

getVendor

public Database.Vendor getVendor()

Returns the vendor for the Database.

Returns:

he vendor for the Database

getXaDriverClass

public String getXaDriverClass()

Returns the fully qualified Java class name of the XA JDBC driver.

Returns:

the fully qualified Java class name of the XA JDBC driver

setDbaCredentialRef

public Database setDbaCredentialRef(String dbaCredentialRef)

Sets the DBA Credential reference which may be null.

Parameters:

dbaCredentialRef - the DBA Credential reference which may be null

Returns:

this Database object (for method chaining)

setDbaRole

public Database setDbaRole(Database.Role dbaRole)

Sets the DBA role.

Parameters:

dbaRole - the DBA role to be set for this Database

Returns:

this Database object (for method chaining)

setDriverClass

public Database setDriverClass(String driverClass)

Sets the fully qualified Java class name of the non-XA JDBC driver.

Parameters:

driverClass - the fully qualified Java class name of the non-XA JDBC driver

Returns:

this Database object (for method chaining)

setId

public Database setId(String id)

Description copied from interface: oracle.fmwplatform.envspec.common.EntityWithId

Sets the id used to reference this model object.

Specified by:

setId in interface oracle.fmwplatform.envspec.common.EntityWithId

Parameters:

id - the id to be used when referencing this model object

Returns:

this (for method chaining)

setNodes

public Database setNodes(List<Node> nodes)

Sets the Nodes in this Database.

Parameters:

nodes - the Nodes in this Database

Returns:

this Database object (for method chaining)

setRcuConnectString

public Database setRcuConnectString(String rcuConnectString)

Sets the RCU connect string. This is the database connect string for RCU usage – this should be in the format ‘server:port/service’ without JDBC decoration, and must be for a single node if the database is a cluster

Parameters:

rcuConnectString - the RCU connect string

Returns:

this Database object (for method chaining)

setVendor

public Database setVendor(Database.Vendor vendor)

Sets the vendor of this Database.

Parameters:

vendor - the vendor of this Database

Returns:

this Database object (for method chaining)

setXaDriverClass

public Database setXaDriverClass(String xaDriverClass)

Sets the fully qualified Java class name of the XA JDBC driver.

Parameters:

xaDriverClass - the fully qualified Java class name of the XA JDBC driver

Returns:

this Database object (for method chaining)

getEffectiveVariables

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

Returns the derived map of variables for this element.

Specified by:

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

Returns:

a map of variables

Throws:

FMWEnvSpecException - in the event of a critical error

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

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