OracleHome (Oracle® Fusion Middleware Java API Reference for the Lifecycle Management Environment Specification)

java.lang.Object
- oracle.fmwplatform.envspec.model.topology.OracleHome

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.ContainerAware<Topology>, oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.ParentContainerWithVariables, oracle.fmwplatform.envspec.common.Substitutable
```
public class OracleHome
extends Object
implements oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.ContainerAware<Topology>, oracle.fmwplatform.envspec.common.ParentContainerWithVariables
```
Represents an OracleHome - a set of product binaries. This is a logical representation of the OracleHome, without consideration for which Hosts it is available on, or how many copies of it there are.

Since:

12.2.1

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`id` A logical name that is used to refer to this OracleHome.
`protected InstallationData`	`installationData` Data needed to create this Oracle Home using the Cloud Installer.
`protected String`	`inventoryLocation` Identifies the inventory location of the OracleHome
`protected String`	`javaHome` Identifies the filesystem path to the Java Home (JDK install directory).
`protected String`	`path` Identifies the (filesystem) path to the OracleHome.
`protected Type`	`type` Identifies whether this is a shared or local OracleHome.

Constructor Summary

Constructors
Constructor and Description

OracleHome()

Constructors
Constructor and Description
`OracleHome()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,String>`	`getEffectiveVariables()` Provides the effective list of variables that apply to the tuning parameters.
`String`	`getId()` Returns the id used to reference this model object.
`InstallationData`	`getInstallationData()` Returns the InstallationData for this OracleHome.
`String`	`getInventoryLocation()` Returns the filesystem inventory location for this OracleHome
`String`	`getJavaHome()` Returns filesystem path to the Java Home (JDK install directory)
`Topology`	`getParent()` Returns the object that contains this entity
`String`	`getPath()` Returns the (filesystem) path to the OracleHome.
`Type`	`getType()` Returns the type of this OracleHome (shared or local).
`String`	`getVariableValue(String key)` Returns the variable value assigned to the specified key.
`OracleHome`	`setId(String id)` Sets the id used to reference this model object.
`OracleHome`	`setInstallationData(InstallationData installationData)` Set the installation data information about the installations in the OracleHome.
`OracleHome`	`setInventoryLocation(String inventoryLocation)` Sets the inventory location for the OracleHome.
`OracleHome`	`setJavaHome(String javaHome)` Sets the filesystem path to the Java Home (JDK install directory).
`OracleHome`	`setParent(Topology containerTopology)` Sets the container object that contains this.
`OracleHome`	`setPath(String path)` Set the path to the OracleHome.
`OracleHome`	`setType(Type type)` Sets the type of this OracleHome (shared or local).
`String`	`substitute(String text)` Replaces substitution keys in the specified text with their corresponding values.
`String`	`toCompactString()` Returns a compact string representation of the object in XML format.
`String`	`toJsonCompactString()` Returns a compact string representation of the object in JSON format.
`String`	`toJsonString()` Returns a string representation of the object in JSON format.
`String`	`toString()` Returns a string representation of the object in XML 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.

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

- Field Detail
  - id
```
protected String id
```
    A logical name that is used to refer to this OracleHome.
  - path
```
protected String path
```
    Identifies the (filesystem) path to the OracleHome.
  - inventoryLocation
```
protected String inventoryLocation
```
    Identifies the inventory location of the OracleHome
  - type
```
protected Type type
```
    Identifies whether this is a shared or local OracleHome.
  - javaHome
```
protected String javaHome
```
    Identifies the filesystem path to the Java Home (JDK install directory).
  - installationData
```
protected InstallationData installationData
```
    Data needed to create this Oracle Home using the Cloud Installer.
- Constructor Detail
  - OracleHome
```
public OracleHome()
```
- Method Detail
  - getId
```
public String getId()
```
    Description copied from interface: oracle.fmwplatform.envspec.common.EntityWithId
    
    Returns the id used to reference this model object.
    
    Specified by:
    
    getId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Returns:
    
    the id used to reference this model object
  - getParent
```
public Topology getParent()
```
    Description copied from interface: oracle.fmwplatform.envspec.common.ContainerAware
    
    Returns the object that contains this entity
    
    Specified by:
    
    getParent in interface oracle.fmwplatform.envspec.common.ContainerAware<Topology>
    
    Returns:
    
    parent container
  - setParent
```
public OracleHome setParent(Topology containerTopology)
```
    Description copied from interface: oracle.fmwplatform.envspec.common.ContainerAware
    
    Sets the container object that contains this. The container object has variables in it that are used in this.
    
    Specified by:
    
    setParent in interface oracle.fmwplatform.envspec.common.ContainerAware<Topology>
    
    Parameters:
    
    containerTopology - the parent container
    
    Returns:
    
    the current container-aware object
  - getInstallationData
