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

java.lang.Object
- oracle.fmwplatform.envspec.model.EnvironmentModel

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.EnvironmentSpecification
```
public class EnvironmentModel
extends Object
implements oracle.fmwplatform.envspec.common.EnvironmentSpecification
```
The EnvironmentModel provides data access methods for reading information from the various objects within the model (i.e., Topology, DomainProfiles, TuningParameters, Blueprints, and Credentials). The EnvironmentModel contains a reference to a Topology and a Credential.

Since:

12.2.1

Constructor Summary

Constructors
Constructor and Description

EnvironmentModel()
Creates an empty EnvironmentModel

Constructors
Constructor and Description
`EnvironmentModel()` Creates an empty EnvironmentModel

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static EnvironmentModel`	`createEnvironmentModel(Topology topology, oracle.fmwplatform.credentials.credential.Credentials credentials)` Returns a new environment model created with the specified topology and credentials.
`Template`	`getBaseTemplateForDomain(String domainId)` Returns the base Template from the Domain specified or null if no match is found.
`ClusterBinding`	`getClusterBindingByNameForDomain(String clusterBindingName, Domain domain)` Returns the ClusterBinding for the name specified or null if no match is found.
`ClusterBinding`	`getClusterBindingByNameForDomain(String clusterBindingName, String domainId)` Returns the ClusterBinding for the name and Domain id specified or an empty list if no match is found
`List<ClusterBinding>`	`getClusterBindingsForDomain(Domain domain)` Returns the ClusterBindings for the Domain specified or an empty list if no match is found.
`List<ClusterBinding>`	`getClusterBindingsForDomain(String domainId)` Returns the ClusterBindings associated with the domain specified or an empty list if no match is found.
`List<String>`	`getClusterIdsInDomain(Domain domain)` Returns the Cluster ids associated with the Domain specified or an empty list if no match is found.
`List<String>`	`getClusterIdsInDomain(String domainId)` Returns the Cluster ids associated with the Domain specified or an empty list if no match is found.
`List<Cluster>`	`getClustersInDomain(Domain domain)` Returns the Clusters associated with the Domain specified or an empty list if no match is found.
`List<Cluster>`	`getClustersInDomain(String domainId)` Returns the Clusters associated with the Domain specified or an empty list if no match is found.
`oracle.fmwplatform.credentials.credential.Credential`	`getCredentialByAlias(String alias)` Returns the Credential from the Credentials of this EnvironmentModel for the provided alias or null if no match is found.
`oracle.fmwplatform.credentials.credential.Credentials`	`getCredentials()` Returns the Credentials associated with this EnvironmentModel or null if none are found.
`Database`	`getDatabaseById(String databaseId)` Returns the Database for the databaseId specified or null if it is not found.
`List<String>`	`getDatabaseIds()` Returns the Database ids associated with the Topology in this EnvironmentModel or an empty list if none are found.
`List<Database>`	`getDatabases()` Returns the Databases ids associated with the Topology in this EnvironmentModel or an empty list if none are found
`List<DataSourceBinding>`	`getDataSourceBindingsInDomain(Domain domain)` Returns the DataSourceBindings associated with the Domain specified or an empty list if no match is found
`List<DataSourceBinding>`	`getDataSourceBindingsInDomain(String domainId)` Returns the DataSourceBindings associated with the Domain specified or an empty list if no match is found.
`List<String>`	`getDataSourceNamesInDomain(Domain domain)` Returns the DataSource names associated with the Domain specified or an empty list if no match is found.
`List<String>`	`getDataSourceNamesInDomain(String domainId)` Returns the DataSource names associated with the Domain specified or an empty list if no match is found.
`Domain`	`getDomainById(String domainId)` Returns the Domain for the domainId specified or null if it is not found.
`List<String>`	`getDomainIds()` Returns the Domain ids associated with the Topology in this EnvironmentModel or an empty list if none are found.
`List<Domain>`	`getDomains()` Returns the Domains associated with the Topology in this EnvironmentModel or an empty list if none are found.
`List<Domain>`	`getDomainsByName(String domainName)`
`List<Domain>`	`getDomainsForNodeManagerId(String nodeManagerId)` Returns the Domains that are associated with the NodeManager specified or an empty list if no matches are found.
`List<Domain>`	`getDomainsForNodeManagerId(String nodeManagerId, boolean localOnly)` Returns the Domains that are associated with the NodeManager specified or an empty list if no matches are found.
`List<Domain>`	`getDomainsOnHost(Host host)` Returns the Domains associated with the Topology in this EnvironmentModel that match the Host specified or an empty list if no match is found.
`List<Domain>`	`getDomainsOnHost(String hostId)` Returns the Domains associated with the Topology in this EnvironmentModel that match the Host specified or an empty list if no match is found.
`List<Domain>`	`getDomainsUsingOracleHome(OracleHome oracleHome)` Returns the Domains using the OracleHome specified or an empty list if no matches are found.
`List<Domain>`	`getDomainsUsingOracleHome(String oracleHomeId)` Returns the Domains that are associated with the OracleHome specified or an empty list if no matches are found
`List<Template>`	`getExtensionTemplatesForDomain(String domainId)` Returns the extension Templates for the Domain specified or an empty list if none are found.
`Host`	`getHostById(String hostId)` Returns the Host for the hostId specified or null if it is not found.
`Host`	`getHostForDomainAndServer(String domainId, String serverName)` Returns the host mapped to this domain and server
`Host`	`getHostForDomainServer(String domainId, String serverName)` Returns the host mapped to a given domain and server
`Host`	`getHostForNodeManager(String nodeManagerId)` Returns the Host associated to the NodeManager specified or null if no match is found.
`List<String>`	`getHostIds()` Returns the Host ids associated with the Topology in this EnvironmentModel or an empty list if none are found.
`List<String>`	`getHostIdsHostingDomain(Domain domain)` Returns the Host ids associated with the Domain specified or an empty list if none are found
`List<String>`	`getHostIdsHostingDomain(String domainId)` Returns the Host ids associated with the Domain specified or an empty list if none are found.
`List<String>`	`getHostIdsHostingOracleHome(OracleHome oracleHome)` Returns the Host ids associated with the OracleHome specified or an empty list if none are found.
`List<String>`	`getHostIdsHostingOracleHome(String oracleHomeId)` Returns the Host ids associated with the OracleHome specified or an empty list if none are found
`List<Host>`	`getHosts()` Returns the Hosts associated with the Topology in this EnvironmentModel or an empty list if none are found.
`List<Host>`	`getHostsHostingDomain(Domain domain)` Returns the Hosts associated with the Domain specified or an empty list if none are found.
`List<Host>`	`getHostsHostingDomain(String domainId)` Returns the Hosts associated with the Domain specified or an empty list if none are found.
`List<Host>`	`getHostsHostingOracleHome(OracleHome oracleHome)` Returns the Hosts associated with the OracleHome specified or an empty list if none are found.
`List<Host>`	`getHostsHostingOracleHome(String oracleHomeId)` Returns the Hosts associated with the OracleHome specified or an empty list if none are found.
`MappedDomain`	`getMappedDomainForHostAndDomain(String hostId, String domainId)` Returns the MappedDomain that is associated to the Domain and Host specified or null if no match is found.
`MappedOracleHome`	`getMappedOracleHomeForHostAndOracleHome(String hostId, String oracleHomeId)` Returns The MappedOracleHome for the Host and OracleHome specified or null if no match is found.
`NodeManager`	`getNodeManagerById(String nodeManagerId)` Returns the NodeManager for the nodeManagerId specified or null if it is not found.
`List<NodeManager>`	`getNodeManagerByName(String nodeManagerName)`
`NodeManager`	`getNodeManagerForDomainAndServer(String domainId, String serverName)` Returns the NodeManager associated with the Domain and Server specified or null if it is not found.
`List<String>`	`getNodeManagerIds()` Returns the NodeManager ids associated with the Topology in this EnvironmentModel or an empty list if none are found.
`List<NodeManager>`	`getNodeManagers()` Returns the NodeManagers associated with the Topology in this EnvironmentModel or an empty list if none are found.
`List<NodeManager>`	`getNodeManagersForDomain(String domainId)` Returns the NodeManagers associated with the Domain specified or null if it is not found.
`OracleHome`	`getOracleHomeById(String oracleHomeId)` Returns the OracleHome for the oracleHomeId specified or null if it is not found.
`OracleHome`	`getOracleHomeForAdminServerOfDomain(String domainId)` Returns the OracleHome mapped to the AdminServer of the Domain specified or null if no match is found.
`OracleHome`	`getOracleHomeForNodeManager(String nodeManagerId)` Return the OracleHome that was targeted in the model
`List<String>`	`getOracleHomeIds()` Returns the OracleHome ids associated with the Topology in this EnvironmentModel or an empty list if none are found.
`List<OracleHome>`	`getOracleHomes()` Returns the OracleHomes associated with the Topology in this EnvironmentModel or an empty list if none are found
`List<ServerBinding>`	`getServerBindingsInClusterForDomain(String clusterName, String domainId)` Returns the ServerBindings associated with the Domain and Cluster specified or an empty list if none are found
`List<ServerBinding>`	`getServerBindingsOnHost(Host host)` Returns the ServerBindings associated with the Host specified or an empty list if none are found.
`List<ServerBinding>`	`getServerBindingsOnHost(String hostId)` Returns the ServerBindings associated with the Host specified or an empty list if none are found Returns an empty list if none found.
`List<ServerBinding>`	`getServerBindingsOnHostAndDomain(String hostId, String domainId)` Returns the ServerBindings associated with the Domain and Host specified or an empty list if none are found.
`Map<String,Set<String>>`	`getServerGroupMapFromTemplates(String domainId)` Returns a map of server name to list of server groups found in all the templates reference in the given domain
`List<String>`	`getServerGroups(String domainId, String serverName)` Returns the Server group names for the specified Domain and Server or and empty list is none are found.
`List<String>`	`getServerIdsInDomain(Domain domain)` Returns the Server ids associated with the Domain specified or an empty list if none are found.
`List<String>`	`getServerIdsInDomain(String domainId)` Returns the Server ids associated with the Domain specified or an empty list if none are found.
`List<Server>`	`getServersInDomain(Domain domain)` Returns the Servers associated with the Domain specified or an empty list if none are found.
`List<Server>`	`getServersInDomain(String domainId)` Returns the Servers associated with the Domain specified or an empty list if none are found.
`List<SettingWithAliasWLSTValues>`	`getSettingWithAliasWLSTValues(oracle.fmwplatform.envspec.common.Tunable tunable)` Returns a list of Setting key, value as well as the corresponding WLST online and offline path and attributes.
`List<String>`	`getTemplateNamesInDomain(Domain domain)` Returns the Templates associated with the Domain specified or an empty list if none are found.
`List<String>`	`getTemplateNamesInDomain(String domainId)` Returns the Template names associated with the Domain specified or an empty list if none are found.
`List<Template>`	`getTemplatesInDomain(Domain domain)` Returns the Templates associated with the Domain specified or an empty list if none are found.
`List<Template>`	`getTemplatesInDomain(String domainId)` Returns the Templates associated with the Domain specified or an empty list if none are found.
`Topology`	`getTopology()` Returns the Topology associated with this EnvironmentModel or null if it has not been set.
`WebTier`	`getWebTierById(String webTierId)` Returns the WebTier for the webTierId specified or null if it is not found.
`List<WebTier>`	`getWebTiers()` Returns the WebTiers associated with the Topology in this EnvironmentModel or an empty list if none are found.
`List<WebTier>`	`getWebTiersForDomain(String domainId)` Returns the list of WebTier objects for the specified domain
`void`	`setCredentials(oracle.fmwplatform.credentials.credential.Credentials credentials)` Sets the Credentials associated with this EnvironmentModel.
`void`	`setTopology(Topology topology)` Sets the Topology associated with this EnvironmentModel.
`List<oracle.fmwplatform.util.validation.ValidationMessage>`	`validate()` Performs basic validation without reference to any actual environment.
`List<oracle.fmwplatform.util.validation.ValidationMessage>`	`validate(ModelTarget target)` Validates a single environment model target against this model.

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

- Constructor Detail
  - EnvironmentModel
```
public EnvironmentModel()
```
    Creates an empty EnvironmentModel
- Method Detail
  - createEnvironmentModel
```
public static EnvironmentModel createEnvironmentModel(Topology topology,
                                                      oracle.fmwplatform.credentials.credential.Credentials credentials)
