SIS 3.1.0 :: SIS Overview and Concepts :: Invoking an Interceptor

You invoke SIS interceptors using one of the Interceptor Extension Resource Adaptor Types.

There are two Interceptor Extension Resource Adaptor Types, the:

The Interceptor Extensions Provider interface defined by this resource adaptor type provides various methods for invoking interceptors. Invoking an interceptor requires the following parameters:

Parameter Type Description Optional?

Interceptor Reference

 String

The interceptor component to be invoked.

Interceptor Input

 Object

The object that will be provided as input to the interceptor. The interceptor may inspect or modify this object, or may pass it to extension components.

When invoking an IN interceptor, this object typically would be of a subclass of OperationInvokeEvent or OperationResultEvent, or be an array containing objects of these types.
When invoking a SIP interceptor, this object typically would be of type Request or Response.

It is not required that an input object be passed to the interceptor; however the interceptor will be very limited in what it can do if it has no input object to operate on.

YES

Activity

 axref:sis-in-interceptors-ratype/com.opencloud.slee.resources.sis.script.interceptors.InterceptorInvocationActivity[InterceptorInvocationActivity]

The interceptor invocation activity on which the interceptor completion callback event will be fired if the interceptor completes asynchronously. If an activity is not provided and the interceptor will complete asynchronously, the SIS will automatically create a new activity for the callback event.

Interceptors that complete synchronously do not require or use an InterceptorInvocationActivity as the interceptor result is passed back to the invoking service in the calling thread.

YES

User Variables

 axref:sis-in-interceptors-ratype/com.opencloud.slee.resources.sis.script.interceptors.UserVariables[UserVariables]

A map containing the names (as map keys) and values (as key values) of any SIS user variables that should be populated in the context the interceptor runs in before the interceptor is evaluated. This parameter can be used, for example, to pass additional information to the interceptor through user variables with predetermined names.

YES

Previous page Next page