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

java.lang.Object
- oracle.fmwplatform.envspec.model.domain.DomainProfile

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.Versioned, oracle.fmwplatform.util.validation.ValidationParticipant
```
public class DomainProfile
extends Object
implements oracle.fmwplatform.envspec.common.Versioned, oracle.fmwplatform.util.validation.ValidationParticipant
```
Domain Profile is a reusable set of logical information about a domain, e.g. the servers, clusters, etc., and does not include any mapping to actual machines, etc.

Since:

12.2.1

Constructor Summary

Constructors
Constructor and Description

DomainProfile()

Constructors
Constructor and Description
`DomainProfile()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addAllBlueprints(List<Blueprint> blueprints)` Add a list of Blueprints to the existing list of blueprints in this domain profile.
`boolean`	`addAllClusters(List<Cluster> clusters)` Add a list of clusters to the existing list of clusters in this domain profile.
`boolean`	`addAllServers(List<Server> servers)` Adds a list of Server objects to the list of Servers in this DomainProfile
`boolean`	`addAllTargets(List<Target> targets)` Adds a list of Target objects to the list of Targets in this DomainProfile
`boolean`	`addBlueprint(Blueprint blueprint)` Add a blueprint to the list of blueprints in this domain profile.
`boolean`	`addBlueprint(String blueprintName)` Add a blueprint to the list of blueprints in this domain profile identified by the blueprintName.
`boolean`	`addBlueprint(String blueprintName, String version, EnvironmentModelFileLocator locator)` Add a blueprint to the list of blueprints in this domain profile identified by the blueprintName.
`boolean`	`addCluster(Cluster cluster)` Add a Cluster to the list of clusters in this domain profile.
`boolean`	`addServer(Server server)` Adds a Server to the list of Servers in this DomainProfile
`boolean`	`addTarget(Target target)` Adds a Target to the list of Targets in this DomainProfile
`List<Blueprint>`	`getBlueprints()` Get the list of Blueprints available in this DomainProfile.
`List<Cluster>`	`getClusters()` Returns the list of clusters defined in this domain profile.
`DomainProfile`	`getDomainProfile()` Returns the domain profile from any domain profile reference this domain profile may have.
`String`	`getFMWVersionRange()` Returns the range of FMW releases that this model object is supported under.
`String`	`getName()` Returns the name.
`String`	`getSchemaVersion()` Returns the version of the EnvSpec (XML) schema that applies to this model.
`List<Server>`	`getServers()` Returns the list of servers defined in this domain profile.
`List<Target>`	`getTargets()` Returns the list of targets defined in this domain profile.
`String`	`getVersion()` Returns the consumer specified version of the this model file.
`DomainProfile`	`removeDomainProfile()` Removes the domainProfile of this DomainProfile
`DomainProfile`	`removeServers()` Removes the servers of this DomainProfile
`DomainProfile`	`setBlueprints(List<Blueprint> blueprints)` Sets a list of Blueprints replacing the existing list of blueprints in this domain profile.
`DomainProfile`	`setClusters(List<Cluster> clusters)` Sets the list of Clusters in this DomainProfile.
`DomainProfile`	`setDomainProfile(DomainProfile domainProfile)` Set the child domain profile to the domain profile specified in domainProfile.
`DomainProfile`	`setDomainProfile(String domainProfileName)` Set the child domain profile by loading the domain profile identified by the domainProfileName.
`DomainProfile`	`setDomainProfile(String domainProfileName, String version, EnvironmentModelFileLocator locator)` Set the child domain profile by loading the domain profile identified by the domainProfileName.
`DomainProfile`	`setFMWVersionRange(String fmwVersionRange)` Sets the the range of FMW releases that this model object is supported under.
`DomainProfile`	`setName(String name)` Sets the name.
`DomainProfile`	`setSchemaVersion(String schemaVersion)` Sets the version of the EnvSpec (XML) schema that applies to this model.
`DomainProfile`	`setServers(List<Server> servers)` Sets the list of Servers in this DomainProfile.
`DomainProfile`	`setTargets(List<Target> targets)` Sets the list of targets defined in this DomainProfile.
`DomainProfile`	`setVersion(String version)` Sets the consumer specified version of the their model file.
`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)`

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

- Constructor Detail
  - DomainProfile
```
public DomainProfile()
```
- Method Detail
  - addBlueprint
