oracle.fmwplatform.actionframework.api.v2

Class RemoteProxyActions

java.lang.Object

oracle.fmwplatform.actionframework.api.v2.RemoteProxyActions

public class RemoteProxyActions
extends Object

Option to be passed to the remote action proxy.

Since:

12.2.1.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoteProxyActions.RemoteProxyProtocol Communication protocols supported for remote action invocation.

Constructor Summary

Constructors

Constructor and Description
RemoteProxyActions() Default constructor.
RemoteProxyActions(String host, int port, String actionName) Construct object providing most common data fields.
RemoteProxyActions(String host, int port, String actionName, ActionType actionType) Construct object providing most common data fields.

Method Summary

Modifier and Type	Method and Description
String	getActionName() Return the name of the remote action to be invoked.
ActionType	getActionType() Return the action type of the remote action to be invoked.
Object	getExtras() Return the "extras" argument that will be passed to the remote action.
String	getHost() Return the remote host name or IP address.
int	getPort() Return the port used by the remote action server.
RemoteProxyActions.RemoteProxyProtocol	getProtocol() Return the protocol used to communicate with the remote action server.
ActionType	getRemoteActionType() Return the remote action type to run
String	getRemoteOracleHome() Return the value of the remote Oracle home.
void	setActionName(String actionName) Set the name of the remote action to be invoked.
void	setActionType(ActionType actionType) Set the action type of the remote action to be invoked.
void	setExtras(Object extras) Set the "extras" argument that will be passed to the remote action.
void	setHost(String host) Set the name or IP address of the remote host.
void	setPort(int port) Set the port used by the remote action server.
void	setProtocol(RemoteProxyActions.RemoteProxyProtocol protocol) Set the protocol used to communicate with the remote action server.
void	setRemoteActionType(ActionType remoteActionType) Set the remote action type to run.
void	setRemoteOracleHome(String remoteOracleHome) Set the value of the remote Oracle home.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteProxyActions

public RemoteProxyActions()

Default constructor.

RemoteProxyActions

public RemoteProxyActions(String host,
                          int port,
                          String actionName)

Construct object providing most common data fields.

Parameters:

host - the remote host name or IP address

port - the port being used by the remote action server

actionName - the name of the remote action to be invoked

RemoteProxyActions

public RemoteProxyActions(String host,
                          int port,
                          String actionName,
                          ActionType actionType)

Construct object providing most common data fields.

Parameters:

host - the remote host name or IP address

port - the port being used by the remote action server

actionName - the name of the remote action to be invoked

actionType - the action type of the remote action to be invoked

Method Detail

getHost

public String getHost()

Return the remote host name or IP address.

Returns:

host name or IP address

setHost

public void setHost(String host)

Set the name or IP address of the remote host.

Parameters:

host - the remote host name or IP address

getPort

public int getPort()

Return the port used by the remote action server.

Returns:

listen port for remote action server

setPort

public void setPort(int port)

Set the port used by the remote action server.

Parameters:

port - listen port for remote action server

getActionType

public ActionType getActionType()

Return the action type of the remote action to be invoked.

Returns:

remote action type

setActionType

public void setActionType(ActionType actionType)

Set the action type of the remote action to be invoked.

Parameters:

actionType - remote action type

getActionName

public String getActionName()

Return the name of the remote action to be invoked.

Returns:

remote action name

setActionName

public void setActionName(String actionName)

Set the name of the remote action to be invoked.

Parameters:

actionName - remote action name

getProtocol

public RemoteProxyActions.RemoteProxyProtocol getProtocol()

Return the protocol used to communicate with the remote action server.

Returns:

communication protocol

setProtocol

public void setProtocol(RemoteProxyActions.RemoteProxyProtocol protocol)

Set the protocol used to communicate with the remote action server.

Parameters:

protocol - communication protocol

getExtras

public Object getExtras()

Return the "extras" argument that will be passed to the remote action.

Returns:

the object that will be passed to the remote action as its "extras" argument or null for none.

setExtras

public void setExtras(Object extras)

Set the "extras" argument that will be passed to the remote action.

Parameters:

extras - the object that will be passed to the remote action as its "extras" argument or null for none.

getRemoteOracleHome

public String getRemoteOracleHome()

Return the value of the remote Oracle home.

Returns:

the remote Oracle home or null for default.

setRemoteOracleHome

public void setRemoteOracleHome(String remoteOracleHome)

Set the value of the remote Oracle home.

Parameters:

remoteOracleHome - the remote Oracle home or null for the default.

getRemoteActionType

public ActionType getRemoteActionType()

Return the remote action type to run

Returns:

the action type

setRemoteActionType

public void setRemoteActionType(ActionType remoteActionType)

Set the remote action type to run.

Parameters:

remoteActionType - the action type (i.e. classname)