oracle.fmwplatform.envspec.model.targets

Interface ModelTarget

All Superinterfaces:

oracle.fmwplatform.util.validation.ValidationParticipant

All Known Implementing Classes:

ClusterInDomainTarget, DomainTarget, HostTarget, ModelTargetImpl, NodeManagerOnHostTarget, OracleHomeTarget, ServerInDomainTarget, ServerOnHostTarget

public interface ModelTarget
extends oracle.fmwplatform.util.validation.ValidationParticipant

The ModelTarget object is used to specify the object on which an action should act or focus on. The environment model target may be of type Domain, Host, Oracle Home, or NodeManager. The scope is used narrow the target and may be either a Cluster or Server type. The scope may be either a name or id depending upon the requirements of the Action being called.

Since:

12.2.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ModelTarget.ModelTargetType

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_NAMES_WILDCARD Target name wildcard character.
static String	ID_PREFIX Prefix to identify an ID value.
static String	NAME_PREFIX Prefix to identify a name value.
static String	VALIDATE_MODEL_PROPERTY Property key used to identify the environment model in the validation process.

Method Summary

Modifier and Type	Method and Description
<T> T	getContainerFromModel(EnvironmentModel model) Return the model object of the target container.
String	getContainerName() Return the name (or id) of the target's container.
ModelTarget.ModelTargetType	getContainerType() Return the type of the target's container.
<T> T	getSingleTargetFromModel(EnvironmentModel model) Return a single model object which should be targeted.
String	getTargetName() Return the name (or id) of the target object.
<T> List<T>	getTargetsFromModel(EnvironmentModel model) Return a list of model objects which should be targeted.
ModelTarget.ModelTargetType	getTargetType() Return the type of the target.
boolean	isAllNamesWildcard(String name) Examine the passed name and determine if it is a wildcard representing all names for the type.
String	toCompactString() Returns a compact string representation of the object in JSON format.

Methods inherited from interface oracle.fmwplatform.util.validation.ValidationParticipant

validate

Field Detail

ALL_NAMES_WILDCARD

static final String ALL_NAMES_WILDCARD

Target name wildcard character.

See Also:

Constant Field Values

ID_PREFIX

static final String ID_PREFIX

Prefix to identify an ID value.

See Also:

Constant Field Values

NAME_PREFIX

static final String NAME_PREFIX

Prefix to identify a name value.

See Also:

Constant Field Values

VALIDATE_MODEL_PROPERTY

static final String VALIDATE_MODEL_PROPERTY

Property key used to identify the environment model in the validation process.

See Also:

Constant Field Values

Method Detail

getTargetName

String getTargetName()

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

Returns:

name or id of the target

getContainerName

String getContainerName()

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

Returns:

name of the target container.

getTargetType

ModelTarget.ModelTargetType getTargetType()

Return the type of the target.

Returns:

target type.

getContainerType

ModelTarget.ModelTargetType getContainerType()

Return the type of the target's container.

Returns:

target container type.

isAllNamesWildcard

boolean isAllNamesWildcard(String name)

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

Parameters:

name - the name to be examined.

Returns:

true if all names wildcard, false otherwise.

getTargetsFromModel

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

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

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.

getSingleTargetFromModel

<T> T getSingleTargetFromModel(EnvironmentModel model)
                        throws FMWEnvSpecException

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, for example ClusterBinding for ClusterInDomainTarget.

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.

getContainerFromModel

<T> T getContainerFromModel(EnvironmentModel model)
                     throws FMWEnvSpecException

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

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.

toCompactString

String toCompactString()

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

Returns:

String