org.mobicents.ussdgateway

Class XmlMAPDialog

java.lang.Object

org.mobicents.ussdgateway.XmlMAPDialog

All Implemented Interfaces:

Serializable, javolution.xml.XMLSerializable, org.mobicents.protocols.ss7.map.api.MAPDialog

public class XmlMAPDialog
extends Object
implements org.mobicents.protocols.ss7.map.api.MAPDialog, javolution.xml.XMLSerializable

Represents the underlying MAPDialogSupplementary. Application can use this instance of this class, set the supplementary MAPMessage and pass it EventsSerializeFactory to serialize this Dialog to send across the wire.

Application may also pass byte[] to EventsSerializeFactory and get deserialized Dailog back

Author:

amit bhayani

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.mobicents.protocols.ss7.map.api.MAPApplicationContext	appCntx
protected org.mobicents.protocols.ss7.sccp.parameter.SccpAddress	localAddress
protected org.mobicents.protocols.ss7.sccp.parameter.SccpAddress	remoteAddress
protected static javolution.xml.XMLFormat<XmlMAPDialog>	USSR_XML

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

_Timer_Default, _Timer_l, _Timer_m, _Timer_ml, _Timer_s

Constructor Summary

Constructors

Constructor and Description
XmlMAPDialog()
XmlMAPDialog(org.mobicents.protocols.ss7.map.api.MAPApplicationContext appCntx, org.mobicents.protocols.ss7.sccp.parameter.SccpAddress localAddress, org.mobicents.protocols.ss7.sccp.parameter.SccpAddress remoteAddress, Long localId, Long remoteId, org.mobicents.protocols.ss7.map.api.primitives.AddressString destReference, org.mobicents.protocols.ss7.map.api.primitives.AddressString origReference)

Method Summary

Methods

