InterceptorContext (Invocation API 1.5.0.Final API)

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

All Implemented Interfaces:

Cloneable, PrivilegedExceptionAction<Object>
```
public final class InterceptorContext
extends Object
implements Cloneable, PrivilegedExceptionAction<Object>
```
An interceptor/invocation context object.

Author:

David M. Lloyd

Constructor Summary

Constructors
Constructor and Description

InterceptorContext()

Constructors
Constructor and Description
`InterceptorContext()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InterceptorContext`	`clone()` Clone this interceptor context instance.
`Constructor<?>`	`getConstructor()` Get the intercepted constructor.
`Map<String,Object>`	`getContextData()` Get the context data which is reported to the interceptor invocation context.
`Interceptor[]`	`getInterceptors()` Get the current interceptors.
`List<Interceptor>`	`getInterceptors$$bridge()` Binary compatibility bridge for interceptors list.
`javax.interceptor.InvocationContext`	`getInvocationContext()` Get the invocation context.
`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.
`Transaction`	`getTransaction()` Get the transaction for this invocation, if any.
`boolean`	`hasTransaction()` Determine if a transaction supplier was established for this invocation.
`boolean`	`isBlockingCaller()` Determine whether this invocation is currently directly blocking the calling thread.
`Object`	`proceed()` Pass the invocation on to the next step in the chain.
`<T> T`	`putPrivateData(Class<T> type, T value)` Insert a private data item.
`Object`	`putPrivateData(Object key, Object value)` Insert a private data item.
`Object`	`run()` Synonymous with `proceed()`; exists to implement `PrivilegedExceptionAction`.
`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(Interceptor[] interceptors)` Set the interceptor iterator.
`void`	`setInterceptors(Interceptor[] interceptors, int nextIndex)` Set the interceptors, with a starting index to proceed from.
`void`	`setInterceptors(List<Interceptor> interceptorList)` Set the interceptor array from a list.
`void`	`setInterceptors(List<Interceptor> 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.
`void`	`setTransaction(Transaction transaction)` Set the transaction for the invocation.
`void`	`setTransactionSupplier(org.wildfly.common.function.ExceptionSupplier<Transaction,SystemException> transactionSupplier)` Set the transaction supplier for the invocation.

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

- Constructor Detail
  - InterceptorContext
```
public InterceptorContext()
```
- 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
  - getInvocationContext
```
public javax.interceptor.InvocationContext getInvocationContext()
```
    Get the invocation context.
    
    Returns:
    
    the invocation context
  - hasTransaction
```
public boolean hasTransaction()
```
    Determine if a transaction supplier was established for this invocation.
    
    Returns:
    
    true if there is an enclosing transaction, false otherwise
  - getTransaction
```
public Transaction getTransaction()
                           throws SystemException
```
    Get the transaction for this invocation, if any.
    
    Returns:
    
    the transaction for this invocation, or null if there is no transaction
    
    Throws:
    
    SystemException - if the transaction import failed
  - setTransaction
```
public void setTransaction(Transaction transaction)
```
    Set the transaction for the invocation. If null, then there is no enclosing transaction.
    
    Parameters:
    
    transaction - the transaction for the invocation
  - setTransactionSupplier
```
public void setTransactionSupplier(org.wildfly.common.function.ExceptionSupplier<Transaction,SystemException> transactionSupplier)
```
    Set the transaction supplier for the invocation. If null, then there is no enclosing transaction. The supplier must not return null.
    
    Parameters:
    
    transactionSupplier - the transaction supplier, or null to clear the present transaction
  - 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
  - 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
  - getInterceptors
```
public Interceptor[] getInterceptors()
```
    Get the current interceptors. The returned array should not be modified.
    
    Returns:
    
    the interceptors
  - getInterceptors$$bridge
```
public List<Interceptor> getInterceptors$$bridge()
```
    Binary compatibility bridge for interceptors list.
    
    Returns:
    
    the interceptors array as a list
  - getNextInterceptorIndex
```
public int getNextInterceptorIndex()
```
    Returns the next interceptor index.
    
    Returns:
    
    the next interceptor index
  - setInterceptors
```
public void setInterceptors(Interceptor[] interceptors)
```
    Set the interceptor iterator.
    
    Parameters:
    
    interceptors - the interceptor list
  - setInterceptors
```
public void setInterceptors(List<Interceptor> interceptorList)
```
    Set the interceptor array from a list.
    
    Parameters:
    
    interceptorList - the interceptor list
  - setInterceptors
```
public void setInterceptors(Interceptor[] 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<Interceptor> interceptorList,
                            int nextIndex)
```
    Set the interceptors, with a starting index to proceed from.
    
    Parameters:
    
    interceptorList - the interceptor list
    
    nextIndex - the next index to proceed
  - proceed
```
public Object proceed()
               throws Exception
```
    Pass the invocation on to the next step in the chain.
    
    Returns:
    
    the result
    
    Throws:
    
    Exception - if an invocation throws an exception
  - run
```
public Object run()
           throws Exception
```
    Synonymous with proceed(); exists to implement PrivilegedExceptionAction.
    
    Specified by:
    
    run in interface PrivilegedExceptionAction<Object>
    
    Returns:
    
    the result of proceed()
    
    Throws:
    
    Exception - if proceed() threw an exception
  - clone
```
public InterceptorContext clone()
```
    Clone this interceptor context instance. The cloned context will resume execution at the same point that this context would have at the moment it was cloned.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    the copied context

Class InterceptorContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InterceptorContext

Method Detail

getTarget

setTarget

getMethod

setMethod

getConstructor

setConstructor

getParameters

setParameters

getContextData

setContextData

getTimer

setTimer

getInvocationContext

hasTransaction

getTransaction

setTransaction

setTransactionSupplier

getPrivateData

getPrivateData

putPrivateData

putPrivateData

isBlockingCaller

setBlockingCaller

getInterceptors

getInterceptors$$bridge

getNextInterceptorIndex

setInterceptors

setInterceptors

setInterceptors

setInterceptors

proceed

run

clone