```
    Returns a new environment model created with the specified topology and credentials.
    
    Parameters:
    
    topology - the Topology to be wrapped by this EnvironmentModel
    
    credentials - the Credentials to be wrapped by this EnvironmentModel
    
    Returns:
    
    returns a new environment model created with the specified topology and credentials
  - getBaseTemplateForDomain
```
public Template getBaseTemplateForDomain(String domainId)
                                  throws FMWEnvSpecException
```
    Returns the base Template from the Domain specified or null if no match is found.
    
    Parameters:
    
    domainId - the id representing the Domain who's base Template is to be returned
    
    Returns:
    
    the base Template associated with the Domain specified or null if no match is found
    
    Throws:
    
    FMWEnvSpecException - If any external file references cannot be read or when a custom template does not have location specified
  - getClusterBindingByNameForDomain
```
public ClusterBinding getClusterBindingByNameForDomain(String clusterBindingName,
                                                       Domain domain)
```
    Returns the ClusterBinding for the name specified or null if no match is found.
    
    Parameters:
    
    clusterBindingName - the name of the cluster who's ClusterBinding is to be returned
    
    domain - the Domain representing the Domain who's ClusterBinding is to be returned
    
    Returns:
    
    the ClusterBinding for the name specified or null if no match is found
  - getClusterBindingByNameForDomain
```
public ClusterBinding getClusterBindingByNameForDomain(String clusterBindingName,
                                                       String domainId)
