Schema (Oracle? Fusion Middleware Java API Reference for the Lifecycle Management Environment Specification)

java.lang.Object
- oracle.fmwplatform.envspec.model.topology.Schema

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.ContainerAware<Domain>, oracle.fmwplatform.envspec.common.ParentContainerWithVariables, oracle.fmwplatform.envspec.common.Substitutable, oracle.fmwplatform.util.validation.ValidationParticipant
```
public class Schema
extends Object
implements oracle.fmwplatform.envspec.common.ParentContainerWithVariables, oracle.fmwplatform.envspec.common.ContainerAware<Domain>, oracle.fmwplatform.util.validation.ValidationParticipant
```
Defines the data to be used by RCU actions.

Since:

12.2.1

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Schema.Shared` Type of Schema: "no" is default, "yes" meaning this Schema is shared and owned by another, "primary", domain.

Constructor Summary

Constructors
Constructor and Description

Schema()

Constructors
Constructor and Description
`Schema()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addAllAuxiliarySchemaCredentialRefs(List<String> auxiliarySchemaCredentialRefs)` Adds a list AuxiliarySchemaCredentialRefs to the existing list of AuxiliarySchemaCredentialRefs
`boolean`	`addAllDataSourceBindings(List<DataSourceBinding> dataSourceBindings)` Adds the specified DataSourceBindings to the list of DataSourceBindings in this Schema.
`boolean`	`addAuxiliarySchemaCredentialRef(String auxiliarySchemaCredentialRef)` Adds an AuxiliarySchemaCredentialRef to the existing list of AuxiliarySchemaCredentialRefs
`boolean`	`addDataSourceBinding(DataSourceBinding dataSourceBinding)` Adds a DataSourceBinding to the list of DataSourceBindings in this Schema.
`List<String>`	`getAuxiliarySchemaCredentialRefs()` Returns a list of auxiliary Schema credential references.
`String`	`getComponentInfo()` Returns the component info.
`String`	`getCredentialRef()` Returns the CredentialReference for the Credential that is required to connect to this Schema.
`Database`	`getDatabase()` Returns the Database associated to this Schema.
`DataSourceBinding`	`getDataSourceBindingByName(String dataSourceName)` Returns the DataSourceBinding that matches the provided DataSource name.
`List<DataSourceBinding>`	`getDataSourceBindings()` Returns the list of DataSourceBindings or an empty list if there are none.
`Map<String,String>`	`getEffectiveVariables()` Provides the effective list of variables that apply to the tuning parameters.
`List<GenericDataSourceBinding>`	`getGenericDataSourceBindings()` Returns the list of GenericDataSourceBindings or an empty list if there are none.
`List<MultiDataSourceBinding>`	`getMultiDataSourceBindings()` Returns the MultiDataSourceBinding or an empty list if there are none.
`Domain`	`getParent()` Returns the object that contains this entity
`String`	`getPrefix()` Returns the Schema prefix.
`String`	`getSchemaComponentIdRef()` Returns the Schema id reference which is the component id in template database.xml
`Schema.Shared`	`getShared()` Returns the type of this Schema.
`String`	`getStorageLocation()` Returns the storage location if one has been specified.
`String`	`getTablespace()` Returns the tablespace string if one has been specified.
`String`	`getTempTablespace()` Returns the tempTablespace string.
`String`	`getVariableValue(String key)` Returns the variable value assigned to the specified key.
`Schema`	`setAuxiliarySchemaCredentialRefs(List<String> auxiliarySchemaCredentialRefs)` Sets a given list of auxiliary Schema credential references.
`Schema`	`setComponentInfo(String componentInfo)` Sets the component info.
`Schema`	`setCredentialRef(String credentialRef)` Sets the Credential reference for the Credential that is required to connect to this Schema.
`Schema`	`setDatabase(Database database)` Sets the Database that is to be associated with this Schema
`Schema`	`setDataSourceBindings(List<DataSourceBinding> dataSourceBindings)` Sets the DataSourceBindings that are associated with this Schema.
`Schema`	`setParent(Domain containerDomain)` Sets the container object that contains this.
`Schema`	`setPrefix(String prefix)` Sets the Schema prefix
`Schema`	`setSchemaComponentIdRef(String schemaComponentIdRef)` Sets the Schema id reference which is the component id in template database.xml
`Schema`	`setShared(Schema.Shared shared)` Sets the type of this Schema.
`Schema`	`setStorageLocation(String storageLocation)` Sets the storage location.
`Schema`	`setTablespace(String tablespace)` Sets the tablespace string.
`Schema`	`setTempTablespace(String tempTablespace)` Sets the tempTablespace string.
`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.
`void`	`validate(oracle.fmwplatform.util.validation.Validate validate)` Validate this Schema using the specified Validate instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Schema
```
public Schema()
```
- Method Detail
  - addAllDataSourceBindings
```
public boolean addAllDataSourceBindings(List<DataSourceBinding> dataSourceBindings)
                                 throws IllegalArgumentException
```
    Adds the specified DataSourceBindings to the list of DataSourceBindings in this Schema.
    
    Parameters:
    
    dataSourceBindings - the DataSourceBindings that are to be added to this Schema
    
    Returns:
    
    the specified DataSourceBindings to the list of DataSourceBindings in this Schema
    
    Throws:
    
    IllegalArgumentException
  - addDataSourceBinding
