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

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

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.ContainerAware<Topology>, oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.ParentContainerWithVariables, oracle.fmwplatform.envspec.common.ReservedKeywordProvider, oracle.fmwplatform.envspec.common.Substitutable, oracle.fmwplatform.envspec.common.Tunable<Topology>, oracle.fmwplatform.util.validation.ValidationParticipant
```
public class Domain
extends Object
implements oracle.fmwplatform.envspec.common.ParentContainerWithVariables, oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.Tunable<Topology>, oracle.fmwplatform.util.validation.ValidationParticipant
```
Represents a Domain in a Topology model.

Field Summary

Fields
Modifier and Type Field and Description

static String RESERVED_TOKEN_ADMINSERVER

static String RESERVED_TOKEN_DOMAIN

Fields
Modifier and Type	Field and Description
`static String`	`RESERVED_TOKEN_ADMINSERVER`
`static String`	`RESERVED_TOKEN_DOMAIN`

Constructor Summary

Constructors
Constructor and Description

Domain()

Constructors
Constructor and Description
`Domain()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`addAllClusterBindings(List<ClusterBinding> clusterBindings)` Adds the ClusterBindings provided to the list of ClusterBindings in this Domain.
`boolean`	`addAllDependencies(List<Dependency> dependencies)` Add a list of Dependency objects to the Domain
`boolean`	`addAllSchemas(List<Schema> schemas)` Adds the Schemas provided to the list of Schemas in this Domain.
`boolean`	`addAllServerBindings(List<ServerBinding> serverBindings)` Adds the ServerBindings provided to the list of ServerBindings in this Domain.
`boolean`	`addAllWebTierBindings(List<WebTierBinding> webTierBindings)` Adds the WebTierBindings provided to the list of WebTierBindings in this domain
`boolean`	`addClusterBinding(ClusterBinding clusterBinding)` Adds the ClusterBinding provided to the list of ClusterBindings in this Domain.
`boolean`	`addDependency(Dependency dependency)` Add a single Dependency object to the Domain
`boolean`	`addSchema(Schema schema)` Adds the Schema provided to the list of Schemas in this Domain.
`boolean`	`addServerBinding(ServerBinding serverBinding)` Adds the ServerBinding provided to the list of ServerBindings in this Domain.
`boolean`	`addSetting(String alias, String value)` Convenience method to add a setting with the given alias and value, to the tuning parameters for this Domain.
`boolean`	`addWebTierBinding(WebTierBinding webTierBinding)` Adds the WebTierBinding provided to the list of WebTierBindings in this Domain
`String`	`getAdminCredentialRef()` Returns the Credential reference used to login to the AdminServer.
`Server`	`getAdminServer()` Returns the AdminServer on this Domain or null if one has not been set.
`String`	`getAdminServerId()` Returns the Server id of the AdminServer on this Domain or null if one has not been set.
`String`	`getAdminServerUrl()` Returns the admin server URL
`String`	`getApplicationPath()` Return the domain's application path.
`ClusterBinding`	`getClusterBindingForClusterID(String clusterID)` Returns the cluster binding for the cluster Id specified or null if none are found.
`List<ClusterBinding>`	`getClusterBindings()` Returns the list of cluster bindings in this domain.
`List<ClusterBinding>`	`getClusterBindingsForClusterIDs(List<String> clusterIDs)` Returns the cluster bindings for the cluster IDs specified o an empty list if none are found.
`Cluster`	`getClusterById(String clusterId)` Return the Cluster in this Domain that matches the name provided or null if no match is found.
`List<String>`	`getClusterIds()` Returns the list of cluster Ids on this domain.
`String`	`getDefaultCoherencePort()` Returns the Default Coherence Port
`List<Dependency>`	`getDependencies()` Returns the dependencies of the Domain
`String`	`getDomainName()` Deprecated.
`DomainProfile`	`getDomainProfile()`
`List<Cluster>`	`getEffectiveClusters()` Returns all the clusters in this domain.
`List<Server>`	`getEffectiveServers()` Returns all the servers in this domain.
`List<Target>`	`getEffectiveTargets()` Returns all the targets in this domain.
`List<Template>`	`getEffectiveTemplates()` Returns all the templates in this domain.
`Map<String,String>`	`getEffectiveVariables()` Returns the variables from the tuning parameters of this domain as well as from the topology that this domain belongs to.
`List<GenericDataSourceBinding>`	`getGenericDataSourceBindings()` Returns the list of generic data source bindings from the schemas in this domain
`String`	`getId()` Returns the id used to reference this Domain.
`List<MultiDataSourceBinding>`	`getMultiDataSourceBindings()` Returns the list of multi data source bindings from the schemas in this domain
`String`	`getName()` Returns the name of this Domain.
`Topology`	`getParent()` Returns the object that contains this entity
`String`	`getPath()` Returns the path of the domain
`String`	`getProvides()` Return the domain's provides value.
`Map<String,String>`	`getReservedKeywords()` Returns a map containing any reserved keywords and values for variable substitution for this entity
`Schema`	`getSchemaForSchemaComponentRefID(String schemaComponentRefID)` Returns the Schema for the schemaComponentRefID specified or null if no match is found.
`List<Schema>`	`getSchemas()` Returns the list of schemas in this domain
`ServerBinding`	`getServerBindingByName(String serverName)` Returns the ServerBinding matching the server name provided or null if no match is found.
`ServerBinding`	`getServerBindingForServerID(String serverID)` Returns the ServerBinding for the server Id specified or null if no match is found.
`List<ServerBinding>`	`getServerBindings()` Returns the list of ServerBindings in this Domain or an empty list if none are found.
`List<ServerBinding>`	`getServerBindingsForServerIDs(List<String> serverIDs)` Returns the ServerBindings for the server ids specified or an empty list if none are found.
`String`	`getServerIdForServerName(String serverName)` Returns the Server id for the server name provided or null if no match is found
`List<String>`	`getServerIds()` Returns the list of unique server ids on this domain or an empty list if none are found.
`TuningParameters`	`getTuningParameters()` Returns the TuningParamaeters for this Domain or null if one has not been set.
`Type`	`getType()` Returns the type of the domain (local or shared)
`String`	`getVariableValue(String key)` Returns the variable value assigned to the specified key.
`List<WebTierBinding>`	`getWebTierBindings()` Returns the list of WebTierBindings in this Domain or an empty list if none are found
`Domain`	`removeClusterBindings()` Removes the clusterBindings of this Domain
`Domain`	`removeDependencies()` Removes the id of this Domain
`Domain`	`removePath()` Clears the path to the location on the file system where the Domain is located.
`Domain`	`removeSchemas()` Removes the schemas of this Database
`Domain`	`removeServerBindings()` Removes the serverBindings of this Database
`Domain`	`removeType()` Removes the type of this Domain
`Domain`	`removeWebTierBindings()` Removes the webTierBindings of this Database
`Domain`	`setAdminCredentialRef(String adminCredentialRef)` Sets the Credential reference for the AdminServer of this Domain
`Domain`	`setAdminServerUrl(String adminServerUrl)` Sets the URL for the aAdminServer
`Domain`	`setApplicationPath(String applicationPath)` Set the domain application path.
`Domain`	`setDefaultCoherencePort(String defaultCoherencePort)` Set the domain defaultCoherencePort value.
`Domain`	`setDomainProfile(DomainProfile domainProfile)` Sets the DomainProfile for this Domain.
`Domain`	`setId(String id)` Sets id to be used when referencing this Domain.
`Domain`	`setName(String name)` Sets the name of this Domain.
`Domain`	`setParent(Topology containerTopology)` Sets the container object that contains this.
`Domain`	`setPath(String path)` Sets the path to the location on the file system where the Domain is located.
`Domain`	`setProvides(String provides)` Set the domain provides value.
`Domain`	`setTuningParameters(TuningParameters tuningParameters)` Sets the TuningParameters for this Domain or null if no TuningParameters.
`Domain`	`setType(Type type)` Sets the type of the Domain (local or shared).
`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 Domain using the specified Validate instance.

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

