com.objectxp.msg
Class SmppOptionalParameter

java.lang.Object
  com.objectxp.msg.SmppOptionalParameter

public class SmppOptionalParameter
extends java.lang.Object

This class represents a SMPP TLV field. TLV's are used for providing additional parameters to SMPP PDU's.

Have a look at the SMPP Specification (available at www.smsforum.org) for more information about TLV.

Field Summary

static int	TAG_ADDITIONAL_STATUS_INFO_TEXT
static int	TAG_ALERT_ON_MESSAGE_DELIVERY
static int	TAG_CALLBACK_NUM
static int	TAG_CALLBACK_NUM_ATAG
static int	TAG_CALLBACK_NUM_PRES_IND
static int	TAG_DELIVERY_FAILURE_REASON
static int	TAG_DEST_ADDR_SUBUNIT
static int	TAG_DEST_BEARER_TYPE
static int	TAG_DEST_NETWORK_TYPE
static int	TAG_DEST_SUBADDRESS
static int	TAG_DEST_TELEMATICS_ID
static int	TAG_DESTINATION_PORT
static int	TAG_DISPLAY_TIME
static int	TAG_DPF_RESULT
static int	TAG_ITS_REPLY_TYPE
static int	TAG_ITS_SESSION_INFO
static int	TAG_LANGUAGE_INDICATOR
static int	TAG_MESSAGE_PAYLOAD
static int	TAG_MESSAGE_STATE
static int	TAG_MORE_MESSAGES_TO_SEND
static int	TAG_MS_AVAILABILITY_STATUS
static int	TAG_MS_MSG_WAIT_FACILITIES
static int	TAG_MS_VALIDITY
static int	TAG_NETWORK_ERROR_CODE
static int	TAG_NUMBER_OF_MESSAGES
static int	TAG_PAYLOAD_TYPE
static int	TAG_PRIVACY_INDICATOR
static int	TAG_QOS_TIME_TO_LIVE
static int	TAG_RECEIPTED_MESSAGE_ID
static int	TAG_SAR_MSG_REF_NUM
static int	TAG_SAR_SEGMENT_SEQNUM
static int	TAG_SAR_TOTAL_SEGMENTS
static int	TAG_SC_INTERFACE_VERSION
static int	TAG_SET_DPF
static int	TAG_SMS_SIGNAL
static int	TAG_SOURCE_ADDR_SUBUNIT
static int	TAG_SOURCE_BEARER_TYPE
static int	TAG_SOURCE_NETWORK_TYPE
static int	TAG_SOURCE_PORT
static int	TAG_SOURCE_SUBADDRESS
static int	TAG_SOURCE_TELEMATICS_ID
static int	TAG_USER_MESSAGE_REFERENCE
static int	TAG_USER_RESPONSE_CODE
static int	TAG_USSD_SERVICE_OP

Constructor Summary

SmppOptionalParameter(int tag, byte[] value)
Construct a new TLV.

SmppOptionalParameter(int tag, int value, int size)
Construct a TLV using an unsigned integer value, which can be 1, 2 or 4 octets in size.

SmppOptionalParameter(int tag, java.lang.String value)
Construct a TLV using a String.

Method Summary

int	getLength() Returns the length of the TLV data
int	getTag() Returns the Tag.
byte[]	getValue() Returns the TLV value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TAG_DEST_ADDR_SUBUNIT

public static final int TAG_DEST_ADDR_SUBUNIT

See Also:

Constant Field Values

TAG_DEST_NETWORK_TYPE

public static final int TAG_DEST_NETWORK_TYPE

See Also:

Constant Field Values

TAG_DEST_BEARER_TYPE

public static final int TAG_DEST_BEARER_TYPE

See Also:

Constant Field Values

TAG_DEST_TELEMATICS_ID

public static final int TAG_DEST_TELEMATICS_ID

See Also:

Constant Field Values

TAG_SOURCE_ADDR_SUBUNIT

public static final int TAG_SOURCE_ADDR_SUBUNIT

See Also:

Constant Field Values

TAG_SOURCE_NETWORK_TYPE

public static final int TAG_SOURCE_NETWORK_TYPE

See Also:

Constant Field Values

TAG_SOURCE_BEARER_TYPE

public static final int TAG_SOURCE_BEARER_TYPE

See Also:

Constant Field Values

TAG_SOURCE_TELEMATICS_ID

public static final int TAG_SOURCE_TELEMATICS_ID

See Also:

Constant Field Values

TAG_QOS_TIME_TO_LIVE

public static final int TAG_QOS_TIME_TO_LIVE

See Also:

Constant Field Values

TAG_PAYLOAD_TYPE

public static final int TAG_PAYLOAD_TYPE

See Also:

Constant Field Values

TAG_ADDITIONAL_STATUS_INFO_TEXT

public static final int TAG_ADDITIONAL_STATUS_INFO_TEXT

See Also:

Constant Field Values

TAG_RECEIPTED_MESSAGE_ID

public static final int TAG_RECEIPTED_MESSAGE_ID

See Also:

Constant Field Values

TAG_MS_MSG_WAIT_FACILITIES

public static final int TAG_MS_MSG_WAIT_FACILITIES

See Also:

Constant Field Values

TAG_PRIVACY_INDICATOR

public static final int TAG_PRIVACY_INDICATOR

See Also:

Constant Field Values

TAG_SOURCE_SUBADDRESS

public static final int TAG_SOURCE_SUBADDRESS

See Also:

Constant Field Values

TAG_DEST_SUBADDRESS

public static final int TAG_DEST_SUBADDRESS

See Also:

Constant Field Values

TAG_USER_MESSAGE_REFERENCE

public static final int TAG_USER_MESSAGE_REFERENCE

See Also:

Constant Field Values

TAG_USER_RESPONSE_CODE

public static final int TAG_USER_RESPONSE_CODE

See Also:

Constant Field Values

TAG_SOURCE_PORT

public static final int TAG_SOURCE_PORT

See Also:

Constant Field Values

TAG_DESTINATION_PORT

public static final int TAG_DESTINATION_PORT

See Also:

Constant Field Values

TAG_SAR_MSG_REF_NUM

public static final int TAG_SAR_MSG_REF_NUM

See Also:

Constant Field Values

TAG_LANGUAGE_INDICATOR

public static final int TAG_LANGUAGE_INDICATOR

See Also:

Constant Field Values

TAG_SAR_TOTAL_SEGMENTS

public static final int TAG_SAR_TOTAL_SEGMENTS

See Also:

Constant Field Values

TAG_SAR_SEGMENT_SEQNUM

public static final int TAG_SAR_SEGMENT_SEQNUM

See Also:

Constant Field Values

TAG_SC_INTERFACE_VERSION

public static final int TAG_SC_INTERFACE_VERSION

See Also:

Constant Field Values

TAG_CALLBACK_NUM_PRES_IND

public static final int TAG_CALLBACK_NUM_PRES_IND

See Also:

Constant Field Values

TAG_CALLBACK_NUM_ATAG

public static final int TAG_CALLBACK_NUM_ATAG

See Also:

Constant Field Values

TAG_NUMBER_OF_MESSAGES

public static final int TAG_NUMBER_OF_MESSAGES

See Also:

Constant Field Values

TAG_CALLBACK_NUM

public static final int TAG_CALLBACK_NUM

See Also:

Constant Field Values

TAG_DPF_RESULT

public static final int TAG_DPF_RESULT

See Also:

Constant Field Values

TAG_SET_DPF

public static final int TAG_SET_DPF

See Also:

Constant Field Values

TAG_MS_AVAILABILITY_STATUS

public static final int TAG_MS_AVAILABILITY_STATUS

See Also:

Constant Field Values

TAG_NETWORK_ERROR_CODE

public static final int TAG_NETWORK_ERROR_CODE

See Also:

Constant Field Values

TAG_MESSAGE_PAYLOAD

public static final int TAG_MESSAGE_PAYLOAD

See Also:

Constant Field Values

TAG_DELIVERY_FAILURE_REASON

public static final int TAG_DELIVERY_FAILURE_REASON

See Also:

Constant Field Values

TAG_MORE_MESSAGES_TO_SEND

public static final int TAG_MORE_MESSAGES_TO_SEND

See Also:

Constant Field Values

TAG_MESSAGE_STATE

public static final int TAG_MESSAGE_STATE

See Also:

Constant Field Values

TAG_USSD_SERVICE_OP

public static final int TAG_USSD_SERVICE_OP

See Also:

Constant Field Values

TAG_DISPLAY_TIME

public static final int TAG_DISPLAY_TIME

See Also:

Constant Field Values

TAG_SMS_SIGNAL

public static final int TAG_SMS_SIGNAL

See Also:

Constant Field Values

TAG_MS_VALIDITY

public static final int TAG_MS_VALIDITY

See Also:

Constant Field Values

TAG_ALERT_ON_MESSAGE_DELIVERY

public static final int TAG_ALERT_ON_MESSAGE_DELIVERY

See Also:

Constant Field Values

TAG_ITS_REPLY_TYPE

public static final int TAG_ITS_REPLY_TYPE

See Also:

Constant Field Values

TAG_ITS_SESSION_INFO

public static final int TAG_ITS_SESSION_INFO

See Also:

Constant Field Values

Constructor Detail

SmppOptionalParameter

public SmppOptionalParameter(int tag,
                             byte[] value)

Construct a new TLV.

Parameters:

tag - the Tag

value - the value

SmppOptionalParameter

public SmppOptionalParameter(int tag,
                             int value,
                             int size)

Construct a TLV using an unsigned integer value, which can be 1, 2 or 4 octets in size. The octets are always encoded in Most Significant Byte (MSB) first order, otherwise known as Big Endian Encoding.

Parameters:

tag - the Tag

value - the Integer value.

size - the size of the integer in octets (1, 2, 4)

SmppOptionalParameter

public SmppOptionalParameter(int tag,
                             java.lang.String value)

Construct a TLV using a String. The string will be converted to a C-Style string (zero-terminated) using the current locale.

Parameters:

tag - the Tag

value - the Value

Method Detail

getLength

public int getLength()

Returns the length of the TLV data

getTag

public int getTag()

Returns the Tag.

getValue

public byte[] getValue()

Returns the TLV value.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object