```
public boolean addBlueprint(Blueprint blueprint)
                     throws IllegalArgumentException
```
    Add a blueprint to the list of blueprints in this domain profile.
    
    Parameters:
    
    blueprint - The blueprint to be added
    
    Returns:
    
    true if the list of Blueprints changed as a result of this call
    
    Throws:
    
    IllegalArgumentException - if input parameter is null
  - setBlueprints
```
public DomainProfile setBlueprints(List<Blueprint> blueprints)
```
    Sets a list of Blueprints replacing the existing list of blueprints in this domain profile.
    
    Parameters:
    
    blueprints - A List of Blueprint objects to be added
    
    Returns:
    
    true if the list of Blueprints changed as a result of this call
    
    Throws:
    
    IllegalArgumentException - if input parameter is null
  - addAllBlueprints
```
public boolean addAllBlueprints(List<Blueprint> blueprints)
                         throws IllegalArgumentException
```
    Add a list of Blueprints to the existing list of blueprints in this domain profile.
    
    Parameters:
    
    blueprints - A List of Blueprint objects to be added
    
    Returns:
    
    true if the list of Blueprints changed as a result of this call
    
    Throws:
    
    IllegalArgumentException - if input parameter is null
  - addBlueprint
```
public boolean addBlueprint(String blueprintName,
                            String version,
                            EnvironmentModelFileLocator locator)
                     throws FMWEnvSpecException,
                            IllegalArgumentException
```
    Add a blueprint to the list of blueprints in this domain profile identified by the blueprintName. When multiple versions of a blueprint are available with the same name, the version number can be specified to select the desired blueprint. Specifying the optional file locator allows the blueprint search to include other blueprint locations outside the Oracle Home.
    
    Parameters:
    
    blueprintName - The name of the blueprint to be added
    
    version - The version of the blueprint to be added or null if any version is acceptable
    
    locator - An EnvironmentModelFileLocator locator that has been initialized with the paths that are to be searched when finding the blueprint or null if only the Oracle Home needs to be searched
    
    Returns:
    
    true if the list of Blueprints changed as a result of this call
    
    Throws:
    
    FMWEnvSpecException - The blueprint could not be loaded
    
    IllegalArgumentException - if blueprintName parameter is null
  - addBlueprint
```
public boolean addBlueprint(String blueprintName)
                     throws FMWEnvSpecException
```
    Add a blueprint to the list of blueprints in this domain profile identified by the blueprintName. This method uses the internal file locator to find and instantiate the blueprint identified by the blueprintName provided. If multiple versions of the blueprint exist that are identified by the same name, the first one found will be used.
    
    Parameters:
    
    blueprintName - the name of the Blueprint to be added
    
    Returns:
    
    true if the list of Blueprints changed as a result of this call
    
    Throws:
    
    FMWEnvSpecException - The blueprint could not be loaded
  - getBlueprints
```
public List<Blueprint> getBlueprints()
```
    Get the list of Blueprints available in this DomainProfile. If the Blueprint References haven't been resolved then they will be resolved now and the ResourceReference list will be cleared.
    
    Returns:
    
    the list of Blueprints available in this DomainProfile
  - getClusters
```
public List<Cluster> getClusters()
```
    Returns the list of clusters defined in this domain profile.
    
    Returns:
    
    list of clusters
  - getDomainProfile
```
public DomainProfile getDomainProfile()
                               throws FMWEnvSpecException
```
    Returns the domain profile from any domain profile reference this domain profile may have. Null if no domain profile reference is present. if the DomainProfile has not yet been resolved then it will be resolved now and the DomainProfileResourceReference will be cleared.
    
    Returns:
    
    domain profile
    
    Throws:
    
    FMWEnvSpecException - if domain profile reference cannot be read.
  - getName
```
public String getName()
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Returns the name.
    
    Specified by:
    
    getName in interface oracle.fmwplatform.envspec.common.Versioned
    
    Returns:
    
    name
  - getSchemaVersion
```
public String getSchemaVersion()
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Returns the version of the EnvSpec (XML) schema that applies to this model.
    
    Specified by:
    
    getSchemaVersion in interface oracle.fmwplatform.envspec.common.Versioned
    
    Returns:
    
    the version of the EnvSpec (XML) schema that applies to this model
  - getServers
