Package com.opencloud.sentinel.ipsmgw.eventmanager.tcapmessage

Class BaseDialogTcapMessage

java.lang.Object

com.opencloud.sentinel.ipsmgw.eventmanager.tcapmessage.BaseDialogTcapMessage

All Implemented Interfaces:

DialogTcapMessage, com.opencloud.util.FastSerializable, java.io.Serializable

Direct Known Subclasses:

DialogMessageTcapMessage, DialogOpenRefuseTcapMessage, DialogProviderAbortTcapMessage, DialogUserAbortTcapMessage

public abstract class BaseDialogTcapMessage
extends java.lang.Object
implements DialogTcapMessage, java.io.Serializable, com.opencloud.util.FastSerializable

Base class for all classes that represent a message received on a tcap dialog

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BaseDialogTcapMessage.MessageType

Nested classes/interfaces inherited from interface com.opencloud.sentinel.ipsmgw.eventmanager.tcapmessage.DialogTcapMessage

DialogTcapMessage.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected static TcapComponent[]	NO_COMPONENTS

Constructor Summary

Constructors

Constructor	Description
BaseDialogTcapMessage(BaseDialogTcapMessage toCopy)
BaseDialogTcapMessage(BaseDialogTcapMessage.MessageType messageType, DialogTcapMessage.Type type)
BaseDialogTcapMessage(BaseDialogTcapMessage.MessageType messageType, DialogTcapMessage.Type type, java.lang.Object[] userInformation)
BaseDialogTcapMessage(java.io.DataInput ip)

Method Summary

Modifier and Type	Method	Description
DialogMessageTcapMessage	asDialogMessage()
DialogMessageTcapMessage	asDialogOpenAccept()
DialogOpenRefuseTcapMessage	asDialogOpenRefuse()
DialogOpenRequestTcapMessage	asDialogOpenRequest()
DialogProviderAbortTcapMessage	asDialogProviderAbort()
DialogUserAbortTcapMessage	asDialogUserAbort()
void	asTcContinue()	change this message to be a TC-Continue, if possible.
void	asTcEnd()	change this message to be a TC-End(prearranged = false), if possible.
void	asTcEnd(boolean prearranged)	change this message to be a TC-End(prearranged), if possible.
boolean	equals(java.lang.Object o)
TcapComponent[]	getComponents()
protected BaseDialogTcapMessage.MessageType	getMessageType()
DialogTcapMessage.Type	getType()
java.lang.Object[]	getUserInformation()
boolean	hasComponents()
int	hashCode()
boolean	isPrearrangedEnd()
boolean	isTcBegin()
boolean	isTcContinue()
boolean	isTcEnd()
boolean	isType(DialogTcapMessage.Type toCheck)
void	setUserInformation(java.lang.Object[] userInformation)
void	toStream(java.io.DataOutput op)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_COMPONENTS

protected static final TcapComponent[] NO_COMPONENTS

Constructor Detail

BaseDialogTcapMessage

public BaseDialogTcapMessage(java.io.DataInput ip)
                      throws java.io.IOException

Throws:

java.io.IOException

BaseDialogTcapMessage

public BaseDialogTcapMessage(BaseDialogTcapMessage.MessageType messageType,
                             DialogTcapMessage.Type type)

BaseDialogTcapMessage

public BaseDialogTcapMessage(BaseDialogTcapMessage.MessageType messageType,
                             DialogTcapMessage.Type type,
                             java.lang.Object[] userInformation)

BaseDialogTcapMessage

public BaseDialogTcapMessage(BaseDialogTcapMessage toCopy)

Method Detail

toStream

public void toStream(java.io.DataOutput op)
              throws java.io.IOException

Specified by:

toStream in interface com.opencloud.util.FastSerializable

Throws:

java.io.IOException

hasComponents

public boolean hasComponents()

Specified by:

hasComponents in interface DialogTcapMessage

Returns:

true if this message has some associated components

getComponents

public TcapComponent[] getComponents()

Specified by:

getComponents in interface DialogTcapMessage

Returns:

the components associated with this message

getUserInformation

public final java.lang.Object[] getUserInformation()

setUserInformation

public final void setUserInformation(java.lang.Object[] userInformation)

getType

public final DialogTcapMessage.Type getType()

Specified by:

getType in interface DialogTcapMessage

Returns:

the type of this tcap dialog message

isType

public final boolean isType(DialogTcapMessage.Type toCheck)

Specified by:

isType in interface DialogTcapMessage

Parameters:

toCheck - the type to compare the type of this tcap message to

Returns:

true, if the type if this tcap message is the compatible toCheck

asDialogOpenRequest

public final DialogOpenRequestTcapMessage asDialogOpenRequest()

Specified by:

asDialogOpenRequest in interface DialogTcapMessage

Returns:

this message as an open request

asDialogOpenAccept

public final DialogMessageTcapMessage asDialogOpenAccept()

Specified by:

asDialogOpenAccept in interface DialogTcapMessage

Returns:

this message as an open accept

asDialogOpenRefuse

public final DialogOpenRefuseTcapMessage asDialogOpenRefuse()

Specified by:

asDialogOpenRefuse in interface DialogTcapMessage

Returns:

this message as an open refuse

asDialogUserAbort

public final DialogUserAbortTcapMessage asDialogUserAbort()

Specified by:

asDialogUserAbort in interface DialogTcapMessage

Returns:

this message as a dialog user abort

asDialogProviderAbort

public final DialogProviderAbortTcapMessage asDialogProviderAbort()

Specified by:

asDialogProviderAbort in interface DialogTcapMessage

Returns:

this message as a dialog provider abort

asDialogMessage

public final DialogMessageTcapMessage asDialogMessage()

Specified by:

asDialogMessage in interface DialogTcapMessage

Returns:

this message as a dialog message

isTcBegin

public final boolean isTcBegin()

Specified by:

isTcBegin in interface DialogTcapMessage

Returns:

true is this message is a TC-Begin

isTcContinue

public final boolean isTcContinue()

Specified by:

isTcContinue in interface DialogTcapMessage

Returns:

true is this message is a TC-Continue

isTcEnd

public final boolean isTcEnd()

Specified by:

isTcEnd in interface DialogTcapMessage

Returns:

true is this message is a TC-End

asTcContinue

public final void asTcContinue()

Description copied from interface: DialogTcapMessage

change this message to be a TC-Continue, if possible.

Specified by:

asTcContinue in interface DialogTcapMessage

asTcEnd

public final void asTcEnd()

Description copied from interface: DialogTcapMessage

change this message to be a TC-End(prearranged = false), if possible.

Specified by:

asTcEnd in interface DialogTcapMessage

asTcEnd

public final void asTcEnd(boolean prearranged)

Description copied from interface: DialogTcapMessage

change this message to be a TC-End(prearranged), if possible.

Specified by:

asTcEnd in interface DialogTcapMessage

isPrearrangedEnd

public final boolean isPrearrangedEnd()

Specified by:

isPrearrangedEnd in interface DialogTcapMessage

Returns:

true if the prearranged flag is true

getMessageType

protected final BaseDialogTcapMessage.MessageType getMessageType()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object