com.opencloud.slee.resources.cgin

Interface CGINProvider

public interface CGINProvider

Allows SLEE services to create new outgoing CGIN dialogs.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isApplicationContextSupported(TcapApplicationContext appContext) Test if a given application context is supported by this provider.
Dialog	issueOpenRequest(TcapApplicationContext appContext, ObjectID appContextName, SccpAddress origAddress, SccpAddress destAddress, long timeout, Object... userInformation) Attempt to open a new dialog.
Dialog	issueOpenRequest(TcapApplicationContext appContext, SccpAddress destAddress) Attempt to open a new dialog.
Dialog	issueStatelessOpenRequest(TcapApplicationContext appContext, ObjectID appContextName, byte[] origTransactionID, SccpAddress origAddress, SccpAddress destAddress, Object... userInformation) Attempt to open a new stateless dialog.
Dialog	relayStatelessOpenRequest(DialogOpenRequestEvent openRequest, SccpAddress destAddress) Create a stateless dialog suitable for relaying the given open request.

Method Detail

issueOpenRequest

Dialog issueOpenRequest(TcapApplicationContext appContext,
                      SccpAddress destAddress)
                        throws ProtocolException

Attempt to open a new dialog. A Dialog is allocated in the local Provider stack but the open request does not actually get delivered to the remote Provider until a dialog component primitive (such as a delimiter) is subsequently sent on the dialog. The originating SCCP address set for the open request is the default local SCCP address for the resource adaptor. No user information is included in the request.

Parameters:

appContext - the application context for the dialog

destAddress - the SCCP address of the remote Provider to receive the open request

Returns:

a dialog object

Throws:

NullPointerException - if appContext or destAddress is null.

ProtocolException - if the open request could not be passed down to the local Provider stack.

issueOpenRequest

Dialog issueOpenRequest(TcapApplicationContext appContext,
                      ObjectID appContextName,
                      SccpAddress origAddress,
                      SccpAddress destAddress,
                      long timeout,
                      Object... userInformation)
                        throws ProtocolException

Attempt to open a new dialog. A Dialog is allocated in the local Provider stack but the open request does not actually get delivered to the remote Provider until a dialog component primitive (such as a delimiter) is subsequently sent on the dialog.

Parameters:

appContext - the application context for the dialog

appContextName - the OID to use on the external network; null causes use of what's configured for appContext

origAddress - the SCCP address of the local Provider; if null, the default local address is used

destAddress - the SCCP address of the remote Provider to receive the open request

timeout - how long, in milliseconds, to wait for a response on this dialog before aborting; 0 disables the timeout

userInformation - the user information to include in the TC-BEGIN

Returns:

a dialog object

Throws:

NullPointerException - if appContext or destAddress is null

ProtocolException - if the open request could not be passed down to the local Provider stack.

issueStatelessOpenRequest

Dialog issueStatelessOpenRequest(TcapApplicationContext appContext,
                               ObjectID appContextName,
                               byte[] origTransactionID,
                               SccpAddress origAddress,
                               SccpAddress destAddress,
                               Object... userInformation)
                                 throws ProtocolException

Attempt to open a new stateless dialog. A Dialog is allocated in the local Provider stack but the open request does not actually get delivered to the remote Provider until a dialog component primitive (such as a delimiter) is subsequently sent on the dialog.

Stateless dialogs provide support for "SCCP relay mode", where a TC-BEGIN is relayed to a new destination, but the node performing the relaying does not participate in subsequent messages on that dialog. They differ from normal (stateful) dialogs in several ways:

• the TCAP Originating Transaction ID to use in the TC-BEGIN is explicitly provided;
• they never receive incoming messages or generate timeouts;
• the dialog's SLEE activity is ended as soon as a Delimiter is sent

In general, to implement relay mode, an incoming stateful dialog causes creation of an outgoing stateless dialog, with the outgoing dialog using the same Originating Transaction ID and Originating Address as the incoming dialog. Invokes received on the incoming dialog are forwarded to the outgoing dialog, with modifications if necessary. When an incoming Delimiter is received, it is forwarded to the outgoing dialog (causing the SLEE activity for the outgoing dialog to end), and the incoming dialog is ended with a prearranged-end Close (causing the SLEE activity for the incoming dialog to end without a response being sent)

Parameters:

appContext - the application context for the dialog

appContextName - the OID to use on the external network; null causes use of what's configured for appContext

origTransactionID - the originating TCAP transaction ID to include; 1-4 bytes; mandatory

origAddress - the SCCP address of the local Provider; mandatory

destAddress - the SCCP address of the remote Provider to receive the open request

userInformation - the user information to include in the TC-BEGIN

Returns:

a stateless-dialog object

Throws:

NullPointerException - if appContext, origTransactionID, origAddress, or destAddress is null

ProtocolException - if the open request could not be passed down to the local Provider stack.

relayStatelessOpenRequest

Dialog relayStatelessOpenRequest(DialogOpenRequestEvent openRequest,
                               SccpAddress destAddress)
                                 throws ProtocolException

Create a stateless dialog suitable for relaying the given open request. This is a convenience method that calls issueStatelessOpenRequest with originating transaction ID, originating address, application context, and user information taken from the provided open request event. Additionally, the new dialog's SCCP parameters (SCCP class and return option) and external network ACN are set from those of the existing dialog.

Parameters:

openRequest - the received open request to relay

destAddress - the SCCP address of the remote provider to relay to

Returns:

a stateless-dialog object

Throws:

NullPointerException - if openRequest or destAddress are null

ProtocolException - if the open request could not be passed down to the local Provider stack.

isApplicationContextSupported

boolean isApplicationContextSupported(TcapApplicationContext appContext)

Test if a given application context is supported by this provider.

Parameters:

appContext - the application context to query

Returns:

true iff the given AC is supported