org.mobicents.protocols.ss7.map.api

Interface MAPDialog

All Known Subinterfaces:

MAPDialogLsm, MAPDialogSms, MAPDialogSupplementary

public interface MAPDialog

Author:

amit bhayani

Field Summary

Fields

Modifier and Type	Field and Description
static int	_Timer_Default
static int	_Timer_l
static int	_Timer_m
static int	_Timer_ml
static int	_Timer_s

Method Summary

Methods

Modifier and Type	Method and Description
void	abort(MAPUserAbortChoice mapUserAbortChoice) This is equivalent to MAP User issuing the MAP_U_ABORT Service Request.
boolean	cancelInvocation(java.lang.Long invokeId) Causes local termination of an operation invocation (TC-U-CANCEL)
void	close(boolean prearrangedEnd) This is equivalent of MAP User issuing the MAP_CLOSE Service Request.
MAPApplicationContext	getApplicationContext()
java.lang.Long	getDialogId() Returns this Dialog's ID.
int	getMaxUserDataLength() Return the maximum MAP message length (in bytes) that are allowed for this dialog
int	getMessageUserDataLengthOnClose(boolean prearrangedEnd) Return the MAP message length (in bytes) that will be after encoding if TC-END case This value must not exceed getMaxUserDataLength() value
int	getMessageUserDataLengthOnSend() Return the MAP message length (in bytes) that will be after encoding if TC-BEGIN or TC-CONTINUE cases This value must not exceed getMaxUserDataLength() value
MAPServiceBase	getService() Returns the MAP service that serve this dialog
java.lang.Object	getUserObject() Getting from the MAPDialog a user-defined object to save relating to the Dialog information
void	keepAlive() This method can be called on timeout of dialog, inside MAPDialogListener#onDialogTimeout(Dialog) callback.
void	refuse(Reason reason) Send T_U_ABORT with MAP-RefuseInfo
void	release() Remove MAPDialog without sending any messages and invoking events
void	resetInvokeTimer(java.lang.Long invokeId) Reset the Invoke Timeout timer for the Invoke.
void	send() This is equivalent of MAP User issuing the MAP_DELIMITER Service Request.
void	sendErrorComponent(java.lang.Long invokeId, MAPErrorMessage mapErrorMessage) Sends the TC-U-ERROR component
void	sendInvokeComponent(Invoke invoke) Sends the TC-INVOKE component
void	sendRejectComponent(java.lang.Long invokeId, Problem problem) Sends the TC-U-REJECT component
void	sendReturnResultComponent(ReturnResult returnResult) Sends the TC-RESULT-NL component
void	sendReturnResultLastComponent(ReturnResultLast returnResultLast) Sends the TC-RESULT-L component
void	setExtentionContainer(MAPExtensionContainer extContainer) Set ExtentionContainer that will be send in 1) T-BEGIN 2) T-CONTINUE or T-END if it is response to the T-BEGIN 3) T-ABORT If no Dialogue control APDU is sending - ExtentionContainer will also not be sent
void	setUserObject(java.lang.Object userObject) Store in the MAPDialog a user-defined object to save relating to the Dialog information

Field Detail

_Timer_s

static final int _Timer_s

See Also:

Constant Field Values

_Timer_m

static final int _Timer_m

See Also:

Constant Field Values

_Timer_ml

static final int _Timer_ml

See Also:

Constant Field Values

_Timer_l

static final int _Timer_l

See Also:

Constant Field Values

_Timer_Default

static final int _Timer_Default

See Also:

Constant Field Values

Method Detail

release

void release()

Remove MAPDialog without sending any messages and invoking events

keepAlive

void keepAlive()

This method can be called on timeout of dialog, inside MAPDialogListener#onDialogTimeout(Dialog) callback. If its called, dialog wont be removed in case application does not perform 'send'.

getDialogId

java.lang.Long getDialogId()

Returns this Dialog's ID. This ID is actually TCAP's Dialog ID. Dialog

Returns:

getService

MAPServiceBase getService()

Returns the MAP service that serve this dialog

Returns:

setExtentionContainer

void setExtentionContainer(MAPExtensionContainer extContainer)