```
    Returns the ClusterBinding for the name and Domain id specified or an empty list if no match is found
    
    Parameters:
    
    clusterBindingName - the name of the Cluster who's ClusterBinding is to be returned
    
    domainId - the id representing the Domain who's ClusterBinding is to be returned
    
    Returns:
    
    the ClusterBinding for the name and Domain id specified or null if no match is found
  - getClusterBindingsForDomain
```
public List<ClusterBinding> getClusterBindingsForDomain(Domain domain)
```
    Returns the ClusterBindings for the Domain specified or an empty list if no match is found.
    
    Parameters:
    
    domain - the Domain Domain who's ClusterBinding is to be returned
    
    Returns:
    
    the ClusterBindings for the Domain specified or an empty list if no match is found
  - getClusterBindingsForDomain
```
public List<ClusterBinding> getClusterBindingsForDomain(String domainId)
```
    Returns the ClusterBindings associated with the domain specified or an empty list if no match is found.
    
    Parameters:
    
    domainId - the id representing the Domain who's ClusterBindings are to be returned
    
    Returns:
    
    the ClusterBindings associated with the Domain specified or an empty list if no match is found
  - getClusterIdsInDomain
```
public List<String> getClusterIdsInDomain(Domain domain)
                                   throws FMWEnvSpecException
```
    Returns the Cluster ids associated with the Domain specified or an empty list if no match is found.
    
    Parameters:
    
    domain - the Domain who's Cluster ids are to be returned
    
    Returns:
    
    the Cluster ids associated with the Domain specified or an empty list if no match is found
    
    Throws:
    
    FMWEnvSpecException - When any external domain profile references cannot be read
  - getClusterIdsInDomain
```
public List<String> getClusterIdsInDomain(String domainId)
                                   throws FMWEnvSpecException
```
    Returns the Cluster ids associated with the Domain specified or an empty list if no match is found.
    
    Parameters:
    
    domainId - the id representing the Domain who's Cluster ids are to be returned
    
    Returns:
    
    the Cluster ids associated with the Domain specified or an empty list if no match is found
    
    Throws:
    
    FMWEnvSpecException - When any external domain profile references cannot be read
  - getClustersInDomain
```
public List<Cluster> getClustersInDomain(Domain domain)
                                  throws FMWEnvSpecException
```
    Returns the Clusters associated with the Domain specified or an empty list if no match is found. 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. Returns an empty list if none found.
    
    Parameters:
    
    domain - the Domain who's Clusters are to be returned
    
    Returns:
    
    the Clusters associated with the Domain specified or an empty list if no match is found
    
    Throws:
    
    FMWEnvSpecException - When any external domain profile references cannot be read
  - getClustersInDomain
```
public List<Cluster> getClustersInDomain(String domainId)
                                  throws FMWEnvSpecException
