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

java.lang.Object
- oracle.fmwplatform.envspec.environment.Environment
- - oracle.fmwplatform.envspec.environment.DomainEnvironment

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.EnvironmentSpecification

Direct Known Subclasses:

OfflineEnvironment, OnlineEnvironment
```
public abstract class DomainEnvironment
extends Environment
```
Represents the interface to the data access methods for information from a domain that is currently offline or online.

Since:

12.2.1

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`clusterId` Current cluster ID.
`protected String`	`domainId` Current domain ID.
`protected String`	`serverId` Current server ID.
`protected Domain`	`topologyDomain` Domain being discovered.
`protected OracleHome`	`topologyOracleHome` Oracle home being discovered.
`protected static String`	`WLST_CLUSTERS_METHOD` Get clusters method for WLST discovery.
`protected static String`	`WLST_CONFIGGROUPS_METHOD` Get configuration groups method fro WLST discovery.
`protected static String`	`WLST_DATASOURCES_METHOD` Get data sources method fro WLST discovery.
`protected static String`	`WLST_DOMAIN_METHOD` Get domain method for WLST discovery.
`protected static String`	`WLST_NODEMANAGERS_METHOD` Get node managers method for WLST discovery.
`protected static String`	`WLST_SERVERS_METHOD` Get servers method fro WLST discovery.
`protected static String`	`WLST_TEMPLATES_METHOD` Get templates method fro WLST discovery.
`protected oracle.fmwplatform.wlst.EmbeddedWLSTInvoker`	`wlstInvoker` WLST invoker for executing discovery commands.
`protected static String`	`wlstModulePrefix` Module prefix for the WLST interpreter.

Fields inherited from class oracle.fmwplatform.envspec.environment.Environment
topology

Constructor Summary

Constructors
Constructor and Description

DomainEnvironment()

Constructors
Constructor and Description
`DomainEnvironment()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`endSession()` Cleanup the embedded WLST session.
`protected void`	`execWLST(String command)` Execute a WLST command in the embedded WLST session
`abstract List<Cluster>`	`getClusters()` Returns the list of cluster objects of the discovered WebLogic Domain.
`abstract List<DataSource>`	`getDataSources()` Returns the list of datasource objects of the discovered WebLogic Domain.
`abstract Domain`	`getDomain()` Returns a Domain object that has fields which are associated with WebLogic Domain properties like JTA timeout etc, and does not have any server or cluster information.
`abstract List<NodeManager>`	`getNodeManagers()` Returns the list of nodemanager or machine objects of the discovered offline WebLogic Domain.
`abstract List<Server>`	`getServers()` Returns list of server objects of the discovered WebLogic Domain In offline mode it is not possible to retrieve the value of a particular WebLogic attribute when it contains the default value.
`protected <T> T`	`getWLSTValue(String myModule, String method)` Execute a WLST command in the embedded WLST session and return the discovered environment object.
`protected <T> List<T>`	`getWLSTValues(String myModule, String method)` Execute a WLST command in the embedded WLST session and return a list of discovered environment objects.
`protected <T> List<T>`	`getWLSTValuesByFilter(String myModule, String method, String filter)` Execute a WLST command in the embedded WLST session and return a list of discovered environment objects.
`protected void`	`importModule(String myModule)` Import and load a WLST jython module.
`protected void`	`retrieveTopologyObjects(Topology topology)` Retrieve the right Oracle Home and Domain from the topology object.
`protected void`	`startSession(String oracleHome)` Start an embedded WLST session.
`protected void`	`validateEnvironmentTarget(ModelTarget target, EnvironmentModel model, String envType)` Validate the target, which should be a DomainTarget, so it can be used for Domain discovery.

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

- Field Detail
  - WLST_DOMAIN_METHOD
```
protected static final String WLST_DOMAIN_METHOD
```
    Get domain method for WLST discovery.
    
    See Also:
    
    Constant Field Values
  - WLST_NODEMANAGERS_METHOD
```
protected static final String WLST_NODEMANAGERS_METHOD
```
    Get node managers method for WLST discovery.
    
    See Also:
    
    Constant Field Values
  - WLST_CLUSTERS_METHOD
```
protected static final String WLST_CLUSTERS_METHOD
```
    Get clusters method for WLST discovery.
    
    See Also:
    
    Constant Field Values
  - WLST_SERVERS_METHOD
```
protected static final String WLST_SERVERS_METHOD
```
    Get servers method fro WLST discovery.
    
    See Also:
    
    Constant Field Values
  - WLST_DATASOURCES_METHOD
```
protected static final String WLST_DATASOURCES_METHOD
```
    Get data sources method fro WLST discovery.
    
    See Also:
    
    Constant Field Values
  - WLST_TEMPLATES_METHOD
```
protected static final String WLST_TEMPLATES_METHOD
```
    Get templates method fro WLST discovery.
    
    See Also:
    
    Constant Field Values
  - WLST_CONFIGGROUPS_METHOD
```
protected static final String WLST_CONFIGGROUPS_METHOD
```
    Get configuration groups method fro WLST discovery.
    
    See Also:
    
    Constant Field Values
  - wlstModulePrefix
```
protected static String wlstModulePrefix
```
    Module prefix for the WLST interpreter.
  - wlstInvoker
```
protected oracle.fmwplatform.wlst.EmbeddedWLSTInvoker wlstInvoker
```
    WLST invoker for executing discovery commands.
  - domainId
```
protected String domainId
```
    Current domain ID.
  - serverId
```
protected String serverId
```
    Current server ID.
  - clusterId
```
protected String clusterId
```
    Current cluster ID.
  - topologyOracleHome
```
protected OracleHome topologyOracleHome
```
    Oracle home being discovered.
  - topologyDomain
```
protected Domain topologyDomain
```
    Domain being discovered.
- Constructor Detail
  - DomainEnvironment
```
public DomainEnvironment()
```
- Method Detail
  - endSession
```
protected void endSession()
```
    Cleanup the embedded WLST session.
  - execWLST
```
protected void execWLST(String command)
                 throws FMWEnvSpecException
