com.cloudhopper.smpp.util

Class DeliveryReceipt

java.lang.Object

com.cloudhopper.smpp.util.DeliveryReceipt

public class DeliveryReceipt
extends Object

Utility class to represent a Delivery Receipt that may be contained within a DataSm or DeliverSm PDU. A delivery receipt has a specific message text and a few specific optional parameters.

If the setRawErrorCode(String) method takes in a String that is not parseable to an int via Integer.parseInt(String) then the errorCode property will remain what it was originally set as, default(int) or in the case of parseShortMessage(String, DateTimeZone) -1.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_DLVRD
static String	FIELD_DONE_DATE
static String	FIELD_ERR
static int	FIELD_ERR_MAX_LEN
static String	FIELD_ID
static String	FIELD_STAT
static String	FIELD_SUB
static String	FIELD_SUBMIT_DATE
static String	FIELD_TEXT

Constructor Summary

Constructors

Constructor and Description
DeliveryReceipt()
DeliveryReceipt(String messageId, int submitCount, int deliveredCount, org.joda.time.DateTime submitDate, org.joda.time.DateTime doneDate, byte state, int errorCode, String text)
DeliveryReceipt(String messageId, int submitCount, int deliveredCount, org.joda.time.DateTime submitDate, org.joda.time.DateTime doneDate, byte state, String errorCode, String text)

Method Summary

Methods

Modifier and Type	Method and Description
static void	findFieldAndAddToTreeMap(String normalizedText, String field, TreeMap<Integer,String> fieldsByStartPos)
int	getDeliveredCount()
org.joda.time.DateTime	getDoneDate()
int	getErrorCode()
String	getMessageId()
long	getMessageIdAsLong()
String	getRawErrorCode()
byte	getState()
int	getSubmitCount()
org.joda.time.DateTime	getSubmitDate()
String	getText()
static DeliveryReceipt	parseShortMessage(String shortMessage, org.joda.time.DateTimeZone zone)
static DeliveryReceipt	parseShortMessage(String shortMessage, org.joda.time.DateTimeZone zone, boolean checkMissingFields) Parses the text of the short message and creates a DeliveryReceipt from the fields.
void	setDeliveredCount(int deliveredCount)
void	setDoneDate(org.joda.time.DateTime finalDate)
void	setErrorCode(int errorCode)
void	setMessageId(long messageId) Sets the "id" field parameter as a long value that is zero padded to 10 digits.
void	setMessageId(String messageId) Sets the "id" field to the exact String we'll use.
void	setRawErrorCode(String rawErrorCode) Smpp 3.4 spec states that the "err" field is a <= 3 c-octet string, this field takes that into account and will be chained with the setErrorCode(int) field if the "err" field is valid
void	setState(byte state)
void	setSubmitCount(int submitCount)
void	setSubmitDate(org.joda.time.DateTime submitDate)
void	setText(String text)
static String	toMessageIdAsHexString(long value) Converts a long value to a hex string.
static long	toMessageIdAsLong(String value) Converts a hex string to a long value.
String	toShortMessage()
static byte	toState(String stateText)
static String	toStateText(byte state)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_ERR_MAX_LEN

public static final int FIELD_ERR_MAX_LEN

See Also:

Constant Field Values

FIELD_ID

public static final String FIELD_ID

See Also:

Constant Field Values

FIELD_SUB

public static final String FIELD_SUB

See Also:

Constant Field Values

FIELD_DLVRD

public static final String FIELD_DLVRD

See Also:

Constant Field Values

FIELD_SUBMIT_DATE

public static final String FIELD_SUBMIT_DATE

See Also:

Constant Field Values

FIELD_DONE_DATE

public static final String FIELD_DONE_DATE

See Also:

Constant Field Values

FIELD_STAT

public static final String FIELD_STAT

See Also:

Constant Field Values

FIELD_ERR

public static final String FIELD_ERR

See Also:

Constant Field Values

FIELD_TEXT

public static final String FIELD_TEXT

See Also:

Constant Field Values

Constructor Detail

DeliveryReceipt

public DeliveryReceipt()

DeliveryReceipt

public DeliveryReceipt(String messageId,
               int submitCount,
               int deliveredCount,
               org.joda.time.DateTime submitDate,
               org.joda.time.DateTime doneDate,
               byte state,
               int errorCode,
               String text)

DeliveryReceipt

public DeliveryReceipt(String messageId,
               int submitCount,
               int deliveredCount,
               org.joda.time.DateTime submitDate,
               org.joda.time.DateTime doneDate,
               byte state,
               String errorCode,
               String text)

Method Detail

getDeliveredCount

public int getDeliveredCount()

setDeliveredCount

public void setDeliveredCount(int deliveredCount)

getErrorCode

public int getErrorCode()

setErrorCode

public void setErrorCode(int errorCode)

getRawErrorCode

public String getRawErrorCode()

setRawErrorCode

public void setRawErrorCode(String rawErrorCode)

Smpp 3.4 spec states that the "err" field is a <= 3 c-octet string, this field takes that into account and will be chained with the setErrorCode(int) field if the "err" field is valid

Parameters:

rawErrorCode -

getDoneDate

public org.joda.time.DateTime getDoneDate()

setDoneDate

public void setDoneDate(org.joda.time.DateTime finalDate)

getMessageId

public String getMessageId()

getMessageIdAsLong

public long getMessageIdAsLong()
                        throws NumberFormatException

Throws:

NumberFormatException

setMessageId

public void setMessageId(String messageId)

Sets the "id" field to the exact String we'll use. Utility method provided for setting this value as a long.

Parameters:

messageId -

setMessageId

public void setMessageId(long messageId)

Sets the "id" field parameter as a long value that is zero padded to 10 digits.

Parameters:

messageId -

getState

public byte getState()

setState

public void setState(byte state)

getSubmitCount

public int getSubmitCount()

setSubmitCount

public void setSubmitCount(int submitCount)

getSubmitDate

public org.joda.time.DateTime getSubmitDate()

setSubmitDate

public void setSubmitDate(org.joda.time.DateTime submitDate)

getText

public String getText()

setText

public void setText(String text)

toShortMessage

public String toShortMessage()

toString

public String toString()

Overrides:

toString in class Object

findFieldAndAddToTreeMap

public static void findFieldAndAddToTreeMap(String normalizedText,
                            String field,
                            TreeMap<Integer,String> fieldsByStartPos)

parseShortMessage

public static DeliveryReceipt parseShortMessage(String shortMessage,
                                org.joda.time.DateTimeZone zone)
                                         throws DeliveryReceiptException

Throws:

DeliveryReceiptException

parseShortMessage

public static DeliveryReceipt parseShortMessage(String shortMessage,
                                org.joda.time.DateTimeZone zone,
                                boolean checkMissingFields)
                                         throws DeliveryReceiptException

Parses the text of the short message and creates a DeliveryReceipt from the fields. This method is lenient as possible. The order of the fields does not matter, as well as permitting some fields to be optional.

Parameters:

shortMessage -

zone -

Returns:

Throws:

DeliveryReceiptException

toState

public static byte toState(String stateText)

toStateText

public static String toStateText(byte state)

toMessageIdAsHexString

public static String toMessageIdAsHexString(long value)

Converts a long value to a hex string. E.g. 98765432101L to "16fee0e525"

Parameters:

value -

Returns:

toMessageIdAsLong

public static long toMessageIdAsLong(String value)
                              throws NumberFormatException

Converts a hex string to a long value. E.g. "16fee0e525" to 98765432101L

Parameters:

value -

Returns:

Throws:

NumberFormatException