```
public List<Server> getServers()
```
    Returns the list of servers defined in this domain profile.
    
    Returns:
    
    list of servers
  - getTargets
```
public List<Target> getTargets()
```
    Returns the list of targets defined in this domain profile.
    
    Returns:
    
    list of targets
  - getVersion
```
public String getVersion()
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Returns the consumer specified version of the this model file. This should be incremented when the model file is changed. This is used to allow the consumer to select a version by using it's version or a version range.
    
    Specified by:
    
    getVersion in interface oracle.fmwplatform.envspec.common.Versioned
    
    Returns:
    
    the consumer specified version of the their model file
  - getFMWVersionRange
```
public String getFMWVersionRange()
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Returns the range of FMW releases that this model object is supported under.
    
    Specified by:
    
    getFMWVersionRange in interface oracle.fmwplatform.envspec.common.Versioned
    
    Returns:
    
    the consumer specified version of the their model
  - setFMWVersionRange
```
public DomainProfile setFMWVersionRange(String fmwVersionRange)
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Sets the the range of FMW releases that this model object is supported under.
    
    Specified by:
    
    setFMWVersionRange in interface oracle.fmwplatform.envspec.common.Versioned
    
    Parameters:
    
    fmwVersionRange - the range of FMW releases that this model object is supported under
    
    Returns:
    
    this (for method chaining)
  - setClusters
```
public DomainProfile setClusters(List<Cluster> clusters)
```
    Sets the list of Clusters in this DomainProfile.
    
    Parameters:
    
    clusters - the list of Clusters to be added this DomainProfile
    
    Returns:
    
    this DomainProfile object (for method chaining)
  - addCluster
```
public boolean addCluster(Cluster cluster)
                   throws IllegalArgumentException
```
    Add a Cluster to the list of clusters in this domain profile.
    
    Parameters:
    
    cluster - The Cluster to be added
    
    Returns:
    
    true if the list of Blueprints changed as a result of this call
    
    Throws:
    
    IllegalArgumentException - if input parameter is null
  - addAllClusters
```
public boolean addAllClusters(List<Cluster> clusters)
                       throws IllegalArgumentException
```
    Add a list of clusters to the existing list of clusters in this domain profile.
    
    Parameters:
    
    clusters - A List of Cluster objects to be added
    
    Returns:
    
    true if the list of Blueprints changed as a result of this call
    
    Throws:
    
    IllegalArgumentException - if input parameter is null
  - setDomainProfile
```
public DomainProfile setDomainProfile(DomainProfile domainProfile)
                               throws IllegalArgumentException
```
    Set the child domain profile to the domain profile specified in domainProfile. If there is a domain profile reference then it will be removed.
    
    Parameters:
    
    domainProfile - The domain profile to be set as the child of this domain profile
    
    Returns:
    
    this (for method chaining)
    
    Throws:
    
    IllegalArgumentException
  - removeDomainProfile
```
public DomainProfile removeDomainProfile()
```
    Removes the domainProfile of this DomainProfile
    
    Returns:
    
    this DomainProfile object (for method chaining)
  - setDomainProfile
```
public DomainProfile setDomainProfile(String domainProfileName,
                                      String version,
                                      EnvironmentModelFileLocator locator)
                               throws FMWEnvSpecException
```
    Set the child domain profile by loading the domain profile identified by the domainProfileName. If a version is specified then only a domain profile that matches the name and version will be loaded. If there is a domain profile reference then it will be removed. pd.getName()
    
    Parameters:
    
    domainProfileName - The name of the domain profile to be set as the child domain profile
    
    version - The version of the domain profile to be added or null if any version is acceptable
    
    locator - An EnvironmentModelFileLocator locator that has been initialized with the paths that are to be searched when finding the domain profile or null if only the Oracle Home needs to be searched
    
    Returns:
    
    this DomainProfile object (for method chaining)
    
    Throws:
    
    FMWEnvSpecException - The domain profile could not be loaded
  - setDomainProfile
```
public DomainProfile setDomainProfile(String domainProfileName)
                               throws FMWEnvSpecException