```
public boolean addDataSourceBinding(DataSourceBinding dataSourceBinding)
                             throws IllegalArgumentException
```
    Adds a DataSourceBinding to the list of DataSourceBindings in this Schema.
    
    Parameters:
    
    dataSourceBinding - a DataSourceBinding to be added to the list of DataSourceBindings in this Schema
    
    Returns:
    
    true if the DataSourceBinding was successfully added
    
    Throws:
    
    IllegalArgumentException
  - getAuxiliarySchemaCredentialRefs
```
public List<String> getAuxiliarySchemaCredentialRefs()
```
    Returns a list of auxiliary Schema credential references.
    
    Returns:
    
    a list of auxiliary Schema credential reference
  - getComponentInfo
```
public String getComponentInfo()
```
    Returns the component info. This is optional, if specified, it is the full path to the location of the ComponentInfo.xml file.
    
    Returns:
    
    the component info
  - getCredentialRef
```
public String getCredentialRef()
```
    Returns the CredentialReference for the Credential that is required to connect to this Schema.
    
    Returns:
    
    the CredentialReference for the Credential that is required to connect to this Schema
  - getDatabase
```
public Database getDatabase()
```
    Returns the Database associated to this Schema.
    
    Returns:
    
    the Database associated to this Schema
  - getDataSourceBindingByName
```
public DataSourceBinding getDataSourceBindingByName(String dataSourceName)
```
    Returns the DataSourceBinding that matches the provided DataSource name.
    
    Parameters:
    
    dataSourceName - the name of the DataSource to be returned
    
    Returns:
    
    the DataSourceBinding that matches the provided DataSource name
  - getDataSourceBindings
```
public List<DataSourceBinding> getDataSourceBindings()
```
    Returns the list of DataSourceBindings or an empty list if there are none.
    
    Returns:
    
    the list of DataSourceBindings or an empty list if there are none
  - getEffectiveVariables
```
public Map<String,String> getEffectiveVariables()
                                         throws FMWEnvSpecException
```
    Provides the effective list of variables that apply to the tuning parameters. If there are multiple definitions of the same variable name, then the one with closest scope is used - definitions of a variable in an entity x, effectively ‘hide’ any definitions of that variable in larger entities containing the entity x.
    
    Specified by:
    
    getEffectiveVariables in interface oracle.fmwplatform.envspec.common.ParentContainerWithVariables
    
    Returns:
    
    the list of Variables
    
    Throws:
    
    FMWEnvSpecException - When any tuning parameters references cannot be read
  - 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
  - getGenericDataSourceBindings
```
public List<GenericDataSourceBinding> getGenericDataSourceBindings()
```
    Returns the list of GenericDataSourceBindings or an empty list if there are none.
    
    Returns:
    
    the GenericDataSourceBindings or an empty list if there are none.
  - getMultiDataSourceBindings
```
public List<MultiDataSourceBinding> getMultiDataSourceBindings()
```
    Returns the MultiDataSourceBinding or an empty list if there are none.
    
    Returns:
    
    the MultiDataSourceBinding or an empty list if there are none.
  - 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:
    
    the object that contains this entity
  - getPrefix
```
public String getPrefix()
```
    Returns the Schema prefix.
    
    Returns:
    
    Schema prefix
  - getSchemaComponentIdRef
```
public String getSchemaComponentIdRef()
```
    Returns the Schema id reference which is the component id in template database.xml
    
    Returns:
    
    Schema id reference
  - getShared
```
public Schema.Shared getShared()
```
    Returns the type of this Schema.
    
    Returns:
    
    type of this Schema
  - getStorageLocation
```
public String getStorageLocation()
```
    Returns the storage location if one has been specified.
    
    Returns:
    
    the storage location if one has been specified
  - getTablespace
```
public String getTablespace()
```
    Returns the tablespace string if one has been specified.
    
    Returns:
    
    the tablespace string if one has been specified
  - getTempTablespace
```
public String getTempTablespace()
```
    Returns the tempTablespace string.
    
    Returns:
    
    the tempTablespace string
  - setAuxiliarySchemaCredentialRefs
```
public Schema setAuxiliarySchemaCredentialRefs(List<String> auxiliarySchemaCredentialRefs)
```
    Sets a given list of auxiliary Schema credential references.
    
    Parameters:
    
    auxiliarySchemaCredentialRefs - the auxiliary Schema Credential reference ids
    
    Returns:
    
    this Schema object (for method chaining)
  - addAuxiliarySchemaCredentialRef
```
public boolean addAuxiliarySchemaCredentialRef(String auxiliarySchemaCredentialRef)
                                        throws IllegalArgumentException
```
    Adds an AuxiliarySchemaCredentialRef to the existing list of AuxiliarySchemaCredentialRefs
    
    Parameters:
    
    auxiliarySchemaCredentialRef - an auxiliary Schema Credential reference id
    
    Returns:
    
    true if the list of MappedWebTiers has changed as a result of this call
    
    Throws:
    
    IllegalArgumentException
  - addAllAuxiliarySchemaCredentialRefs
