org.jboss.ejb.server

Interface Association

public interface Association

A server association. Since server associations yield ClassLoader instances, it is important that classes implementing this interface are not accessible without a permission check when a security manager is present. This class is implemented by EJB server environments and consumed by protocol implementations.

Author:

David M. Lloyd

Method Summary

Modifier and Type	Method and Description
ClassLoader	mapClassLoader(String appName, String moduleName) Map the class loader for the given EJB application and module.
<T> CancelHandle	receiveInvocationRequest(InvocationRequest<T> invocationRequest) Receive and execute an invocation request.
CancelHandle	receiveSessionOpenRequest(SessionOpenRequest sessionOpenRequest) Receive and execute a session open request.
ListenerHandle	registerClusterTopologyListener(ClusterTopologyListener clusterTopologyListener) Register a cluster topology listener.
ListenerHandle	registerModuleAvailabilityListener(ModuleAvailabilityListener moduleAvailabilityListener) Register a module availability listener.

Method Detail

mapClassLoader

ClassLoader mapClassLoader(String appName,
                           String moduleName)

Map the class loader for the given EJB application and module.

Parameters:

appName - the application name (not null)

moduleName - the module name (not null)

Returns:

the class loader containing the EJB application

receiveInvocationRequest

@NotNull
<T> CancelHandle receiveInvocationRequest(@NotNull
                                                   InvocationRequest<T> invocationRequest)

Receive and execute an invocation request. An invocation may be cancelled; the returned handle may be used by the protocol implementation when a cancellation request is received by the server.

Type Parameters:

T - the type of the target EJB

Parameters:

invocationRequest - the invocation request (not null)

Returns:

a handle which may be used to request cancellation of the invocation (must not be null)

receiveSessionOpenRequest

@NotNull
CancelHandle receiveSessionOpenRequest(@NotNull
                                                SessionOpenRequest sessionOpenRequest)

Receive and execute a session open request. An invocation may be cancelled; the returned handle may be used by the protocol implementation when a cancellation request is received by the server.

Parameters:

sessionOpenRequest - the session open request (not null)

Returns:

a handle which may be used to request cancellation of the invocation (must not be null)

registerClusterTopologyListener

@NotNull
ListenerHandle registerClusterTopologyListener(@NotNull
                                                        ClusterTopologyListener clusterTopologyListener)

Register a cluster topology listener. This is used by legacy protocols to transmit cluster updates to old clients.

Parameters:

clusterTopologyListener - the cluster topology listener (not null)

Returns:

a handle which may be used to cancel the topology listener registration (must not be null)

registerModuleAvailabilityListener

@NotNull
ListenerHandle registerModuleAvailabilityListener(@NotNull
                                                           ModuleAvailabilityListener moduleAvailabilityListener)

Register a module availability listener. This is used by legacy clients which use no-affinity EJB locators.

Parameters:

moduleAvailabilityListener - the module availability listener (not null)

Returns:

a handle which may be used to cancel the availability listener registration (must not be null)