com.goldencode.p2j.util

Class ProxyProcedureWrapper

java.lang.Object

com.goldencode.p2j.util.TransparentWrapper

com.goldencode.p2j.util.ExternalProgramWrapper

com.goldencode.p2j.util.ProxyProcedureWrapper

All Implemented Interfaces:

ADMData, AsyncRequestCountAttribute, AsyncRequestListener, CallbackProcedure, CommonFile, CommonHandle, CommonHandleChain, CommonProcedure, DeferredDeletable, Deletable, InstantiatingProcedure, MultiDeletable, Nameable, PersistableProcedure, PersistentProcedure, Remotable, RemoteResource, UniqueID, WrappedResource

public class ProxyProcedureWrapper
extends ExternalProgramWrapper
implements RemoteResource, AsyncRequestListener

This class implements the proxy procedure resource; on the requester side, this resource is linked with a remote procedure resource from the remote, appserver, side. If this resource gets deleted, the remote resource gets deleted too.

Otherwise, the procedure handle on the remote and the requester side are not linked. Changes performed to the resource on one side are not visible on the other side. Only the NAME and FILE-NAME attributes are in sync with the remote side, when accessed from the requester side.

Field Summary

Fields

Modifier and Type	Field and Description
private int	agentId The agent ID which created this procedure.
private long	asyncRequestCount Count the number of active async internal-entry requests.
private java.lang.String	fileName The name of this proxy procedure.
private boolean	initialized Flag indicating if the proxy procedure has been initialized on the remote side.
private ProxyProcedureWrapper	next The next proxy procedure (in the same server).
private ProxyProcedureWrapper	prev The previous proxy procedure (in the same server).
private ServerImpl	server The server used to obtain this proxy procedure.

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

pm

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

referent

Constructor Summary

Constructors

Constructor and Description
ProxyProcedureWrapper(java.lang.String code, character fileName, int agentId) Instantiate a new proxy procedure.

Method Summary

Modifier and Type	Method and Description
logical	addSuperProcedure(handle h) This call is a no-op on proxy procedures, always returns false.
void	delete() Delete this proxy procedure (from the requester side) and the associated remote procedure on the appserver side.
boolean	equals(java.lang.Object obj) Determines if this instance and the passed-in instance are equivalent.
int	getAgentId() Get the agent ID, which created the remote procedure for this proxy.
integer	getAsyncRequestCount() Returns the number of asynchronous requests.
character	getFileName() Get the external program name associated with the proxy procedure.
handle	getNextSibling() Get a handle for the next chained procedure.
handle	getPrevSibling() Get a handle for the previous procedure in the chain.
java.lang.String	getResourceId() Get the ID of this remote resource.
(package private) ServerImpl	getServer() Get the server instance for this proxy procedure.
handle	getServerHandle() Returns a handle to the app server in which the procedure is ran.
character	getSignature(character internalEntry) This call is a no-op on proxy procedures, always returns the empty string.
boolean	handleMultipleDeletes() Such procedures can't handle multiple deletes, so this call should fail.
int	hashCode() Calculate the hash, considering the agentId.
character	internalEntries() This call is a no-op on proxy procedures, always returns the unknown.
(package private) boolean	isInitialized() Check the initialized state.
logical	isPersistent() Check if this is a persistent procedure.
logical	isProxy() Indicates if the procedure is a proxy procedure.
logical	isRemote() Indicate if the procedure is a remote procedure.
void	notifyFinish() Called when the async call of an internal-entry for proxy procedure has finished.
void	notifyStart() Called when an internal-entry of this proxy procedure is invoked async.
logical	removeSuperProcedure(handle h) This call is a no-op on proxy procedures, always returns false.
void	setInitialized(boolean initialized) Mark this proxy procedure as initialized on the remote side (its 'execute' method was invoked).
(package private) void	setNextSibling(ProxyProcedureWrapper proxyProcedure) Add the passed proxyProcedure as the next one in the chain.
(package private) void	setPrevSibling(ProxyProcedureWrapper proxyProcedure) Add the passed proxyProcedure as the previous one in the chain.
(package private) void	setServer(ServerImpl server) Set the server for this proxy procedure.
character	superProcedures() This call is a no-op on proxy procedures, always returns the empty string.
boolean	valid() Determine if this instance is valid.
(package private) void	waitForInitialize() Wait for this proxy procedure to be initialized (its 'execute' method invoked) on the remote side.

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

