oracle.fmwplatform.actionframework.api.v2.rest

Class RestActionInvoker

java.lang.Object

oracle.fmwplatform.actionframework.api.v2.rest.RestActionInvoker

public class RestActionInvoker
extends Object

Helper class for making client REST requests to invoke a standard action on a remote REST server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestActionInvoker.JacksonObjectMapper

Field Summary

Fields

Modifier and Type	Field and Description
javax.ws.rs.client.Client	client
static oracle.fmwplatform.util.logging.PlatformLogger	logger
static String	ROOT_CTX
String	url

Constructor Summary

Constructors

Constructor and Description
RestActionInvoker(String url) Construct a REST action invoker.

Method Summary

Modifier and Type	Method and Description
ListActionsResp	getActions() Invoke the get known action REST request
ActionResult	runAction(String actionName, oracle.fmwplatform.envspec.model.EnvironmentModel env, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets) Run a remote action via the action framework REST server
ActionResult	runAction(String actionName, oracle.fmwplatform.envspec.model.EnvironmentModel env, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, Object extra) Run a remote action via the action framework REST server
ActionResult	runAction(String actionName, oracle.fmwplatform.envspec.model.EnvironmentModel env, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, Object extra, String oracleHome) Run a remote action via the action framework REST server
ActionResult	runAction(String actionName, oracle.fmwplatform.envspec.model.EnvironmentModel env, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, Object extra, String oracleHome, ActionType actionType)
ActionResult	runAction(String actionName, oracle.fmwplatform.envspec.model.EnvironmentModel env, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, String oracleHome) Run a remote action via the action framework REST server

Methods inherited from class java.lang.Object

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

Field Detail

url

public String url

client

public javax.ws.rs.client.Client client

ROOT_CTX

public static final String ROOT_CTX

See Also:

Constant Field Values

logger

public static final oracle.fmwplatform.util.logging.PlatformLogger logger

Constructor Detail

RestActionInvoker

public RestActionInvoker(String url)
                  throws NoSuchAlgorithmException,
                         KeyManagementException

Construct a REST action invoker. All certificates are accepted as the assumption is that the LCM Agent will be running with a self signed certificate. If CA signed certificates will be purchased for production LCM Agents we might want to make the TrustManager code conditional.

Parameters:

url - the url of the REST server - http(s)://host:port

Throws:

NoSuchAlgorithmException - if SSL error encountered

KeyManagementException - if SSL error encountered

Method Detail

getActions

public ListActionsResp getActions()
                           throws ActionInvocationException

Invoke the get known action REST request

Returns:

List of known actions

Throws:

ActionInvocationException - if response status is bad

runAction

public ActionResult runAction(String actionName,
                              oracle.fmwplatform.envspec.model.EnvironmentModel env,
                              List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets)
                       throws ActionInvocationException

Run a remote action via the action framework REST server

Parameters:

actionName - name of the action to run

env - the environment model to be passed to the action

targets - the list of targets to be passed to the action

Returns:

the action result

Throws:

ActionInvocationException - if response status is bad

runAction

public ActionResult runAction(String actionName,
                              oracle.fmwplatform.envspec.model.EnvironmentModel env,
                              List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
                              Object extra)
                       throws ActionInvocationException

Run a remote action via the action framework REST server

Parameters:

actionName - name of the action to run

env - the environment model to be passed to the action

targets - the list of targets to be passed to the action

extra - any extra parameters needed by the action

Returns:

the action result

Throws:

ActionInvocationException - if response status is bad

runAction

public ActionResult runAction(String actionName,
                              oracle.fmwplatform.envspec.model.EnvironmentModel env,
                              List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
                              String oracleHome)
                       throws ActionInvocationException

Run a remote action via the action framework REST server

Parameters:

actionName - name of the action to run

env - the environment model to be passed to the action

targets - the list of targets to be passed to the action

oracleHome - oracle home containing the action

Returns:

the action result

Throws:

ActionInvocationException - if response status is bad

runAction

public ActionResult runAction(String actionName,
                              oracle.fmwplatform.envspec.model.EnvironmentModel env,
                              List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
                              Object extra,
                              String oracleHome)
                       throws ActionInvocationException

Run a remote action via the action framework REST server

Parameters:

actionName - name of the action to run

env - the environment model to be passed to the action

targets - the list of targets to be passed to the action

extra - extra parameter if necessary

oracleHome - oracle home containing the action

Returns:

the action result

Throws:

ActionInvocationException - if response status is bad

runAction

public ActionResult runAction(String actionName,
                              oracle.fmwplatform.envspec.model.EnvironmentModel env,
                              List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
                              Object extra,
                              String oracleHome,
                              ActionType actionType)
                       throws ActionInvocationException

Parameters:

actionName - name of the action to run

env - the environment model to be passed to the action

targets - the list of targets to be passed to the action

extra - extra parameter if necessary

oracleHome - oracle home containing the action

actionType - the action type to attempt to run

Returns:

the action result

Throws:

ActionInvocationException - if the response status is bad