```
    Returns the Clusters associated with the Domain specified or an empty list if no match is found. 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. Returns an empty list if none found.
    
    Parameters:
    
    domainId - the id representing the Domain who's Clusters are to be returned
    
    Returns:
    
    the Clusters associated with the Domain specified or an empty list if no match is found
    
    Throws:
    
    FMWEnvSpecException - When any external domain profile references cannot be read
  - getCredentials
```
public oracle.fmwplatform.credentials.credential.Credentials getCredentials()
```
    Returns the Credentials associated with this EnvironmentModel or null if none are found.
    
    Returns:
    
    the Credentials associated with this EnvironmentModel or null if none are found
  - getCredentialByAlias
```
public oracle.fmwplatform.credentials.credential.Credential getCredentialByAlias(String alias)
```
    Returns the Credential from the Credentials of this EnvironmentModel for the provided alias or null if no match is found.
    
    Parameters:
    
    alias - the Alias representing the specific Credential from this EnvironmentModels Credentials
    
    Returns:
    
    the Credential from the Credentials of this EnvironmentModel for the provided alias or null if no match is found
  - getDatabaseById
```
public Database getDatabaseById(String databaseId)
```
    Returns the Database for the databaseId specified or null if it is not found.
    
    Parameters:
    
    databaseId - The Database associated with the Topology in this EnvironmentModel for the id specified or null if no match is found
    
    Returns:
    
    database the Database associated with the Topology in this EnvironmentModel for the id specified or null if no match
  - getDatabaseIds
```
public List<String> getDatabaseIds()
```
    Returns the Database ids associated with the Topology in this EnvironmentModel or an empty list if none are found. if none found.
    
    Returns:
    
    the Database ids associated with the Topology in this EnvironmentModel or an empty list if none are found
  - getDatabases
```
public List<Database> getDatabases()
```
    Returns the Databases ids associated with the Topology in this EnvironmentModel or an empty list if none are found
    
    Returns:
    
    the Databases associated with the Topology in this EnvironmentModel or an empty list if none are found
  - getDataSourceBindingsInDomain
```
public List<DataSourceBinding> getDataSourceBindingsInDomain(Domain domain)
```
    Returns the DataSourceBindings associated with the Domain specified or an empty list if no match is found
    
    Parameters:
    
    domain - the Domain who's DataSourceBindings are to be returned
    
    Returns:
    
    the DataSourceBindings associated with the Domain specified or an empty list if no match is found
  - getDataSourceBindingsInDomain
```
public List<DataSourceBinding> getDataSourceBindingsInDomain(String domainId)
```
    Returns the DataSourceBindings associated with the Domain specified or an empty list if no match is found.
    
    Parameters:
    
    domainId - the id representing the Domain who's DataSourceBindings are to be returned
    
    Returns:
    
    the DataSourceBindings associated with the Domain specified or an empty list if no match is found
  - getDataSourceNamesInDomain
```
public List<String> getDataSourceNamesInDomain(Domain domain)
```
    Returns the DataSource names associated with the Domain specified or an empty list if no match is found.
    
    Parameters:
    
    domain - the Domain who's DataSource names are to be returned
    
    Returns:
    
    the DataSource names associated with the Domain specified or an empty list if no match is found
  - getDataSourceNamesInDomain
```
public List<String> getDataSourceNamesInDomain(String domainId)
```
    Returns the DataSource names associated with the Domain specified or an empty list if no match is found.
    
    Parameters:
    
    domainId - the id representing the Domain who's DataSource names are to be returned
    
    Returns:
    
    the DataSource names associated with the Domain specified or an empty list if no match is found
  - getDomainById
```
public Domain getDomainById(String domainId)
```
    Returns the Domain for the domainId specified or null if it is not found.
    
    Parameters:
    
    domainId - the id representing the Domain that is to be returned
    
    Returns:
    
    he domain matching the id provided or null if no match is found
  - getDomainsByName
```
public List<Domain> getDomainsByName(String domainName)
```
  - getDomainIds
```
public List<String> getDomainIds()
```
    Returns the Domain ids associated with the Topology in this EnvironmentModel or an empty list if none are found.
    
    Returns:
    
    the Domain ids associated with the Topology in this EnvironmentModel or an empty list if none are found
  - getDomains
```
public List<Domain> getDomains()
```
    Returns the Domains associated with the Topology in this EnvironmentModel or an empty list if none are found.
    
    Returns:
    
    the Domains associated with the Topology in this EnvironmentModel or an empty list if none are found
  - getDomainsOnHost
```
public List<Domain> getDomainsOnHost(Host host)
```
    Returns the Domains associated with the Topology in this EnvironmentModel that match the Host specified or an empty list if no match is found.
    
    Parameters:
    
    host - the host containing the Domains that are to be returned
    
    Returns:
    
    the Domains associated with the Topology in this EnvironmentModel that match the Host specified or an empty list if no match is found
  - getDomainsOnHost
```
public List<Domain> getDomainsOnHost(String hostId)
```
    Returns the Domains associated with the Topology in this EnvironmentModel that match the Host specified or an empty list if no match is found.
    
    Parameters:
    
    hostId - the id representing the host who's Domains are to be returned
    
    Returns:
    
    the Domains associated with the Topology in this EnvironmentModel model that match the Host specified or an empty list if no match is found
  - getDomainsUsingOracleHome
```
public List<Domain> getDomainsUsingOracleHome(OracleHome oracleHome)
```
    Returns the Domains using the OracleHome specified or an empty list if no matches are found.
    
    Parameters:
    
    oracleHome - the OracleHome who's Domains that are to be returned
    
    Returns:
    
    the Domains using the OracleHome specified or an empty list if no matches are found
  - getDomainsForNodeManagerId
```
public List<Domain> getDomainsForNodeManagerId(String nodeManagerId)
```
    Returns the Domains that are associated with the NodeManager specified or an empty list if no matches are found.
    
    Parameters:
    
    nodeManagerId - the id representing the NodeManager who's Domains are to be returned
    
    Returns:
    
    the Domains that are associated with the NodeManager specified or an empty list if no matches are found
  - getDomainsForNodeManagerId
```
public List<Domain> getDomainsForNodeManagerId(String nodeManagerId,
                                               boolean localOnly)
