org.mobicents.protocols.smpp.message
Class SubmitMulti

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

All Implemented Interfaces:

Serializable, Cloneable

public class SubmitMulti
extends SMPPPacket

Submit a message to multiple destinations.

Version:

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

SubmitMulti()
Construct a new SubmitMulti.

Method Summary

int	addDestination(Address d) Add an address to the destination table.
int	addDestination(String d) Add a distribution list to the destination table.
boolean	equals(Object obj)
int	getDataCoding()
int	getDefaultMsg()
SMPPDate	getDeliveryTime()
DestinationTable	getDestinationTable() Get a handle to the error destination table.
int	getEsmClass()
SMPPDate	getExpiryTime()
protected int	getMandatorySize() Get the encoded size of the mandatory parameters of this packet.
byte[]	getMessage()
int	getNumDests() Get the number of destinations in the destination table.
int	getPriority()
int	getProtocolID()
int	getRegistered()
int	getReplaceIfPresent()
String	getServiceType()
Address	getSource()
int	hashCode()
protected void	readMandatory(PacketDecoder decoder) Read the mandatory parameters from a packet decoder.
void	setDataCoding(int dataCoding)
void	setDefaultMsg(int defaultMsg)
void	setDeliveryTime(SMPPDate deliveryTime)
void	setEsmClass(int esmClass)
void	setExpiryTime(SMPPDate expiryTime)
void	setMessage(byte[] message)
void	setPriority(int priority)
void	setProtocolID(int protocolID)
void	setRegistered(int registered)
void	setReplaceIfPresent(int replaceIfPresent)
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

SubmitMulti

public SubmitMulti()

Construct a new SubmitMulti.

Method Detail

getDestinationTable

public DestinationTable getDestinationTable()

Get a handle to the error destination table. Applications may add destination addresses or distribution list names to the destination table.

getDataCoding

public int getDataCoding()

setDataCoding

public void setDataCoding(int dataCoding)

getDefaultMsg

public int getDefaultMsg()

setDefaultMsg

public void setDefaultMsg(int defaultMsg)

getDeliveryTime

public SMPPDate getDeliveryTime()

setDeliveryTime

public void setDeliveryTime(SMPPDate deliveryTime)

getEsmClass

public int getEsmClass()

setEsmClass

public void setEsmClass(int esmClass)

getExpiryTime

public SMPPDate getExpiryTime()

setExpiryTime

public void setExpiryTime(SMPPDate expiryTime)

getMessage

public byte[] getMessage()

setMessage

public void setMessage(byte[] message)

getPriority

public int getPriority()

setPriority

public void setPriority(int priority)

getProtocolID

public int getProtocolID()

setProtocolID

public void setProtocolID(int protocolID)

getRegistered

public int getRegistered()

setRegistered

public void setRegistered(int registered)

getReplaceIfPresent

public int getReplaceIfPresent()

setReplaceIfPresent

public void setReplaceIfPresent(int replaceIfPresent)

getServiceType

public String getServiceType()

setServiceType

public void setServiceType(String serviceType)

getSource

public Address getSource()

setSource

public void setSource(Address source)

addDestination

public int addDestination(Address d)

Add an address to the destination table.

Parameters:

d - The SME destination address

Returns:

The current number of destination addresses (including the new one).

See Also:

Address

addDestination

public int addDestination(String d)

Add a distribution list to the destination table.

Parameters:

d - the distribution list name.

Returns:

The current number of destination addresses (including the new

getNumDests

public int getNumDests()

Get the number of destinations in the 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.