```
    Execute a WLST command in the embedded WLST session
    
    Parameters:
    
    command - The command to execute
    
    Throws:
    
    FMWEnvSpecException - on error
  - getClusters
```
public abstract List<Cluster> getClusters()
                                   throws FMWEnvSpecException
```
    Returns the list of cluster objects of the discovered WebLogic Domain. The cluster object also contains its cluster members as a list of servers. In offline mode it is not possible to retrieve the value of a particular WebLogic attribute when it contains the default value. In this case the attribute will have an empty value.
    
    Returns:
    
    list of Cluster
    
    Throws:
    
    FMWEnvSpecException - on error
  - getDataSources
```
public abstract List<DataSource> getDataSources()
                                         throws FMWEnvSpecException
```
    Returns the list of datasource objects of the discovered WebLogic Domain. When the datasource is of type multi datasource, the MDS Datasource will also contain its child datasources In offline mode it is not possible to retrieve the value of a particular WebLogic attribute when it contains the default value. In this case the attribute will have an empty value.
    
    Returns:
    
    list of Datasource
    
    Throws:
    
    FMWEnvSpecException - on error
  - getDomain
```
public abstract Domain getDomain()
                          throws FMWEnvSpecException
```
    Returns a Domain object that has fields which are associated with WebLogic Domain properties like JTA timeout etc, and does not have any server or cluster information. In offline mode it is not possible to retrieve the value of a particular WebLogic attribute when it contains the default value. In this case the attribute will have an empty value.
    
    Returns:
    
    Domain
    
    Throws:
    
    FMWEnvSpecException - on error
  - getNodeManagers
```
public abstract List<NodeManager> getNodeManagers()
                                           throws FMWEnvSpecException
```
    Returns the list of nodemanager or machine objects of the discovered offline WebLogic Domain. In offline mode it is not possible to retrieve the value of a particular WebLogic attribute when it contains the default value. In this case the attribute will have an empty value.
    
    Returns:
    
    list of NodeManager
    
    Throws:
    
    FMWEnvSpecException - on error
  - getServers
```
public abstract List<Server> getServers()
                                 throws FMWEnvSpecException