addSuperProcedure, addSuperProcedure, addSuperProcedure, applyCallback, currentWindow, deferredDelete, getADMData, getCallbackProcContext, getCallbackProcName, getPrivateData, getPublishedEvents, getSignature, getTransaction, getUniqueID, initFileInfo, initFileInfo, instantiatingProcedure, isSingleRun, isSingleton, name, name, name, readOnlyError, readOnlyError, resourceType, setADMData, setADMData, setCallback, setCallbackProcedure, setCallbackProcedure, setCallbackProcedure, setCallbackProcedure, setCallbackProcedure, setCallbackProcedure, setCallbackProcedure, setCallbackProcedure, setCurrentWindow, setCurrentWindow, setPrivateData, setPrivateData

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

get, id, id, set, unknown

Methods inherited from class java.lang.Object

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

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

id, id, unknown

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

applyCallback, getCallbackProcContext, getCallbackProcName, setCallback, setCallback, setCallback, setCallback, setCallback, setCallback

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

setPersistent, setPersistent

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

setServerHandle

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

allowDelete

Field Detail

fileName

private java.lang.String fileName

The name of this proxy procedure.

server

private ServerImpl server

The server used to obtain this proxy procedure.

prev

private ProxyProcedureWrapper prev

The previous proxy procedure (in the same server).

next

private ProxyProcedureWrapper next

The next proxy procedure (in the same server).

asyncRequestCount

private long asyncRequestCount

Count the number of active async internal-entry requests.

initialized

private volatile boolean initialized

Flag indicating if the proxy procedure has been initialized on the remote side.

agentId

private int agentId

The agent ID which created this procedure.

Constructor Detail

ProxyProcedureWrapper

public ProxyProcedureWrapper(java.lang.String code,
                             character fileName,
                             int agentId)

Instantiate a new proxy procedure. The underlying referent is the code for the remote procedure handle, on the appserver side.

Parameters:

code - The procedure handle code, as on the remote side.

fileName - The name of this external program.

agentId - The agent ID which created the remote procedure for this proxy.

Method Detail

getAgentId

public int getAgentId()

Get the agent ID, which created the remote procedure for this proxy.

Returns:

The agentId.

getServerHandle

public handle getServerHandle()

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

Specified by:

getServerHandle in interface Remotable

Overrides:

getServerHandle in class ExternalProgramWrapper

Returns:

See above

valid

public boolean valid()

Determine if this instance is valid.

Specified by:

valid in interface WrappedResource

Overrides:

valid in class ExternalProgramWrapper

Returns:

true if this instance is valid, false otherwise.

getAsyncRequestCount

public integer getAsyncRequestCount()

Returns the number of asynchronous requests.

Specified by:

getAsyncRequestCount in interface AsyncRequestCountAttribute

Overrides:

getAsyncRequestCount in class ExternalProgramWrapper

Returns:

See above.

isProxy

public logical isProxy()

Indicates if the procedure is a proxy procedure.

Specified by:

isProxy in interface PersistentProcedure

Overrides:

isProxy in class ExternalProgramWrapper

Returns:

always true.

isRemote

public logical isRemote()

Indicate if the procedure is a remote procedure.

Specified by:

isRemote in interface CommonProcedure

Overrides:

isRemote in class ExternalProgramWrapper

Returns:

always false

internalEntries

public character internalEntries()

This call is a no-op on proxy procedures, always returns the unknown.

Specified by:

internalEntries in interface PersistentProcedure

Overrides:

internalEntries in class ExternalProgramWrapper

Returns:

See above.

getSignature

public character getSignature(character internalEntry)

This call is a no-op on proxy procedures, always returns the empty string.

Specified by:

getSignature in interface PersistentProcedure

Overrides:

getSignature in class ExternalProgramWrapper

Parameters:

internalEntry - The legacy procedure/function name.

Returns:

See above.

addSuperProcedure

public logical addSuperProcedure(handle h)

This call is a no-op on proxy procedures, always returns false.

Specified by:

