org.mobicents.protocols.ss7.map

Class MAPDialogImpl

java.lang.Object

org.mobicents.protocols.ss7.map.MAPDialogImpl

All Implemented Interfaces:

MAPDialog

Direct Known Subclasses:

MAPDialogLsmImpl, MAPDialogSmsImpl, MAPDialogSupplementaryImpl

public abstract class MAPDialogImpl
extends java.lang.Object
implements MAPDialog

MAP-DialoguePDU ::= CHOICE { map-open [0] MAP-OpenInfo, map-accept [1] MAP-AcceptInfo, map-close [2] MAP-CloseInfo, map-refuse [3] MAP-RefuseInfo, map-userAbort [4] MAP-UserAbortInfo, map-providerAbort [5] MAP-ProviderAbortInfo}

Author:

amit bhayani, baranowb, sergey vetyutnev

Field Summary

Fields

Modifier and Type	Field and Description
protected MAPApplicationContext	appCntx
protected AddressString	destReference
protected MAPExtensionContainer	extContainer
protected MAPProviderImpl	mapProviderImpl
protected MAPServiceBase	mapService
protected boolean	normalDialogShutDown
protected AddressString	origReference
protected MAPDialogState	state
protected Dialog	tcapDialog

Fields inherited from interface org.mobicents.protocols.ss7.map.api.MAPDialog

_Timer_Default, _Timer_l, _Timer_m, _Timer_ml, _Timer_s

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MAPDialogImpl(MAPApplicationContext appCntx, Dialog tcapDialog, MAPProviderImpl mapProviderImpl, MAPServiceBase mapService, AddressString origReference, AddressString destReference)

Method Summary

Methods

Modifier and Type	Method and Description
void	abort(MAPUserAbortChoice mapUserAbortChoice)
boolean	addIncomingInvokeId(java.lang.Long invokeId) Adding the new incoming invokeId into incomingInvokeList list
boolean	cancelInvocation(java.lang.Long invokeId)
java.lang.Boolean	checkIncomingInvokeIdExists(java.lang.Long invokeId)
void	close(boolean prearrangedEnd)
MAPApplicationContext	getApplicationContext()
java.lang.Long	getDialogId()
int	getMaxUserDataLength()
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
protected java.lang.Boolean	getNormalDialogShutDown()
MAPServiceBase	getService()
MAPDialogState	getState()
Dialog	getTcapDialog()
java.lang.Object	getUserObject()
void	keepAlive()
void	refuse(Reason reason)
void	release()
void	removeIncomingInvokeId(java.lang.Long invokeId)
void	resetInvokeTimer(java.lang.Long invokeId)
void	send()
void	sendErrorComponent(java.lang.Long invokeId, MAPErrorMessage mem)
void	sendInvokeComponent(Invoke invoke)
void	sendRejectComponent(java.lang.Long invokeId, Problem problem)
void	sendReturnResultComponent(ReturnResult returnResult)
void	sendReturnResultLastComponent(ReturnResultLast returnResultLast)
void	setExtentionContainer(MAPExtensionContainer extContainer)
protected void	setNormalDialogShutDown() Setting that the MAP Dialog is normally shutting down - to prevent performing onDialogReleased()
protected void	setState(MAPDialogState newState)
void	setUserObject(java.lang.Object userObject)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

tcapDialog

protected Dialog tcapDialog

mapProviderImpl

protected MAPProviderImpl mapProviderImpl

mapService

protected MAPServiceBase mapService

appCntx

protected MAPApplicationContext appCntx

destReference

protected AddressString destReference

origReference

protected AddressString origReference

extContainer

protected MAPExtensionContainer extContainer

state

protected MAPDialogState state

normalDialogShutDown

protected boolean normalDialogShutDown

Constructor Detail

MAPDialogImpl

protected MAPDialogImpl(MAPApplicationContext appCntx,
             Dialog tcapDialog,
             MAPProviderImpl mapProviderImpl,
             MAPServiceBase mapService,
             AddressString origReference,
             AddressString destReference)

