org.jboss.ejb.client

Class EJBClientInvocationContext

java.lang.Object

org.jboss.ejb.client.Attachable

org.jboss.ejb.client.EJBClientInvocationContext

public final class EJBClientInvocationContext
extends Attachable

An invocation context for EJB invocations from an EJB client

Author:

David M. Lloyd, Jaikiran Pai

Field Summary

Fields

Modifier and Type	Field and Description
static String	PRIVATE_ATTACHMENTS_KEY

Method Summary

Modifier and Type	Method and Description
boolean	awaitCancellationResult() Wait to determine whether this invocation was cancelled.
void	discardResult() Discard the result from this request.
EJBClientContext	getClientContext() Get the EJB client context associated with this invocation.
int	getCompressionLevel() Get the compression hint level.
Map<String,Object>	getContextData() Get the context data.
Method	getInvokedMethod() Get the invoked proxy method.
Object	getInvokedProxy() Get the invoked proxy object.
EJBLocator<?>	getLocator() Get the locator for the invocation target.
EJBMethodLocator	getMethodLocator() Get the EJB method locator.
String	getMethodSignatureString() Get the method type signature string, used to identify the method.
Object[]	getParameters() Get the invocation method parameters.
<T> T	getProxyAttachment(AttachmentKey<T> key) Get a value attached to the proxy.
protected EJBReceiver	getReceiver() Get the EJB receiver associated with this invocation.
Object	getResult() Get the invocation result from this request.
Transaction	getTransaction() Get the transaction associated with the invocation.
ClientTransactionPolicy	getTransactionPolicy() Determine whether the method has an explicit transaction policy set.
Class<?>	getViewClass() Get the invoked view class.
Affinity	getWeakAffinity() Get the invocation weak affinity.
boolean	isBlockingCaller() Determine whether this invocation is currently blocking the calling thread.
boolean	isClientAsync() Determine whether the method is marked client-asynchronous, meaning that invocation should be asynchronous regardless of whether the server-side method is asynchronous.
boolean	isCompressRequest() Determine whether the request is expected to be compressed.
boolean	isCompressResponse() Determine whether the response is expected to be compressed.
boolean	isIdempotent() Determine whether the method is marked idempotent, meaning that the method may be invoked more than one time with no additional effect.
boolean	isSynchronous() Determine whether the method is definitely synchronous, that is, it is not marked client-async, and the return value of the method is not void or Future<?>.
<T> T	removeProxyAttachment(AttachmentKey<T> key) Remove a value attached to the proxy.
void	sendRequest() Proceed with sending the request normally.
void	setBlockingCaller(boolean blockingCaller) Establish whether this invocation is currently blocking the calling thread.
<T> void	setLocator(EJBLocator<T> locator) Set the locator for the invocation target.
void	setReceiver(EJBReceiver receiver) Set the EJB receiver associated with this invocation.
void	setTransaction(Transaction transaction) Set the transaction associated with the invocation.
void	setWeakAffinity(Affinity weakAffinity) Set the invocation weak affinity.

Methods inherited from class org.jboss.ejb.client.Attachable

getAttachment, getAttachments, putAttachment, putAttachmentIfAbsent, removeAttachment, removeAttachment, replaceAttachment, replaceAttachment

Methods inherited from class java.lang.Object

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

Field Detail

PRIVATE_ATTACHMENTS_KEY

public static final String PRIVATE_ATTACHMENTS_KEY

See Also:

Constant Field Values

Method Detail

getProxyAttachment

public <T> T getProxyAttachment(AttachmentKey<T> key)

Get a value attached to the proxy.

Type Parameters:

T - the value type

Parameters:

key - the attachment key

Returns:

the value, or null if there is none

removeProxyAttachment

public <T> T removeProxyAttachment(AttachmentKey<T> key)

Remove a value attached to the proxy.

Type Parameters:

T - the value type

Parameters:

key - the attachment key

Returns:

the value, or null if there is none

getClientContext

public EJBClientContext getClientContext()

Get the EJB client context associated with this invocation.

Returns:

the EJB client context

isClientAsync

public boolean isClientAsync()

Determine whether the method is marked client-asynchronous, meaning that invocation should be asynchronous regardless of whether the server-side method is asynchronous.

Returns:

true if the method is marked client-asynchronous, false otherwise

isSynchronous

public boolean isSynchronous()

Determine whether the method is definitely synchronous, that is, it is not marked client-async, and the return value of the method is not void or Future<?>.

Returns:

true if the method is definitely synchronous, false if the method may be asynchronous

