org.jboss.ejb.client

Class EJBReceiverInvocationContext

java.lang.Object

org.jboss.ejb.client.AbstractReceiverInvocationContext

org.jboss.ejb.client.EJBReceiverInvocationContext

public final class EJBReceiverInvocationContext
extends AbstractReceiverInvocationContext

The context used for an EJB receiver to return the result of an invocation.

Author:

David M. Lloyd

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EJBReceiverInvocationContext.ResultProducer A result producer for invocation.

Method Summary

Modifier and Type	Method and Description
AuthenticationContext	getAuthenticationContext() Get the authentication context of the request.
EJBClientInvocationContext	getClientInvocationContext() Get the invocation context associated with this receiver invocation context.
void	proceedAsynchronously() Indicate that the invocation should proceed asynchronously, if it isn't already.
void	requestCancelled() Indicate that the request was successfully cancelled and that no result is forthcoming.
void	requestFailed(Exception cause) Indicate that a request failed locally with the given exception cause.
void	requestFailed(Exception cause, Executor retryExecutor) Indicate that a request failed locally with the given exception cause.
void	resultReady(EJBReceiverInvocationContext.ResultProducer resultProducer) Indicate that the invocation result is ready.

Methods inherited from class java.lang.Object

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

Method Detail

proceedAsynchronously

public void proceedAsynchronously()

Indicate that the invocation should proceed asynchronously, if it isn't already.

resultReady

public void resultReady(EJBReceiverInvocationContext.ResultProducer resultProducer)

Indicate that the invocation result is ready. The given producer should either return the final invocation result or throw an appropriate exception. Any unmarshalling is expected to be deferred until the result producer is called, in order to offload the work on the invoking thread even in the presence of asynchronous invocation.

Parameters:

resultProducer - the result producer

requestCancelled

public void requestCancelled()

Indicate that the request was successfully cancelled and that no result is forthcoming.

requestFailed

public void requestFailed(Exception cause)

Indicate that a request failed locally with the given exception cause. Retries are called in the current thread before this method returns.

Parameters:

cause - the failure cause (must not be null)

requestFailed

public void requestFailed(Exception cause,
                          Executor retryExecutor)

Indicate that a request failed locally with the given exception cause.

Parameters:

cause - the failure cause (must not be null)

retryExecutor - the executor to use for retry attempts (must not be null)

getClientInvocationContext

public EJBClientInvocationContext getClientInvocationContext()

Description copied from class: AbstractReceiverInvocationContext

Get the invocation context associated with this receiver invocation context.

Specified by:

getClientInvocationContext in class AbstractReceiverInvocationContext

Returns:

the invocation context

getAuthenticationContext

public AuthenticationContext getAuthenticationContext()

Description copied from class: AbstractReceiverInvocationContext

Get the authentication context of the request. The configuration may be associated with the proxy, or it may have been inherited from the environment.

Specified by:

getAuthenticationContext in class AbstractReceiverInvocationContext

Returns:

the authentication configuration of the request (not null)