- Field Detail
  - RESERVED_TOKEN_DOMAIN
```
public static final String RESERVED_TOKEN_DOMAIN
```
    See Also:
    
    Constant Field Values
  - RESERVED_TOKEN_ADMINSERVER
```
public static final String RESERVED_TOKEN_ADMINSERVER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Domain
```
public Domain()
```
- Method Detail
  - addAllClusterBindings
```
public boolean addAllClusterBindings(List<ClusterBinding> clusterBindings)
                              throws IllegalArgumentException
```
    Adds the ClusterBindings provided to the list of ClusterBindings in this Domain.
    
    Parameters:
    
    clusterBindings - the ClusterBindings to be added to list of ClusterBindings
    
    Returns:
    
    true if this list changed as a result of the call
    
    Throws:
    
    IllegalArgumentException
  - removeClusterBindings
```
public Domain removeClusterBindings()
```
    Removes the clusterBindings of this Domain
    
    Returns:
    
    this Domain object (for method chaining)
  - addAllSchemas
```
public boolean addAllSchemas(List<Schema> schemas)
                      throws IllegalArgumentException
```
    Adds the Schemas provided to the list of Schemas in this Domain.
    
    Parameters:
    
    schemas - he Schemas to add to the list of Schemas
    
    Returns:
    
    true if this list changed as a result of the call
    
    Throws:
    
    IllegalArgumentException
  - removeSchemas
```
public Domain removeSchemas()
```
    Removes the schemas of this Database
    
    Returns:
    
    this Domain object (for method chaining)
  - addAllServerBindings
```
public boolean addAllServerBindings(List<ServerBinding> serverBindings)
                             throws IllegalArgumentException