```
    Returns the Domains that are associated with the NodeManager specified or an empty list if no matches are found.
    
    Parameters:
    
    nodeManagerId - the id representing the NodeManager who's Domains are to be returned
    
    localOnly - only return domains for hosts that are local to current runtime ex: 127.0.0.1 , localhost, hostname mapped to local network interface
    
    Returns:
    
    the Domains that are associated with the NodeManager specified or an empty list if no matches are found
  - getDomainsUsingOracleHome
```
public List<Domain> getDomainsUsingOracleHome(String oracleHomeId)
```
    Returns the Domains that are associated with the OracleHome specified or an empty list if no matches are found
    
    Parameters:
    
    oracleHomeId - the id representing the OracleHome who's Domains are to be returned
    
    Returns:
    
    the Domains that are associated with the OracleHome specified or an empty list if no matches are found
  - getExtensionTemplatesForDomain
```
public List<Template> getExtensionTemplatesForDomain(String domainId)
                                              throws FMWEnvSpecException
```
    Returns the extension Templates for the Domain specified or an empty list if none are found.
    
    Parameters:
    
    domainId - the id representing the Domain who's Templates are to be returned
    
    Returns:
    
    the extension Templates for the Domain specified or an empty list if none are found
    
    Throws:
    
    FMWEnvSpecException - When any external file references cannot be read or when a custom template does not have location specified
  - getHostById
```
public Host getHostById(String hostId)
```
    Returns the Host for the hostId specified or null if it is not found.
    
    Parameters:
    
    hostId - The id representing the Host to be returned
    
    Returns:
    
    the Host associated with the Topology in this EnvironmentModel or null if no matches are found
  - getHostForNodeManager
```
public Host getHostForNodeManager(String nodeManagerId)
```
    Returns the Host associated to the NodeManager specified or null if no match is found.
    
    Parameters:
    
    nodeManagerId - the id representing the NodeManager mapped to the Host that is to be returned
    
    Returns:
    
    the Host associated to the NodeManager specified or null if no match is found
  - getOracleHomeForNodeManager
```
public OracleHome getOracleHomeForNodeManager(String nodeManagerId)
```
    Return the OracleHome that was targeted in the model
    
    Parameters:
    
    nodeManagerId - the id of the NodeManager
    
    Returns:
    
    the OracleHome associated with the NodeManager
  - getHostIds
```
public List<String> getHostIds()
```
    Returns the Host ids associated with the Topology in this EnvironmentModel or an empty list if none are found. none found.
    
    Returns:
    
    the Host ids associated with the Topology in this EnvironmentModel or an empty list if none are found
  - getHostIdsHostingDomain
```
public List<String> getHostIdsHostingDomain(Domain domain)
```
    Returns the Host ids associated with the Domain specified or an empty list if none are found
    
    Parameters:
    
    domain - the Domain who's Host ids are to be returned
    
    Returns:
    
    the Host ids associated with the Domain specified or an empty list if none are found
  - getHostIdsHostingDomain
```
public List<String> getHostIdsHostingDomain(String domainId)
```
    Returns the Host ids associated with the Domain specified or an empty list if none are found.
    
    Parameters:
    
    domainId - the id representing the Domain who's Host ids are to be returned
    
    Returns:
    
    the Host ids associated with the Domain specified or an empty list if none are found
  - getHostIdsHostingOracleHome
```
public List<String> getHostIdsHostingOracleHome(OracleHome oracleHome)
```
    Returns the Host ids associated with the OracleHome specified or an empty list if none are found.
    
    Parameters:
    
    oracleHome - the OracleHome who's Host ids are to be returned
    
    Returns:
    
    the Host ids associated with the OracleHome specified or an empty list if none are found
  - getHostIdsHostingOracleHome
```
public List<String> getHostIdsHostingOracleHome(String oracleHomeId)
```
    Returns the Host ids associated with the OracleHome specified or an empty list if none are found
    
    Parameters:
    
    oracleHomeId - the id representing the OracleHome who's Host ids are to be returned
    
    Returns:
    
    the Host ids associated with the OracleHome specified or an empty list if none are found
  - getHosts
```
public List<Host> getHosts()
```
    Returns the Hosts associated with the Topology in this EnvironmentModel or an empty list if none are found.
    
    Returns:
    
    the Hosts associated with the Topology in this EnvironmentModel or an empty list if none are found
  - getHostsHostingDomain
```
public List<Host> getHostsHostingDomain(Domain domain)
```
    Returns the Hosts associated with the Domain specified or an empty list if none are found.
    
    Parameters:
    
    domain - the Domain who's Hosts are to be returned
    
    Returns:
    
    the Hosts associated with the Domain specified or an empty list if none are found
  - getHostsHostingDomain
```
public List<Host> getHostsHostingDomain(String domainId)
```
    Returns the Hosts associated with the Domain specified or an empty list if none are found.
    
    Parameters:
    
    domainId - the id representing the Domain who's Hosts are to be returned
    
    Returns:
    
    the Hosts associated with the Domain specified or an empty list if none are found
  - getHostsHostingOracleHome
```
public List<Host> getHostsHostingOracleHome(OracleHome oracleHome)
```
    Returns the Hosts associated with the OracleHome specified or an empty list if none are found.
    
    Parameters:
    
    oracleHome - the OracleHome who's Hosts are to be returned
    
    Returns:
    
    the Hosts associated with the OracleHome specified or an empty list if none are found
  - getHostsHostingOracleHome
```
public List<Host> getHostsHostingOracleHome(String oracleHomeId)
```
    Returns the Hosts associated with the OracleHome specified or an empty list if none are found.
    
    Parameters:
    
    oracleHomeId - the id representing the OracleHome who's Hosts are to be returned
    
    Returns:
    
    the Hosts associated with the OracleHome specified or an empty list if none are found
  - getHostForDomainAndServer
```
public Host getHostForDomainAndServer(String domainId,
                                      String serverName)
