public class Schema extends Object implements oracle.fmwplatform.envspec.common.ParentContainerWithVariables, oracle.fmwplatform.envspec.common.ContainerAware<Domain>
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 and Description |
---|
Schema() |
Modifier and Type | Method and Description |
---|---|
boolean |
addAllAuxiliarySchemaCredentialRefs(List<String> auxiliarySchemaCredentialRefs)
Adds a list AuxiliarySchemaCredentialRefs to the existing list of AuxiliarySchemaCredentialRefs
|
boolean |
addAuxiliarySchemaCredentialRef(String auxiliarySchemaCredentialRef)
Adds an AuxiliarySchemaCredentialRef to the existing list of AuxiliarySchemaCredentialRefs
|
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.
|
String |
getDatabaseRef()
Get the database id
|
Map<String,String> |
getEffectiveVariables()
Provides the effective list of variables that apply to the tuning parameters.
|
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 |
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 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.
|
public List<String> getAuxiliarySchemaCredentialRefs()
public String getComponentInfo()
public String getCredentialRef()
public Database getDatabase()
public String getDatabaseRef()
public Map<String,String> getEffectiveVariables() throws FMWEnvSpecException
getEffectiveVariables
in interface oracle.fmwplatform.envspec.common.ParentContainerWithVariables
FMWEnvSpecException
- When any tuning parameters references cannot be readpublic String getVariableValue(String key)
getVariableValue
in interface oracle.fmwplatform.envspec.common.Substitutable
key
- the key of the variable to be checkedpublic String substitute(String text)
substitute
in interface oracle.fmwplatform.envspec.common.Substitutable
text
- the original textpublic Domain getParent()
oracle.fmwplatform.envspec.common.ContainerAware
getParent
in interface oracle.fmwplatform.envspec.common.ContainerAware<Domain>
public String getPrefix()
public String getSchemaComponentIdRef()
public Schema.Shared getShared()
public String getStorageLocation()
public String getTablespace()
public String getTempTablespace()
public Schema setAuxiliarySchemaCredentialRefs(List<String> auxiliarySchemaCredentialRefs)
auxiliarySchemaCredentialRefs
- the auxiliary Schema Credential reference idspublic boolean addAuxiliarySchemaCredentialRef(String auxiliarySchemaCredentialRef) throws IllegalArgumentException
auxiliarySchemaCredentialRef
- an auxiliary Schema Credential reference idtrue
if the list of MappedWebTiers has changed as a result of this callIllegalArgumentException
public boolean addAllAuxiliarySchemaCredentialRefs(List<String> auxiliarySchemaCredentialRefs) throws IllegalArgumentException
auxiliarySchemaCredentialRefs
- an auxiliary Schema Credential reference idtrue
if the list of MappedWebTiers has changed as a result of this callIllegalArgumentException
public Schema setComponentInfo(String componentInfo)
componentInfo
- the full path to the location of the ComponentInfo.xml filepublic Schema setCredentialRef(String credentialRef)
credentialRef
- the reference id for the Credential to be associated to this Schemapublic Schema setDatabase(Database database)
database
- the Database to be associated with this Schemapublic Schema setParent(Domain containerDomain)
oracle.fmwplatform.envspec.common.ContainerAware
setParent
in interface oracle.fmwplatform.envspec.common.ContainerAware<Domain>
containerDomain
- the parent containerpublic Schema setPrefix(String prefix)
prefix
- the Schema prefixpublic Schema setSchemaComponentIdRef(String schemaComponentIdRef)
schemaComponentIdRef
- he Schema id reference which is the component id in template database.xmlpublic Schema setShared(Schema.Shared shared)
shared
- whether this Schema is shared or notpublic Schema setStorageLocation(String storageLocation)
storageLocation
- the storage locationpublic Schema setTablespace(String tablespace)
tablespace
- the tablespace to usepublic Schema setTempTablespace(String tempTablespace)
tempTablespace
- the temporary tablespace to usepublic String toXmlCompactString()
public String toXmlString()
public String toJsonCompactString()
public String toJsonString()
public String toCompactString()