oracle.fmwplatform.envspec.model.targets

Class ModelTargetImpl

java.lang.Object

oracle.fmwplatform.envspec.model.targets.ModelTargetImpl

All Implemented Interfaces:

ModelTarget, oracle.fmwplatform.util.validation.ValidationParticipant

Direct Known Subclasses:

ClusterInDomainTarget, CompositeInDomainTarget, DomainTarget, HostTarget, NodeManagerOnHostTarget, OracleHomeTarget, SchemaInDomainTarget, ServerInDomainTarget, ServerOnHostTarget

public abstract class ModelTargetImpl
extends Object
implements ModelTarget

Base implementation of a model target. Parent class for all target types implementing common routines.

Since:

12.2.1

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.fmwplatform.envspec.model.targets.ModelTarget

ModelTarget.ModelTargetType

Field Summary

Fields

Modifier and Type	Field and Description
protected static oracle.fmwplatform.util.logging.PlatformLogger	LOGGER

Fields inherited from interface oracle.fmwplatform.envspec.model.targets.ModelTarget

ALL_NAMES_WILDCARD, ID_PREFIX, NAME_PREFIX, VALIDATE_MODEL_PROPERTY

Constructor Summary

Constructors

Constructor and Description
ModelTargetImpl()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
abstract <T> T	getContainerFromModel(EnvironmentModel model) Return the model object of the target container.
abstract String	getContainerName() Return the name (or id) of the target's container.
abstract ModelTarget.ModelTargetType	getContainerType() Return the type of the target's container.
protected Domain	getDomainById(String name, EnvironmentModel model)
protected Domain	getDomainByName(String name, EnvironmentModel model)
protected NodeManager	getNodeManagerByName(String name, EnvironmentModel model)
<T> T	getSingleTargetFromModel(EnvironmentModel model) Return a single model object which should be targeted.
abstract String	getTargetName() Return the name (or id) of the target object.
abstract <T> List<T>	getTargetsFromModel(EnvironmentModel model) Return a list of model objects which should be targeted.
abstract ModelTarget.ModelTargetType	getTargetType() Return the type of the target.
int	hashCode()
boolean	isAllNamesWildcard(String name) Examine the passed name and determine if it is a wildcard representing all names for the type.
protected boolean	isTargetId(String name)
protected boolean	isTargetName(String name)
protected String	stripNamePrefix(String name)
String	toCompactString() Returns a compact string representation of the object in JSON format.
static String	toCompactString(List<ModelTarget> targets) Returns a compact string representation of the objects in JSON format.
String	toString()
void	validate(oracle.fmwplatform.util.validation.Validate validate) Children may override this to provide type specific validation

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LOGGER

protected static final oracle.fmwplatform.util.logging.PlatformLogger LOGGER

Constructor Detail

ModelTargetImpl

public ModelTargetImpl()

Method Detail

validate

public void validate(oracle.fmwplatform.util.validation.Validate validate)

Children may override this to provide type specific validation

Specified by:

validate in interface oracle.fmwplatform.util.validation.ValidationParticipant

Parameters:

validate - the validate object containing configuration and a list of messages to be appended

getTargetName

public abstract String getTargetName()

Description copied from interface: ModelTarget

Return the name (or id) of the target object.

Specified by:

getTargetName in interface ModelTarget

Returns:

name or id of the target

getContainerName

public abstract String getContainerName()

Description copied from interface: ModelTarget

Return the name (or id) of the target's container.

Specified by:

getContainerName in interface ModelTarget

Returns:

name of the target container.

getTargetType

public abstract ModelTarget.ModelTargetType getTargetType()

Description copied from interface: ModelTarget

Return the type of the target.

Specified by:

getTargetType in interface ModelTarget

Returns:

target type.

getContainerType

public abstract ModelTarget.ModelTargetType getContainerType()

Description copied from interface: ModelTarget

Return the type of the target's container.

Specified by:

getContainerType in interface ModelTarget

Returns:

target container type.

isAllNamesWildcard

public boolean isAllNamesWildcard(String name)

Description copied from interface: ModelTarget

Examine the passed name and determine if it is a wildcard representing all names for the type.

Specified by:

isAllNamesWildcard in interface ModelTarget

Parameters:

name - the name to be examined.

Returns:

true if all names wildcard, false otherwise.

getTargetsFromModel

public abstract <T> List<T> getTargetsFromModel(EnvironmentModel model)
                                         throws FMWEnvSpecException

Description copied from interface: ModelTarget

Return a list of model objects which should be targeted. The type of the objects will vary depending on the type of the ModelTarget, ie. ClusterBinding for ClusterInDomainTarget.

Specified by:

getTargetsFromModel in interface ModelTarget

Type Parameters:

T - type derived by compiler from the assignment statement.

Parameters:

model - the environment model.

Returns:

list of the model objects to be targeted.

Throws:

FMWEnvSpecException - if an error occurs.

getContainerFromModel

public abstract <T> T getContainerFromModel(EnvironmentModel model)
                                     throws FMWEnvSpecException

Description copied from interface: ModelTarget

Return the model object of the target container. Data type will vary depending on the type of ModelTarget, i.e. Domain for ClusterInDomainTarget.

Specified by:

getContainerFromModel in interface ModelTarget

Type Parameters:

T - type derived by compiler from the assignment statement.

Parameters:

model - the environment model.

Returns:

model object which is the container or null for none.

Throws:

FMWEnvSpecException - if an error occurs.

getSingleTargetFromModel

public <T> T getSingleTargetFromModel(EnvironmentModel model)
                               throws FMWEnvSpecException

Description copied from interface: ModelTarget

Return a single model object which should be targeted. If there are more than one target object only the first found will be returned The type of the objects will vary depending on the type of the ModelTarget, ie. ClusterBinding for ClusterInDomainTarget.

Specified by:

getSingleTargetFromModel in interface ModelTarget

Type Parameters:

T - type derived by compiler from the assignment statement.

Parameters:

model - the environment model.

Returns:

model object to be targeted.

Throws:

FMWEnvSpecException - if an error occurs.

toCompactString

public String toCompactString()

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

Specified by:

toCompactString in interface ModelTarget

Returns:

String

toCompactString

public static String toCompactString(List<ModelTarget> targets)

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

Parameters:

targets - the list of targets

Returns:

the JSON string

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isTargetId

protected boolean isTargetId(String name)

isTargetName

protected boolean isTargetName(String name)

stripNamePrefix

protected String stripNamePrefix(String name)

getDomainById

protected Domain getDomainById(String name,
                               EnvironmentModel model)

getDomainByName

protected Domain getDomainByName(String name,
                                 EnvironmentModel model)
                          throws FMWEnvSpecException

Throws:

FMWEnvSpecException

getNodeManagerByName

protected NodeManager getNodeManagerByName(String name,
                                           EnvironmentModel model)
                                    throws FMWEnvSpecException

Throws:

FMWEnvSpecException