```
    Returns the host mapped to this domain and server
    
    Parameters:
    
    domainId - id of the requested domain
    
    serverName - name of the server The name of the ServerBinding
    
    Returns:
    
    Host. Null if no match found.
  - getHostForDomainServer
```
public Host getHostForDomainServer(String domainId,
                                   String serverName)
```
    Returns the host mapped to a given domain and server
    
    Parameters:
    
    domainId - the id of the domain to search for
    
    serverName - the name of the server to search for
    
    Returns:
    
    Host if found or else null
  - getNodeManagerById
```
public NodeManager getNodeManagerById(String nodeManagerId)
```
    Returns the NodeManager for the nodeManagerId specified or null if it is not found.
    
    Parameters:
    
    nodeManagerId - the id representing the NodeManager to be returned
    
    Returns:
    
    the NodeManager for the nodeManagerId specified or null if it is not found
  - getNodeManagerByName
```
public List<NodeManager> getNodeManagerByName(String nodeManagerName)
```
  - getNodeManagerForDomainAndServer
```
public NodeManager getNodeManagerForDomainAndServer(String domainId,
                                                    String serverName)
```
    Returns the NodeManager associated with the Domain and Server specified or null if it is not found.
    
    Parameters:
    
    domainId - the id representing the Domain who's NodeManager is to be returned
    
    serverName - The name of the Server
    
    Returns:
    
    the NodeManager associated with the Domain and Server specified or null if it is not found
  - getNodeManagerIds
```
public List<String> getNodeManagerIds()
```
    Returns the NodeManager ids associated with the Topology in this EnvironmentModel or an empty list if none are found. list if none found.
    
    Returns:
    
    the NodeManager ids associated with the Topology in this EnvironmentModel or an empty list if none are found
  - getNodeManagers
```
public List<NodeManager> getNodeManagers()
```
    Returns the NodeManagers associated with the Topology in this EnvironmentModel or an empty list if none are found.
    
    Returns:
    
    he NodeManagers associated with the Topology in this EnvironmentModel or an empty list if none are found
  - getNodeManagersForDomain
```
public List<NodeManager> getNodeManagersForDomain(String domainId)
```
    Returns the NodeManagers associated with the Domain specified or null if it is not found.
    
    Parameters:
    
    domainId - the id representing the Domain who's NodeManagers are to be returned
    
    Returns:
    
    the NodeManagers associated with the Domain specified or null if it is not found
  - getOracleHomeById
```
public OracleHome getOracleHomeById(String oracleHomeId)
```
    Returns the OracleHome for the oracleHomeId specified or null if it is not found.
    
    Parameters:
    
    oracleHomeId - the id representing the OracleHome that is to be returned
    
    Returns:
    
    the OracleHome for the oracleHomeId specified or null if it is not found
  - getOracleHomeForAdminServerOfDomain
```
public OracleHome getOracleHomeForAdminServerOfDomain(String domainId)
                                               throws FMWEnvSpecException
```
    Returns the OracleHome mapped to the AdminServer of the Domain specified or null if no match is found.
    
    Parameters:
    
    domainId - the id representing the Domain who's OracleHome is to be returned
    
    Returns:
    
    the OracleHome mapped to the AdminServer of the Domain specified or null if no match is found
    
    Throws:
    
    FMWEnvSpecException - When any external domain profile references cannot be read
  - getOracleHomeIds
```
public List<String> getOracleHomeIds()
```
    Returns the OracleHome ids associated with the Topology in this EnvironmentModel or an empty list if none are found.
    
    Returns:
    
    the OracleHome ids associated with the Topology in this EnvironmentModel or an empty list if none are found
  - getOracleHomes
```
public List<OracleHome> getOracleHomes()
```
    Returns the OracleHomes associated with the Topology in this EnvironmentModel or an empty list if none are found
    
    Returns:
    
    the OracleHomes associated with the Topology in this EnvironmentModel or an empty list if none are found
  - getServerBindingsInClusterForDomain
```
public List<ServerBinding> getServerBindingsInClusterForDomain(String clusterName,
                                                               String domainId)
                                                        throws FMWEnvSpecException
```
    Returns the ServerBindings associated with the Domain and Cluster specified or an empty list if none are found
    
    Parameters:
    
    clusterName - the name of the Cluster who's ServerBindings are to be returned
    
    domainId - the id representing the Domain who's ServerBindings are to be returned
    
    Returns:
    
    the ServerBindings associated with the Domain and Cluster specified or an empty list if none are found
    
    Throws:
    
    FMWEnvSpecException - When any external domain profile references cannot be read
  - getServerBindingsOnHost
```
public List<ServerBinding> getServerBindingsOnHost(Host host)
```
    Returns the ServerBindings associated with the Host specified or an empty list if none are found.
    
    Parameters:
    
    host - the host from which the ServerBindings are to be returned
    
    Returns:
    
    the ServerBindings associated with the Host specified or an empty list if none are found
  - getServerBindingsOnHost
```
public List<ServerBinding> getServerBindingsOnHost(String hostId)
```
    Returns the ServerBindings associated with the Host specified or an empty list if none are found Returns an empty list if none found.
    
    Parameters:
    
    hostId - the id representing the Host from which the ServerBindings are to be returned
    
    Returns:
    
    the ServerBindings associated with the Host specified or an empty list if none are found
  - getServerBindingsOnHostAndDomain
```
public List<ServerBinding> getServerBindingsOnHostAndDomain(String hostId,
                                                            String domainId)
```
    Returns the ServerBindings associated with the Domain and Host specified or an empty list if none are found.
    
    Parameters:
    
    hostId - the id representing the Host from which the ServerBindings are to be returned
    
    domainId - the ServerBindings associated with the Domain and Host specified or an empty list if none are found
    
    Returns:
    
    list of ServerBinding. Empty list if none found
  - getServerIdsInDomain
```
public List<String> getServerIdsInDomain(Domain domain)
                                  throws FMWEnvSpecException
