oracle.fmwplatform.envspec.environment.topology

Class EnvironmentBootstrapMapping

java.lang.Object

oracle.fmwplatform.envspec.environment.topology.EnvironmentBootstrapMapping

public class EnvironmentBootstrapMapping
extends Object

Bootstrap methods for adding the minimal bootstrap information for an OracleHome or a WebLogic Domain ( online or offline ) discovery.

Since:

12.2.1

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_GENERATED_MODEL_VERSION_NUMBER This constant controls the version number that gets put inside model objects (e.g., topology, domain profile, blueprint, etc.) created from scratch where no version number was specified.

Constructor Summary

Constructors

Constructor and Description
EnvironmentBootstrapMapping()

Method Summary

Modifier and Type	Method and Description
static Domain	buildBootstrapDomain(String domainId, String domainPath, String adminUrl, String adminCredentialRef) Deprecated. - Use buildBootstrapDomain(String, String, String, String, String). Domain name is a mandatory attribute.This method defaults domainName to be same as domainId and invokes buildBootstrapDomain(String, String, String, String, String)
static Domain	buildBootstrapDomain(String domainId, String domainName, String domainPath, String adminUrl, String adminCredentialRef) Create a Domain object and add the online or offline bootstrap parameters.
static OracleHome	buildBootstrapOracleHome(String id, String oracleHomePath, String javaHomePath, Type oracleHomeType) Create an OracleHome object and add the oracle home bootstrap parameters
static Topology	buildBootstrapTopology(String topologyName, OracleHome oracleHome, Domain domain) Create a basic topology object with an Oracle home and a Domain object
static Domain	mapDomain(EnvironmentModel model, Domain domain) Maps a Domain to a given EnvironmentModel
static Host	mapHostToTopology(Topology topology) Adds current Host to Topology if it's not present in the topology
static MappedOracleHome	mapOracleHomeToHost(Host host, OracleHome oracleHome) Adds an OracleHome to Host if it's not mapped already.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_GENERATED_MODEL_VERSION_NUMBER

public static final String DEFAULT_GENERATED_MODEL_VERSION_NUMBER

This constant controls the version number that gets put inside model objects (e.g., topology, domain profile, blueprint, etc.) created from scratch where no version number was specified.

See Also:

Constant Field Values

Constructor Detail

EnvironmentBootstrapMapping

public EnvironmentBootstrapMapping()

Method Detail

buildBootstrapDomain

@Deprecated
public static Domain buildBootstrapDomain(String domainId,
                                                      String domainPath,
                                                      String adminUrl,
                                                      String adminCredentialRef)
                                               throws FMWEnvSpecException

Deprecated. - Use buildBootstrapDomain(String, String, String, String, String). Domain name is a mandatory attribute.This method defaults domainName to be same as domainId and invokes buildBootstrapDomain(String, String, String, String, String)

Create a Domain object and add the online or offline bootstrap parameters.

Parameters:

domainId - id value for the Topology domain object

domainPath - full path to the domain folder necessary for offline

adminUrl - t3 url to the adminserver necessary for online

adminCredentialRef - which contains a reference to a credential which will be used for the adminserver

Returns:

Domain object which contains Online or Offline bootstrap parameters

Throws:

FMWEnvSpecException - when domainId is null

buildBootstrapDomain

public static Domain buildBootstrapDomain(String domainId,
                                          String domainName,
                                          String domainPath,
                                          String adminUrl,
                                          String adminCredentialRef)
                                   throws FMWEnvSpecException

Create a Domain object and add the online or offline bootstrap parameters.

Parameters:

domainId - - id value for the Topology domain object

domainName - - name value for the Topology domain object

domainPath - - full path to the domain folder necessary for offline

adminUrl - - t3 url to the adminserver necessary for online

adminCredentialRef - - contains a reference to a credential which will be used for the adminserver

Returns:

Domain object which contains Online or Offline bootstrap parameters

Throws:

FMWEnvSpecException - when domainId or domainName is null

buildBootstrapOracleHome

public static OracleHome buildBootstrapOracleHome(String id,
                                                  String oracleHomePath,
                                                  String javaHomePath,
                                                  Type oracleHomeType)
                                           throws FMWEnvSpecException

Create an OracleHome object and add the oracle home bootstrap parameters

Parameters:

id - The oracle home id when empty oracleHomePath will be used

oracleHomePath - Full path to the oracle home

javaHomePath - Full path to the java home

oracleHomeType - Local or Shared

Returns:

OracleHome object with its bootstrap parameters

Throws:

FMWEnvSpecException - when oracheHomePath is null

buildBootstrapTopology

public static Topology buildBootstrapTopology(String topologyName,
                                              OracleHome oracleHome,
                                              Domain domain)
                                       throws FMWEnvSpecException

Create a basic topology object with an Oracle home and a Domain object

Parameters:

topologyName - Topology name

oracleHome - Topology OracleHome object

domain - Topology Domain object

Returns:

Topology return a Topology object which contains the bootstrap parameter

Throws:

FMWEnvSpecException - fired when the input parameters are not valid

mapHostToTopology

public static Host mapHostToTopology(Topology topology)
                              throws FMWEnvSpecException

Adds current Host to Topology if it's not present in the topology

Parameters:

topology - Topology object to add Host to

Returns:

Host that is added to Topology

Throws:

FMWEnvSpecException - throws exception if topology parameter is null or if hostname cannot be resolved

mapOracleHomeToHost

public static MappedOracleHome mapOracleHomeToHost(Host host,
                                                   OracleHome oracleHome)
                                            throws FMWEnvSpecException

Adds an OracleHome to Host if it's not mapped already.

Parameters:

host - Host object to map to

oracleHome - OracleHome object

Returns:

MappedOracleHome

Throws:

FMWEnvSpecException - If parameters are null

mapDomain

public static Domain mapDomain(EnvironmentModel model,
                               Domain domain)
                        throws FMWEnvSpecException

Maps a Domain to a given EnvironmentModel

Parameters:

model - EnvironmentModel to map the Domain to

domain - Domain object to be added to the EnvironmentModel's topology

Returns:

the Domain object

Throws:

FMWEnvSpecException - If EnvironmentModel is null