org.jboss.ejb.client

Class EJBReceiver

java.lang.Object

org.jboss.ejb.client.Attachable

org.jboss.ejb.client.EJBReceiver

public abstract class EJBReceiver
extends Attachable

A receiver for EJB invocations. Receivers can be associated with one or more client contexts. This interface is implemented by providers for EJB invocation services.

Author:

David M. Lloyd

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EJBReceiver() Construct a new instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	cancelInvocation(EJBReceiverInvocationContext receiverContext, boolean cancelIfRunning) Attempt to cancel an invocation.
protected abstract StatefulEJBLocator<?>	createSession(EJBReceiverSessionCreationContext receiverContext) Creates a session for a stateful session bean represented by the passed app name, module name, distinct name and bean name combination.
protected InetSocketAddress	getSourceAddress(InetSocketAddress destination) Query the expected or actual source IP address configured for the given target URI.
protected boolean	isConnected(URI uri) Determine if the given target URI is "connected".
protected abstract void	processInvocation(EJBReceiverInvocationContext receiverContext) Process the invocation.

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

Constructor Detail

EJBReceiver

protected EJBReceiver()

Construct a new instance.

Method Detail

processInvocation

protected abstract void processInvocation(EJBReceiverInvocationContext receiverContext)
                                   throws Exception

Process the invocation. Implementations of this method should always execute the operation asynchronously. The operation result should be passed in to the receiver invocation context. To ensure ideal GC behavior, the receiver should discard any reference to the invocation context(s) once the result producer has been set.

Parameters:

receiverContext - The EJB receiver invocation context

Throws:

Exception - if the operation throws an exception

cancelInvocation

protected boolean cancelInvocation(EJBReceiverInvocationContext receiverContext,
                                   boolean cancelIfRunning)

Attempt to cancel an invocation. Implementations should make a reasonable effort to determine whether the operation was actually cancelled; however it is permissible to fall back to returning false if it cannot be discovered.

Parameters:

receiverContext - the EJB receiver invocation context

cancelIfRunning - true to request that the cancellation proceed even if the method is running

Returns:

true if the operation was definitely cancelled immediately, false otherwise

createSession

protected abstract StatefulEJBLocator<?> createSession(EJBReceiverSessionCreationContext receiverContext)
                                                throws Exception

Creates a session for a stateful session bean represented by the passed app name, module name, distinct name and bean name combination. Returns a StatefulEJBLocator representing the newly created session. The returned locator should have the same view type as the requested locator.

Parameters:

receiverContext - the EJB receiver session creation context

Returns:

the EJB locator for the newly opened session

Throws:

IllegalArgumentException - if the session creation request is made for a bean which is not a stateful session bean

Exception

getSourceAddress

protected InetSocketAddress getSourceAddress(InetSocketAddress destination)

Query the expected or actual source IP address configured for the given target URI.

Parameters:

destination - the supported URI of the peer (not null)

Returns:

the socket address, or null if none is known

isConnected

protected boolean isConnected(URI uri)

Determine if the given target URI is "connected". Connectionless or connect-per-request protocols can inherit the default, which always returns true.

Parameters:

uri - the supported URI of the peer (not null)

Returns:

true if the peer is readily available, false otherwise