```
    Adds the ServerBindings provided to the list of ServerBindings in this Domain.
    
    Parameters:
    
    serverBindings - the ServerBindings to add to the list of ServerBindings in this Domain
    
    Returns:
    
    true if this list changed as a result of the call
    
    Throws:
    
    IllegalArgumentException
  - removeServerBindings
```
public Domain removeServerBindings()
```
    Removes the serverBindings of this Database
    
    Returns:
    
    this Domain object (for method chaining)
  - addAllWebTierBindings
```
public boolean addAllWebTierBindings(List<WebTierBinding> webTierBindings)
                              throws IllegalArgumentException
```
    Adds the WebTierBindings provided to the list of WebTierBindings in this domain
    
    Parameters:
    
    webTierBindings - the WebTierBindings to add
    
    Returns:
    
    true if this list changed as a result of the call
    
    Throws:
    
    IllegalArgumentException
  - removeWebTierBindings
```
public Domain removeWebTierBindings()
```
    Removes the webTierBindings of this Database
    
    Returns:
    
    this Domain object (for method chaining)
  - addClusterBinding
```
public boolean addClusterBinding(ClusterBinding clusterBinding)
                          throws IllegalArgumentException
```
    Adds the ClusterBinding provided to the list of ClusterBindings in this Domain.
    
    Parameters:
    
    clusterBinding - the ClusterBinding to add to the list of ClusterBindings in this Domain
    
    Returns:
    
    true (as specified by Collection.add(E))
    
    Throws:
    
    IllegalArgumentException
  - addSchema
```
public boolean addSchema(Schema schema)
                  throws IllegalArgumentException
```
    Adds the Schema provided to the list of Schemas in this Domain.
    
    Parameters:
    
    schema - the Schema to add to the list of Schemas in this Domain
    
    Returns:
    
    true (as specified by Collection.add(E))
    
    Throws:
    
    IllegalArgumentException
  - addServerBinding
```
public boolean addServerBinding(ServerBinding serverBinding)
                         throws IllegalArgumentException
```
    Adds the ServerBinding provided to the list of ServerBindings in this Domain.
    
    Parameters:
    
    serverBinding - the ServerBinding to add to the list of ServerBindings in this Domain
    
    Returns:
    
    true if the item is added to the list
    
    Throws:
    
    IllegalArgumentException
  - addWebTierBinding
```
public boolean addWebTierBinding(WebTierBinding webTierBinding)
                          throws IllegalArgumentException
```
    Adds the WebTierBinding provided to the list of WebTierBindings in this Domain
    
    Parameters:
    
    webTierBinding - the WebTierBinding to add
    
    Returns:
    
    true if the item is added to the list
    
    Throws:
    
    IllegalArgumentException
  - 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 Domain.
    
    Specified by:
    
    addSetting in interface oracle.fmwplatform.envspec.common.Tunable<Topology>
    
    Parameters:
    
    alias - the alias of a Setting
    
    value - the value of a Setting
    
    Returns:
    
    true if the item is added to the list
  - getAdminCredentialRef
```
public String getAdminCredentialRef()
```
    Returns the Credential reference used to login to the AdminServer.
    
    Returns:
    
    credential the Credential reference used to login to the AdminServer
  - getAdminServer
```
public Server getAdminServer()
                      throws FMWEnvSpecException