```
    Returns the Server ids associated with the Domain specified or an empty list if none are found. 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. Returns an empty list if none found.
    
    Parameters:
    
    domain - the Domain who's Server ids are to be returned
    
    Returns:
    
    the Server ids associated with the Domain specified or an empty list if none are found
    
    Throws:
    
    FMWEnvSpecException - When any external domain profile references cannot be read
  - getServerIdsInDomain
```
public List<String> getServerIdsInDomain(String domainId)
                                  throws FMWEnvSpecException
```
    Returns the Server ids associated with the Domain specified or an empty list if none are found. 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.
    
    Parameters:
    
    domainId - the id representing the Domain who's Server ids are to be returned
    
    Returns:
    
    the Server ids associated with the Domain specified or an empty list if none are found.
    
    Throws:
    
    FMWEnvSpecException - When any external domain profile references cannot be read
  - getServersInDomain
```
public List<Server> getServersInDomain(Domain domain)
                                throws FMWEnvSpecException
```
    Returns the Servers associated with the Domain specified or an empty list if none are found. 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.
    
    Parameters:
    
    domain - the Domain who's Servers are to be returned
    
    Returns:
    
    the Servers associated with the Domain specified or an empty list if none are found
    
    Throws:
    
    FMWEnvSpecException - When any external domain profile references cannot be read
  - getServersInDomain
```
public List<Server> getServersInDomain(String domainId)
                                throws FMWEnvSpecException
```
    Returns the Servers associated with the Domain specified or an empty list if none are found. 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.
    
    Parameters:
    
    domainId - the id representing the Domain who's Servers are to be returned
    
    Returns:
    
    the Servers associated with the Domain specified or an empty list if none are found
    
    Throws:
    
    FMWEnvSpecException - When any external domain profile references cannot be read
  - getSettingWithAliasWLSTValues
```
public List<SettingWithAliasWLSTValues> getSettingWithAliasWLSTValues(oracle.fmwplatform.envspec.common.Tunable tunable)
                                                               throws FMWEnvSpecException
```
    Returns a list of Setting key, value as well as the corresponding WLST online and offline path and attributes. The value is cast to the datatype it is supposed to be for this key. For the list of valid datatypes, refer AliasWLSTValues.WLSTAttributeTypes For the type Boolean, the string value of the boolean is returned. Any tokens %x% in the values are replaced with actual values. The effective online or offline value will be null if the setting is not applicable in an online or offline context.
    
    Parameters:
    
    tunable - the tunable model object to retrieve settings for
    
    Returns:
    
    List of SettingWithAliasWLSTValues
    
    Throws:
    
    FMWEnvSpecException - When Setting or Alias information cannot be read from the file system or when the actual value in the setting is not of the datatype defined or when credentials are null in the model when datatype is credential based or when no matching credential is found when datatype is credential based
  - getTemplateNamesInDomain
```
public List<String> getTemplateNamesInDomain(Domain domain)
                                      throws FMWEnvSpecException
```
    Returns the Templates associated with the Domain specified or an empty list if none are found. 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 they are Oracle Provided and by name and location if the are custom.
    
    Parameters:
    
    domain - the Domain who's Template names are to be returned
    
    Returns:
    
    list of template names
    
    Throws:
    
    FMWEnvSpecException - When external file references cannot be read or when a custom template does not have location specified
  - getTemplateNamesInDomain
```
public List<String> getTemplateNamesInDomain(String domainId)
                                      throws FMWEnvSpecException
```
    Returns the Template names associated with the Domain specified or an empty list if none are found. 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.
    
    Parameters:
    
    domainId - the id representing the Domain who's Template names are to be returned
    
    Returns:
    
    the Template names associated with the Domain specified or an empty list if none are found
    
    Throws:
    
    FMWEnvSpecException - When external file references cannot be read or when a custom template does not have location specified
  - getTemplatesInDomain
```
public List<Template> getTemplatesInDomain(Domain domain)
                                    throws FMWEnvSpecException
```
    Returns the Templates associated with the Domain specified or an empty list if none are found. This is the complete list from all the Blueprints referenced in the DomainProfiles, including nested ones within another Blueprint. Only unique Templates are returned. Templates are unique by name if they are Oracle Provided and by name and location if they are custom.
    
    Parameters:
    
    domain - the Domain who's Templates are to be returned
    
    Returns:
    
    the Templates associated with the Domain specified or an empty list if none are found
    
    Throws:
    
    FMWEnvSpecException - When external file references cannot be read or when a custom template does not have location specified
  - getTemplatesInDomain
```
public List<Template> getTemplatesInDomain(String domainId)
                                    throws FMWEnvSpecException
```
    Returns the Templates associated with the Domain specified or an empty list if none are found. This is the complete list from all the Blueprints referenced in the DomainProfiles, including nested ones within another Blueprint. Only unique Templates are returned. Templates are unique by name if they are Oracle Provided and by name and location if they are custom.
    
    Parameters:
    
    domainId - the id representing the Domain who's Templates are to be returned
    
    Returns:
    
    the Templates associated with the Domain specified or an empty list if none are found
    
    Throws:
    
    FMWEnvSpecException - When external file references cannot be read or when a custom template does not have location specified
  - getMappedDomainForHostAndDomain
```
public MappedDomain getMappedDomainForHostAndDomain(String hostId,
                                                    String domainId)
```
    Returns the MappedDomain that is associated to the Domain and Host specified or null if no match is found.
    
    Parameters:
    
    hostId - The id representing the Host who's MappedDomain is to be returned
    
    domainId - the id representing the Domain who's MappedDomain is to be returned
    
    Returns:
    
    the MappedDomain that is associated to the Domain and Host specified or null if no match is found
  - getMappedOracleHomeForHostAndOracleHome
```
public MappedOracleHome getMappedOracleHomeForHostAndOracleHome(String hostId,
                                                                String oracleHomeId)