```
public boolean addAllAuxiliarySchemaCredentialRefs(List<String> auxiliarySchemaCredentialRefs)
                                            throws IllegalArgumentException
```
    Adds a list AuxiliarySchemaCredentialRefs to the existing list of AuxiliarySchemaCredentialRefs
    
    Parameters:
    
    auxiliarySchemaCredentialRefs - an auxiliary Schema Credential reference id
    
    Returns:
    
    true if the list of MappedWebTiers has changed as a result of this call
    
    Throws:
    
    IllegalArgumentException
  - setComponentInfo
```
public Schema setComponentInfo(String componentInfo)
```
    Sets the component info. This is optional, if specified, it is the full path to the location of the ComponentInfo.xml file.
    
    Parameters:
    
    componentInfo - the full path to the location of the ComponentInfo.xml file
    
    Returns:
    
    this Schema object (for method chaining)
  - setCredentialRef
```
public Schema setCredentialRef(String credentialRef)
```
    Sets the Credential reference for the Credential that is required to connect to this Schema.
    
    Parameters:
    
    credentialRef - the reference id for the Credential to be associated to this Schema
    
    Returns:
    
    this Schema object (for method chaining)
  - setDatabase
```
public Schema setDatabase(Database database)
```
    Sets the Database that is to be associated with this Schema
    
    Parameters:
    
    database - the Database to be associated with this Schema
    
    Returns:
    
    this Schema object (for method chaining)
  - setDataSourceBindings
```
public Schema setDataSourceBindings(List<DataSourceBinding> dataSourceBindings)
```
    Sets the DataSourceBindings that are associated with this Schema.
    
    Parameters:
    
    dataSourceBindings - the DataSourceBindings that are to be associated with this Schema
    
    Returns:
    
    this Schema object (for method chaining)
  - setParent
```
public Schema setParent(Domain containerDomain)
                 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<Domain>
    
    Parameters:
    
    containerDomain - the parent container
    
    Returns:
    
    the ContainerAware parent object
    
    Throws:
    
    IllegalArgumentException
  - setPrefix
```
public Schema setPrefix(String prefix)
```
    Sets the Schema prefix
    
    Parameters:
    
    prefix - the Schema prefix
    
    Returns:
    
    this Schema object (for method chaining)
  - setSchemaComponentIdRef
```
public Schema setSchemaComponentIdRef(String schemaComponentIdRef)
```
    Sets the Schema id reference which is the component id in template database.xml
    
    Parameters:
    
    schemaComponentIdRef - he Schema id reference which is the component id in template database.xml
    
    Returns:
    
    this Schema object (for method chaining)
  - setShared
```
public Schema setShared(Schema.Shared shared)
```
    Sets the type of this Schema.
    
    Parameters:
    
    shared - whether this Schema is shared or not
    
    Returns:
    
    this Schema object (for method chaining)
  - setStorageLocation
```
public Schema setStorageLocation(String storageLocation)
```
    Sets the storage location. This is optional, if specified, use this storage location explicitly.
    
    Parameters:
    
    storageLocation - the storage location
    
    Returns:
    
    this Schema object (for method chaining)
  - setTablespace
```
public Schema setTablespace(String tablespace)
```
    Sets the tablespace string. It is optional, if specified, create and use this tablespace.
    
    Parameters:
    
    tablespace - the tablespace to use
    
    Returns:
    
    this Schema object (for method chaining)
  - setTempTablespace
```
public Schema setTempTablespace(String tempTablespace)
```
    Sets the tempTablespace string. It is optional, if specified, create and use this tablespace.
    
    Parameters:
    
    tempTablespace - the temporary tablespace to use
    
    Returns:
    
    this Schema object (for method chaining)
  - validate
```
public void validate(oracle.fmwplatform.util.validation.Validate validate)
```
    Validate this Schema using the specified Validate instance.
    
    Specified by:
    
    validate in interface oracle.fmwplatform.util.validation.ValidationParticipant
    
    Parameters:
    
    validate - the Validate instance performing the validation
  - 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

Class Schema

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Schema

Method Detail

addAllDataSourceBindings

addDataSourceBinding

getAuxiliarySchemaCredentialRefs

getComponentInfo

getCredentialRef

getDatabase

getDataSourceBindingByName

getDataSourceBindings

getEffectiveVariables

getVariableValue

substitute

getGenericDataSourceBindings

getMultiDataSourceBindings

getParent

getPrefix

getSchemaComponentIdRef

getShared

getStorageLocation

getTablespace

getTempTablespace

setAuxiliarySchemaCredentialRefs

addAuxiliarySchemaCredentialRef

addAllAuxiliarySchemaCredentialRefs

setComponentInfo

setCredentialRef

setDatabase

setDataSourceBindings

setParent

setPrefix

setSchemaComponentIdRef

setShared

setStorageLocation

setTablespace

setTempTablespace

validate

toXmlCompactString

toXmlString

toCompactString

toString