```
    Returns the AdminServer on this Domain or null if one has not been set.
    
    Returns:
    
    the AdminServer on this Domain or null if one has not been set
    
    Throws:
    
    FMWEnvSpecException - When a domain profile reference cannot be found or read
  - getAdminServerId
```
public String getAdminServerId()
                        throws FMWEnvSpecException
```
    Returns the Server id of the AdminServer on this Domain or null if one has not been set.
    
    Returns:
    
    the Server id of the AdminServer on this Domain or null if one has not been set
    
    Throws:
    
    FMWEnvSpecException - When a DomainProfile cannot be found or read
  - getAdminServerUrl
```
public String getAdminServerUrl()
```
    Returns the admin server URL
    
    Returns:
    
    admin server URL
  - getClusterBindingForClusterID
```
public ClusterBinding getClusterBindingForClusterID(String clusterID)
```
    Returns the cluster binding for the cluster Id specified or null if none are found.
    
    Parameters:
    
    clusterID - the cluster binding for the cluster Id specified or null if none are found
    
    Returns:
    
    ClusterBinding. Null if none found
  - getClusterBindings
```
public List<ClusterBinding> getClusterBindings()
```
    Returns the list of cluster bindings in this domain.
    
    Returns:
    
    list of cluster bindings. Initialized so it never returns null.
  - getClusterBindingsForClusterIDs
```
public List<ClusterBinding> getClusterBindingsForClusterIDs(List<String> clusterIDs)
```
    Returns the cluster bindings for the cluster IDs specified o an empty list if none are found.
    
    Parameters:
    
    clusterIDs - the clusterIds for the ClusterBIndings to be returned
    
    Returns:
    
    the cluster bindings for the cluster IDs specified o an empty list if none are found
  - getClusterById
```
public Cluster getClusterById(String clusterId)
                       throws FMWEnvSpecException
```
    Return the Cluster in this Domain that matches the name provided or null if no match is found. Clusters in a domain are unique by Id.
    
    Parameters:
    
    clusterId - the id of the Cluster to be returned
    
    Returns:
    
    the Cluster in this Domain that matches the name provided or null if no match is found
    
    Throws:
    
    FMWEnvSpecException - When a domain profile cannot be found or read
  - getClusterIds
```
public List<String> getClusterIds()
                           throws FMWEnvSpecException
```
    Returns the list of cluster Ids on this domain.
    
    Returns:
    
    list of cluster Ids. Empty list if none found.
    
    Throws:
    
    FMWEnvSpecException - When a domain profile cannot be found or read
  - getDomainName
```
@Deprecated
public String getDomainName()
```
    Deprecated.
    
    Returns the name of the domain based on the path element. The name is derived as the last node in the path.
    
    Returns:
    
    Domain name. Null if could not be determined from path.
  - getDomainProfile
```
public DomainProfile getDomainProfile()
```
  - getEffectiveClusters
```
public List<Cluster> getEffectiveClusters()
                                   throws FMWEnvSpecException
```
    Returns all the clusters in this domain. This is the complete list from all the domain profiles this domain may contain. If two clusters with the same ID are found, only one is returned with the serverRefs combined. Any null clusters or clusters with null IDs are ignored with a warning in the logs and not returned.
    
    Returns:
    
    List of clusters. An empty list is returned if no clusters are defined in this domain.
    
    Throws:
    
    FMWEnvSpecException - When a domain profile reference cannot be found or read
  - getEffectiveServers
```
public List<Server> getEffectiveServers()
                                 throws FMWEnvSpecException
```
    Returns all the servers in this domain. This is the complete list from all the domain profiles this domain may contain. If two servers with the same ID are found, only one of them is returned. Any null servers or servers with null IDs are ignored with a warning in the logs and not returned.
    
    Returns:
    
    List of servers. An empty list is returned if no servers are defined in this domain.
    
    Throws:
    
    FMWEnvSpecException - When a domain profile reference cannot be found or read
  - getEffectiveTargets
```
public List<Target> getEffectiveTargets()
                                 throws FMWEnvSpecException