```
    Set the child domain profile by loading the domain profile identified by the domainProfileName. This method will load the first version that matches the name. Only the domain profile located in the Oracle Home will be searched for. If there is a domain profile reference then it will be removed.
    
    Parameters:
    
    domainProfileName - The name of the domain profile to be added
    
    Returns:
    
    this DomainProfile object (for method chaining)
    
    Throws:
    
    FMWEnvSpecException - The domain profile could not be loaded
  - setName
```
public DomainProfile setName(String name)
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Sets the name.
    
    Specified by:
    
    setName in interface oracle.fmwplatform.envspec.common.Versioned
    
    Parameters:
    
    name - the name
    
    Returns:
    
    this (for method chaining)
  - setSchemaVersion
```
public DomainProfile setSchemaVersion(String schemaVersion)
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Sets the version of the EnvSpec (XML) schema that applies to this model.
    
    Specified by:
    
    setSchemaVersion in interface oracle.fmwplatform.envspec.common.Versioned
    
    Parameters:
    
    schemaVersion - the version of the EnvSpec (XML) schema that applies to this model
    
    Returns:
    
    this (for method chaining)
  - setServers
```
public DomainProfile setServers(List<Server> servers)
                         throws IllegalArgumentException
```
    Sets the list of Servers in this DomainProfile.
    
    Parameters:
    
    servers - the Servers that are to be contained in this DomainProfile
    
    Returns:
    
    this (for method chaining)
    
    Throws:
    
    IllegalArgumentException
  - removeServers
```
public DomainProfile removeServers()
```
    Removes the servers of this DomainProfile
    
    Returns:
    
    this DomainProfile object (for method chaining)
  - addAllServers
```
public boolean addAllServers(List<Server> servers)
                      throws IllegalArgumentException
```
    Adds a list of Server objects to the list of Servers in this DomainProfile
    
    Parameters:
    
    servers - list of String objects to add
    
    Returns:
    
    true if the list of servers changed as a result of this call
    
    Throws:
    
    IllegalArgumentException - if input parameter is null
  - addServer
```
public boolean addServer(Server server)
                  throws IllegalArgumentException
```
    Adds a Server to the list of Servers in this DomainProfile
    
    Parameters:
    
    server - the Cluster object to add
    
    Returns:
    
    true if the list of servers changed as a result of this call
    
    Throws:
    
    IllegalArgumentException - if input parameter is null
  - setTargets
```
public DomainProfile setTargets(List<Target> targets)
```
    Sets the list of targets defined in this DomainProfile.
    
    Parameters:
    
    targets - the list of targets for this DomainProfile
    
    Returns:
    
    this (for method chaining)
  - addAllTargets
```
public boolean addAllTargets(List<Target> targets)
                      throws IllegalArgumentException
```
    Adds a list of Target objects to the list of Targets in this DomainProfile
    
    Parameters:
    
    targets - list of String objects to add
    
    Returns:
    
    true if the list of servers changed as a result of this call
    
    Throws:
    
    IllegalArgumentException - if input parameter is null
  - addTarget
```
public boolean addTarget(Target target)
                  throws IllegalArgumentException
```
    Adds a Target to the list of Targets in this DomainProfile
    
    Parameters:
    
    target - the Cluster object to add
    
    Returns:
    
    true if the list of servers changed as a result of this call
    
    Throws:
    
    IllegalArgumentException - if input parameter is null
  - setVersion
```
public DomainProfile setVersion(String version)
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Sets the consumer specified version of the their model file. This should be incremented when the model file is changed. This is used to allow the consumer to select a version by using it's version or a version range.
    
    Specified by:
    
    setVersion in interface oracle.fmwplatform.envspec.common.Versioned
    
    Parameters:
    
    version - the consumer specified version of the their model file.
    
    Returns:
    
    this (for method chaining)
  - validate
```
public void validate(oracle.fmwplatform.util.validation.Validate validate)
```
    Specified by:
    
    validate in interface oracle.fmwplatform.util.validation.ValidationParticipant
  - 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 DomainProfile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DomainProfile

Method Detail

addBlueprint

setBlueprints

addAllBlueprints

addBlueprint

addBlueprint

getBlueprints

getClusters

getDomainProfile

getName

getSchemaVersion

getServers

getTargets

getVersion

getFMWVersionRange

setFMWVersionRange

setClusters

addCluster

addAllClusters

setDomainProfile

removeDomainProfile

setDomainProfile

setDomainProfile

setName

setSchemaVersion

setServers

removeServers

addAllServers

addServer

setTargets

addAllTargets

addTarget

setVersion

validate

toXmlCompactString

toXmlString

toCompactString

toString