Set ExtentionContainer that will be send in 1) T-BEGIN 2) T-CONTINUE or T-END if it is response to the T-BEGIN 3) T-ABORT If no Dialogue control APDU is sending - ExtentionContainer will also not be sent

send

void send()
          throws MAPException

This is equivalent of MAP User issuing the MAP_DELIMITER Service Request. send() is called to explicitly request the transfer of the MAP protocol data units to the peer entities.

Throws:

MAPException

close

void close(boolean prearrangedEnd)
           throws MAPException

This is equivalent of MAP User issuing the MAP_CLOSE Service Request. This service is used for releasing a previously established MAP dialogue. The service may be invoked by either MAP service-user depending on rules defined within the service-user.
If prearrangedEnd is false, all the Service Primitive added to MAPDialog and not sent yet, will be sent to peer.
If prearrangedEnd is true, all the Service Primitive added to MAPDialog and not sent yet, will not be sent to peer.

Parameters:

prearrangedEnd -

Throws:

MAPException

abort

void abort(MAPUserAbortChoice mapUserAbortChoice)
           throws MAPException

This is equivalent to MAP User issuing the MAP_U_ABORT Service Request.

Parameters:

userReason -

Throws:

MAPException

refuse

void refuse(Reason reason)
            throws MAPException

Send T_U_ABORT with MAP-RefuseInfo

Throws:

MAPException

sendInvokeComponent

void sendInvokeComponent(Invoke invoke)
                         throws MAPException

Sends the TC-INVOKE component

Parameters:

invoke -

Throws:

MAPException

sendReturnResultComponent

void sendReturnResultComponent(ReturnResult returnResult)
                               throws MAPException

Sends the TC-RESULT-NL component

Parameters:

returnResult -

Throws:

MAPException

sendReturnResultLastComponent

void sendReturnResultLastComponent(ReturnResultLast returnResultLast)
                                   throws MAPException

Sends the TC-RESULT-L component

Parameters:

returnResultLast -

Throws:

MAPException

sendErrorComponent

void sendErrorComponent(java.lang.Long invokeId,
                      MAPErrorMessage mapErrorMessage)
                        throws MAPException

Sends the TC-U-ERROR component

Parameters:

invokeId -

mapErrorMessage -

Throws:

MAPException

sendRejectComponent

void sendRejectComponent(java.lang.Long invokeId,
                       Problem problem)
                         throws MAPException

Sends the TC-U-REJECT component

Parameters:

invokeId - This parameter is optional and may be the null

problem -

Throws:

MAPException

resetInvokeTimer

void resetInvokeTimer(java.lang.Long invokeId)
                      throws MAPException

Reset the Invoke Timeout timer for the Invoke. (TC-TIMER-RESET)

Parameters:

invokeId -

Throws:

MAPException

cancelInvocation

boolean cancelInvocation(java.lang.Long invokeId)
                         throws MAPException

Causes local termination of an operation invocation (TC-U-CANCEL)

Parameters:

invokeId -

Returns:

true:OK, false: Invoke not found

Throws:

MAPException

getUserObject

java.lang.Object getUserObject()

Getting from the MAPDialog a user-defined object to save relating to the Dialog information

Returns:

setUserObject

void setUserObject(java.lang.Object userObject)

Store in the MAPDialog a user-defined object to save relating to the Dialog information

Parameters:

userObject -

getApplicationContext

MAPApplicationContext getApplicationContext()

getMaxUserDataLength

int getMaxUserDataLength()

Return the maximum MAP message length (in bytes) that are allowed for this dialog

Returns:

getMessageUserDataLengthOnSend

int getMessageUserDataLengthOnSend()
                                   throws MAPException

Return the MAP message length (in bytes) that will be after encoding if TC-BEGIN or TC-CONTINUE cases This value must not exceed getMaxUserDataLength() value

Returns:

Throws:

MAPException

getMessageUserDataLengthOnClose

int getMessageUserDataLengthOnClose(boolean prearrangedEnd)
                                    throws MAPException

Return the MAP message length (in bytes) that will be after encoding if TC-END case This value must not exceed getMaxUserDataLength() value

Parameters:

prearrangedEnd -

Returns:

Throws:

MAPException