InvokeConfig (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.util.InvokeConfig

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable
```
public class InvokeConfig
extends java.lang.Object
implements java.io.Externalizable
```
Defines a configuration which can be used by a RUN or dynamic function call. All the information required to perform a call can be setup using a builder approach, as all setters return this instance.
The final call can be delegated to ControlFlowOps.invoke(InvokeConfig).

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.Object[]`	`arguments` The arguments for this call.
`private boolean`	`asThread` Flag indicating if AS-THREAD FWD-extension option is present.
`private handle`	`asyncHandle` The handle where to pass back the reference to the `async resource`.
`private boolean`	`asynchronous` Flag indicating if ASYNCHRONOUS option is present.
`private InvokeConfig`	`callSite` The callsite instance (at the converted code) for this call.
`private java.lang.String`	`clientContextId` The value of the `OERequestInfo:` field.
`private byte[]`	`clientPrincipal` The value of the `OERequestInfo:clientPrincipal` field.
`private java.lang.String`	`clientType` The value of the `OERequestInfo:clientType` field.
`private boolean`	`dynamicFunction` Flag indicating if this is a DYNAMIC-FUNCTION call.
`private character`	`eventProcedure` This represents the name of the internal procedure for the EVENT-PROCEDURE clause, null if this clause is not specified.
`private handle`	`eventProcedureContext` The handle to a procedure in which context the specified EVENT-PROCEDURE internal procedure is found, null if EVENT-PROCEDURE clause is not specified.
`private static int`	`FIELD_ARGS` Constant to identify field `arguments` during serialization.
`private static int`	`FIELD_AS_THREAD` Constant to identify field `asThread` during serialization.
`private static int`	`FIELD_ASYNC` Constant to identify field `asynchronous` during serialization.
`private static int`	`FIELD_ASYNC_HANDLE` Constant to identify field `asyncHandle` during serialization.
`private static int`	`FIELD_CLIENTCONTEXTID` Constant to identify field `clientContextId` during serialization.
`private static int`	`FIELD_CLIENTPRINCIPAL` Constant to identify field `clientPrincipal` during serialization.
`private static int`	`FIELD_CLIENTTYPE` Constant to identify field `clientType` during serialization.
`private static int`	`FIELD_DYN_FUNC` Constant to identify field `dynamicFunction` during serialization.
`private static int`	`FIELD_EVT_PROC` Constant to identify field `eventProcedure` during serialization.
`private static int`	`FIELD_EVT_PROC_CONTEXT` Constant to identify field `eventProcedureContext` during serialization.
`private static int`	`FIELD_FUNCTION` Constant to identify field `function` during serialization.
`private static int`	`FIELD_IN_HANDLE` Constant to identify field `inHandle` during serialization.
`private static int`	`FIELD_IS_CLASS` Constant to identify field `isClass` during serialization.
`private static int`	`FIELD_MODES` Constant to identify field `modes` during serialization.
`private static int`	`FIELD_PERSISTENT` Constant to identify field `persistent` during serialization.
`private static int`	`FIELD_PORT_HANDLE` Constant to identify field `portHandle` during serialization.
`private static int`	`FIELD_PROC_HANDLE` Constant to identify field `procedureHandle` during serialization.
`private static int`	`FIELD_REQUESTID` Constant to identify field `requestId` during serialization.
`private static int`	`FIELD_RETURN_VALUE` Constant to identify field `returnValue` during serialization.
`private static int`	`FIELD_SERVER_HANDLE` Constant to identify field `serverHandle` during serialization.
`private static int`	`FIELD_SINGLE_RUN` Constant to identify field `singleRun` during serialization.
`private static int`	`FIELD_SINGLETON` Constant to identify field `singleton` during serialization.
`private static int`	`FIELD_SUPER_CALL` Constant to identify field `superCall` during serialization.
`private static int`	`FIELD_TX_DISTINCT` Constant to identify field `transactionDistinct` during serialization.
`private static int`	`FIELD_VERSIONINFO` Constant to identify field `versionInfo` during serialization.
`private static int`	`FIELD_WEB_SERVICE_TOKEN` Constant to identify field `webServiceToken` during serialization.
`private boolean`	`function` Flag indicating if this is a function or procedure call.
`private handle`	`inHandle` When specified, it will mean the target will be a function or internal procedure, using the given procedure handle as a start.
`private boolean`	`isClass` Flag indicating that this is a legacy OO class.
`private java.lang.String`	`modes` A string representation of the modes of each parameter.
`private boolean`	`persistent` When set, this call will be an external program call, ran persistent.
`private handle`	`portHandle` The handle where to pass back the reference in case of a web service invocation.
`private handle`	`procedureHandle` The handle where to pass back the reference to the newly persistent-run external program.
`private java.lang.String`	`requestId` The value of the `OERequestInfo:requestId` field.
`private boolean`	`returnValue` Flag indicating if the OO method call is function-like (return value is needed).
`private handle`	`serverHandle` The remote server handle where to run this request.
`private boolean`	`singleRun` When set, this call will be an external program call, ran in SINGLE-RUN mode.
`private boolean`	`singleton` When set, this call will be an external program call, ran in SINGLETON mode.
`private boolean`	`superCall` Flag indicating if this is a RUN SUPER or SUPER().
`private java.lang.String`	`target` This call's target (a function, internal procedure or program name).
`private boolean`	`transactionDistinct` Flag indicating if TRANSACTION-DISTINCT option is present.
`private java.lang.String[]`	`versionInfo` The value of the `OERequestInfo:versionInfo` field.
`private java.lang.String`	`webServiceToken` A token sent via a web service request, to execute the target service in the specified FWD context.

Constructor Summary

Constructors
Constructor and Description
`InvokeConfig()` Default constructor.
`InvokeConfig(character target)` Create a new invocation for the given target.
`InvokeConfig(InvokeConfig callSite)` Copy constructor.
`InvokeConfig(java.lang.String target)` Create a new invocation for the given target.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InvokeConfig`	`asThread()` Set this invocation's `asThread` flag to `true`.
`InvokeConfig`	`asynchronous()` Set this invocation's `asynchronous` flag to `true`.
`InvokeConfig`	`clone()` Clone this instance.
`private long`	`computeWriting()` For each field, it sets a bit if the field's value is no longer the default value.
`InvokeConfig`	`dynamicFunction()` Set this invocation's `dynamicFunction` and `function` flags to `true`.
`<T extends BaseDataType> T`	`execute(java.lang.Class<T> cls, java.lang.Object... args)` Execute this config for a function typed call.
`BaseDataType`	`execute(java.lang.Object... args)` Execute this config for a function call.
`BaseDataType`	`executeForResource(WrappedResource resource)` Execute this config for a callback procedure associated with a resource event.
`InvokeConfig`	`function()` Set this invocation's `function` flag to `true`.
`java.lang.Object[]`	`getArguments()` Get the caller's `arguments`.
`handle`	`getAsyncHandle()` Get the caller's `asyncHandle`.
`InvokeConfig`	`getCallSite()` Get the `callSite`.
`character`	`getEventProcedure()` Get the caller's `eventProcedure`.
`handle`	`getEventProcedureContext()` Get the caller's `eventProcedureContext`.
`handle`	`getInHandle()` Get the target handle for internal entry call.
`java.lang.String`	`getModes()` Get the caller's `modes`.
`handle`	`getPortHandle()` Get the `portHandle`.
`handle`	`getProcedureHandle()` Get the `procedureHandle`.
`java.lang.String`	`getRequestId()` Get the request ID.
`handle`	`getServerHandle()` Get the `serverHandle`.
`java.lang.String`	`getTarget()` Get the caller's target.
`java.lang.String`	`getWebServiceToken()` Get the web service token.
`boolean`	`isAsThread()` Get the `asThread` flag.
`boolean`	`isAsynchronous()` Get the `asynchronous` flag.
`boolean`	`isClass()` Get the `isClass` flag.
`boolean`	`isDynamicFunction()` Get the caller's `dynamicFunction`.
`boolean`	`isFunction()` Get the `function` flag.
`boolean`	`isPersistent()` Get the `persistent` flag.
`boolean`	`isReturnValue()` Get the `returnValue` flag.
`boolean`	`isSingleRun()` Get the `singleRun` flag.
`boolean`	`isSingleton()` Get the `singleton` flag.
`boolean`	`isSuperCall()` Get the caller's `superCall`.
`boolean`	`isTransactionDistinct()` Get the `transactionDistinct` flag.
`InvokeConfig`	`persistent()` Set this invocation's `persistent` flag to `true`.
`void`	`readExternal(java.io.ObjectInput in)` Read this invoke configuration from a stream.
`(package private) void`	`restoreRequest(OerequestInfo req, java.lang.Integer agentId, java.lang.Integer sessionId, java.lang.Integer threadId)` Restore the `OerequestInfo` from this call details, as received from a remote call.
`void`	`run(java.lang.Object... args)` Execute this config for a RUN call.
`<T extends BaseDataType> T`	`runSuper(java.lang.Class<T> type, java.lang.Object... args)` Execute this config as a `SUPER()` function, with the provided arguments and return type.
`void`	`runSuper(java.lang.Object... args)` Execute this config as a `RUN SUPER` statement with the provided arguments.
`InvokeConfig`	`setArguments(java.lang.Object... arguments)` Set this invocation's `arguments`.
`InvokeConfig`	`setAsThread(boolean asThread)` Set this invocation's `asThread` flag.
`InvokeConfig`	`setAsyncHandle(handle asyncHandle)` Set this invocation's `asyncHandle` handle where to save the async resource.
`InvokeConfig`	`setAsynchronous(boolean asynchronous)` Set this invocation's `asynchronous` flag.
`InvokeConfig`	`setClass()` Mark this configuration as a OO invocation.
`InvokeConfig`	`setDynamicFunction(boolean dynamicFunction)` Set this invocation's `dynamicFunction` flag.
`InvokeConfig`	`setEventProcedure(character eventProcedure)` Set this invocation's `EVENT-PROCEDURE` option.
`InvokeConfig`	`setEventProcedure(java.lang.String eventProcedure)` Set this invocation's `EVENT-PROCEDURE` option.
`InvokeConfig`	`setEventProcedureContext(handle eventProcedureContext)` Set this invocation's `EVENT-PROCEDURE-CONTEXT` option.
`InvokeConfig`	`setFunction(boolean function)` Set this invocation's `function` flag.
`InvokeConfig`	`setInHandle(handle inHandle)` Set this invocation's `IN handle` option.
`InvokeConfig`	`setModes(java.lang.String modes)` Set this invocation's `argument modes`.
`InvokeConfig`	`setPersistent(boolean persistent)` Set this invocation's `persistent` flag.
`InvokeConfig`	`setPortHandle(handle portHandle)` Set this invocation's `portHandle` handle where to save the web service.
`InvokeConfig`	`setProcedureHandle(handle procedureHandle)` Set this invocation's `procedureHandle` handle where to save the persistent program.
`InvokeConfig`	`setRequestId(java.lang.String requestId)` Set the `requestId`.
`InvokeConfig`	`setReturnValue(boolean returnValue)` Set this invocation's `returnValue` flag.
`InvokeConfig`	`setServerHandle(handle serverHandle)` Set this invocation's `serverHandle` remote handle where to perform the call.
`InvokeConfig`	`setSingleRun(boolean singleRun)` Set this invocation's `singleRun` flag.
`InvokeConfig`	`setSingleton(boolean singleton)` Set this invocation's `singleton` flag.
`InvokeConfig`	`setSuperCall(boolean superCall)` Set this invocation's `superCall` flag.
`InvokeConfig`	`setTarget(character target)` Set this invocation's `target`.
`InvokeConfig`	`setTarget(java.lang.String target)` Set this invocation's `target`.
`InvokeConfig`	`setTransactionDistinct(boolean transactionDistinct)` Set this invocation's `transactionDistinct` flag.
`InvokeConfig`	`setWebServiceToken(java.lang.String webServiceToken)` Set the `webServiceToken`.
`InvokeConfig`	`singleRun()` Set this invocation's `singleRun` flag to `true`.
`InvokeConfig`	`singleton()` Set this invocation's `singleton` flag to `true`.
`(package private) InvokeConfig`	`storeRequest(object<? extends OerequestInfo> requestInfo)` Store the passed request info object, to be sent to a remote side.
`java.lang.String`	`toString()` Construct and return a short representation of this object to be used mainly for debugging.
`InvokeConfig`	`transactionDistinct()` Set this invocation's `transactionDistinct` flag to `true`.
`void`	`writeExternal(java.io.ObjectOutput out)` Serialize this invoke configuration.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - FIELD_IN_HANDLE
```
private static final int FIELD_IN_HANDLE
```
    Constant to identify field inHandle during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_FUNCTION
```
private static final int FIELD_FUNCTION
```
    Constant to identify field function during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_PERSISTENT
```
private static final int FIELD_PERSISTENT
```
    Constant to identify field persistent during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_SINGLE_RUN
```
private static final int FIELD_SINGLE_RUN
```
    Constant to identify field singleRun during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_SINGLETON
```
private static final int FIELD_SINGLETON
```
    Constant to identify field singleton during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_PROC_HANDLE
```
private static final int FIELD_PROC_HANDLE
```
    Constant to identify field procedureHandle during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_SERVER_HANDLE
```
private static final int FIELD_SERVER_HANDLE
```
    Constant to identify field serverHandle during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_TX_DISTINCT
```
private static final int FIELD_TX_DISTINCT
```
    Constant to identify field transactionDistinct during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_ASYNC
```
private static final int FIELD_ASYNC
```
    Constant to identify field asynchronous during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_ASYNC_HANDLE
```
private static final int FIELD_ASYNC_HANDLE
```
    Constant to identify field asyncHandle during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_EVT_PROC
```
private static final int FIELD_EVT_PROC
```
    Constant to identify field eventProcedure during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_EVT_PROC_CONTEXT
```
private static final int FIELD_EVT_PROC_CONTEXT
```
    Constant to identify field eventProcedureContext during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_ARGS
```
private static final int FIELD_ARGS
```
    Constant to identify field arguments during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_MODES
```
private static final int FIELD_MODES
```
    Constant to identify field modes during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_PORT_HANDLE
```
private static final int FIELD_PORT_HANDLE
```
    Constant to identify field portHandle during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_DYN_FUNC
```
private static final int FIELD_DYN_FUNC
```
    Constant to identify field dynamicFunction during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_SUPER_CALL
```
private static final int FIELD_SUPER_CALL
```
    Constant to identify field superCall during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_IS_CLASS
```
private static final int FIELD_IS_CLASS
```
    Constant to identify field isClass during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_RETURN_VALUE
```
private static final int FIELD_RETURN_VALUE
```
    Constant to identify field returnValue during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_CLIENTCONTEXTID
```
private static final int FIELD_CLIENTCONTEXTID
```
    Constant to identify field clientContextId during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_REQUESTID
```
private static final int FIELD_REQUESTID
```
    Constant to identify field requestId during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_CLIENTPRINCIPAL
```
private static final int FIELD_CLIENTPRINCIPAL
```
    Constant to identify field clientPrincipal during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_VERSIONINFO
```
private static final int FIELD_VERSIONINFO
```
    Constant to identify field versionInfo during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_CLIENTTYPE
```
private static final int FIELD_CLIENTTYPE
```
    Constant to identify field clientType during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_WEB_SERVICE_TOKEN
```
private static final int FIELD_WEB_SERVICE_TOKEN
```
    Constant to identify field webServiceToken during serialization.
    
    See Also:
    
    Constant Field Values
  - FIELD_AS_THREAD
```
private static final int FIELD_AS_THREAD
```
    Constant to identify field asThread during serialization.
    
    See Also:
    
    Constant Field Values
  - target
```
private java.lang.String target
```
    This call's target (a function, internal procedure or program name).
  - isClass
```
private boolean isClass
```
    Flag indicating that this is a legacy OO class.
  - inHandle
```
private handle inHandle
```
    When specified, it will mean the target will be a function or internal procedure, using the given procedure handle as a start.
  - function
```
private boolean function
```
    Flag indicating if this is a function or procedure call.
  - persistent
```
private boolean persistent
```
    When set, this call will be an external program call, ran persistent.
  - singleRun
```
private boolean singleRun
```
    When set, this call will be an external program call, ran in SINGLE-RUN mode.
  - singleton
```
private boolean singleton
```
    When set, this call will be an external program call, ran in SINGLETON mode.
  - procedureHandle
```
private handle procedureHandle
```
    The handle where to pass back the reference to the newly persistent-run external program.
  - portHandle
```
private handle portHandle
```
    The handle where to pass back the reference in case of a web service invocation.
  - serverHandle
```
private handle serverHandle
```
    The remote server handle where to run this request.
  - transactionDistinct
```
private boolean transactionDistinct
```
    Flag indicating if TRANSACTION-DISTINCT option is present.
  - asynchronous
```
private boolean asynchronous
```
    Flag indicating if ASYNCHRONOUS option is present.
  - asThread
```
private boolean asThread
```
    Flag indicating if AS-THREAD FWD-extension option is present.
  - asyncHandle
```
private handle asyncHandle
```
    The handle where to pass back the reference to the async resource.
  - eventProcedure
```
private character eventProcedure
```
    This represents the name of the internal procedure for the EVENT-PROCEDURE clause, null if this clause is not specified.
  - eventProcedureContext
```
private handle eventProcedureContext
```
    The handle to a procedure in which context the specified EVENT-PROCEDURE internal procedure is found, null if EVENT-PROCEDURE clause is not specified.
  - arguments
```
private java.lang.Object[] arguments
```
    The arguments for this call.
  - modes
```
private java.lang.String modes
```
    A string representation of the modes of each parameter.
  - dynamicFunction
```
private boolean dynamicFunction
```
    Flag indicating if this is a DYNAMIC-FUNCTION call.
  - superCall
```
private boolean superCall
```
    Flag indicating if this is a RUN SUPER or SUPER(). call.
  - returnValue
```
private boolean returnValue
```
    Flag indicating if the OO method call is function-like (return value is needed).
  - clientContextId
```
private java.lang.String clientContextId
```
    The value of the OERequestInfo: field.
  - requestId
```
private java.lang.String requestId
```
    The value of the OERequestInfo:requestId field.
  - clientPrincipal
```
private byte[] clientPrincipal
```
    The value of the OERequestInfo:clientPrincipal field.
  - versionInfo
```
private java.lang.String[] versionInfo
```
    The value of the OERequestInfo:versionInfo field.
  - clientType
```
private java.lang.String clientType
```
    The value of the OERequestInfo:clientType field.
  - webServiceToken
```
private java.lang.String webServiceToken
```
    A token sent via a web service request, to execute the target service in the specified FWD context.
  - callSite
```
private InvokeConfig callSite
```
    The callsite instance (at the converted code) for this call.
- Constructor Detail
  - InvokeConfig
```
public InvokeConfig()
```
    Default constructor.
  - InvokeConfig
```
public InvokeConfig(InvokeConfig callSite)
```
    Copy constructor. This also saves the call-site reference, to be able to cache the target.
  - InvokeConfig
```
public InvokeConfig(character target)
```
    Create a new invocation for the given target.
    
    Parameters:
    
    target - The target to be invoked.
  - InvokeConfig
```
public InvokeConfig(java.lang.String target)
```
    Create a new invocation for the given target.
    
    Parameters:
    
    target - The target to be invoked.
- Method Detail
  - clone
```
public InvokeConfig clone()
```
    Clone this instance.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    A copy of this instance.
  - executeForResource
```
public BaseDataType executeForResource(WrappedResource resource)
```
    Execute this config for a callback procedure associated with a resource event.
    
    Parameters:
    
    resource - The resource associated with the call-site.
    
    Returns:
    
    The result of the invocation, if this is a function call.
  - runSuper
```
public void runSuper(java.lang.Object... args)
```
    Execute this config as a RUN SUPER statement with the provided arguments.
    
    Parameters:
    
    args - The arguments.
  - runSuper
```
public <T extends BaseDataType> T runSuper(java.lang.Class<T> type,
                                           java.lang.Object... args)
```
    Execute this config as a SUPER() function, with the provided arguments and return type.
    
    Parameters:
    
    type - The return type.
    
    args - The arguments.
    
    Returns:
    
    The function's return value.
  - run
```
public void run(java.lang.Object... args)
```
    Execute this config for a RUN call.
  - execute
```
public <T extends BaseDataType> T execute(java.lang.Class<T> cls,
                                          java.lang.Object... args)
```
    Execute this config for a function typed call.
    
    Returns:
    
    The function's returned value.
  - execute
```
public BaseDataType execute(java.lang.Object... args)
```
    Execute this config for a function call.
    
    Returns:
    
    The function's returned value.
  - getCallSite
```
public InvokeConfig getCallSite()
```
    Get the callSite.
    
    Returns:
    
    See above.
  - setTarget
```
public InvokeConfig setTarget(character target)
```
    Set this invocation's target.
    
    Parameters:
    
    target - The target to be invoked.
    
    Returns:
    
    This instance.
  - setTarget
```
public InvokeConfig setTarget(java.lang.String target)
```
    Set this invocation's target.
    
    Parameters:
    
    target - The target to be invoked.
    
    Returns:
    
    This instance.
  - setClass
```
public InvokeConfig setClass()
```
    Mark this configuration as a OO invocation.
    
    Returns:
    
    This instance.
  - setReturnValue
```
public InvokeConfig setReturnValue(boolean returnValue)
```
    Set this invocation's returnValue flag.
    
    Parameters:
    
    returnValue - The new value of this flag.
    
    Returns:
    
    This instance.
  - setFunction
```
public InvokeConfig setFunction(boolean function)
```
    Set this invocation's function flag.
    
    Parameters:
    
    function - The new value of this flag.
    
    Returns:
    
    This instance.
  - function
```
public InvokeConfig function()
```
    Set this invocation's function flag to true.
    
    Returns:
    
    This instance.
  - setPersistent
```
public InvokeConfig setPersistent(boolean persistent)
```
    Set this invocation's persistent flag.
    
    Parameters:
    
    persistent - The new value of this flag.
    
    Returns:
    
    This instance.
  - persistent
```
public InvokeConfig persistent()
```
    Set this invocation's persistent flag to true.
    
    Returns:
    
    This instance.
  - setSingleRun
```
public InvokeConfig setSingleRun(boolean singleRun)
```
    Set this invocation's singleRun flag.
    
    Parameters:
    
    singleRun - The new value of this flag.
    
    Returns:
    
    This instance.
  - singleRun
```
public InvokeConfig singleRun()
```
    Set this invocation's singleRun flag to true.
    
    Returns:
    
    This instance.
  - setSingleton
```
public InvokeConfig setSingleton(boolean singleton)
```
    Set this invocation's singleton flag.
    
    Parameters:
    
    singleton - The new value of this flag.
    
    Returns:
    
    This instance.
  - singleton
```
public InvokeConfig singleton()
```
    Set this invocation's singleton flag to true.
    
    Returns:
    
    This instance.
  - setProcedureHandle
```
public InvokeConfig setProcedureHandle(handle procedureHandle)
```
    Set this invocation's procedureHandle handle where to save the persistent program.
    
    Parameters:
    
    procedureHandle - A handle variable or field reference.
    
    Returns:
    
    This instance.
  - setPortHandle
```
public InvokeConfig setPortHandle(handle portHandle)
```
    Set this invocation's portHandle handle where to save the web service.
    
    Parameters:
    
    portHandle - A handle variable or field reference.
    
    Returns:
    
    This instance.
  - setServerHandle
```
public InvokeConfig setServerHandle(handle serverHandle)
```
    Set this invocation's serverHandle remote handle where to perform the call.
    
    Parameters:
    
    serverHandle - A handle to a remote appserver.
    
    Returns:
    
    This instance.
  - setTransactionDistinct
```
public InvokeConfig setTransactionDistinct(boolean transactionDistinct)
```
    Set this invocation's transactionDistinct flag.
    
    Parameters:
    
    transactionDistinct - The new value of this flag.
    
    Returns:
    
    This instance.
  - transactionDistinct
```
public InvokeConfig transactionDistinct()
```
    Set this invocation's transactionDistinct flag to true.
    
    Returns:
    
    This instance.
  - setAsynchronous
```
public InvokeConfig setAsynchronous(boolean asynchronous)
```
    Set this invocation's asynchronous flag.
    
    Parameters:
    
    asynchronous - The new value of this flag.
    
    Returns:
    
    This instance.
  - asThread
```
public InvokeConfig asThread()
```
    Set this invocation's asThread flag to true.
    
    Returns:
    
    This instance.
  - setAsThread
```
public InvokeConfig setAsThread(boolean asThread)
```
    Set this invocation's asThread flag.
    
    Parameters:
    
    asThread - The new value of this flag.
    
    Returns:
    
    This instance.
  - asynchronous
```
public InvokeConfig asynchronous()
```
    Set this invocation's asynchronous flag to true.
    
    Returns:
    
    This instance.
  - setAsyncHandle
```
public InvokeConfig setAsyncHandle(handle asyncHandle)
```
    Set this invocation's asyncHandle handle where to save the async resource.
    
    Parameters:
    
    asyncHandle - A handle variable or field reference.
    
    Returns:
    
    This instance.
  - setEventProcedure
```
public InvokeConfig setEventProcedure(character eventProcedure)
```
    Set this invocation's EVENT-PROCEDURE option.
    
    Parameters:
    
    eventProcedure - The event procedure name.
    
    Returns:
    
    This instance.
  - setEventProcedure
```
public InvokeConfig setEventProcedure(java.lang.String eventProcedure)
```
    Set this invocation's EVENT-PROCEDURE option.
    
    Parameters:
    
    eventProcedure - The event procedure name.
    
    Returns:
    
    This instance.
  - setEventProcedureContext
```
public InvokeConfig setEventProcedureContext(handle eventProcedureContext)
```
    Set this invocation's EVENT-PROCEDURE-CONTEXT option.
    
    Parameters:
    
    eventProcedureContext - The event procedure context.
    
    Returns:
    
    This instance.
  - setInHandle
```
public InvokeConfig setInHandle(handle inHandle)
```
    Set this invocation's IN handle option.
    
    Parameters:
    
    inHandle - A program handle where to perform the call.
    
    Returns:
    
    This instance.
  - setArguments
```
public InvokeConfig setArguments(java.lang.Object... arguments)
```
    Set this invocation's arguments.
    
    Parameters:
    
    arguments - A invocation's arguments.
    
    Returns:
    
    This instance.
  - setModes
```
public InvokeConfig setModes(java.lang.String modes)
```
    Set this invocation's argument modes.
    
    Parameters:
    
    modes - A invocation's argument modes.
    
    Returns:
    
    This instance.
  - setSuperCall
```
public InvokeConfig setSuperCall(boolean superCall)
```
    Set this invocation's superCall flag.
    
    Parameters:
    
    superCall - Flag indicating that this is a super-call.
    
    Returns:
    
    This instance.
  - setDynamicFunction
```
public InvokeConfig setDynamicFunction(boolean dynamicFunction)
```
    Set this invocation's dynamicFunction flag.
    
    Parameters:
    
    dynamicFunction - Flag indicating that this is a dynamic-function call.
    
    Returns:
    
    This instance.
  - dynamicFunction
```
public InvokeConfig dynamicFunction()
```
    Set this invocation's dynamicFunction and function flags to true.
    
    Returns:
    
    This instance.
  - setRequestId
```
public InvokeConfig setRequestId(java.lang.String requestId)
```
    Set the requestId.
    
    Parameters:
    
    requestId - The request ID.
    
    Returns:
    
    This instance.
  - setWebServiceToken
```
public InvokeConfig setWebServiceToken(java.lang.String webServiceToken)
```
    Set the webServiceToken.
    
    Parameters:
    
    webServiceToken - The web service token.
    
    Returns:
    
    This instance.
  - isClass
```
public boolean isClass()
```
    Get the isClass flag.
    
    Returns:
    
    See above.
  - isReturnValue
```
public boolean isReturnValue()
```
    Get the returnValue flag.
    
    Returns:
    
    See above.
  - isFunction
```
public boolean isFunction()
```
    Get the function flag.
    
    Returns:
    
    See above.
  - isPersistent
```
public boolean isPersistent()
```
    Get the persistent flag.
    
    Returns:
    
    See above.
  - isSingleRun
```
public boolean isSingleRun()
```
    Get the singleRun flag.
    
    Returns:
    
    See above.
  - isSingleton
```
public boolean isSingleton()
```
    Get the singleton flag.
    
    Returns:
    
    See above.
  - isTransactionDistinct
```
public boolean isTransactionDistinct()
```
    Get the transactionDistinct flag.
    
    Returns:
    
    See above.
  - isAsynchronous
```
public boolean isAsynchronous()
```
    Get the asynchronous flag.
    
    Returns:
    
    See above.
  - isAsThread
```
public boolean isAsThread()
```
    Get the asThread flag.
    
    Returns:
    
    See above.
  - getTarget
```
public java.lang.String getTarget()
```
    Get the caller's target.
    
    Returns:
    
    the target.
  - getInHandle
```
public handle getInHandle()
```
    Get the target handle for internal entry call.
    
    Returns:
    
    the inHandle
  - getProcedureHandle
```
public handle getProcedureHandle()
```
    Get the procedureHandle.
    
    Returns:
    
    the procedureHandle
  - getPortHandle
```
public handle getPortHandle()
```
    Get the portHandle.
    
    Returns:
    
    the portHandle
  - getServerHandle
```
public handle getServerHandle()
```
    Get the serverHandle.
    
    Returns:
    
    the serverHandle
  - getAsyncHandle
```
public handle getAsyncHandle()
```
    Get the caller's asyncHandle.
    
    Returns:
    
    the asyncHandle.
  - getEventProcedure
```
public character getEventProcedure()
```
    Get the caller's eventProcedure.
    
    Returns:
    
    the eventProcedure
  - getEventProcedureContext
```
public handle getEventProcedureContext()
```
    Get the caller's eventProcedureContext.
    
    Returns:
    
    the eventProcedureContext
  - getArguments
```
public java.lang.Object[] getArguments()
```
    Get the caller's arguments.
    
    Returns:
    
    the arguments
  - getModes
```
public java.lang.String getModes()
```
    Get the caller's modes.
    
    Returns:
    
    the modes
  - isSuperCall
```
public boolean isSuperCall()
```
    Get the caller's superCall.
    
    Returns:
    
    the superCall
  - isDynamicFunction
```
public boolean isDynamicFunction()
```
    Get the caller's dynamicFunction.
    
    Returns:
    
    the dynamicFunction
  - getRequestId
```
public java.lang.String getRequestId()
```
    Get the request ID.
    
    Returns:
    
    The requestId.
  - getWebServiceToken
```
public java.lang.String getWebServiceToken()
```
    Get the web service token.
    
    Returns:
    
    The webServiceToken.
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    Serialize this invoke configuration. To reduce the size of the written data, computeWriting() will be used to set a bit for each field in this class, which was changed from its default value. Only the fields which are no longer holding the default value will be serialized.
    The target field is always written.
    
    Specified by:
    
    writeExternal in interface java.io.Externalizable
    
    Parameters:
    
    out - The output stream.
    
    Throws:
    
    java.io.IOException
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
```
    Read this invoke configuration from a stream. Only the fields which are no longer holding the default value will be read (see computeWriting()).
    The target field is always read.
    
    Specified by:
    
    readExternal in interface java.io.Externalizable
    
    Parameters:
    
    in - The input stream.
    
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException
  - storeRequest
```
InvokeConfig storeRequest(object<? extends OerequestInfo> requestInfo)
```
    Store the passed request info object, to be sent to a remote side.
    
    Parameters:
    
    requestInfo - The OerequestInfo instance.
    
    Returns:
    
    This instance.
  - restoreRequest
```
void restoreRequest(OerequestInfo req,
                    java.lang.Integer agentId,
                    java.lang.Integer sessionId,
                    java.lang.Integer threadId)
```
    Restore the OerequestInfo from this call details, as received from a remote call.
    
    Parameters:
    
    req - The request info for the Agent's SESSION.
    
    agentId - The agent ID, as computed by the Agent.
    
    sessionId - The sessionID, as computed by the Agent.
    
    threadId - The threadID, as computed by the Agent.
  - computeWriting
```
private long computeWriting()
```
    For each field, it sets a bit if the field's value is no longer the default value.
    For Boolean fields, this means the field is set to true.
    For Object fields, this means the field is now not-null.
    
    Returns:
    
    A 64-bit value with bits set only for changed fields.
  - toString
```
public java.lang.String toString()
```
    Construct and return a short representation of this object to be used mainly for debugging. In this case, the returned string is composed of name and parameter types of the target routine.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    name and parameter types (in, out) of the target routine.

Class InvokeConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FIELD_IN_HANDLE

FIELD_FUNCTION

FIELD_PERSISTENT

FIELD_SINGLE_RUN

FIELD_SINGLETON

FIELD_PROC_HANDLE

FIELD_SERVER_HANDLE

FIELD_TX_DISTINCT

FIELD_ASYNC

FIELD_ASYNC_HANDLE

FIELD_EVT_PROC

FIELD_EVT_PROC_CONTEXT

FIELD_ARGS

FIELD_MODES

FIELD_PORT_HANDLE

FIELD_DYN_FUNC

FIELD_SUPER_CALL

FIELD_IS_CLASS

FIELD_RETURN_VALUE

FIELD_CLIENTCONTEXTID

FIELD_REQUESTID

FIELD_CLIENTPRINCIPAL

FIELD_VERSIONINFO

FIELD_CLIENTTYPE

FIELD_WEB_SERVICE_TOKEN

FIELD_AS_THREAD

target

isClass

inHandle

function

persistent

singleRun

singleton

procedureHandle

portHandle

serverHandle

transactionDistinct

asynchronous

asThread

asyncHandle

eventProcedure

eventProcedureContext

arguments

modes

dynamicFunction

superCall

returnValue

clientContextId

requestId

clientPrincipal

versionInfo

clientType

webServiceToken

callSite

Constructor Detail

InvokeConfig

InvokeConfig

InvokeConfig

InvokeConfig

Method Detail

clone

executeForResource

runSuper

runSuper

run

execute

execute

getCallSite

setTarget

setTarget

setClass

setReturnValue

setFunction

function