addSuperProcedure in interface CommonProcedure

Overrides:

addSuperProcedure in class ExternalProgramWrapper

Parameters:

h - A procedure handle.

Returns:

See above.

removeSuperProcedure

public logical removeSuperProcedure(handle h)

This call is a no-op on proxy procedures, always returns false.

Specified by:

removeSuperProcedure in interface CommonProcedure

Overrides:

removeSuperProcedure in class ExternalProgramWrapper

Parameters:

h - A procedure handle.

Returns:

See above.

superProcedures

public character superProcedures()

This call is a no-op on proxy procedures, always returns the empty string.

Specified by:

superProcedures in interface CommonProcedure

Overrides:

superProcedures in class ExternalProgramWrapper

Returns:

See above.

isPersistent

public logical isPersistent()

Check if this is a persistent procedure.

Specified by:

isPersistent in interface PersistableProcedure

Overrides:

isPersistent in class ExternalProgramWrapper

Returns:

always true, as proxy procedures are always persistent.

getFileName

public character getFileName()

Get the external program name associated with the proxy procedure.

Specified by:

getFileName in interface CommonFile

Overrides:

getFileName in class ExternalProgramWrapper

Returns:

The external program name.

getNextSibling

public handle getNextSibling()

Get a handle for the next chained procedure.

Specified by:

getNextSibling in interface CommonHandleChain

Overrides:

getNextSibling in class ExternalProgramWrapper

Returns:

See above.

getPrevSibling

public handle getPrevSibling()

Get a handle for the previous procedure in the chain.

Specified by:

getPrevSibling in interface CommonHandleChain

Overrides:

getPrevSibling in class ExternalProgramWrapper

Returns:

See above.

delete

public void delete()

Delete this proxy procedure (from the requester side) and the associated remote procedure on the appserver side.

Specified by:

delete in interface Deletable

Overrides:

delete in class ExternalProgramWrapper

handleMultipleDeletes

public boolean handleMultipleDeletes()

Such procedures can't handle multiple deletes, so this call should fail.

Specified by:

handleMultipleDeletes in interface MultiDeletable

Overrides:

handleMultipleDeletes in class ExternalProgramWrapper

Returns:

false if this can't handle an invalid delete or true otherwise.

getResourceId

public java.lang.String getResourceId()

Get the ID of this remote resource.

Specified by:

getResourceId in interface RemoteResource

Returns:

See above.

notifyStart

public void notifyStart()

Called when an internal-entry of this proxy procedure is invoked async.

Specified by:

notifyStart in interface AsyncRequestListener

notifyFinish

public void notifyFinish()

Called when the async call of an internal-entry for proxy procedure has finished.

Specified by:

notifyFinish in interface AsyncRequestListener

setInitialized

public void setInitialized(boolean initialized)

Mark this proxy procedure as initialized on the remote side (its 'execute' method was invoked).

Parameters:

initialized - The initialized state.

hashCode

public int hashCode()

Calculate the hash, considering the agentId.

Overrides:

hashCode in class TransparentWrapper

Returns:

Hash code value for this object instance.

equals

public boolean equals(java.lang.Object obj)

Determines if this instance and the passed-in instance are equivalent.

Overrides:

equals in class TransparentWrapper

Parameters:

obj - The instance to compare against.

Returns:

true if the objects are the same.

isInitialized

boolean isInitialized()

Check the initialized state.

Returns:

See above.

waitForInitialize

void waitForInitialize()

Wait for this proxy procedure to be initialized (its 'execute' method invoked) on the remote side.

setPrevSibling

void setPrevSibling(ProxyProcedureWrapper proxyProcedure)

Add the passed proxyProcedure as the previous one in the chain.

Parameters:

proxyProcedure - The proxy procedure to add to the chain.

setNextSibling

void setNextSibling(ProxyProcedureWrapper proxyProcedure)

Add the passed proxyProcedure as the next one in the chain.

Parameters:

proxyProcedure - The proxy procedure to add to the chain.

setServer

void setServer(ServerImpl server)

Set the server for this proxy procedure.

Parameters:

server - A the ServerImpl instance.

getServer

ServerImpl getServer()

Get the server instance for this proxy procedure.

Returns:

See above.