isIdempotent

public boolean isIdempotent()

Determine whether the method is marked idempotent, meaning that the method may be invoked more than one time with no additional effect.

Returns:

true if the method is marked idempotent, false otherwise

getTransactionPolicy

public ClientTransactionPolicy getTransactionPolicy()

Determine whether the method has an explicit transaction policy set.

Returns:

the transaction policy, if any, or null if none was explicitly set

isCompressRequest

public boolean isCompressRequest()

Determine whether the request is expected to be compressed.

Returns:

true if the request is expected to be compressed, false otherwise

isCompressResponse

public boolean isCompressResponse()

Determine whether the response is expected to be compressed.

Returns:

true if the response is expected to be compressed, false otherwise

getCompressionLevel

public int getCompressionLevel()

Get the compression hint level. If no compression hint is given, -1 is returned.

Returns:

the compression hint level, or -1 for no compression

getMethodSignatureString

public String getMethodSignatureString()

Get the method type signature string, used to identify the method.

Returns:

the method signature string

getMethodLocator

public EJBMethodLocator getMethodLocator()

Get the EJB method locator.

Returns:

the EJB method locator

getContextData

public Map<String,Object> getContextData()

Get the context data. This same data will be made available verbatim to server-side interceptors via the InvocationContext.getContextData() method, and thus can be used to pass data from the client to the server (as long as all map values are Serializable).

Returns:

the context data

getLocator

public EJBLocator<?> getLocator()

Get the locator for the invocation target.

Returns:

the locator

setLocator

public <T> void setLocator(EJBLocator<T> locator)

Set the locator for the invocation target.

Parameters:

locator - the locator for the invocation target

isBlockingCaller

public boolean isBlockingCaller()

Determine whether this invocation is currently blocking the calling thread.

Returns:

true if the calling thread is being blocked; false otherwise

setBlockingCaller

public void setBlockingCaller(boolean blockingCaller)

Establish whether this invocation is currently blocking the calling thread.

Parameters:

blockingCaller - true if the calling thread is being blocked; false otherwise

sendRequest

public void sendRequest()
                 throws Exception

Proceed with sending the request normally.

Throws:

Exception - if the request was not successfully sent

getResult

public Object getResult()
                 throws Exception

Get the invocation result from this request. The result is not actually acquired unless all interceptors call this method. Should only be called from EJBClientInterceptor.handleInvocationResult(EJBClientInvocationContext).

Returns:

the invocation result

Throws:

Exception - if the invocation did not succeed

discardResult

public void discardResult()
                   throws IllegalStateException

Discard the result from this request. Should only be called from EJBClientInterceptor.handleInvocationResult(EJBClientInvocationContext).

Throws:

IllegalStateException - if there is no result to discard

getReceiver

protected EJBReceiver getReceiver()

Get the EJB receiver associated with this invocation.

Returns:

the EJB receiver

setReceiver

public void setReceiver(EJBReceiver receiver)

Set the EJB receiver associated with this invocation.

Parameters:

receiver - the EJB receiver associated with this invocation

getInvokedProxy

public Object getInvokedProxy()

Get the invoked proxy object.

Returns:

the invoked proxy

getInvokedMethod

public Method getInvokedMethod()

Get the invoked proxy method.

Returns:

the invoked method

getParameters

public Object[] getParameters()

Get the invocation method parameters.

Returns:

the invocation method parameters

getViewClass

public Class<?> getViewClass()

Get the invoked view class.

Returns:

the invoked view class

getTransaction

public Transaction getTransaction()

Get the transaction associated with the invocation. If there is no transaction (i.e. transactions should not be propagated), null is returned.

Returns:

the transaction associated with the invocation, or null if no transaction should be propagated

setTransaction

public void setTransaction(Transaction transaction)

Set the transaction associated with the invocation. If there is no transaction (i.e. transactions should not be propagated), null should be set.

Parameters:

transaction - the transaction associated with the invocation, or null if no transaction should be propagated

getWeakAffinity

public Affinity getWeakAffinity()

Get the invocation weak affinity.

Returns:

the invocation weak affinity, or Affinity.NONE if none (not null)

setWeakAffinity

public void setWeakAffinity(Affinity weakAffinity)

Set the invocation weak affinity.

Parameters:

weakAffinity - the invocation weak affinity (must not be null)

awaitCancellationResult

public boolean awaitCancellationResult()

Wait to determine whether this invocation was cancelled.

Returns:

true if the invocation was cancelled; false if it completed or failed or the thread was interrupted