org.mobicents.protocols.smpp.message
Class CancelSM

java.lang.Object
  org.mobicents.protocols.smpp.message.SMPPPacket
      org.mobicents.protocols.smpp.message.CancelSM

All Implemented Interfaces:

Serializable, Cloneable

public class CancelSM
extends SMPPPacket

Cancal message. This SMPP message is used to cancel a previously submitted but yet undelivered short message at the SMSC. Relevant inherited fields from SMPPPacket:

serviceType
messageId
source
destination

Version:

$Id: CancelSM.java 457 2009-01-15 17:37:42Z orank $

See Also:

Serialized Form

Field Summary

Fields inherited from class org.mobicents.protocols.smpp.message.SMPPPacket

commandId, commandStatus, sequenceNum, tlvTable

Constructor Summary

CancelSM()
Construct a new CancelSM.

Method Summary

boolean	equals(Object obj)
Address	getDestination()
protected int	getMandatorySize() Get the encoded size of the mandatory parameters of this packet.
String	getMessageId()
String	getServiceType()
Address	getSource()
int	hashCode()
protected void	readMandatory(PacketDecoder decoder) Read the mandatory parameters from a packet decoder.
void	setDestination(Address destination)
void	setMessageId(String messageId)
void	setServiceType(String serviceType)
void	setSource(Address source)
protected void	toString(StringBuilder buffer) Get the mandatory parameters in string form (for display purposes only).
protected void	validateMandatory(SMPPVersion smppVersion) Validate the mandatory parameters for this packet.
protected void	writeMandatory(PacketEncoder encoder) Write the mandatory parameters to a packet encoder.

Methods inherited from class org.mobicents.protocols.smpp.message.SMPPPacket

clone, getCommandId, getCommandStatus, getLength, getSequenceNum, getTLV, getTLVTable, isRequest, isResponse, isSet, readFrom, removeTLV, safeCompare, setCommandStatus, setSequenceNum, setTLV, sizeOf, sizeOf, sizeOf, sizeOf, toString, validate, validateTLVTable, writeTo, writeTo

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CancelSM

public CancelSM()

Construct a new CancelSM.

Method Detail

getDestination

public Address getDestination()

setDestination

public void setDestination(Address destination)

getMessageId

public String getMessageId()

setMessageId

public void setMessageId(String messageId)

getServiceType

public String getServiceType()

setServiceType

public void setServiceType(String serviceType)

getSource

public Address getSource()

setSource

public void setSource(Address source)

equals

public boolean equals(Object obj)

Overrides:

equals in class SMPPPacket

hashCode

public int hashCode()

Overrides:

hashCode in class SMPPPacket

toString

protected void toString(StringBuilder buffer)

Description copied from class: SMPPPacket

Get the mandatory parameters in string form (for display purposes only).

Overrides:

toString in class SMPPPacket

validateMandatory

protected void validateMandatory(SMPPVersion smppVersion)

Description copied from class: SMPPPacket

Validate the mandatory parameters for this packet. If any mandatory parameter fails validation, a org.mobicents.smpp.version.VersionException should be thrown.

Overrides:

validateMandatory in class SMPPPacket

Parameters:

smppVersion - The version to validate against.

readMandatory

protected void readMandatory(PacketDecoder decoder)

Description copied from class: SMPPPacket

Read the mandatory parameters from a packet decoder. This default implementation is empty, parsing no mandatory parameters. Sub-classes may override this as they wish.

Overrides:

readMandatory in class SMPPPacket

Parameters:

decoder - The decoder to read fields from.

writeMandatory

protected void writeMandatory(PacketEncoder encoder)
                       throws IOException

Description copied from class: SMPPPacket

Write the mandatory parameters to a packet encoder.

Overrides:

writeMandatory in class SMPPPacket

Parameters:

encoder - The encoder to write mandatory parameters to.

Throws:

IOException - If an problem occurs while writing.

getMandatorySize

protected int getMandatorySize()

Description copied from class: SMPPPacket

Get the encoded size of the mandatory parameters of this packet.

Overrides:

getMandatorySize in class SMPPPacket

Returns:

The number of bytes the mandatory parameters will encode to.