org.mobicents.protocols.smpp.message
Class SubmitMultiResp

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

All Implemented Interfaces:

Serializable, Cloneable

public class SubmitMultiResp
extends SMPPPacket

Submit to multiple destinations response.

Version:

$Id: SubmitMultiResp.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

SubmitMultiResp()
Construct a new Unbind.

SubmitMultiResp(SMPPPacket request)
Create a new SubmitMultiResp packet in response to a BindReceiver.

Method Summary

int	add(ErrorAddress ea) Add a destination address to the table of unsuccessful destinations.
boolean	equals(Object obj)
protected int	getMandatorySize() Get the encoded size of the mandatory parameters of this packet.
String	getMessageId()
int	getUnsuccessfulCount() Get the number of destinations the message was not delivered to.
int	hashCode()
protected void	readMandatory(PacketDecoder decoder) Read the mandatory parameters from a packet decoder.
int	remove(Address a) Remove an address from the table of unsuccessful destinations.
void	setMessageId(String messageId)
ListIterator<ErrorAddress>	tableIterator() Get an iterator to iterate over the set of addresses in the unsuccessful destination table.
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

SubmitMultiResp

public SubmitMultiResp()

Construct a new Unbind.

SubmitMultiResp

public SubmitMultiResp(SMPPPacket request)

Create a new SubmitMultiResp packet in response to a BindReceiver. This constructor will set the sequence number to it's expected value.

Parameters:

request - The Request packet the response is to

Method Detail

getMessageId

public String getMessageId()

setMessageId

public void setMessageId(String messageId)

getUnsuccessfulCount

public int getUnsuccessfulCount()

Get the number of destinations the message was not delivered to.

add

public int add(ErrorAddress ea)

Add a destination address to the table of unsuccessful destinations.

Parameters:

ea - ErrorAddress object representing the failed destination

Returns:

The current count of unsuccessful destinations (including the new one)

remove

public int remove(Address a)

Remove an address from the table of unsuccessful destinations.

Parameters:

a - the address to remove.

Returns:

the size of the table after removal.

tableIterator

public ListIterator<ErrorAddress> tableIterator()

Get an iterator to iterate over the set of addresses in the unsuccessful destination table.

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.