```
    Returns list of server objects of the discovered WebLogic Domain In offline mode it is not possible to retrieve the value of a particular WebLogic attribute when it contains the default value. In this case the attribute will have an empty value.
    
    Returns:
    
    list of Server
    
    Throws:
    
    FMWEnvSpecException - on error
  - getWLSTValue
```
protected <T> T getWLSTValue(String myModule,
                             String method)
                      throws FMWEnvSpecException
```
    Execute a WLST command in the embedded WLST session and return the discovered environment object.
    
    Type Parameters:
    
    T - Discovered Environment Object class
    
    Parameters:
    
    myModule - WLST python module, can be the offline or online module
    
    method - Method name of the WLST python module
    
    Returns:
    
    Discovered object
    
    Throws:
    
    FMWEnvSpecException - on error
  - getWLSTValues
```
protected <T> List<T> getWLSTValues(String myModule,
                                    String method)
                             throws FMWEnvSpecException
```
    Execute a WLST command in the embedded WLST session and return a list of discovered environment objects.
    
    Type Parameters:
    
    T - Discovered Environment Object class
    
    Parameters:
    
    myModule - WLST python module, can be the offline or online module
    
    method - Method name of the WLST python module
    
    Returns:
    
    List of Discovered objects
    
    Throws:
    
    FMWEnvSpecException - on error
  - getWLSTValuesByFilter
```
protected <T> List<T> getWLSTValuesByFilter(String myModule,
                                            String method,
                                            String filter)
                                     throws FMWEnvSpecException
```
    Execute a WLST command in the embedded WLST session and return a list of discovered environment objects.
    
    Type Parameters:
    
    T - Discovered Environment Object class
    
    Parameters:
    
    myModule - WLST python module, can be the offline or online module
    
    method - Method name of the WLST python module
    
    filter - Parameter which can be used to filter the result for only one particular object.
    
    Returns:
    
    List of Discovered objects
    
    Throws:
    
    FMWEnvSpecException - on error
  - importModule
```
protected void importModule(String myModule)
                     throws FMWEnvSpecException
```
    Import and load a WLST jython module.
    
    Parameters:
    
    myModule - is it for online or offline
    
    Throws:
    
    FMWEnvSpecException - when a not valid WLST/Jython command is executed
  - retrieveTopologyObjects
```
protected void retrieveTopologyObjects(Topology topology)
                                throws FMWEnvSpecException
```
    Retrieve the right Oracle Home and Domain from the topology object. This will use the EnvironmentTarget information to retrieve the right Oracle Home and the domain.
    
    Parameters:
    
    topology - The topology object which contains the online or offline domain bootstrap information
    
    Throws:
    
    FMWEnvSpecException - on error
  - startSession
```
protected void startSession(String oracleHome)
                     throws FMWEnvSpecException
```
    Start an embedded WLST session.
    
    Parameters:
    
    oracleHome - this oracle home will be used for all the library references
    
    Throws:
    
    FMWEnvSpecException - when WLST can't be started
  - validateEnvironmentTarget
```
protected void validateEnvironmentTarget(ModelTarget target,
                                         EnvironmentModel model,
                                         String envType)
                                  throws FMWEnvSpecException
```
    Validate the target, which should be a DomainTarget, so it can be used for Domain discovery.
    
    Parameters:
    
    target - EnvironmentModelTarget with Domain, CLuster or Server target type which can be used to focus on a particular area of the offline WebLogic domain
    
    model - EnvironmentModel object
    
    envType - OfflineEnvironment or OnlineEnvironment
    
    Throws:
    
    FMWEnvSpecException - on error

Class DomainEnvironment

Field Summary

Fields inherited from class oracle.fmwplatform.envspec.environment.Environment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WLST_DOMAIN_METHOD

WLST_NODEMANAGERS_METHOD

WLST_CLUSTERS_METHOD

WLST_SERVERS_METHOD

WLST_DATASOURCES_METHOD

WLST_TEMPLATES_METHOD

WLST_CONFIGGROUPS_METHOD

wlstModulePrefix

wlstInvoker

domainId

serverId

clusterId

topologyOracleHome

topologyDomain

Constructor Detail

DomainEnvironment

Method Detail

endSession

execWLST

getClusters

getDataSources

getDomain

getNodeManagers

getServers

getWLSTValue

getWLSTValues

getWLSTValuesByFilter

importModule

retrieveTopologyObjects

startSession

validateEnvironmentTarget