public interface InterceptorExtensionsProvider
An instance of this interface may be bound into an SBB's JNDI environment using a resource adaptor entity binding.
Modifier and Type | Interface and Description |
---|---|
static class |
InterceptorExtensionsProvider.Metadata |
Modifier and Type | Method and Description |
---|---|
InterceptorInvocationActivity |
createInterceptorInvocationActivity()
Create a new Interceptor Invocation Activity.
|
InterceptorInvocationResult |
invokeInterceptor(String interceptorRef,
Object input)
Invoke a SIS interceptor.
|
InterceptorInvocationResult |
invokeInterceptor(String interceptorRef,
Object input,
InterceptorInvocationActivity activity)
Invoke a SIS interceptor.
|
InterceptorInvocationResult |
invokeInterceptor(String interceptorRef,
Object input,
InterceptorInvocationActivity activity,
UserVariables userVariables)
Invoke a SIS interceptor.
|
InterceptorInvocationResult |
invokeInterceptor(String interceptorRef,
Object input,
UserVariables userVariables)
Invoke a SIS interceptor.
|
InterceptorInvocationActivity createInterceptorInvocationActivity()
InterceptorInvocationResult invokeInterceptor(String interceptorRef, Object input) throws NullPointerException
This method is equivalent to invokeInterceptor(interceptorRef, input, null, null)
interceptorRef
- the name of an interceptor reference indicating the interceptor to invoke.input
- the input object that the interceptor can operate on. May be null
.NullPointerException
- if interceptorRef
is null
.InterceptorInvocationResult invokeInterceptor(String interceptorRef, Object input, UserVariables userVariables) throws NullPointerException
This method is equivalent to invokeInterceptor(interceptorRef, input, null, userVariable)
interceptorRef
- the name of an interceptor reference indicating the interceptor to invoke.input
- the input object that the interceptor can operate on. May be null
.userVariables
- a collection of user variables that will be populated into the context of the interceptor invocation.
May be null
.NullPointerException
- if interceptorRef
is null
.InterceptorInvocationResult invokeInterceptor(String interceptorRef, Object input, InterceptorInvocationActivity activity) throws NullPointerException, UnrecognizedActivityException
This method is equivalent to invokeInterceptor(interceptorRef, input, activity, null)
interceptorRef
- the name of an interceptor reference indicating the interceptor to invoke.input
- the input object that the interceptor can operate on. May be null
.activity
- the interceptor invocation activity on which the callback event will be fired if
the interceptor completes asynchronously. May be null
, in which case the SIS will
automatically create a new activity if an invoked interceptor is going to complete asynchronously.
A reference to the newly created activity will be returned in the result.NullPointerException
- if interceptorRef
is null
.UnrecognizedActivityException
- if the interceptor invocation activity is unknown to the SIS.InterceptorInvocationResult invokeInterceptor(String interceptorRef, Object input, InterceptorInvocationActivity activity, UserVariables userVariables) throws NullPointerException, UnrecognizedActivityException
An interceptor may complete synchronously or asynchronously. An interceptor that only performs
simple operations such as conditional evaluation and variable assignments will typically complete
synchronously and return the result immediately to the calling thread. An interceptor that invokes
an extension component will always complete asynchronously, and the result when the interceptor has
completed will be fired as an InterceptorInvocationCompletedEvent
on the specified
InterceptorInvocationActivity
.
interceptorRef
- the name of an interceptor reference indicating the interceptor to invoke.input
- the input object that the interceptor can operate on. May be null
.activity
- the interceptor invocation activity on which the callback event will be fired if
the interceptor completes asynchronously. May be null
, in which case the SIS will
automatically create a new activity if an invoked interceptor is going to complete asynchronously.
A reference to the newly created activity will be returned in the result.userVariables
- a collection of user variables that will be populated into the context of the interceptor invocation.
May be null
. Note that any user variables contained in this collection will replace any existing user
variables with the same name if they already exist in the context of the specified activity.NullPointerException
- if interceptorRef
is null
.UnrecognizedActivityException
- if the interceptor invocation activity is unknown to the SIS.