Method Detail

keepAlive

public void keepAlive()

Specified by:

keepAlive in interface MAPDialog

getDialogId

public java.lang.Long getDialogId()

Specified by:

getDialogId in interface MAPDialog

getService

public MAPServiceBase getService()

Specified by:

getService in interface MAPDialog

getTcapDialog

public Dialog getTcapDialog()

release

public void release()

Specified by:

release in interface MAPDialog

setExtentionContainer

public void setExtentionContainer(MAPExtensionContainer extContainer)

Specified by:

setExtentionContainer in interface MAPDialog

setNormalDialogShutDown

protected void setNormalDialogShutDown()

Setting that the MAP Dialog is normally shutting down - to prevent performing onDialogReleased()

getNormalDialogShutDown

protected java.lang.Boolean getNormalDialogShutDown()

addIncomingInvokeId

public boolean addIncomingInvokeId(java.lang.Long invokeId)

Adding the new incoming invokeId into incomingInvokeList list

Parameters:

invokeId -

Returns:

false: failure - this invokeId already present in the list

removeIncomingInvokeId

public void removeIncomingInvokeId(java.lang.Long invokeId)

checkIncomingInvokeIdExists

public java.lang.Boolean checkIncomingInvokeIdExists(java.lang.Long invokeId)

abort

public void abort(MAPUserAbortChoice mapUserAbortChoice)
           throws MAPException

Specified by:

abort in interface MAPDialog

Throws:

MAPException

refuse

public void refuse(Reason reason)
            throws MAPException

Specified by:

refuse in interface MAPDialog

Throws:

MAPException

close

public void close(boolean prearrangedEnd)
           throws MAPException

Specified by:

close in interface MAPDialog

Throws:

MAPException

send

public void send()
          throws MAPException

Specified by:

send in interface MAPDialog

Throws:

MAPException

getApplicationContext

public MAPApplicationContext getApplicationContext()

Specified by:

getApplicationContext in interface MAPDialog

getState

public MAPDialogState getState()

setState

protected void setState(MAPDialogState newState)

sendInvokeComponent

public void sendInvokeComponent(Invoke invoke)
                         throws MAPException

Specified by:

sendInvokeComponent in interface MAPDialog

Throws:

MAPException

sendReturnResultComponent

public void sendReturnResultComponent(ReturnResult returnResult)
                               throws MAPException

Specified by:

sendReturnResultComponent in interface MAPDialog

Throws:

MAPException

sendReturnResultLastComponent

public void sendReturnResultLastComponent(ReturnResultLast returnResultLast)
                                   throws MAPException

Specified by:

sendReturnResultLastComponent in interface MAPDialog

Throws:

MAPException

sendErrorComponent

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

Specified by:

sendErrorComponent in interface MAPDialog

Throws:

MAPException

sendRejectComponent

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

Specified by:

sendRejectComponent in interface MAPDialog

Throws:

MAPException

resetInvokeTimer

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

Specified by:

resetInvokeTimer in interface MAPDialog

Throws:

MAPException

cancelInvocation

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

Specified by:

cancelInvocation in interface MAPDialog

Throws:

MAPException

getUserObject

public java.lang.Object getUserObject()

Specified by:

getUserObject in interface MAPDialog

setUserObject

public void setUserObject(java.lang.Object userObject)

Specified by:

setUserObject in interface MAPDialog

getMaxUserDataLength

public int getMaxUserDataLength()

Specified by:

getMaxUserDataLength in interface MAPDialog

getMessageUserDataLengthOnSend

public 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

Specified by:

getMessageUserDataLengthOnSend in interface MAPDialog

Returns:

Throws:

MAPException

getMessageUserDataLengthOnClose

public 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

Specified by:

getMessageUserDataLengthOnClose in interface MAPDialog

Parameters:

prearrangedEnd -

Returns:

Throws:

MAPException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object