oracle.fmwplatform.envspec.environment

Class OnlineEnvironment

java.lang.Object

oracle.fmwplatform.envspec.environment.Environment

oracle.fmwplatform.envspec.environment.DomainEnvironment

oracle.fmwplatform.envspec.environment.OnlineEnvironment

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.EnvironmentSpecification

public class OnlineEnvironment
extends DomainEnvironment

Represents the interface to the data access methods for information from a domain that is currently online.

Since:

12.2.1

Field Summary

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

clusterId, domainId, serverId, topologyDomain, topologyOracleHome, WLST_CLUSTERS_METHOD, WLST_CONFIGGROUPS_METHOD, WLST_DATASOURCES_METHOD, WLST_DOMAIN_METHOD, WLST_NODEMANAGERS_METHOD, WLST_SERVERS_METHOD, WLST_TEMPLATES_METHOD, wlstInvoker, wlstModulePrefix

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

topology

Constructor Summary

Constructors

Constructor and Description
OnlineEnvironment(EnvironmentModel model, ModelTarget target) OnlineEnvironment constructor which will allow users to create an environment object representing the online query interface into the WebLogic domain

Method Summary

Modifier and Type	Method and Description
void	close() Disconnect from the WebLogic Managed Server and end the embedded WLST session
List<Cluster>	getClusters() returns the list of cluster objects of the discovered WebLogic Domain.
List<DataSource>	getDataSources() returns the list of datasource objects of the discovered WebLogic Domain.
Domain	getDomain() Returns a Domain object, this object only has fields which are associated with WebLogic Domain properties like JTA timeout etc and does not have any server or cluster information.
List<NodeManager>	getNodeManagers() Returns the list of NodeManager or machine objects of the discovered WebLogic Domain.
List<Server>	getServers() Returns list of server objects of the discovered WebLogic Domain

Methods inherited from class oracle.fmwplatform.envspec.environment.DomainEnvironment

endSession, execWLST, getWLSTValue, getWLSTValues, getWLSTValuesByFilter, importModule, retrieveTopologyObjects, startSession, validateEnvironmentTarget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OnlineEnvironment

public OnlineEnvironment(EnvironmentModel model,
                         ModelTarget target)
                  throws FMWEnvSpecException

OnlineEnvironment constructor which will allow users to create an environment object representing the online query interface into the WebLogic domain

Parameters:

model - EnvironmentModel which contains a topology with at least the online bootstrap parameters

target - EnvironmentModelTarget with Domain, CLuster or Server target type which can be used to focus on a particular area of the online WebLogic domain

Throws:

FMWEnvSpecException - on error

Method Detail

close

public void close()
           throws FMWEnvSpecException

Disconnect from the WebLogic Managed Server and end the embedded WLST session

Throws:

FMWEnvSpecException - when disconnect or end session fails

getClusters

public 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

Specified by:

getClusters in class DomainEnvironment

Returns:

list of Cluster

Throws:

FMWEnvSpecException - on error

getDataSources

public 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

Specified by:

getDataSources in class DomainEnvironment

Returns:

list of Datasource

Throws:

FMWEnvSpecException - on error

getDomain

public Domain getDomain()
                 throws FMWEnvSpecException

Returns a Domain object, this object only has fields which are associated with WebLogic Domain properties like JTA timeout etc and does not have any server or cluster information.

Specified by:

getDomain in class DomainEnvironment

Returns:

Domain

Throws:

FMWEnvSpecException - on error

getNodeManagers

public List<NodeManager> getNodeManagers()
                                  throws FMWEnvSpecException

Returns the list of NodeManager or machine objects of the discovered WebLogic Domain.

Specified by:

getNodeManagers in class DomainEnvironment

Returns:

list of NodeManager

Throws:

FMWEnvSpecException - on error

getServers

public List<Server> getServers()
                        throws FMWEnvSpecException

Returns list of server objects of the discovered WebLogic Domain

Specified by:

getServers in class DomainEnvironment

Returns:

list of Server

Throws:

FMWEnvSpecException - on error