org.jboss.ejb.server

Interface InvocationRequest<T>

Type Parameters:

T - the target EJB type

All Superinterfaces:

Request

public interface InvocationRequest<T>
extends Request

An EJB method invocation request.

Author:

David M. Lloyd

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getAttachments() Get the invocation attachment map.
default EJBIdentifier	getEJBIdentifier() Get the identifier of the target EJB.
EJBLocator<T>	getEJBLocator() Get the EJB locator of the request.
EJBMethodLocator	getMethodLocator() Get the EJB method locator.
Object[]	getParameters() Get the method invocation parameters.
default <S> InvocationRequest<S>	narrowTo(Class<S> clazz) Safely narrow the invocation's generic type to the given type.
void	writeInvocationResult(Object result) Write the invocation result message.
void	writeNoSuchMethod() Write a message indicating that the method is not found on the EJB.
void	writeSessionNotActive() Write a message indicating that the session is inactive.

Methods inherited from interface org.jboss.ejb.server.Request

convertToStateful, getLocalAddress, getPeerAddress, getProtocol, getRequestExecutor, getTransaction, getWeakAffinity, hasTransaction, isBlockingCaller, writeCancelResponse, writeException, writeNoSuchEJB, writeNotStateful

Method Detail

getAttachments

@NotNull
Map<String,Object> getAttachments()

Get the invocation attachment map.

Returns:

the invocation attachment map (must not be null)

getMethodLocator

@NotNull
EJBMethodLocator getMethodLocator()

Get the EJB method locator.

Returns:

the EJB method locator (must not be null)

getParameters

@NotNull
Object[] getParameters()

Get the method invocation parameters.

Returns:

the method invocation parameters (must not be null)

getEJBIdentifier

@NotNull
default EJBIdentifier getEJBIdentifier()

Get the identifier of the target EJB. The default implementation delegates to getEJBLocator() and returns the identifier portion.

Specified by:

getEJBIdentifier in interface Request

Returns:

the identifier of the target EJB (must not be null)

getEJBLocator

@NotNull
EJBLocator<T> getEJBLocator()

Get the EJB locator of the request. This contains the same identifier as is returned with getEJBIdentifier(), but of a type corresponding to the EJB type, and with a resolved EJB class and affinity.

Returns:

the EJB locator (must not be null)

writeNoSuchMethod

void writeNoSuchMethod()

Write a message indicating that the method is not found on the EJB. The request should be abandoned after invoking this method.

writeSessionNotActive

void writeSessionNotActive()

Write a message indicating that the session is inactive. The request should be abandoned after invoking this method.

writeInvocationResult

void writeInvocationResult(Object result)

Write the invocation result message.

Parameters:

result - the invocation result

narrowTo

@NotNull
default <S> InvocationRequest<S> narrowTo(@NotNull
                                                   Class<S> clazz)
                                            throws ClassCastException

Safely narrow the invocation's generic type to the given type. This is a convenience method and does not create any new objects; it simply tests the argument and re-casts this instance as the narrowed type.

Type Parameters:

S - the type to narrow to

Parameters:

clazz - the type class instance (must not be null)

Returns:

this instance, narrowed to the given type (must not be null)

Throws:

ClassCastException - if the narrow operation did not succeed