com.cloudhopper.smpp.pdu

Class BaseSm<R extends PduResponse>

java.lang.Object

com.cloudhopper.smpp.pdu.Pdu

com.cloudhopper.smpp.pdu.PduRequest<R>

com.cloudhopper.smpp.pdu.BaseSm<R>

Direct Known Subclasses:

DataSm, DeliverSm, SubmitSm

public abstract class BaseSm<R extends PduResponse>
extends PduRequest<R>

Base "short message" PDU as a super class for submit_sm, deliver_sm, and data_sm. Having a common base class they all inherit from makes it easier to work with requests in a standard way, even though data_sm does NOT actually support all of the same parameters.

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Field Summary

Fields

Modifier and Type	Field and Description
protected byte	dataCoding
protected Address	destAddress
protected byte	esmClass
protected byte	registeredDelivery
protected String	serviceType
protected Address	sourceAddress

Constructor Summary

Constructors

Constructor and Description
BaseSm(int commandId, String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	appendBodyToString(StringBuilder buffer)
int	calculateByteSizeOfBody()
byte	getDataCoding()
byte	getDefaultMsgId()
Address	getDestAddress()
byte	getEsmClass()
byte	getPriority()
byte	getProtocolId()
byte	getRegisteredDelivery()
byte	getReplaceIfPresent()
String	getScheduleDeliveryTime()
String	getServiceType()
byte[]	getShortMessage()
int	getShortMessageLength()
Address	getSourceAddress()
String	getValidityPeriod()
void	readBody(org.jboss.netty.buffer.ChannelBuffer buffer)
void	setDataCoding(byte value)
void	setDefaultMsgId(byte value)
void	setDestAddress(Address value)
void	setEsmClass(byte value)
void	setPriority(byte value)
void	setProtocolId(byte value)
void	setRegisteredDelivery(byte value)
void	setReplaceIfPresent(byte value)
void	setScheduleDeliveryTime(String value)
void	setServiceType(String value)
void	setShortMessage(byte[] value)
void	setSourceAddress(Address value)
void	setValidityPeriod(String value)
void	writeBody(org.jboss.netty.buffer.ChannelBuffer buffer)

Methods inherited from class com.cloudhopper.smpp.pdu.PduRequest

createGenericNack, createResponse, getResponseClass

Methods inherited from class com.cloudhopper.smpp.pdu.Pdu

addOptionalParameter, appendOptionalParameterToString, calculateAndSetCommandLength, calculateByteSizeOfOptionalParameters, findOptionalParameter, getCommandId, getCommandLength, getCommandStatus, getName, getOptionalParameter, getOptionalParameterCount, getOptionalParameters, getReferenceObject, getSequenceNumber, hasCommandLengthCalculated, hasOptionalParameter, hasSequenceNumberAssigned, isRequest, isResponse, readOptionalParameters, removeCommandLength, removeOptionalParameter, removeSequenceNumber, setCommandLength, setCommandStatus, setOptionalParameter, setReferenceObject, setSequenceNumber, toString, writeOptionalParameters

Methods inherited from class java.lang.Object

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

Field Detail

serviceType

protected String serviceType

sourceAddress

protected Address sourceAddress

destAddress

protected Address destAddress

esmClass

protected byte esmClass

registeredDelivery

protected byte registeredDelivery

dataCoding

protected byte dataCoding

Constructor Detail

BaseSm

public BaseSm(int commandId,
      String name)

Method Detail

getShortMessageLength

public int getShortMessageLength()

getShortMessage

public byte[] getShortMessage()

setShortMessage

public void setShortMessage(byte[] value)
                     throws SmppInvalidArgumentException

Throws:

SmppInvalidArgumentException

getReplaceIfPresent

public byte getReplaceIfPresent()

setReplaceIfPresent

public void setReplaceIfPresent(byte value)

getDataCoding

public byte getDataCoding()

setDataCoding

public void setDataCoding(byte value)

getDefaultMsgId

public byte getDefaultMsgId()

setDefaultMsgId

public void setDefaultMsgId(byte value)

getRegisteredDelivery

public byte getRegisteredDelivery()

setRegisteredDelivery

public void setRegisteredDelivery(byte value)

getValidityPeriod

public String getValidityPeriod()

setValidityPeriod

public void setValidityPeriod(String value)

getScheduleDeliveryTime

public String getScheduleDeliveryTime()

setScheduleDeliveryTime

public void setScheduleDeliveryTime(String value)

getPriority

public byte getPriority()

setPriority

public void setPriority(byte value)

getEsmClass

public byte getEsmClass()

setEsmClass

public void setEsmClass(byte value)

getProtocolId

public byte getProtocolId()

setProtocolId

public void setProtocolId(byte value)

getServiceType

public String getServiceType()

setServiceType

public void setServiceType(String value)

getSourceAddress

public Address getSourceAddress()

setSourceAddress

public void setSourceAddress(Address value)

getDestAddress

public Address getDestAddress()

setDestAddress

public void setDestAddress(Address value)

readBody

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

Specified by:

readBody in class Pdu

Throws:

UnrecoverablePduException

RecoverablePduException

calculateByteSizeOfBody

public int calculateByteSizeOfBody()

Specified by:

calculateByteSizeOfBody in class Pdu

writeBody

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

Specified by:

writeBody in class Pdu

Throws:

UnrecoverablePduException

RecoverablePduException

appendBodyToString

public void appendBodyToString(StringBuilder buffer)

Specified by:

appendBodyToString in class Pdu