com.goldencode.p2j.util

Class AsyncRequestImpl

java.lang.Object

com.goldencode.p2j.util.HandleResource

com.goldencode.p2j.util.HandleChain

com.goldencode.p2j.util.AsyncRequestImpl

All Implemented Interfaces:

AsyncRequest, CommonHandle, CommonHandleChain, Deletable, Errorable, EventProcedure, InstantiatingProcedure, Nameable, Remotable, RequestResponseInfo, WrappedResource, Printable, java.lang.Runnable

public class AsyncRequestImpl
extends HandleChain
implements AsyncRequest, java.lang.Runnable

Implements the async request resource. Beside adding support for its attributes, the async resource is also responsible of initiating the async call and raising the PROCEDURE-COMPLETE event.

As some the mutable fields of this class can be modified by more than one thread, they are marked as volatile.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Object[]	args The procedure's arguments.
private boolean	async Flag indicating if the request invoked on another thread or immediately.
private java.lang.Runnable	asyncAction The async action to execute.
private boolean	cancelled Flag indicating that the async call has been cancelled.
private boolean	complete Flag indicating that the async call has completed (will be false if the call was cancelled.
private boolean	error Flag indicating that the call was terminated with an ERROR condition.
private java.lang.String	eventProcedure The name of the EVENT-PROCEDURE.
private WrappedResource	eventProcedureContext The context of the EVENT-PROCEDURE.
private AppServerHelper	helper For appserver calls, the helper for the remote connection.
private java.util.ArrayList<AsyncRequestListener>	listeners List of listeners which need to receive notifications when the call is started or finished.
private java.lang.String	modes The modes for the procedure's arguments.
private int	passCount The number of passes for the execute(boolean) method - 1 is on the Conversation thread, 2 is on a separate thread.
private WrappedResource	persistentProcedure The proxy procedure, if the remote call is for an internal procedure.
private java.lang.String	procedureName The name of the target procedure.
private boolean	quit Flag indicating that the call was terminated with a QUIT condition.
private java.lang.Runnable	request A worker indicating what will be invoked.
private int	requestId The ID of the remote request being executed.
private object<? extends OerequestInfo>	requestInfo The reference to the REQUEST-INFO attribute.
private object<? extends OerequestInfo>	responseInfo The reference to the RESPONSE-INFO attribute.
private RemoteInvocationResult	result The result from the remote call.
private handle	server A handle to the SERVER resource.
private boolean	stop Flag indicating that the call was terminated with a STOP condition.
private boolean	valid Flag indicating if the resource is valid.
private boolean	webService Flag indicating if this is a web service call.

Fields inherited from class com.goldencode.p2j.util.HandleChain

name, nextSibling, prevSibling, wa

Fields inherited from class com.goldencode.p2j.util.HandleResource

instProc, pm

Constructor Summary

Constructors

Constructor and Description
AsyncRequestImpl(handle server, java.lang.Runnable request, character eventProcedure, handle eventProcedureContext, character procedureName, handle persistentProcedure, java.lang.String modes, java.lang.Object... args) Create a new async request resource, by specifying the attributes related to the async call definition.

Method Summary

Modifier and Type	Method and Description
boolean	_isCancelled() Get the CANCELLED attribute of this async request, as a Java boolean.
boolean	_isComplete() Get the COMPLETE attribute of this async request, as a Java boolean.
(package private) void	cancelled() Called when the async call was cancelled by the user.
(package private) void	complete() Called when the async call has finished normally (not with a cancel).
logical	error() Returns the state of the ERROR attribute
void	error(boolean value) Setter for ERROR attribute.
void	error(logical value) Setter for ERROR attribute.
(package private) void	execute(boolean async) Execute the async request.
java.lang.Object[]	getArgs() Get the arguments for this async requests.
character	getEventProcedure() Get the EVENT-PROCEDURE attribute of this async request.
handle	getEventProcedureContext() Get the EVENT-PROCEDURE-CONTEXT attribute of this async request.
java.lang.String	getModes() Get the parameter modes for this async request.
handle	getPersistentProcedure() Get the PERSISTENT-PROCEDURE attribute of this async request.
character	getProcedureName() Get the PROCEDURE-NAME attribute of this async request.
object<? extends OerequestInfo>	getRequestInfo() Get the REQUEST-INFO legacy attribute.
object<? extends OerequestInfo>	getResponseInfo() Get the RESPONSE-INFO legacy attribute.
handle	getServerHandle() Returns a handle to the app server in which the procedure is ran.
protected boolean	hasNameReadOnly() As this resource supports the name attribute in R/W mode, return false
(package private) boolean	isAsync() Check if the request can be executed immediately or it needs to be async.
logical	isCancelled() Get the CANCELLED attribute of this async request.
logical	isComplete() Get the COMPLETE attribute of this async request.
logical	isQuit() Get the QUIT attribute of this async request.
logical	isStop() Get the STOP attribute of this async request.
private void	notifyListeners(boolean start) Notify the listeners about the invocation request state (start or finish).
(package private) void	notifyStart() Notify all listeners that the async call is about to start.
(package private) void	registerListener(AsyncRequestListener listener) Register a new listener for notifications about the state of the async call.
protected boolean	resourceDelete() The async resource can be deleted only if it has been completed or cancelled.
void	run() Invoke the event procedure for this async request, if used.
(package private) void	setAsyncAction(java.lang.Runnable action) Set the async action to be executed for this request.
(package private) void	setError() Mark this async call as having ended with a ERROR condition.
(package private) void	setQuit() Mark this async call as having ended with a QUIT condition.
(package private) void	setRequestId(int reqId) Set the ID of this remote request.
(package private) void	setResult(RemoteInvocationResult result) Set the result from the request execution.
(package private) void	setStop() Mark this async call as having ended with a STOP condition.
(package private) void	stop() Stop this async request by sending the STOP condition to the remote side.
boolean	valid() Reports if this object is valid for use (has not been deleted).

Methods inherited from class com.goldencode.p2j.util.HandleChain

_name, delete, firstResource, firstResource, getHead, getNextSibling, getNextSibling, getPrevSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasNextSibling, hasParent, hasPrevSibling, hasPrivateData, interlink, isChained, lastResource, lastResource, moveInChain, name, name, name, readOnlyError, readOnlyError, resolveChainType, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName

Methods inherited from class com.goldencode.p2j.util.HandleResource

_instantiatingProcedure, addToPool, doDelete, equals, hashCode, id, id, implicitDeletion, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, registerResource, resourceType, setInstantiatingProcedure, toString, type, unableToAssignUnknown, unknown

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.util.CommonHandleChain

getNextSibling, getPrevSibling, getPrivateData, setPrivateData, setPrivateData

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

readOnlyError, readOnlyError, resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown

Methods inherited from interface com.goldencode.p2j.util.Nameable

name, name, name

Methods inherited from interface com.goldencode.p2j.util.Remotable

setServerHandle

Methods inherited from interface com.goldencode.p2j.util.EventProcedure

setEventProcedure, setEventProcedure, setEventProcedureContext

Methods inherited from interface com.goldencode.util.Printable

asString, print

Methods inherited from interface com.goldencode.p2j.util.Deletable

allowDelete

Field Detail

server

private final handle server

A handle to the SERVER resource.

eventProcedure

private java.lang.String eventProcedure

The name of the EVENT-PROCEDURE.

eventProcedureContext

private WrappedResource eventProcedureContext

The context of the EVENT-PROCEDURE.

persistentProcedure

private WrappedResource persistentProcedure

The proxy procedure, if the remote call is for an internal procedure.

procedureName

private java.lang.String procedureName

The name of the target procedure.

args

private final java.lang.Object[] args

The procedure's arguments.

modes

private java.lang.String modes

The modes for the procedure's arguments.

result

private RemoteInvocationResult result

The result from the remote call.

complete

private volatile boolean complete

Flag indicating that the async call has completed (will be false if the call was cancelled.

cancelled

private volatile boolean cancelled

Flag indicating that the async call has been cancelled.

quit

private volatile boolean quit

Flag indicating that the call was terminated with a QUIT condition.

stop

private volatile boolean stop

Flag indicating that the call was terminated with a STOP condition.

error

private volatile boolean error

Flag indicating that the call was terminated with an ERROR condition.

valid

private volatile boolean valid

Flag indicating if the resource is valid.

requestId

private volatile int requestId

The ID of the remote request being executed.

listeners

private java.util.ArrayList<AsyncRequestListener> listeners

List of listeners which need to receive notifications when the call is started or finished.

request

private java.lang.Runnable request

A worker indicating what will be invoked.

requestInfo

private object<? extends OerequestInfo> requestInfo

The reference to the REQUEST-INFO attribute.

responseInfo

private object<? extends OerequestInfo> responseInfo

The reference to the RESPONSE-INFO attribute.

webService

private boolean webService

Flag indicating if this is a web service call.

async

private boolean async

Flag indicating if the request invoked on another thread or immediately.

asyncAction

private java.lang.Runnable asyncAction

The async action to execute.

passCount

private volatile int passCount

The number of passes for the execute(boolean) method - 1 is on the Conversation thread, 2 is on a separate thread.

helper

private AppServerHelper helper

For appserver calls, the helper for the remote connection.

Constructor Detail

AsyncRequestImpl

public AsyncRequestImpl(handle server,
                        java.lang.Runnable request,
                        character eventProcedure,
                        handle eventProcedureContext,
                        character procedureName,
                        handle persistentProcedure,
                        java.lang.String modes,
                        java.lang.Object... args)

Create a new async request resource, by specifying the attributes related to the async call definition.

Parameters:

server - The server used to invoke the remote call. May be a SERVER or the SESSION resource.

request - The request which will execute the procedure call.

eventProcedure - The event procedure name.

eventProcedureContext - The context of the event procedure.

procedureName - The name of the procedure to be invoked.

persistentProcedure - The handle to the proxy procedure to which the target procedure belongs. Will be unknown if this is not a remote call.

modes - The modes for the procedure's arguments.

args - The procedure's arguments.

Method Detail

getModes

public java.lang.String getModes()

Get the parameter modes for this async request.

Returns:

See above.

getArgs

public java.lang.Object[] getArgs()

Get the arguments for this async requests.

Returns:

See above.

error

public logical error()

Returns the state of the ERROR attribute

Specified by:

error in interface Errorable

Returns:

Current state of the ERROR attribute.

error

public void error(boolean value)

Setter for ERROR attribute.

Specified by:

error in interface Errorable

Parameters:

value - The new value of ERROR attribute.

error

public void error(logical value)

Setter for ERROR attribute.

Specified by:

error in interface Errorable

Parameters:

value - The new value of ERROR attribute.

valid

public boolean valid()

Reports if this object is valid for use (has not been deleted).

Specified by:

valid in interface WrappedResource

Returns:

true if we are valid (can be used).

getServerHandle

public handle getServerHandle()

Returns a handle to the app server in which the procedure is ran.

Specified by:

getServerHandle in interface Remotable

Returns:

See above

isCancelled

public logical isCancelled()

Get the CANCELLED attribute of this async request.

Specified by:

isCancelled in interface AsyncRequest

Returns:

See above.

_isCancelled

public boolean _isCancelled()

Get the CANCELLED attribute of this async request, as a Java boolean.

Returns:

See above.

isComplete

public logical isComplete()

Get the COMPLETE attribute of this async request.

Specified by:

isComplete in interface AsyncRequest

Returns:

See above.

_isComplete

public boolean _isComplete()

Get the COMPLETE attribute of this async request, as a Java boolean.

Returns:

See above.

getEventProcedure

public character getEventProcedure()

Get the EVENT-PROCEDURE attribute of this async request.

Specified by:

getEventProcedure in interface EventProcedure

Returns:

See above.

getEventProcedureContext

public handle getEventProcedureContext()

Get the EVENT-PROCEDURE-CONTEXT attribute of this async request.

Specified by:

getEventProcedureContext in interface EventProcedure

Returns:

See above.

getPersistentProcedure

public handle getPersistentProcedure()

Get the PERSISTENT-PROCEDURE attribute of this async request.

Specified by:

getPersistentProcedure in interface AsyncRequest

Returns:

See above.

getProcedureName

public character getProcedureName()

Get the PROCEDURE-NAME attribute of this async request.

Specified by:

getProcedureName in interface AsyncRequest

Returns:

See above.

getRequestInfo

public object<? extends OerequestInfo> getRequestInfo()

Get the REQUEST-INFO legacy attribute.

Specified by:

getRequestInfo in interface RequestResponseInfo

Returns:

See above.

getResponseInfo

public object<? extends OerequestInfo> getResponseInfo()

Get the RESPONSE-INFO legacy attribute.

Specified by:

getResponseInfo in interface RequestResponseInfo

Returns:

See above.

isQuit

public logical isQuit()

Get the QUIT attribute of this async request.

Specified by:

isQuit in interface AsyncRequest

Returns:

See above.

isStop

public logical isStop()

Get the STOP attribute of this async request.

Specified by:

isStop in interface AsyncRequest

Returns:

See above.

run

public void run()

Invoke the event procedure for this async request, if used.

Specified by:

run in interface java.lang.Runnable

isAsync

boolean isAsync()

Check if the request can be executed immediately or it needs to be async.

Returns:

The state of the async flag.

setAsyncAction

void setAsyncAction(java.lang.Runnable action)

Set the async action to be executed for this request.

Parameters:

action - The async action.

setRequestId

void setRequestId(int reqId)

Set the ID of this remote request.

Parameters:

reqId - The ID of the request.

complete

void complete()

Called when the async call has finished normally (not with a cancel).

cancelled

void cancelled()

Called when the async call was cancelled by the user.

setStop

void setStop()

Mark this async call as having ended with a STOP condition.

setQuit

void setQuit()

Mark this async call as having ended with a QUIT condition.

setError

void setError()

Mark this async call as having ended with a ERROR condition.

stop

void stop()

Stop this async request by sending the STOP condition to the remote side. This will be used only in cases when the async call is cancelled by the user.

setResult

void setResult(RemoteInvocationResult result)

Set the result from the request execution.

Parameters:

result - The result.

registerListener

void registerListener(AsyncRequestListener listener)

Register a new listener for notifications about the state of the async call.

Parameters:

listener - A listener instance.

notifyStart

void notifyStart()

Notify all listeners that the async call is about to start.

execute

void execute(boolean async)

Execute the async request. This will either raise the PROCEDURE-COMPLETE event or will invoke the EVENT-PROCEDURE immediately.

Parameters:

async - Flag indicating if the request will be executed in this thread or in another thread.

resourceDelete

protected boolean resourceDelete()

The async resource can be deleted only if it has been completed or cancelled.

Overrides:

resourceDelete in class HandleResource

Returns:

true if the resource was deleted.

hasNameReadOnly

protected boolean hasNameReadOnly()

As this resource supports the name attribute in R/W mode, return false

Overrides:

hasNameReadOnly in class HandleChain

Returns:

always false

notifyListeners

private void notifyListeners(boolean start)

Notify the listeners about the invocation request state (start or finish).

Parameters:

start - true to indicate invocation start, false to notify for invocation finish.