com.cloudhopper.smpp.pdu

Class Pdu

java.lang.Object

com.cloudhopper.smpp.pdu.Pdu

Direct Known Subclasses:

PduRequest, PduResponse

public abstract class Pdu
extends Object

Constructor Summary

Constructors

Constructor and Description
Pdu(int commandId, String name, boolean isRequest)

Method Summary

Methods

Modifier and Type	Method and Description
void	addOptionalParameter(Tlv tlv) Adds an optional parameter to this PDU.
protected abstract void	appendBodyToString(StringBuilder buffer)
protected void	appendOptionalParameterToString(StringBuilder buffer)
int	calculateAndSetCommandLength() Calculates and sets the commandLength for the PDU based on all currently set values and optional parameters.
protected abstract int	calculateByteSizeOfBody()
protected int	calculateByteSizeOfOptionalParameters()
protected int	findOptionalParameter(short tag)
int	getCommandId()
int	getCommandLength()
int	getCommandStatus()
String	getName()
Tlv	getOptionalParameter(short tag) Gets a TLV by tag.
int	getOptionalParameterCount()
ArrayList<Tlv>	getOptionalParameters() Gets the current list of optional parameters.
Object	getReferenceObject()
int	getSequenceNumber()
boolean	hasCommandLengthCalculated()
boolean	hasOptionalParameter(short tag) Checks if an optional parameter by tag exists.
boolean	hasSequenceNumberAssigned()
boolean	isRequest()
boolean	isResponse()
abstract void	readBody(org.jboss.netty.buffer.ChannelBuffer buffer)
void	readOptionalParameters(org.jboss.netty.buffer.ChannelBuffer buffer, PduTranscoderContext context)
void	removeCommandLength()
Tlv	removeOptionalParameter(short tag) Removes an optional parameter by tag.
void	removeSequenceNumber()
void	setCommandLength(int value)
void	setCommandStatus(int value)
Tlv	setOptionalParameter(Tlv tlv) Sets an optional parameter by checking if the tag already exists in our list of optional parameters.
void	setReferenceObject(Object value)
void	setSequenceNumber(int value)
String	toString()
abstract void	writeBody(org.jboss.netty.buffer.ChannelBuffer buffer)
void	writeOptionalParameters(org.jboss.netty.buffer.ChannelBuffer buffer, PduTranscoderContext context)

Methods inherited from class java.lang.Object

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

Constructor Detail

Pdu

public Pdu(int commandId,
   String name,
   boolean isRequest)

Method Detail

setReferenceObject

public void setReferenceObject(Object value)

getReferenceObject

public Object getReferenceObject()

getName

public String getName()

isRequest

public boolean isRequest()

isResponse

public boolean isResponse()

hasCommandLengthCalculated

public boolean hasCommandLengthCalculated()

removeCommandLength

public void removeCommandLength()

setCommandLength

public void setCommandLength(int value)

getCommandLength

public int getCommandLength()

calculateAndSetCommandLength

public int calculateAndSetCommandLength()

Calculates and sets the commandLength for the PDU based on all currently set values and optional parameters.

Returns:

The calculated PDU command length

getCommandId

public int getCommandId()

setCommandStatus

public void setCommandStatus(int value)

getCommandStatus

public int getCommandStatus()

hasSequenceNumberAssigned

public boolean hasSequenceNumberAssigned()

removeSequenceNumber

public void removeSequenceNumber()

setSequenceNumber

public void setSequenceNumber(int value)

getSequenceNumber

public int getSequenceNumber()

getOptionalParameterCount

public int getOptionalParameterCount()

getOptionalParameters

public ArrayList<Tlv> getOptionalParameters()

Gets the current list of optional parameters. If no parameters have been added, this will return null.

Returns:

Null if no parameters added yet, or the list of optional parameters.

addOptionalParameter

public void addOptionalParameter(Tlv tlv)

Adds an optional parameter to this PDU. Does not check if the TLV has already been added (allows duplicates).

Parameters:

tlv - The TLV to add

See Also:

setOptionalParameter(com.cloudhopper.smpp.tlv.Tlv)

removeOptionalParameter

public Tlv removeOptionalParameter(short tag)

Removes an optional parameter by tag. Will only remove the first matching tag.

Parameters:

tag - That tag to remove

Returns:

Null if no TLV removed, or the TLV removed.

setOptionalParameter

public Tlv setOptionalParameter(Tlv tlv)

Sets an optional parameter by checking if the tag already exists in our list of optional parameters. If it already exists, will replace the old value with the new value.

Parameters:

tlv - The TLV to add/set

Returns:

Null if no TLV was replaced, or the TLV replaced.

hasOptionalParameter

public boolean hasOptionalParameter(short tag)

Checks if an optional parameter by tag exists.

Parameters:

tag - The TLV to search for

Returns:

True if exists, otherwise false

findOptionalParameter

protected int findOptionalParameter(short tag)

getOptionalParameter

public Tlv getOptionalParameter(short tag)

Gets a TLV by tag.

Parameters:

tag - The TLV tag to search for

Returns:

The first matching TLV by tag

calculateByteSizeOfBody

protected abstract int calculateByteSizeOfBody()

readBody

public abstract void readBody(org.jboss.netty.buffer.ChannelBuffer buffer)
                       throws UnrecoverablePduException,
                              RecoverablePduException

Throws:

UnrecoverablePduException

RecoverablePduException

writeBody

public abstract void writeBody(org.jboss.netty.buffer.ChannelBuffer buffer)
                        throws UnrecoverablePduException,
                               RecoverablePduException

Throws:

UnrecoverablePduException

RecoverablePduException

appendBodyToString

protected abstract void appendBodyToString(StringBuilder buffer)

calculateByteSizeOfOptionalParameters

protected int calculateByteSizeOfOptionalParameters()

readOptionalParameters

public void readOptionalParameters(org.jboss.netty.buffer.ChannelBuffer buffer,
                          PduTranscoderContext context)
                            throws UnrecoverablePduException,
                                   RecoverablePduException

Throws:

UnrecoverablePduException

RecoverablePduException

writeOptionalParameters

public void writeOptionalParameters(org.jboss.netty.buffer.ChannelBuffer buffer,
                           PduTranscoderContext context)
                             throws UnrecoverablePduException,
                                    RecoverablePduException

Throws:

UnrecoverablePduException

RecoverablePduException

appendOptionalParameterToString

protected void appendOptionalParameterToString(StringBuilder buffer)

toString

public String toString()

Overrides:

toString in class Object