AsynchronousInterceptorContext (Invocation API 1.5.0.Beta3 API)

java.lang.Object
- org.jboss.invocation.AsynchronousInterceptorContext

All Implemented Interfaces:

Cloneable
```
public final class AsynchronousInterceptorContext
extends Object
implements Cloneable
```
An asynchronous interceptor/invocation context object.

Author:

David M. Lloyd

Constructor Summary

Constructors
Constructor and Description

AsynchronousInterceptorContext()
Construct a new instance.

Constructors
Constructor and Description
`AsynchronousInterceptorContext()` Construct a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Constructor<?>`	`getConstructor()` Get the intercepted constructor.
`Map<String,Object>`	`getContextData()` Get the context data which is reported to the interceptor invocation context.
`AsynchronousInterceptor[]`	`getInterceptors()` Get the current interceptors.
`Method`	`getMethod()` Get the invoked method which is reported to the interceptor invocation context.
`int`	`getNextInterceptorIndex()` Returns the next interceptor index.
`Object[]`	`getParameters()` Get the method parameters which are reported to the interceptor invocation context.
`<T> T`	`getPrivateData(Class<T> type)` Get a private data item.
`Object`	`getPrivateData(Object key)` Get a private data item.
`Object`	`getTarget()` Get the invocation target which is reported to the interceptor invocation context.
`Object`	`getTimer()` Get the timer object which is reported to the interceptor invocation context.
`boolean`	`isBlockingCaller()` Determine whether this invocation is currently directly blocking the calling thread.
`AsynchronousInterceptor.CancellationHandle`	`proceed(AsynchronousInterceptor.ResultHandler resultHandler)` Pass the invocation on to the next or previous step in the chain (depending on whether a result has been set).
`<T> T`	`putPrivateData(Class<T> type, T value)` Insert a private data item.
`Object`	`putPrivateData(Object key, Object value)` Insert a private data item.
`void`	`setBlockingCaller(boolean blockingCaller)` Establish whether this invocation is currently directly blocking the calling thread.
`void`	`setConstructor(Constructor<?> constructor)` Set the intercepted constructor.
`void`	`setContextData(Map<String,Object> contextData)` Set the context data which is reported to the interceptor invocation context.
`void`	`setInterceptors(AsynchronousInterceptor[] interceptors)` Set the interceptor iterator.
`void`	`setInterceptors(AsynchronousInterceptor[] interceptors, int nextIndex)` Set the interceptors, with a starting index to proceed from.
`void`	`setInterceptors(List<AsynchronousInterceptor> interceptorList)` Set the interceptor array from a list.
`void`	`setInterceptors(List<AsynchronousInterceptor> interceptorList, int nextIndex)` Set the interceptors, with a starting index to proceed from.
`void`	`setMethod(Method method)` Set the invoked method which is reported to the interceptor invocation context.
`void`	`setParameters(Object[] parameters)` Set the method parameters which are reported to the interceptor invocation context.
`void`	`setTarget(Object target)` Set the invocation target which is reported to the interceptor invocation context.
`void`	`setTimer(Object timer)` Set the timer object which is reported to the interceptor invocation context.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AsynchronousInterceptorContext
```
public AsynchronousInterceptorContext()
```
    Construct a new instance.
- Method Detail
  - getTarget
```
public Object getTarget()
```
    Get the invocation target which is reported to the interceptor invocation context.
    
    Returns:
    
    the invocation target
  - setTarget
```
public void setTarget(Object target)
```
    Set the invocation target which is reported to the interceptor invocation context.
    
    Parameters:
    
    target - the invocation target
  - getMethod
```
public Method getMethod()
```
    Get the invoked method which is reported to the interceptor invocation context.
    
    Returns:
    
    the method
  - setMethod
```
public void setMethod(Method method)
```
    Set the invoked method which is reported to the interceptor invocation context.
    
    Parameters:
    
    method - the method
  - getConstructor
```
public Constructor<?> getConstructor()
```
    Get the intercepted constructor.
    
    Returns:
    
    the constructor
  - setConstructor
```
public void setConstructor(Constructor<?> constructor)
```
    Set the intercepted constructor.
    
    Parameters:
    
    constructor - the constructor
  - getParameters
```
public Object[] getParameters()
```
    Get the method parameters which are reported to the interceptor invocation context.
    
    Returns:
    
    the method parameters
  - setParameters
```
public void setParameters(Object[] parameters)
```
    Set the method parameters which are reported to the interceptor invocation context.
    
    Parameters:
    
    parameters - the method parameters
  - getContextData
```
public Map<String,Object> getContextData()
                                  throws IllegalStateException