```
    Returns all the targets in this domain. This is the complete list from all the domain profiles this domain may contain. Only unique targets are returned.
    
    Returns:
    
    List of targets. An empty list is returned if no targets are defined in this domain.
    
    Throws:
    
    FMWEnvSpecException - When a domain profile reference cannot be found or read
  - getEffectiveTemplates
```
public List<Template> getEffectiveTemplates()
                                     throws FMWEnvSpecException
```
    Returns all the templates in this domain. This is the complete list from all the blueprints referenced in the domain profiles, Including nested ones within another blueprint. Only unique templates are returned. Templates are unique by name if Oracle Provided and by name and location if custom. If a null template or null template name is found, it is ignored with a warning in the logs and not returned.
    
    Returns:
    
    List of templates. An empty list is returned if no templates are defined in this domain.
    
    Throws:
    
    FMWEnvSpecException - When external file references cannot be read OR when a custom template does not have location specified
  - getEffectiveVariables
```
public Map<String,String> getEffectiveVariables()
                                         throws FMWEnvSpecException
```
    Returns the variables from the tuning parameters of this domain as well as from the topology that this domain belongs to. Any variables defined within the tuning parameters of the domain overrides the ones from topology.
    
    Specified by:
    
    getEffectiveVariables in interface oracle.fmwplatform.envspec.common.ParentContainerWithVariables
    
    Returns:
    
    the variables from the tuning parameters of this domain as well as from the topology that this domain belongs to
    
    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 generic data source bindings from the schemas in this domain
    
    Returns:
    
    list of generic data source bindings. Initialized so it never returns null.
  - getId
```
public String getId()
```
    Returns the id used to reference this Domain.
    
    Specified by:
    
    getId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Returns:
    
    the id used to reference this Domain
  - getName
```
public String getName()
```
    Returns the name of this Domain.
    
    Returns:
    
    the name of this Domain
  - getMultiDataSourceBindings
```
public List<MultiDataSourceBinding> getMultiDataSourceBindings()
```
    Returns the list of multi data source bindings from the schemas in this domain
    
    Returns:
    
    list of multi data source bindings. Initialized so it never returns null.
  - 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
  - getPath
```
public String getPath()
```
    Returns the path of the domain
    
    Returns:
    
    path
  - getReservedKeywords
```
public Map<String,String> getReservedKeywords()
                                       throws FMWEnvSpecException
```
    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
    
    Throws:
    
    FMWEnvSpecException - in the event of a critical error
  - getSchemaForSchemaComponentRefID
```
public Schema getSchemaForSchemaComponentRefID(String schemaComponentRefID)
```
    Returns the Schema for the schemaComponentRefID specified or null if no match is found.
    
    Parameters:
    
    schemaComponentRefID - the Schema component ref Id for the Schema that is to be returned
    
    Returns:
    
    the Schema for the Schema component ref Id specified or null if no match is found
  - getSchemas
```
public List<Schema> getSchemas()
```
    Returns the list of schemas in this domain
    
    Returns:
    
    list of schemas. Initialized so it never returns null.
  - getServerBindingByName
```
public ServerBinding getServerBindingByName(String serverName)
```
    Returns the ServerBinding matching the server name provided or null if no match is found.
    
    Parameters:
    
    serverName - the name of the server that is to be returned
    
    Returns:
    
    ServerBinding. null if no match found.
  - getServerBindingForServerID
```
public ServerBinding getServerBindingForServerID(String serverID)
```
    Returns the ServerBinding for the server Id specified or null if no match is found.
    
    Parameters:
    
    serverID - the server id for the ServerBinding that is to be returned
    
    Returns:
    
    the ServerBinding for the server Id specified or null if no match is found
  - getServerBindings
```
public List<ServerBinding> getServerBindings()
```
    Returns the list of ServerBindings in this Domain or an empty list if none are found.
    
    Returns:
    
    the list of ServerBindings in this Domain or an empty list if none are found.
  - getServerBindingsForServerIDs
```
public List<ServerBinding> getServerBindingsForServerIDs(List<String> serverIDs)
```
    Returns the ServerBindings for the server ids specified or an empty list if none are found.
    
    Parameters:
    
    serverIDs - the Server ids for the ServerBinding that are to be returned
    
    Returns:
    
    the ServerBindings for the server ids specified or an empty list if none are found
  - getServerIdForServerName
```
public String getServerIdForServerName(String serverName)
```
    Returns the Server id for the server name provided or null if no match is found
    
    Parameters:
    
    serverName - the name of the Server for which the id is to be returned
    
    Returns:
    
    the Server id for the server name provided or null if no match is found
  - getServerIds
```
public List<String> getServerIds()
                          throws FMWEnvSpecException