Modifier and Type	Method and Description
void	abort(org.mobicents.protocols.ss7.map.api.dialog.MAPUserAbortChoice mapUserAbortChoice)
void	addEricssonData(org.mobicents.protocols.ss7.map.api.primitives.IMSI arg0, org.mobicents.protocols.ss7.map.api.primitives.AddressString arg1)
void	addMAPMessage(org.mobicents.protocols.ss7.map.api.MAPMessage mapMessage) Non MAPDialog methods
boolean	cancelInvocation(Long arg0)
void	close(boolean prearrangedEnd)
void	closeDelayed(boolean arg0)
protected static org.mobicents.protocols.ss7.map.api.MAPApplicationContext	deserializeMAPApplicationContext(String str)
protected static org.mobicents.protocols.ss7.map.api.dialog.MAPUserAbortChoice	deserializeMAPUserAbortChoice(String str)
org.mobicents.protocols.ss7.map.api.MAPApplicationContext	getApplicationContext()
Integer	getCustomInvokeTimeOut()
Boolean	getDialogTimedOut()
Boolean	getEmptyDialogHandshake()
Map<Long,org.mobicents.protocols.ss7.map.api.errors.MAPErrorMessage>	getErrorComponents()
Long	getInvokeTimedOut()
org.mobicents.protocols.ss7.sccp.parameter.SccpAddress	getLocalAddress()
Long	getLocalDialogId()
org.mobicents.protocols.ss7.map.api.dialog.MAPAbortProviderReason	getMapAbortProviderReason()
javolution.util.FastList<org.mobicents.protocols.ss7.map.api.MAPMessage>	getMAPMessages()
org.mobicents.protocols.ss7.map.api.dialog.MAPRefuseReason	getMapRefuseReason()
org.mobicents.protocols.ss7.map.api.dialog.MAPUserAbortChoice	getMAPUserAbortChoice()
int	getMaxUserDataLength()
int	getMessageUserDataLengthOnClose(boolean arg0)
int	getMessageUserDataLengthOnSend()
int	getNetworkId()
Boolean	getPrearrangedEnd()
javolution.util.FastList<Long>	getProcessInvokeWithoutAnswerIds()
org.mobicents.protocols.ss7.map.api.primitives.AddressString	getReceivedDestReference()
org.mobicents.protocols.ss7.map.api.primitives.MAPExtensionContainer	getReceivedExtensionContainer()
org.mobicents.protocols.ss7.map.api.primitives.AddressString	getReceivedOrigReference()
Map<Long,org.mobicents.protocols.ss7.tcap.asn.comp.Problem>	getRejectComponents()
org.mobicents.protocols.ss7.sccp.parameter.SccpAddress	getRemoteAddress()
Long	getRemoteDialogId()
boolean	getReturnMessageOnError()
org.mobicents.protocols.ss7.map.api.MAPServiceBase	getService()
Boolean	getSriPart()
org.mobicents.protocols.ss7.map.api.dialog.MAPDialogState	getState()
org.mobicents.protocols.ss7.tcap.api.MessageType	getTCAPMessageType()
Object	getUserObject()
void	keepAlive()
void	processInvokeWithoutAnswer(Long invokeId)
void	refuse(org.mobicents.protocols.ss7.map.api.dialog.Reason refuseReason)
void	release()
boolean	removeMAPMessage(org.mobicents.protocols.ss7.map.api.MAPMessage mapMessage)
void	reset()
void	resetInvokeTimer(Long arg0)
void	send()
void	sendDelayed()
void	sendErrorComponent(Long invokeId, org.mobicents.protocols.ss7.map.api.errors.MAPErrorMessage mapErrorMessage)
void	sendInvokeComponent(org.mobicents.protocols.ss7.tcap.asn.comp.Invoke arg0)
void	sendRejectComponent(Long invokeId, org.mobicents.protocols.ss7.tcap.asn.comp.Problem problem)
void	sendReturnResultComponent(org.mobicents.protocols.ss7.tcap.asn.comp.ReturnResult arg0)
void	sendReturnResultLastComponent(org.mobicents.protocols.ss7.tcap.asn.comp.ReturnResultLast arg0)
protected static String	serializeMAPApplicationContext(org.mobicents.protocols.ss7.map.api.MAPApplicationContext mapApplicationContext)
protected static String	serializeMAPUserAbortChoice(org.mobicents.protocols.ss7.map.api.dialog.MAPUserAbortChoice abort)
void	setCustomInvokeTimeOut(Integer customInvokeTimeOut) Set custom invoke time out for added MapMessages.
void	setDialogTimedOut(Boolean dialogTimedOut)
void	setEmptyDialogHandshake(Boolean emptyDialogHandshake) A special parameter used only when Dialog is initiated by USSD Gw (Push or Proxy).
void	setExtentionContainer(org.mobicents.protocols.ss7.map.api.primitives.MAPExtensionContainer arg0)
void	setInvokeTimedOut(Long invokeTimedOut)
void	setLocalAddress(org.mobicents.protocols.ss7.sccp.parameter.SccpAddress origAddress)
void	setMapAbortProviderReason(org.mobicents.protocols.ss7.map.api.dialog.MAPAbortProviderReason mapAbortProviderReason)
void	setMapRefuseReason(org.mobicents.protocols.ss7.map.api.dialog.MAPRefuseReason mapRefuseReason)
void	setNetworkId(int networkId)
void	setRemoteAddress(org.mobicents.protocols.ss7.sccp.parameter.SccpAddress destAddress)
void	setReturnMessageOnError(boolean returnMessageOnError)
void	setSriPart(Boolean sriPart)
void	setTCAPMessageType(org.mobicents.protocols.ss7.tcap.api.MessageType messageType)
void	setUserObject(Object obj)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

appCntx

protected org.mobicents.protocols.ss7.map.api.MAPApplicationContext appCntx

localAddress

protected org.mobicents.protocols.ss7.sccp.parameter.SccpAddress localAddress

remoteAddress

protected org.mobicents.protocols.ss7.sccp.parameter.SccpAddress remoteAddress

USSR_XML

protected static final javolution.xml.XMLFormat<XmlMAPDialog> USSR_XML

Constructor Detail

XmlMAPDialog

public XmlMAPDialog()

XmlMAPDialog

public XmlMAPDialog(org.mobicents.protocols.ss7.map.api.MAPApplicationContext appCntx,
            org.mobicents.protocols.ss7.sccp.parameter.SccpAddress localAddress,
            org.mobicents.protocols.ss7.sccp.parameter.SccpAddress remoteAddress,
            Long localId,
            Long remoteId,
            org.mobicents.protocols.ss7.map.api.primitives.AddressString destReference,
            org.mobicents.protocols.ss7.map.api.primitives.AddressString origReference)

Method Detail

abort

public void abort(org.mobicents.protocols.ss7.map.api.dialog.MAPUserAbortChoice mapUserAbortChoice)
           throws org.mobicents.protocols.ss7.map.api.MAPException

Specified by:

abort in interface org.mobicents.protocols.ss7.map.api.MAPDialog

Throws:

org.mobicents.protocols.ss7.map.api.MAPException

addEricssonData