```
    Returns The MappedOracleHome for the Host and OracleHome specified or null if no match is found.
    
    Parameters:
    
    hostId - The id representing the Host who's MappedOracleHome is to be returned
    
    oracleHomeId - The id of the OracleHome that the MappedOracleHome is associated to
    
    Returns:
    
    The MappedOracleHome for the Host and OracleHome specified or null if no match is found
  - getTopology
```
public Topology getTopology()
```
    Returns the Topology associated with this EnvironmentModel or null if it has not been set.
    
    Returns:
    
    the Topology associated with this EnvironmentModel or null if it has not been set
  - setCredentials
```
public void setCredentials(oracle.fmwplatform.credentials.credential.Credentials credentials)
```
    Sets the Credentials associated with this EnvironmentModel.
    
    Parameters:
    
    credentials - the Credentials that are to be wrapped by this EnvironmentModel
  - setTopology
```
public void setTopology(Topology topology)
```
    Sets the Topology associated with this EnvironmentModel.
    
    Parameters:
    
    topology - the Topology that is to be associated with this EnvironmentModel
  - validate
```
public List<oracle.fmwplatform.util.validation.ValidationMessage> validate()
                                                                    throws FMWEnvSpecException
```
    Performs basic validation without reference to any actual environment. Checks integrity of the model. See EnvironmentModelValidator.validate(EnvironmentModel)
    
    Returns:
    
    ValidationResult
    
    Throws:
    
    FMWEnvSpecException - When any external file references cannot be read
  - validate
```
public List<oracle.fmwplatform.util.validation.ValidationMessage> validate(ModelTarget target)
```
    Validates a single environment model target against this model.
    
    Parameters:
    
    target - a ModelTarget object to use for validation
    
    Returns:
    
    a list of validation messages
  - getServerGroups
```
public List<String> getServerGroups(String domainId,
                                    String serverName)
                             throws FMWEnvSpecException
```
    Returns the Server group names for the specified Domain and Server or and empty list is none are found.
    
    Parameters:
    
    domainId - the id representing the Domain who's Server group names are to be returned
    
    serverName - The name of the Server
    
    Returns:
    
    the ServerGroups for the specified Domain and Server or and empty list is none are found
    
    Throws:
    
    FMWEnvSpecException - if a model file could not be found in the search path
  - getServerGroupMapFromTemplates
```
public Map<String,Set<String>> getServerGroupMapFromTemplates(String domainId)
                                                       throws FMWEnvSpecException
```
    Returns a map of server name to list of server groups found in all the templates reference in the given domain
    
    Parameters:
    
    domainId - the id representing the Domain who's templates will be used to construct the server group map
    
    Returns:
    
    a map representing every server name and list of server groups found in the templates
    
    Throws:
    
    FMWEnvSpecException - if templates or Oracle Home cannot be found
  - getWebTiers
```
public List<WebTier> getWebTiers()
```
    Returns the WebTiers associated with the Topology in this EnvironmentModel or an empty list if none are found.
    
    Returns:
    
    the WebTiers associated with the Topology in this EnvironmentModel or an empty list if none are found
  - getWebTierById
```
public WebTier getWebTierById(String webTierId)
```
    Returns the WebTier for the webTierId specified or null if it is not found.
    
    Parameters:
    
    webTierId - the id representing the WebTier that is to be returned
    
    Returns:
    
    the WebTier matching the id provided or null if no match is found
  - getWebTiersForDomain
```
public List<WebTier> getWebTiersForDomain(String domainId)
```
    Returns the list of WebTier objects for the specified domain
    
    Parameters:
    
    domainId - the id of the Domain whose WebTiers are to be returned
    
    Returns:
    
    list of WebTier objects this domain is bound to or an empty list if none found

Class EnvironmentModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnvironmentModel

Method Detail

createEnvironmentModel

getBaseTemplateForDomain

getClusterBindingByNameForDomain

getClusterBindingByNameForDomain

getClusterBindingsForDomain

getClusterBindingsForDomain

getClusterIdsInDomain

getClusterIdsInDomain

getClustersInDomain

getClustersInDomain

getCredentials

getCredentialByAlias

getDatabaseById

getDatabaseIds

getDatabases

getDataSourceBindingsInDomain

getDataSourceBindingsInDomain

getDataSourceNamesInDomain

getDataSourceNamesInDomain

getDomainById

getDomainsByName

getDomainIds

getDomains

getDomainsOnHost

getDomainsOnHost

getDomainsUsingOracleHome

getDomainsForNodeManagerId

getDomainsForNodeManagerId

getDomainsUsingOracleHome

getExtensionTemplatesForDomain

getHostById

getHostForNodeManager

getOracleHomeForNodeManager

getHostIds

getHostIdsHostingDomain

getHostIdsHostingDomain

getHostIdsHostingOracleHome

getHostIdsHostingOracleHome

getHosts

getHostsHostingDomain

getHostsHostingDomain

getHostsHostingOracleHome

getHostsHostingOracleHome

getHostForDomainAndServer

getHostForDomainServer

getNodeManagerById

getNodeManagerByName

getNodeManagerForDomainAndServer

getNodeManagerIds

getNodeManagers

getNodeManagersForDomain

getOracleHomeById

getOracleHomeForAdminServerOfDomain

getOracleHomeIds

getOracleHomes

getServerBindingsInClusterForDomain

getServerBindingsOnHost

getServerBindingsOnHost

getServerBindingsOnHostAndDomain

getServerIdsInDomain

getServerIdsInDomain

getServersInDomain

getServersInDomain

getSettingWithAliasWLSTValues

getTemplateNamesInDomain

getTemplateNamesInDomain

getTemplatesInDomain

getTemplatesInDomain

getMappedDomainForHostAndDomain

getMappedOracleHomeForHostAndOracleHome

getTopology

setCredentials

setTopology