```
    Returns the list of unique server ids on this domain or an empty list if none are found. Any null server or null server ID is ignored and not returned.
    
    Returns:
    
    the list of unique server ids on this domain or an empty list if none are found
    
    Throws:
    
    FMWEnvSpecException - When a domain profile cannot be found or read
  - getTuningParameters
```
public TuningParameters getTuningParameters()
```
    Returns the TuningParamaeters for this Domain or null if one has not been set.
    
    Specified by:
    
    getTuningParameters in interface oracle.fmwplatform.envspec.common.Tunable<Topology>
    
    Returns:
    
    the TuningParamaeters for this Domain or null if one has not been set
  - getType
```
public Type getType()
```
    Returns the type of the domain (local or shared)
    
    Returns:
    
    the type of the domain (local or shared)
  - setAdminCredentialRef
```
public Domain setAdminCredentialRef(String adminCredentialRef)
```
    Sets the Credential reference for the AdminServer of this Domain
    
    Parameters:
    
    adminCredentialRef - the Credential id to be used as a reference
    
    Returns:
    
    this Domain object (for method chaining)
  - setAdminServerUrl
```
public Domain setAdminServerUrl(String adminServerUrl)
```
    Sets the URL for the aAdminServer
    
    Parameters:
    
    adminServerUrl - the AdminServer url
    
    Returns:
    
    this Domain object (for method chaining)
  - setDomainProfile
```
public Domain setDomainProfile(DomainProfile domainProfile)
```
    Sets the DomainProfile for this Domain.
    
    Parameters:
    
    domainProfile - the DomainProile to be associated to this Domain
    
    Returns:
    
    this Domain object (for method chaining)
  - setId
```
public Domain setId(String id)
```
    Sets id to be used when referencing this Domain.
    
    Specified by:
    
    setId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Parameters:
    
    id - the id to be used when referencing this Domain
    
    Returns:
    
    this Domain object (for method chaining)
  - setName
```
public Domain setName(String name)
```
    Sets the name of this Domain.
    
    Parameters:
    
    name - the name of this Domain
    
    Returns:
    
    this Domain object (for method chaining)
  - setParent
```
public Domain 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
  - setPath
```
public Domain setPath(String path)
               throws IllegalArgumentException
```
    Sets the path to the location on the file system where the Domain is located.
    
    Parameters:
    
    path - the path to the location on the file system where the Domain is located
    
    Returns:
    
    this Domain object (for method chaining)
    
    Throws:
    
    IllegalArgumentException
  - removePath
```
public Domain removePath()
```
    Clears the path to the location on the file system where the Domain is located.
    
    Returns:
    
    this Domain object (for method chaining)
  - setTuningParameters
```
public Domain setTuningParameters(TuningParameters tuningParameters)
```
    Sets the TuningParameters for this Domain or null if no TuningParameters.
    
    Specified by:
    
    setTuningParameters in interface oracle.fmwplatform.envspec.common.Tunable<Topology>
    
    Parameters:
    
    tuningParameters - the TuningParameters for this Domain or null if no TuningParameters
    
    Returns:
    
    this Domain object (for method chaining)
  - setType
```
public Domain setType(Type type)
               throws IllegalArgumentException
```
    Sets the type of the Domain (local or shared).
    
    Parameters:
    
    type - the type of the Domain (local or shared)
    
    Returns:
    
    this Domain object (for method chaining)
    
    Throws:
    
    IllegalArgumentException
  - removeType
```
public Domain removeType()
```
    Removes the type of this Domain
    
    Returns:
    
    this Domain object (for method chaining)
  - getWebTierBindings
```
public List<WebTierBinding> getWebTierBindings()
```
    Returns the list of WebTierBindings in this Domain or an empty list if none are found
    
    Returns:
    
    list of WebTierBindings or an empty list if none are found
  - getApplicationPath
