org.jboss.invocation

Class SimpleInvocationContext

java.lang.Object

org.jboss.invocation.SimpleInvocationContext

All Implemented Interfaces:

InvocationContext

public class SimpleInvocationContext
extends Object
implements InvocationContext

A base class for invocation contexts. Also can act as the last interceptor in a chain which does not proceed.

Author:

David M. Lloyd

Constructor Summary

Constructors

Constructor and Description
SimpleInvocationContext(Object target, Method method, Object[] parameters) Construct a new instance.
SimpleInvocationContext(Object target, Method method, Object[] parameters, Map<String,Object> contextData, Object timer) Construct a new instance.
SimpleInvocationContext(Object target, Method method, Object[] parameters, Object timer) Construct a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Object>	getContextData() Returns the context data associated with this invocation or lifecycle callback.
Method	getMethod() Get the invoked method for this invocation.
Object[]	getParameters() Get the parameters of the method invocation (for method interceptors).
Object	getTarget() Get the target instance for this invocation.
Object	getTimer() Get the timer associated with an @AroundTimeout interceptor method.
Object	proceed() Throw an exception indicating that the end of the interceptor chain was reached without an invocation being performed.
void	setParameters(Object[] parameters) Replace the parameters of the method invocation.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleInvocationContext

public SimpleInvocationContext(Object target,
                       Method method,
                       Object[] parameters,
                       Map<String,Object> contextData,
                       Object timer)

Construct a new instance.

Parameters:

target - the target object instance

method - the invocation method (may be null)

parameters - the invocation parameters (may be null)

contextData - the context data map to use

timer - the associated timer (may be null)

SimpleInvocationContext

public SimpleInvocationContext(Object target,
                       Method method,
                       Object[] parameters,
                       Object timer)

Construct a new instance.

Parameters:

target - the target object instance

method - the invocation method (may be null)

parameters - the invocation parameters (may be null)

timer - the associated timer (may be null)

SimpleInvocationContext

public SimpleInvocationContext(Object target,
                       Method method,
                       Object[] parameters)

Construct a new instance.

Parameters:

target - the target object instance

method - the invocation method (may be null)

parameters - the invocation parameters (may be null)

Method Detail

getTarget

public Object getTarget()

Get the target instance for this invocation.

Specified by:

getTarget in interface InvocationContext

Returns:

the target instance

getMethod

public Method getMethod()

Get the invoked method for this invocation. If the invoked method is an @AroundInvoke or @AroundTimeout interceptor method, the method of the target class is returned. For lifecycle callback interceptors (such as @PostConstruct or @PreDestroy), null is returned.

Specified by:

getMethod in interface InvocationContext

Returns:

the invoked method, or null if none applies to the current invocation context

getParameters

public Object[] getParameters()

Get the parameters of the method invocation (for method interceptors).

Specified by:

getParameters in interface InvocationContext

Returns:

the invoked method parameters

setParameters

public void setParameters(Object[] parameters)

Replace the parameters of the method invocation.

Specified by:

setParameters in interface InvocationContext

Parameters:

parameters - the new parameter values to use for the current invocation

getContextData

public Map<String,Object> getContextData()

Returns the context data associated with this invocation or lifecycle callback.

If the current context is an invocation on a web service endpoint, the map returned will be the JAX-WS MessageContext. If there is no context data, an empty Map object will be returned. Normally, information stored in this map is available to subsequent interceptors in an interceptor chain, so this mechanism may be used to pass information from one interceptor to the next.

Specified by:

getContextData in interface InvocationContext

Returns:

the context map

getTimer

public Object getTimer()

Get the timer associated with an @AroundTimeout interceptor method. When intercepting an EJB component timeout, the returned type is Timer.

Specified by:

getTimer in interface InvocationContext

Returns:

the timer object, or null if the invocation did not apply to a timeout method.

proceed

public Object proceed()
               throws Exception

Throw an exception indicating that the end of the interceptor chain was reached without an invocation being performed. This method should be overridden to provide a specific implementation. Though this method always throws CannotProceedException, it is declared to throw Exception so that subclasses can override this method in a spec-compliant way.

Specified by:

proceed in interface InvocationContext

Returns:

nothing

Throws:

Exception - always (in particular, CannotProceedException)