public void addEricssonData(org.mobicents.protocols.ss7.map.api.primitives.IMSI arg0,
                   org.mobicents.protocols.ss7.map.api.primitives.AddressString arg1)

Specified by:

addEricssonData in interface org.mobicents.protocols.ss7.map.api.MAPDialog

cancelInvocation

public boolean cancelInvocation(Long arg0)
                         throws org.mobicents.protocols.ss7.map.api.MAPException

Specified by:

cancelInvocation in interface org.mobicents.protocols.ss7.map.api.MAPDialog

Throws:

org.mobicents.protocols.ss7.map.api.MAPException

close

public void close(boolean prearrangedEnd)
           throws org.mobicents.protocols.ss7.map.api.MAPException

Specified by:

close in interface org.mobicents.protocols.ss7.map.api.MAPDialog

Throws:

org.mobicents.protocols.ss7.map.api.MAPException

closeDelayed

public void closeDelayed(boolean arg0)
                  throws org.mobicents.protocols.ss7.map.api.MAPException

Specified by:

closeDelayed in interface org.mobicents.protocols.ss7.map.api.MAPDialog

Throws:

org.mobicents.protocols.ss7.map.api.MAPException

getApplicationContext

public org.mobicents.protocols.ss7.map.api.MAPApplicationContext getApplicationContext()

Specified by:

getApplicationContext in interface org.mobicents.protocols.ss7.map.api.MAPDialog

getLocalAddress

public org.mobicents.protocols.ss7.sccp.parameter.SccpAddress getLocalAddress()

Specified by:

getLocalAddress in interface org.mobicents.protocols.ss7.map.api.MAPDialog

getLocalDialogId

public Long getLocalDialogId()

Specified by:

getLocalDialogId in interface org.mobicents.protocols.ss7.map.api.MAPDialog

getMaxUserDataLength

public int getMaxUserDataLength()

Specified by:

getMaxUserDataLength in interface org.mobicents.protocols.ss7.map.api.MAPDialog

getMessageUserDataLengthOnClose

public int getMessageUserDataLengthOnClose(boolean arg0)
                                    throws org.mobicents.protocols.ss7.map.api.MAPException

Specified by:

getMessageUserDataLengthOnClose in interface org.mobicents.protocols.ss7.map.api.MAPDialog

Throws:

org.mobicents.protocols.ss7.map.api.MAPException

getMessageUserDataLengthOnSend

public int getMessageUserDataLengthOnSend()
                                   throws org.mobicents.protocols.ss7.map.api.MAPException

Specified by:

getMessageUserDataLengthOnSend in interface org.mobicents.protocols.ss7.map.api.MAPDialog

Throws:

org.mobicents.protocols.ss7.map.api.MAPException

getReceivedDestReference

public org.mobicents.protocols.ss7.map.api.primitives.AddressString getReceivedDestReference()

Specified by:

getReceivedDestReference in interface org.mobicents.protocols.ss7.map.api.MAPDialog

getReceivedExtensionContainer

public org.mobicents.protocols.ss7.map.api.primitives.MAPExtensionContainer getReceivedExtensionContainer()

Specified by:

getReceivedExtensionContainer in interface org.mobicents.protocols.ss7.map.api.MAPDialog

getReceivedOrigReference

public org.mobicents.protocols.ss7.map.api.primitives.AddressString getReceivedOrigReference()

Specified by:

getReceivedOrigReference in interface org.mobicents.protocols.ss7.map.api.MAPDialog

getRemoteAddress

public org.mobicents.protocols.ss7.sccp.parameter.SccpAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface org.mobicents.protocols.ss7.map.api.MAPDialog

getRemoteDialogId

public Long getRemoteDialogId()

Specified by:

getRemoteDialogId in interface org.mobicents.protocols.ss7.map.api.MAPDialog

getReturnMessageOnError

public boolean getReturnMessageOnError()

Specified by:

getReturnMessageOnError in interface org.mobicents.protocols.ss7.map.api.MAPDialog

getService

public org.mobicents.protocols.ss7.map.api.MAPServiceBase getService()

Specified by:

getService in interface org.mobicents.protocols.ss7.map.api.MAPDialog

getState

public org.mobicents.protocols.ss7.map.api.dialog.MAPDialogState getState()

Specified by:

getState in interface org.mobicents.protocols.ss7.map.api.MAPDialog

getTCAPMessageType

public org.mobicents.protocols.ss7.tcap.api.MessageType getTCAPMessageType()

Specified by:

getTCAPMessageType in interface org.mobicents.protocols.ss7.map.api.MAPDialog