```
    Get the context data which is reported to the interceptor invocation context.
    
    Returns:
    
    the context data
    
    Throws:
    
    IllegalStateException - if the context data was never initialized
  - setContextData
```
public void setContextData(Map<String,Object> contextData)
```
    Set the context data which is reported to the interceptor invocation context.
    
    Parameters:
    
    contextData - the context data
  - getTimer
```
public Object getTimer()
```
    Get the timer object which is reported to the interceptor invocation context.
    
    Returns:
    
    the timer object
  - setTimer
```
public void setTimer(Object timer)
```
    Set the timer object which is reported to the interceptor invocation context.
    
    Parameters:
    
    timer - the timer object
  - getPrivateData
```
public <T> T getPrivateData(Class<T> type)
```
    Get a private data item.
    
    Type Parameters:
    
    T - the data type
    
    Parameters:
    
    type - the data type class object
    
    Returns:
    
    the data item or null if no such item exists
  - getPrivateData
```
public Object getPrivateData(Object key)
```
    Get a private data item. The key will be looked up by object identity, not by value.
    
    Parameters:
    
    key - the object key
    
    Returns:
    
    the private data object
  - putPrivateData
```
public <T> T putPrivateData(Class<T> type,
                            T value)
```
    Insert a private data item.
    
    Type Parameters:
    
    T - the data type
    
    Parameters:
    
    type - the data type class object
    
    value - the data item value, or null to remove the mapping
    
    Returns:
    
    the data item which was previously mapped to this position, or null if no such item exists
  - putPrivateData
```
public Object putPrivateData(Object key,
                             Object value)
```
    Insert a private data item. The key is used by object identity, not by value; in addition, if the key is a Class then the value given must be assignable to that class.
    
    Parameters:
    
    key - the data key
    
    value - the data item value, or null to remove the mapping
    
    Returns:
    
    the data item which was previously mapped to this position, or null if no such item exists
  - getInterceptors
```
public AsynchronousInterceptor[] getInterceptors()
```
    Get the current interceptors. The returned array should not be modified.
    
    Returns:
    
    the interceptors
  - getNextInterceptorIndex
```
public int getNextInterceptorIndex()
```
    Returns the next interceptor index.
    
    Returns:
    
    the next interceptor index
  - setInterceptors
```
public void setInterceptors(AsynchronousInterceptor[] interceptors)
```
    Set the interceptor iterator.
    
    Parameters:
    
    interceptors - the interceptor list
  - setInterceptors
```
public void setInterceptors(List<AsynchronousInterceptor> interceptorList)
```
    Set the interceptor array from a list.
    
    Parameters:
    
    interceptorList - the interceptor list
  - setInterceptors
```
public void setInterceptors(AsynchronousInterceptor[] interceptors,
                            int nextIndex)
```
    Set the interceptors, with a starting index to proceed from.
    
    Parameters:
    
    interceptors - the interceptor array
    
    nextIndex - the next index to proceed
  - setInterceptors
```
public void setInterceptors(List<AsynchronousInterceptor> interceptorList,
                            int nextIndex)
```
    Set the interceptors, with a starting index to proceed from.
    
    Parameters:
    
    interceptorList - the interceptor list
    
    nextIndex - the next index to proceed
  - isBlockingCaller
```
public boolean isBlockingCaller()
```
    Determine whether this invocation is currently directly blocking the calling thread. This means that the interceptor is running in the same thread as the original caller.
    
    Returns:
    
    true if the calling thread is being blocked; false otherwise
  - setBlockingCaller
```
public void setBlockingCaller(boolean blockingCaller)
```
    Establish whether this invocation is currently directly blocking the calling thread. This means that the interceptor is running in the same thread as the original caller.
    
    Parameters:
    
    blockingCaller - true if the calling thread is being blocked; false otherwise
  - proceed
```
public AsynchronousInterceptor.CancellationHandle proceed(AsynchronousInterceptor.ResultHandler resultHandler)
```
    Pass the invocation on to the next or previous step in the chain (depending on whether a result has been set).
    
    Parameters:
    
    resultHandler - the result handler to pass to the next interceptor (must not be null)
    
    Returns:
    
    the cancellation handle for the invocation (must not be null)

Class AsynchronousInterceptorContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AsynchronousInterceptorContext

Method Detail

getTarget

setTarget

getMethod

setMethod

getConstructor

setConstructor

getParameters

setParameters

getContextData

setContextData

getTimer

setTimer

getPrivateData

getPrivateData

putPrivateData

putPrivateData

getInterceptors

getNextInterceptorIndex

setInterceptors

setInterceptors

setInterceptors

setInterceptors

isBlockingCaller

setBlockingCaller

proceed