oracle.fmwplatform.envspec.model.topology

Class InstallationData

java.lang.Object

oracle.fmwplatform.envspec.model.topology.InstallationData

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.ContainerAware<OracleHome>, oracle.fmwplatform.envspec.common.ParentContainerWithVariables, oracle.fmwplatform.envspec.common.Substitutable

public class InstallationData
extends Object
implements oracle.fmwplatform.envspec.common.ContainerAware<OracleHome>, oracle.fmwplatform.envspec.common.ParentContainerWithVariables

A set of data that describes an OracleHome in terms of the Oracle Universal Installer metadata required to create that Oracle Home.

Since:

12.2.1

Constructor Summary

Constructors

Constructor and Description
InstallationData()

Method Summary

Modifier and Type	Method and Description
boolean	addAllPatches(List<String> patches) Adds a single patch to the list of patches
boolean	addInstallation(Installation installation) Adds the installation to the end of the list and sets the order id.
boolean	addPatch(String patch) Adds a single patch to the list of patches
Map<String,String>	getEffectiveVariables() Returns the derived map of variables for this element.
List<Installation>	getInstallations() Returns a list of the installations for this InstallationData.
OracleHome	getParent() Returns the object that contains this entity.
List<String>	getPatches() Returns the list of patch identifiers, for example p1234567.
String	getVariableValue(String key) Returns the variable value assigned to the specified key.
boolean	removeInstallation(Installation installation) Remove the installation from the installation list and reassign order ids to the remaining installations.
boolean	removeInstallation(String installationId) Remove the installation from the installation list and reassign order ids to the remaining installations.
InstallationData	setInstallations(List<Installation> installations) Set the installation list for the InstallationData.
InstallationData	setParent(OracleHome containerOracleHome) Sets the parent of this object.
InstallationData	setPatches(List<String> patches) Sets the list of patch identifiers e.g.
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 JSON format.
String	toString() Returns a string representation of the object in JSON 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

Constructor Detail

InstallationData

public InstallationData()

Method Detail

getParent

public OracleHome 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<OracleHome>

Returns:

the object that contains this entity

setParent

public InstallationData setParent(OracleHome containerOracleHome)

Description copied from interface: oracle.fmwplatform.envspec.common.ContainerAware

Sets the parent of this object. The container object has variables in it that are used by child objects.

Specified by:

setParent in interface oracle.fmwplatform.envspec.common.ContainerAware<OracleHome>

Parameters:

containerOracleHome - the parent container

Returns:

the ContainerAware parent object

getPatches

public List<String> getPatches()

Returns the list of patch identifiers, for example p1234567.

Returns:

the list of patch identifiers

setPatches

public InstallationData setPatches(List<String> patches)

Sets the list of patch identifiers e.g. ‘p1234567’.

Parameters:

patches - the list of patch identifiers e.g. ‘p1234567’

Returns:

this InstallationData object (for method chaining)

addPatch

public boolean addPatch(String patch)

Adds a single patch to the list of patches

Parameters:

patch - identifier for a patch

Returns:

true if the list of patches has changed as a result of this call

Throws:

IllegalArgumentException - if the input value is null

addAllPatches

public boolean addAllPatches(List<String> patches)

Adds a single patch to the list of patches

Parameters:

patches - identifier for a patch

Returns:

true if the list of patches has changed as a result of this call

Throws:

IllegalArgumentException - if the input value is null

getInstallations

public List<Installation> getInstallations()

Returns a list of the installations for this InstallationData.

Returns:

installations the set of installations for this InstallationData

setInstallations

public InstallationData setInstallations(List<Installation> installations)

Set the installation list for the InstallationData. The order of this list will be maintained.

Parameters:

installations - an ordered list or list not currently assigned order

Returns:

new installation list in sorted order with assigned order ids.

addInstallation

public boolean addInstallation(Installation installation)

Adds the installation to the end of the list and sets the order id.

Parameters:

installation - the installation to be added to the end of the installations list

Returns:

true if the list has changed as a result of this call

removeInstallation

public boolean removeInstallation(Installation installation)
                           throws IllegalArgumentException

Remove the installation from the installation list and reassign order ids to the remaining installations.

Parameters:

installation - the installation to remove from the installation list.

Returns:

true if installation was removed from the installation list or false will be returned if the installation is null

Throws:

IllegalArgumentException

removeInstallation

public boolean removeInstallation(String installationId)

Remove the installation from the installation list and reassign order ids to the remaining installations.

Parameters:

installationId - the installation id to remove from the list.

Returns:

true if installation was removed from the installation list. false will be returned if the installation id is null

getEffectiveVariables

public Map<String,String> getEffectiveVariables()
                                         throws FMWEnvSpecException

Returns the derived map of variables for this element.

Specified by:

getEffectiveVariables in interface oracle.fmwplatform.envspec.common.ParentContainerWithVariables

Returns:

a map of variables

Throws:

FMWEnvSpecException - in the event of a critical error

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

toCompactString

public String toCompactString()

Returns a compact string representation of the object in JSON format.

Returns:

a compact string representation of the object in JSON format

toString

public String toString()

Returns a string representation of the object in JSON format.

Overrides:

toString in class Object

Returns:

a string representation of the object in JSON format