Package com.opencloud.slee.resources.sis.script.in.interceptors

Interface INInterceptorActivity

All Superinterfaces:

InterceptorActivity

public interface INInterceptorActivity
extends InterceptorActivity

The IN Interceptor Activity is the activity type on which SIS IN variants fire events to interceptor extension components.

Downcall Event Processing

If an interceptor extension component that receives a Downcall event continues processing using a method other than continueProcessing(Operation[], boolean), then Downcall.getDialogPrimitive() is used to determine whether or not the dialog remains open or is closed.

Method Summary

Modifier and Type	Method	Description
void	continueProcessing(Operation op)	Notify the SIS that evaluation of the current interceptor should be continued.
void	continueProcessing(Operation[] ops)	Notify the SIS that evaluation of the current interceptor should be continued.
void	continueProcessing(Operation[] ops, boolean closeDialog)	Deprecated. use continueProcessing(Operation[], DialogPrimitive) instead for greater flexibility.
void	continueProcessing(Operation[] ops, DialogPrimitive primitive)	Notify the SIS that evaluation of the current output interceptor should be continued.
TcapApplicationContext	getApplicationContext()	Get the application context that the underlying network dialog was created with.
String	getDialogID()	Get the unique dialog identifier for the underlying network dialog.
CGINProvider	getProvider()	Get the provider that created the network dialog.

Methods inherited from interface com.opencloud.slee.resources.sis.script.interceptors.InterceptorActivity

continueProcessing, getEvent, getVariable, halt

Method Detail

continueProcessing

void continueProcessing(Operation op)
                 throws IllegalStateException,
                        IllegalArgumentException

Notify the SIS that evaluation of the current interceptor should be continued. The current composition service input or output messages are replaced with the specified operation message.

Parameters:

op - an optional updated message that the SIS should use to continue service invocation.

• if this argument is null, this method is equivalent to InterceptorActivity.continueProcessing().
• if this argument is not null, this method is equivalent to continueProcessing(new Operation[] { op }).

Throws:

IllegalStateException - if the interceptor extension component has already returned a response to the SIS for the most recent event fired on this activity. This exception may also be thrown if the extension component has taken too long to respond to the request and a timeout has occurred in the SIS.

IllegalArgumentException - if op is not an acceptable operation to continue processing with. For example, if the interceptor extension component was invoked for an InitialDP request then only an InitialDP request can be returned.

continueProcessing

void continueProcessing(Operation[] ops)
                 throws IllegalStateException,
                        IllegalArgumentException

Notify the SIS that evaluation of the current interceptor should be continued. The current composition service input or output messages are replaced with the specified operation messages.

Valid Usages

An interceptor extension component invoked from within an input interceptor handles up-call events, eg. CCInitialDPRequestEvent. In this case ops may be either null or an array of length 1 containing an operation of the same type:

• if null, this method behaves the same as continueProcessing().
• if not null, the operation passed to this method replaces the operation that was provided to the interceptor extension component in the call flow.

An interceptor extension component invoked from within an output interceptor handles down-call messages, eg. CCConnectRequestEvent. In this case ops may have any value:

• if null, the operation(s) that were provided to the interceptor extension component for analysis are removed from the call flow.
• if non null, the operations passed to this method replace those that that were provided to the interceptor extension component in the call flow.
• The invocations continueProcessing(null) and continueProcessing(new Operation[0]) are equivalent.

Parameters:

ops - updated messages that the SIS should use to continue call processing.

Throws:

IllegalStateException - if the interceptor extension component has already returned a response to the SIS for the most recent event fired on this activity. This exception may also be thrown if the extension component has taken too long to respond to the request and a timeout has occurred in the SIS.

IllegalArgumentException - if the interceptor extension component was invoked from within an input interceptor and ops is not an acceptable operation to continue processing with. For example, if the interceptor extension component was invoked for an InitialDP request then only an array containing an InitialDP request can be returned.

continueProcessing

@Deprecated
void continueProcessing(Operation[] ops,
                        boolean closeDialog)
                 throws IllegalStateException

Deprecated.

use continueProcessing(Operation[], DialogPrimitive) instead for greater flexibility.

Notify the SIS that evaluation of the current output interceptor should be continued. The current composition service output messages used by the the composition are replaced with the specified operation messages and the dialog optionally marked for closure.

This method can only be used by an interceptor extension component invoked from within an output interceptor that is responding to a Downcall event.

Parameters:

ops - updated messages that the SIS should use to continue call processing. See continueProcessing(Operation[]) for a description of what different argument values mean.

closeDialog - boolean flag indicating if the operations should be followed with a close (TC_END) with basic end (true) or delimiter (TC_CONTINUE) (false).

Throws:

IllegalStateException - if the interceptor extension component is not responding to a Downcall event previously fired to it on this activity, or if the interceptor extension component has already returned a response to the SIS for the most recent Downcall event fired to it. This exception may also be thrown if the interceptor extension component has taken too long to respond to the event and a timeout has occurred in the SIS.

continueProcessing

void continueProcessing(Operation[] ops,
                        DialogPrimitive primitive)
                 throws IllegalStateException

Notify the SIS that evaluation of the current output interceptor should be continued. The current composition service output messages used by the the composition are replaced with the specified operation messages and the output dialog primitive is replaced with the specified primitive.

This method can only be used by an interceptor extension component invoked from within an output interceptor that is responding to a Downcall event.

Parameters:

ops - updated messages that the SIS should use to continue call processing. See continueProcessing(Operation[]) for a description of what different argument values mean.

primitive - updated dialog primitive that the SIS should use to continue call processing.

Throws:

IllegalStateException - if the interceptor extension component is not responding to a Downcall event previously fired to it on this activity, or if the interceptor extension component has already returned a response to the SIS for the most recent Downcall event fired to it. This exception may also be thrown if the interceptor extension component has taken too long to respond to the event and a timeout has occurred in the SIS.

Since:

SIS 2.5.1.

getApplicationContext

TcapApplicationContext getApplicationContext()

Get the application context that the underlying network dialog was created with.

Returns:

the application context.

getDialogID

String getDialogID()

Get the unique dialog identifier for the underlying network dialog.

Returns:

the dialog identifier.

getProvider

CGINProvider getProvider()

Get the provider that created the network dialog.

Returns:

the provider that created the network dialog.