oracle.fmwplatform.actionframework.api.v2.rest

Class RemoteActionInvoker

java.lang.Object

oracle.fmwplatform.actionframework.api.v2.rest.RemoteActionInvoker

public class RemoteActionInvoker
extends Object

Helper class for running remote actions.

Since:

12.2.1.2.0

Constructor Summary

Constructors

Constructor and Description
RemoteActionInvoker()

Method Summary

Modifier and Type	Method and Description
static List<oracle.fmwplatform.envspec.model.topology.Host>	getHostsForTarget(oracle.fmwplatform.envspec.model.EnvironmentModel model, oracle.fmwplatform.envspec.model.targets.ModelTarget target) Return a list of the hosts that need to be contacted for remote action invocation to support the passed targets
static List<oracle.fmwplatform.envspec.model.topology.Host>	getHostsForTargets(oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets) Return a list of the hosts that need to be contacted for remote action invocation to support the passed targets
static ActionResult	runRemoteAction(String actionName, oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, Object extra, String oracleHome) Run remote actions based on the targets provided
static ActionResult	runRemoteAction(String actionName, oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, Object extra, String oracleHome, ActionType actionType) Run remote actions based on the targets provided
static ActionResult	runRemoteAction(String actionName, oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, Object extra, String oracleHome, ActionType actionType, oracle.fmwplatform.envspec.model.topology.Host host) Run a remote action based on the host provided
static ActionResult	runRemoteAction(String actionName, oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, Object extra, String oracleHome, oracle.fmwplatform.envspec.model.topology.Host host) Run remote actions based on the host provided
static ActionResult	runRemoteAction(String actionName, oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, String oracleHome) Run remote actions based on the targets provided
static ActionResult	runRemoteAction(String actionName, oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, String oracleHome, oracle.fmwplatform.envspec.model.topology.Host host) Run remote actions based on the host provided

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteActionInvoker

public RemoteActionInvoker()

Method Detail

runRemoteAction

public static ActionResult runRemoteAction(String actionName,
                                           oracle.fmwplatform.envspec.model.EnvironmentModel model,
                                           List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
                                           String oracleHome)

Run remote actions based on the targets provided

Parameters:

actionName - name of the action to be run

model - the environment model

targets - the list of target to be considered

oracleHome - the oracle home to be used for remote actions

Returns:

the cumulative result of executing remote actions

runRemoteAction

public static ActionResult runRemoteAction(String actionName,
                                           oracle.fmwplatform.envspec.model.EnvironmentModel model,
                                           List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
                                           Object extra,
                                           String oracleHome)

Run remote actions based on the targets provided

Parameters:

actionName - name of the action to be run

model - the environment model

targets - the list of target to be considered

extra - any extra data to be passed to the action

oracleHome - the oracle home to be used for remote actions

Returns:

the cumulative result of executing remote actions

runRemoteAction

public static ActionResult runRemoteAction(String actionName,
                                           oracle.fmwplatform.envspec.model.EnvironmentModel model,
                                           List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
                                           Object extra,
                                           String oracleHome,
                                           ActionType actionType)

Run remote actions based on the targets provided

Parameters:

actionName - name of the action to be run

model - the environment model

targets - the list of target to be considered

extra - any extra data to be passed to the action

oracleHome - the oracle home to be used for remote actions

actionType - the type of action to run or null for default

Returns:

the cumulative result of executing remote actions

runRemoteAction

public static ActionResult runRemoteAction(String actionName,
                                           oracle.fmwplatform.envspec.model.EnvironmentModel model,
                                           List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
                                           String oracleHome,
                                           oracle.fmwplatform.envspec.model.topology.Host host)

Run remote actions based on the host provided

Parameters:

actionName - name of the action to be run

model - the environment model

targets - the list of target to be considered

oracleHome - the oracle home to be used for remote actions

host - the host to run the action on

Returns:

the cumulative result of executing remote actions

runRemoteAction

public static ActionResult runRemoteAction(String actionName,
                                           oracle.fmwplatform.envspec.model.EnvironmentModel model,
                                           List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
                                           Object extra,
                                           String oracleHome,
                                           oracle.fmwplatform.envspec.model.topology.Host host)

Run remote actions based on the host provided

Parameters:

actionName - name of the action to be run

model - the environment model

targets - the list of target to be considered

extra - any extra data to be passed to the action

oracleHome - the oracle home to be used for remote actions

host - the host to run the action on

Returns:

the cumulative result of executing remote actions

runRemoteAction

public static ActionResult runRemoteAction(String actionName,
                                           oracle.fmwplatform.envspec.model.EnvironmentModel model,
                                           List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
                                           Object extra,
                                           String oracleHome,
                                           ActionType actionType,
                                           oracle.fmwplatform.envspec.model.topology.Host host)

Run a remote action based on the host provided

Parameters:

actionName - name of the action to be run

model - the environment model

targets - the list of target to be considered

extra - any extra data to be passed to the action

oracleHome - the oracle home to be used for remote actions

actionType - the type of action to run or null for default

host - the host to run the action on

Returns:

the cumulative result of executing remote actions

getHostsForTarget

public static List<oracle.fmwplatform.envspec.model.topology.Host> getHostsForTarget(oracle.fmwplatform.envspec.model.EnvironmentModel model,
                                                                                     oracle.fmwplatform.envspec.model.targets.ModelTarget target)
                                                                              throws oracle.fmwplatform.envspec.exception.FMWEnvSpecException

Return a list of the hosts that need to be contacted for remote action invocation to support the passed targets

Parameters:

model - the environment model

target - target that should be considered

Returns:

list of hosts which which are affected by target

Throws:

oracle.fmwplatform.envspec.exception.FMWEnvSpecException - is an error occurs

getHostsForTargets

public static List<oracle.fmwplatform.envspec.model.topology.Host> getHostsForTargets(oracle.fmwplatform.envspec.model.EnvironmentModel model,
                                                                                      List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets)
                                                                               throws oracle.fmwplatform.envspec.exception.FMWEnvSpecException

Return a list of the hosts that need to be contacted for remote action invocation to support the passed targets

Parameters:

model - the environment model

targets - list of targets that should be considered

Returns:

list of hosts which which are affected by target

Throws:

oracle.fmwplatform.envspec.exception.FMWEnvSpecException - if an error occurs