```
public InstallationData getInstallationData()
```
    Returns the InstallationData for this OracleHome.
    
    Returns:
    
    the InstallationData for this OracleHome
  - getInventoryLocation
```
public String getInventoryLocation()
```
    Returns the filesystem inventory location for this OracleHome
    
    Returns:
    
    the filesystem inventory location for this OracleHome
  - getJavaHome
```
public String getJavaHome()
```
    Returns filesystem path to the Java Home (JDK install directory)
    
    Returns:
    
    filesystem path to the Java Home (JDK install directory)
  - getPath
```
public String getPath()
```
    Returns the (filesystem) path to the OracleHome.
    
    Returns:
    
    the (filesystem) path to the OracleHome
  - getType
```
public Type getType()
```
    Returns the type of this OracleHome (shared or local).
    
    Returns:
    
    the type of this OracleHome (shared or local)
  - setId
```
public OracleHome setId(String id)
```
    Description copied from interface: oracle.fmwplatform.envspec.common.EntityWithId
    
    Sets the id used to reference this model object.
    
    Specified by:
    
    setId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Parameters:
    
    id - the id to be used when referencing this model object
    
    Returns:
    
    this (for method chaining)
  - setInstallationData
```
public OracleHome setInstallationData(InstallationData installationData)
```
    Set the installation data information about the installations in the OracleHome.
    
    Parameters:
    
    installationData - the installation data information about the installations in the OracleHome
    
    Returns:
    
    the current OracleHome object
  - setInventoryLocation
```
public OracleHome setInventoryLocation(String inventoryLocation)
```
    Sets the inventory location for the OracleHome.
    
    Parameters:
    
    inventoryLocation - the (filesystem) location of the OracleHome inventory
    
    Returns:
    
    the current OracleHome object
  - setJavaHome
```
public OracleHome setJavaHome(String javaHome)
```
    Sets the filesystem path to the Java Home (JDK install directory).
    
    Parameters:
    
    javaHome - the filesystem path to the Java Home (JDK install directory)
    
    Returns:
    
    the current OracleHome object
  - setPath
```
public OracleHome setPath(String path)
```
    Set the path to the OracleHome.
    
    Parameters:
    
    path - the (filesystem) path to the Oracle Home
    
    Returns:
    
    the current OracleHome object
  - setType
```
public OracleHome setType(Type type)
```
    Sets the type of this OracleHome (shared or local).
    
    Parameters:
    
    type - the type of the OracleHome (shared or local)
    
    Returns:
    
    the current OracleHome object
  - getEffectiveVariables
```
public Map<String,String> getEffectiveVariables()
                                         throws FMWEnvSpecException
```
    Description copied from interface: oracle.fmwplatform.envspec.common.ParentContainerWithVariables
    
    Provides the effective list of variables that apply to the tuning parameters. If there are multiple definitions of the same variable name, then the one with closest scope is used - definitions of a variable in an entity x, effectively ‘hide’ any definitions of that variable in larger entities containing the entity x.
    
    Specified by:
    
    getEffectiveVariables in interface oracle.fmwplatform.envspec.common.ParentContainerWithVariables
    
    Returns:
    
    variables contained by the parent
    
    Throws:
    
    FMWEnvSpecException - When any tuning parameters references cannot be read
  - getVariableValue
```
public String getVariableValue(String key)
```
    Returns the variable value assigned to the specified key.
    
    Specified by:
    
    getVariableValue in interface oracle.fmwplatform.envspec.common.Substitutable
    
    Parameters:
    
    key - the key of the variable to be checked
    
    Returns:
    
    the variable value, or null if not found
  - substitute
```
public String substitute(String text)
```
    Replaces substitution keys in the specified text with their corresponding values.
    
    Specified by:
    
    substitute in interface oracle.fmwplatform.envspec.common.Substitutable
    
    Parameters:
    
    text - the original text
    
    Returns:
    
    the text with substitution keys replaced
  - 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
  - toJsonCompactString
```
public String toJsonCompactString()
```
    Returns a compact string representation of the object in JSON format.
    
    Returns:
    
    a compact string representation of the object in JSON format
  - toJsonString
```
public String toJsonString()
```
    Returns a string representation of the object in JSON format.
    
    Returns:
    
    a string representation of the object in JSON format
  - toCompactString
```
public String toCompactString()
```
    Returns a compact string representation of the object in XML format.
    
    Returns:
    
    a compact string representation of the object in XML format
  - toString
```
public String toString()
```
    Returns a string representation of the object in XML format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object in XML format

Class OracleHome

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

path

inventoryLocation

type

javaHome

installationData

Constructor Detail

OracleHome

Method Detail

getId

getParent

setParent

getInstallationData

getInventoryLocation

getJavaHome

getPath

getType

setId

setInstallationData

setInventoryLocation

setJavaHome

setPath

setType

getEffectiveVariables

getVariableValue

substitute

toXmlCompactString

toXmlString

toJsonCompactString

toJsonString

toCompactString

toString