getUserObject

public Object getUserObject()

Specified by:

getUserObject in interface org.mobicents.protocols.ss7.map.api.MAPDialog

keepAlive

public void keepAlive()

Specified by:

keepAlive in interface org.mobicents.protocols.ss7.map.api.MAPDialog

processInvokeWithoutAnswer

public void processInvokeWithoutAnswer(Long invokeId)

Specified by:

processInvokeWithoutAnswer in interface org.mobicents.protocols.ss7.map.api.MAPDialog

refuse

public void refuse(org.mobicents.protocols.ss7.map.api.dialog.Reason refuseReason)
            throws org.mobicents.protocols.ss7.map.api.MAPException

Specified by:

refuse in interface org.mobicents.protocols.ss7.map.api.MAPDialog

Throws:

org.mobicents.protocols.ss7.map.api.MAPException

release

public void release()

Specified by:

release in interface org.mobicents.protocols.ss7.map.api.MAPDialog

resetInvokeTimer

public void resetInvokeTimer(Long arg0)
                      throws org.mobicents.protocols.ss7.map.api.MAPException

Specified by:

resetInvokeTimer in interface org.mobicents.protocols.ss7.map.api.MAPDialog

Throws:

org.mobicents.protocols.ss7.map.api.MAPException

send

public void send()
          throws org.mobicents.protocols.ss7.map.api.MAPException

Specified by:

send in interface org.mobicents.protocols.ss7.map.api.MAPDialog

Throws:

org.mobicents.protocols.ss7.map.api.MAPException

sendDelayed

public void sendDelayed()
                 throws org.mobicents.protocols.ss7.map.api.MAPException

Specified by:

sendDelayed in interface org.mobicents.protocols.ss7.map.api.MAPDialog

Throws:

org.mobicents.protocols.ss7.map.api.MAPException

sendErrorComponent

public void sendErrorComponent(Long invokeId,
                      org.mobicents.protocols.ss7.map.api.errors.MAPErrorMessage mapErrorMessage)
                        throws org.mobicents.protocols.ss7.map.api.MAPException

Specified by:

sendErrorComponent in interface org.mobicents.protocols.ss7.map.api.MAPDialog

Throws:

org.mobicents.protocols.ss7.map.api.MAPException

sendInvokeComponent

public void sendInvokeComponent(org.mobicents.protocols.ss7.tcap.asn.comp.Invoke arg0)
                         throws org.mobicents.protocols.ss7.map.api.MAPException

Specified by:

sendInvokeComponent in interface org.mobicents.protocols.ss7.map.api.MAPDialog

Throws:

org.mobicents.protocols.ss7.map.api.MAPException

sendRejectComponent

public void sendRejectComponent(Long invokeId,
                       org.mobicents.protocols.ss7.tcap.asn.comp.Problem problem)
                         throws org.mobicents.protocols.ss7.map.api.MAPException

Specified by:

sendRejectComponent in interface org.mobicents.protocols.ss7.map.api.MAPDialog

Throws:

org.mobicents.protocols.ss7.map.api.MAPException

sendReturnResultComponent

public void sendReturnResultComponent(org.mobicents.protocols.ss7.tcap.asn.comp.ReturnResult arg0)
                               throws org.mobicents.protocols.ss7.map.api.MAPException

Specified by:

sendReturnResultComponent in interface org.mobicents.protocols.ss7.map.api.MAPDialog

Throws:

org.mobicents.protocols.ss7.map.api.MAPException

sendReturnResultLastComponent

public void sendReturnResultLastComponent(org.mobicents.protocols.ss7.tcap.asn.comp.ReturnResultLast arg0)
                                   throws org.mobicents.protocols.ss7.map.api.MAPException

Specified by:

sendReturnResultLastComponent in interface org.mobicents.protocols.ss7.map.api.MAPDialog

Throws:

org.mobicents.protocols.ss7.map.api.MAPException

setExtentionContainer

public void setExtentionContainer(org.mobicents.protocols.ss7.map.api.primitives.MAPExtensionContainer arg0)

Specified by:

setExtentionContainer in interface org.mobicents.protocols.ss7.map.api.MAPDialog

setLocalAddress

public void setLocalAddress(org.mobicents.protocols.ss7.sccp.parameter.SccpAddress origAddress)

Specified by:

setLocalAddress in interface org.mobicents.protocols.ss7.map.api.MAPDialog

setRemoteAddress

public void setRemoteAddress(org.mobicents.protocols.ss7.sccp.parameter.SccpAddress destAddress)

