oracle.fmwplatform.envspec.environment

Class OracleHomeEnvironment

java.lang.Object

oracle.fmwplatform.envspec.environment.Environment

oracle.fmwplatform.envspec.environment.OracleHomeEnvironment

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.EnvironmentSpecification

public class OracleHomeEnvironment
extends Environment

Represents the interface to the data access methods for information about an Oracle Home.

Since:

12.2.1

Field Summary

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

topology

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<String>	getDistributionNames() This API will return the list of distributions installed in an Oracle Home.
String	getDistributionVersion(String distroName) This API will return the version of the distribution that is installed in an Oracle Home.
List<String>	getPatches() This API will return the list of patches installed in an Oracle Home.
protected void	retrieveTopologyObjects(Topology topology) Retrieve the right Oracle Home from the topology object.
protected void	validateEnvironmentTarget(ModelTarget target, EnvironmentModel model) Validate the EnvironmentModelTarget so it can be used for the OracleHome discovery, it should be of type OracleHome or Domain.

Methods inherited from class java.lang.Object

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

Constructor Detail

OracleHomeEnvironment

public OracleHomeEnvironment(EnvironmentModel model,
                             ModelTarget target)
                      throws FMWEnvSpecException

OracleHomeEnvironment constructor which will allow users to create an environment object representing the query interface into the oracleHome

Parameters:

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

target - EnvironmentModelTarget with OracleHome as target type which can be used to focus on a particular area of an OracleHome

Throws:

FMWEnvSpecException - when OracleHome cannot be found or does not have the required bootstrap parameters

Method Detail

getDistributionNames

public List<String> getDistributionNames()

This API will return the list of distributions installed in an Oracle Home.

Returns:

list of distributions

getDistributionVersion

public String getDistributionVersion(String distroName)

This API will return the version of the distribution that is installed in an Oracle Home.

Parameters:

distroName - distribution name

Returns:

the version of the distribution install in the requested Oracle Home

getPatches

public List<String> getPatches()

This API will return the list of patches installed in an Oracle Home.

Returns:

list of patches installed

retrieveTopologyObjects

protected void retrieveTopologyObjects(Topology topology)
                                throws FMWEnvSpecException

Retrieve the right Oracle Home from the topology object. This will use the EnvironmentTarget information to retrieve the right Oracle Home object.

Parameters:

topology - The topology object which contains the OracleHome object with its bootstrap information

Throws:

FMWEnvSpecException - when the OracleHome reference cannot be found in the topology.

validateEnvironmentTarget

protected void validateEnvironmentTarget(ModelTarget target,
                                         EnvironmentModel model)
                                  throws FMWEnvSpecException

Validate the EnvironmentModelTarget so it can be used for the OracleHome discovery, it should be of type OracleHome or Domain.

Parameters:

target - EnvironmentModelTarget with OracleHome as target type which can be used to focus on a particular OracleHome object in the topology.

model - an EnvironmentModel object (currently unused)

Throws:

FMWEnvSpecException - when the OracleHome reference id is empty