```
public String getApplicationPath()
```
    Return the domain's application path.
    
    Returns:
    
    the application path or null if none.
  - setApplicationPath
```
public Domain setApplicationPath(String applicationPath)
```
    Set the domain application path.
    
    Parameters:
    
    applicationPath - the path where applications will be deployed for this domain.
    
    Returns:
    
    this Domain object (for method chaining)
  - getProvides
```
public String getProvides()
```
    Return the domain's provides value. Used for determining Dependency information.
    
    Returns:
    
    the provides value or null if none.
  - setProvides
```
public Domain setProvides(String provides)
```
    Set the domain provides value.
    
    Parameters:
    
    provides - the String value that shows what this Domain object provides Used for Dependency.
    
    Returns:
    
    this Domain object (for method chaining)
  - getDependencies
```
public List<Dependency> getDependencies()
```
    Returns the dependencies of the Domain
    
    Returns:
    
    list of Dependency objects for the Domain
  - addDependency
```
public boolean addDependency(Dependency dependency)
                      throws IllegalArgumentException
```
    Add a single Dependency object to the Domain
    
    Parameters:
    
    dependency - ExecuteAction object to add to the list
    
    Returns:
    
    true if this list changed as a result of the call
    
    Throws:
    
    IllegalArgumentException - if input parameter is null
  - addAllDependencies
```
public boolean addAllDependencies(List<Dependency> dependencies)
                           throws IllegalArgumentException
```
    Add a list of Dependency objects to the Domain
    
    Parameters:
    
    dependencies - list of Dependency objects to add to the list
    
    Returns:
    
    true if this list changed as a result of the call
    
    Throws:
    
    IllegalArgumentException - if input parameter is null
  - removeDependencies
```
public Domain removeDependencies()
```
    Removes the id of this Domain
    
    Returns:
    
    this Domain object (for method chaining)
  - getDefaultCoherencePort
```
public String getDefaultCoherencePort()
```
    Returns the Default Coherence Port
    
    Returns:
    
    Default Coherence Port
  - setDefaultCoherencePort
```
public Domain setDefaultCoherencePort(String defaultCoherencePort)
```
    Set the domain defaultCoherencePort value.
    
    Parameters:
    
    defaultCoherencePort - set defaultCoherencePort
    
    Returns:
    
    this Domain object (for method chaining)
  - 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
  - validate
```
public void validate(oracle.fmwplatform.util.validation.Validate validate)
```
    Validate this Domain using the specified Validate instance.
    
    Specified by:
    
    validate in interface oracle.fmwplatform.util.validation.ValidationParticipant
    
    Parameters:
    
    validate - the Validate instance performing the validation

Class Domain

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RESERVED_TOKEN_DOMAIN

RESERVED_TOKEN_ADMINSERVER

Constructor Detail

Domain

Method Detail

addAllClusterBindings

removeClusterBindings

addAllSchemas

removeSchemas

addAllServerBindings

removeServerBindings

addAllWebTierBindings

removeWebTierBindings

addClusterBinding

addSchema

addServerBinding

addWebTierBinding

addSetting

getAdminCredentialRef

getAdminServer

getAdminServerId

getAdminServerUrl

getClusterBindingForClusterID

getClusterBindings

getClusterBindingsForClusterIDs

getClusterById

getClusterIds

getDomainName

getDomainProfile

getEffectiveClusters

getEffectiveServers

getEffectiveTargets

getEffectiveTemplates

getEffectiveVariables

getVariableValue

substitute

getGenericDataSourceBindings

getId

getName

getMultiDataSourceBindings

getParent

getPath

getReservedKeywords

getSchemaForSchemaComponentRefID

getSchemas

getServerBindingByName

getServerBindingForServerID

getServerBindings

getServerBindingsForServerIDs

getServerIdForServerName

getServerIds

getTuningParameters

getType

setAdminCredentialRef

setAdminServerUrl

setDomainProfile

setId

setName

setParent

setPath

removePath

setTuningParameters

setType

removeType

getWebTierBindings

getApplicationPath

setApplicationPath

getProvides

setProvides

getDependencies

addDependency

addAllDependencies

removeDependencies

getDefaultCoherencePort