Specified by:

setRemoteAddress in interface org.mobicents.protocols.ss7.map.api.MAPDialog

setReturnMessageOnError

public void setReturnMessageOnError(boolean returnMessageOnError)

Specified by:

setReturnMessageOnError in interface org.mobicents.protocols.ss7.map.api.MAPDialog

setUserObject

public void setUserObject(Object obj)

Specified by:

setUserObject in interface org.mobicents.protocols.ss7.map.api.MAPDialog

getNetworkId

public int getNetworkId()

Specified by:

getNetworkId in interface org.mobicents.protocols.ss7.map.api.MAPDialog

setNetworkId

public void setNetworkId(int networkId)

Specified by:

setNetworkId in interface org.mobicents.protocols.ss7.map.api.MAPDialog

addMAPMessage

public void addMAPMessage(org.mobicents.protocols.ss7.map.api.MAPMessage mapMessage)

Non MAPDialog methods

removeMAPMessage

public boolean removeMAPMessage(org.mobicents.protocols.ss7.map.api.MAPMessage mapMessage)

getMAPMessages

public javolution.util.FastList<org.mobicents.protocols.ss7.map.api.MAPMessage> getMAPMessages()

getProcessInvokeWithoutAnswerIds

public javolution.util.FastList<Long> getProcessInvokeWithoutAnswerIds()

getErrorComponents

public Map<Long,org.mobicents.protocols.ss7.map.api.errors.MAPErrorMessage> getErrorComponents()

getRejectComponents

public Map<Long,org.mobicents.protocols.ss7.tcap.asn.comp.Problem> getRejectComponents()

getMAPUserAbortChoice

public org.mobicents.protocols.ss7.map.api.dialog.MAPUserAbortChoice getMAPUserAbortChoice()

getMapAbortProviderReason

public org.mobicents.protocols.ss7.map.api.dialog.MAPAbortProviderReason getMapAbortProviderReason()

setMapAbortProviderReason

public void setMapAbortProviderReason(org.mobicents.protocols.ss7.map.api.dialog.MAPAbortProviderReason mapAbortProviderReason)

getMapRefuseReason

public org.mobicents.protocols.ss7.map.api.dialog.MAPRefuseReason getMapRefuseReason()

setMapRefuseReason

public void setMapRefuseReason(org.mobicents.protocols.ss7.map.api.dialog.MAPRefuseReason mapRefuseReason)

getDialogTimedOut

public Boolean getDialogTimedOut()

setDialogTimedOut

public void setDialogTimedOut(Boolean dialogTimedOut)

getSriPart

public Boolean getSriPart()

setSriPart

public void setSriPart(Boolean sriPart)

getPrearrangedEnd

public Boolean getPrearrangedEnd()

setTCAPMessageType

public void setTCAPMessageType(org.mobicents.protocols.ss7.tcap.api.MessageType messageType)

getInvokeTimedOut

public Long getInvokeTimedOut()

setInvokeTimedOut

public void setInvokeTimedOut(Long invokeTimedOut)

getCustomInvokeTimeOut

public Integer getCustomInvokeTimeOut()

setCustomInvokeTimeOut

public void setCustomInvokeTimeOut(Integer customInvokeTimeOut)

Set custom invoke time out for added MapMessages. If not set the default values will be used

Parameters:

customInvokeTimeOut -

getEmptyDialogHandshake

public Boolean getEmptyDialogHandshake()

setEmptyDialogHandshake

public void setEmptyDialogHandshake(Boolean emptyDialogHandshake)

A special parameter used only when Dialog is initiated by USSD Gw (Push or Proxy). USSD Gateway will first create empty Dialog and send Begin to remote end and only on Dialog accept from remote side it, will send payload.

Parameters:

emptyDialogHandshake -

reset

public void reset()

toString

public String toString()

Overrides:

toString in class Object

serializeMAPUserAbortChoice

protected static String serializeMAPUserAbortChoice(org.mobicents.protocols.ss7.map.api.dialog.MAPUserAbortChoice abort)

deserializeMAPUserAbortChoice

protected static org.mobicents.protocols.ss7.map.api.dialog.MAPUserAbortChoice deserializeMAPUserAbortChoice(String str)

serializeMAPApplicationContext

protected static String serializeMAPApplicationContext(org.mobicents.protocols.ss7.map.api.MAPApplicationContext mapApplicationContext)

deserializeMAPApplicationContext

protected static org.mobicents.protocols.ss7.map.api.MAPApplicationContext deserializeMAPApplicationContext(String str)