net.java.slee.resources.smpp.pdu
Class Tag

java.lang.Object
  net.java.slee.resources.smpp.pdu.Tag

public final class Tag
extends java.lang.Object

TLV fields may be optionally included in a SMPP message. For a particular SMPP PDU, the ESME or MC may include some, all or none of the defined TLVs as required for the particular application context. For example a paging system may in a SMPP submit_sm operation, include only the “call-back number” related TLVs.

For further details look at Section 4.8 PDU TLV Definitions from SMPP Specs v 5.0

This is the Tag definitions

Author:

amit bhayani

Field Summary

static Tag	ADDITIONAL_STATUS_INFO_TEXT The additional_status_info_text parameter gives an ASCII textual description of the meaning of a response PDU.
static Tag	ALERT_ON_MESSAGE_DELIVERY The alert_on_message_delivery parameter is set to instruct a SMSC to alert the user (in a MS implementation specific manner) when the short message arrives at the MS.
static Tag	BILLING_IDENTIFICATION Billing information
static Tag	BROADCAST_AREA_IDENTIFIER The broadcast_area_identifier defines the Broadcast Area in terms of a geographical descriptor.
static Tag	BROADCAST_AREA_SUCCESS The broadcast_area_success parameter is a success rate indicator, defined as the ratio of the number of BTSs who accepted the message and the total number of BTSs who should accept the message, for a particular broadcast_area_identifier.
static Tag	BROADCAST_CHANNEL_INDICATOR The broadcast_channel_indicator parameter specifies the Cell Broadcast channel that should be used for broadcasting the message.
static Tag	BROADCAST_CONTENT_TYPE The broadcast_content_type parameter specifies the content_type of the message content.
static Tag	BROADCAST_CONTENT_TYPE_INFO The broadcast_content_type_info parameter contains additional information specific to the broadcast_content_type.
static Tag	BROADCAST_END_TIME The broadcast_end_time parameter indicates the date and time at which the broadcasting state of this message was set to terminated in the Message Centre.
static Tag	BROADCAST_ERROR_STATUS The broadcast_error_status parameter specifies the nature of the failure associated with a particular broadcast_area_identifier specified in a broadcast request.
static Tag	BROADCAST_FREQUENCY_INTERVAL The broadcast_frequency_interval parameter specifies the frequency interval at which the broadcasts of a message should be repeated.
static Tag	BROADCAST_MESSAGE_CLASS The broadcast_message_class parameter is used to route messages when received by a mobile station to user-defined destinations or to Terminal Equipment.
static Tag	BROADCAST_REP_NUM This field indicates the number of repeated broadcasts requested by the Submitter.
static Tag	BROADCAST_SERVICE_GROUP The broadcast_service_group parameter is used to specify special target groups for broadcast information.
static Tag	CALLBACK_NUM The callback_num parameter associates a call back number with the message.
static Tag	CALLBACK_NUM_ATAG The callback_num_atag parameter associates an alphanumeric display with the call back number.
static Tag	CALLBACK_NUM_PRES_IND This parameter controls the presentation indication and screening of the CallBackNumber at the mobile station.
static Tag	CONGESTION_STATE The congestion_state parameter is used to pass congestion status information between ESME and SMSC as a means of providing flow control and congestion avoidance capabilities to the sending peer.
static Tag	DELIVERY_FAILURE_REASON The delivery_failure_reason parameter is used in the data_sm_resp operation to indicate the outcome of the message delivery attempt (only applicable for transaction message mode).
static Tag	DEST_ADDR_NP_COUNTRY The dest_addr_np_country TLV is used to carry E.164 information relating to the operator country code.
static Tag	DEST_ADDR_NP_INFORMATION The dest_addr_np_information TLV is used to carry number portability information.
static Tag	DEST_ADDR_NP_RESOLUTION The dest_addr_np_resolution TLV is used to pass an indicator relating to a number portability query.
static Tag	DEST_ADDR_SUBUNIT The dest_addr_subunit parameter is used to route messages when received by a mobile station, for example to a smart card in the mobile station or to an external device connected to the mobile station.
static Tag	DEST_BEARER_TYPE The dest_bearer_type parameter is used to request the desired bearer for delivery of the message to the destination address.
static Tag	DEST_NETWORK_ID The dest_network_id assigned to a wireless network operator or ESME operator is a unique address that may be derived and assigned by the node owner without establishing a central assignment and management authority.
static Tag	DEST_NETWORK_TYPE The dest_network_type parameter is used to indicate a network type associated with the destination address of a message.
static Tag	DEST_NODE_ID The dest_node_id is a unique number assigned within a single ESME or SMSC network and must uniquely identify a destination node within the context of the MC or ESME.
static Tag	DEST_PORT The dest_port parameter is used to indicate the application port number associated with the destination address of the message.
static Tag	DEST_SUBADDRESS The dest_subaddress parameter specifies a subaddress associated with the destination of the message.
static Tag	DEST_TELEMATICS_ID This parameter defines the telematic interworking to be used by the delivering system for the destination address.
static Tag	DISPLAY_TIME The display_time parameter is used to associate a display time of the short message on the MS.
static Tag	DPF_RESULT The dpf_result parameter is used to indicate if delivery pending flag (DPF) was set for a delivery failure of a short message.
static Tag	ITS_REPLY_TYPE The its_reply_type parameter is a required parameter for the CDMA Interactive Teleservice as defined by the Korean PCS carriers [KORITS].
static Tag	ITS_SESSION_INFO The its_session_info parameter is a required parameter for the CDMA Interactive Teleservice as defined by the Korean PCS carriers [KORITS].
static Tag	LANGUAGE_INDICATOR The language_indicator parameter is used to indicate the language of the short message.
static Tag	MESSAGE_PAYLOAD The message_payload parameter contains the user data.
static Tag	MESSAGE_STATE The message_state TLV is used by the MC in the deliver_sm and data_sm PDUs to indicate to the ESME the final message state for a MC Delivery Receipt.
static Tag	MORE_MESSAGES_TO_SEND The more_messages_to_send parameter is used by the ESME in the submit_sm and data_sm operations to indicate to the MC that there are further messages for the same destination SME.
static Tag	MS_AVAILABILITY_STATUS The ms_availability_status parameter is used in the alert_notification operation to indicate the availability state of the MS to the ESME.
static Tag	MS_MSG_WAIT_FACILITIES The ms_msg_wait_facilities parameter allows an indication to be provided to an MS that there are messages waiting for the subscriber on systems on the PLMN.
static Tag	MS_VALIDITY The ms_validity parameter is used to provide an MS with validity information associated with the received short message.
static Tag	NETWORK_ERROR_CODE The network_error_code parameter is used to indicate the actual network error code for a delivery failure.
static Tag	NUMBER_OF_MESSAGES The number_of_messages parameter is used to indicate the number of messages stored in a mailbox.
static Tag	PAYLOAD_TYPE The payload_type parameter defines the higher layer PDU type contained in the message payload.
static Tag	PRIVACY_INDICATOR The privacy_indicator indicates the privacy level of the message.
static Tag	QOS_TIME_TO_LIVE This parameter defines the number of seconds which the sender requests the MC to keep the message if undelivered before it is deemed expired.
static Tag	RECEIPTED_MESSAGE_ID
static Tag	SAR_MSG_REF_NUM
static Tag	SAR_SEGMENT_SEQNUM
static Tag	SAR_TOTAL_SEGMENTS
static Tag	SC_INTERFACE_VERSION
static Tag	SET_DPF
static Tag	SMS_SIGNAL
static Tag	SOURCE_ADDR_SUBUNIT
static Tag	SOURCE_BEARER_TYPE
static Tag	SOURCE_NETWORK_ID
static Tag	SOURCE_NETWORK_TYPE
static Tag	SOURCE_NODE_ID
static Tag	SOURCE_PORT
static Tag	SOURCE_SUBADDRESS
static Tag	SOURCE_TELEMATICS_ID
static Tag	USER_MESSAGE_REFERENCE
static Tag	USER_RESPONSE_CODE
static Tag	USSD_SERVICE_OP

Constructor Summary

Tag(int tag)

Method Summary

boolean	equals(java.lang.Object obj)
int	getTag()
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ADDITIONAL_STATUS_INFO_TEXT

public static final Tag ADDITIONAL_STATUS_INFO_TEXT

The additional_status_info_text parameter gives an ASCII textual description of the meaning of a response PDU. It is to be used by an implementation to allow easy diagnosis of problems.

ALERT_ON_MESSAGE_DELIVERY

public static final Tag ALERT_ON_MESSAGE_DELIVERY

The alert_on_message_delivery parameter is set to instruct a SMSC to alert the user (in a MS implementation specific manner) when the short message arrives at the MS.

BILLING_IDENTIFICATION

public static final Tag BILLING_IDENTIFICATION

Billing information

BROADCAST_AREA_IDENTIFIER

public static final Tag BROADCAST_AREA_IDENTIFIER

The broadcast_area_identifier defines the Broadcast Area in terms of a geographical descriptor.

BROADCAST_AREA_SUCCESS

public static final Tag BROADCAST_AREA_SUCCESS

The broadcast_area_success parameter is a success rate indicator, defined as the ratio of the number of BTSs who accepted the message and the total number of BTSs who should accept the message, for a particular broadcast_area_identifier.

BROADCAST_CONTENT_TYPE_INFO

public static final Tag BROADCAST_CONTENT_TYPE_INFO

The broadcast_content_type_info parameter contains additional information specific to the broadcast_content_type.

BROADCAST_CHANNEL_INDICATOR

public static final Tag BROADCAST_CHANNEL_INDICATOR

The broadcast_channel_indicator parameter specifies the Cell Broadcast channel that should be used for broadcasting the message.

BROADCAST_CONTENT_TYPE

public static final Tag BROADCAST_CONTENT_TYPE

The broadcast_content_type parameter specifies the content_type of the message content.

BROADCAST_END_TIME

public static final Tag BROADCAST_END_TIME

The broadcast_end_time parameter indicates the date and time at which the broadcasting state of this message was set to terminated in the Message Centre.

BROADCAST_ERROR_STATUS

public static final Tag BROADCAST_ERROR_STATUS

The broadcast_error_status parameter specifies the nature of the failure associated with a particular broadcast_area_identifier specified in a broadcast request.

BROADCAST_FREQUENCY_INTERVAL

public static final Tag BROADCAST_FREQUENCY_INTERVAL

The broadcast_frequency_interval parameter specifies the frequency interval at which the broadcasts of a message should be repeated.

BROADCAST_MESSAGE_CLASS

public static final Tag BROADCAST_MESSAGE_CLASS

The broadcast_message_class parameter is used to route messages when received by a mobile station to user-defined destinations or to Terminal Equipment.

BROADCAST_REP_NUM

public static final Tag BROADCAST_REP_NUM

This field indicates the number of repeated broadcasts requested by the Submitter.

BROADCAST_SERVICE_GROUP

public static final Tag BROADCAST_SERVICE_GROUP

The broadcast_service_group parameter is used to specify special target groups for broadcast information.

CALLBACK_NUM

public static final Tag CALLBACK_NUM

The callback_num parameter associates a call back number with the message. In TDMA networks, it is possible to send and receive multiple call-back numbers to/from TDMA mobile stations.

CALLBACK_NUM_ATAG

public static final Tag CALLBACK_NUM_ATAG

The callback_num_atag parameter associates an alphanumeric display with the call back number.

CALLBACK_NUM_PRES_IND

public static final Tag CALLBACK_NUM_PRES_IND

This parameter controls the presentation indication and screening of the CallBackNumber at the mobile station.

CONGESTION_STATE

public static final Tag CONGESTION_STATE

The congestion_state parameter is used to pass congestion status information between ESME and SMSC as a means of providing flow control and congestion avoidance capabilities to the sending peer. The TLV can be used in any SMPP operation response PDU as a means of passing congestion status from one peer to another. Typical uses of this would be in submit_sm/submit_sm_resp sequences where an ESME would drive a batch of submissions at a high rate and use continual tracking of the returned congestion_state values as a means of gauging the congestion. Reaction to a variation in congestion_state would involve increasing/decreasing the rate as required to maintain the balance in the Optimum range.

DELIVERY_FAILURE_REASON

public static final Tag DELIVERY_FAILURE_REASON

The delivery_failure_reason parameter is used in the data_sm_resp operation to indicate the outcome of the message delivery attempt (only applicable for transaction message mode). If a delivery failure due to a network error is indicated, the ESME may check the network_error_code parameter (if present) for the actual network error code.

DEST_ADDR_NP_COUNTRY

public static final Tag DEST_ADDR_NP_COUNTRY

The dest_addr_np_country TLV is used to carry E.164 information relating to the operator country code.

DEST_ADDR_NP_INFORMATION

public static final Tag DEST_ADDR_NP_INFORMATION

The dest_addr_np_information TLV is used to carry number portability information.

DEST_ADDR_NP_RESOLUTION

public static final Tag DEST_ADDR_NP_RESOLUTION

The dest_addr_np_resolution TLV is used to pass an indicator relating to a number portability query. If this TLV is omitted, the default value is assumed.

DEST_ADDR_SUBUNIT

public static final Tag DEST_ADDR_SUBUNIT

The dest_addr_subunit parameter is used to route messages when received by a mobile station, for example to a smart card in the mobile station or to an external device connected to the mobile station.

DEST_BEARER_TYPE

public static final Tag DEST_BEARER_TYPE

The dest_bearer_type parameter is used to request the desired bearer for delivery of the message to the destination address. In the case that the receiving system (e.g. MC) does not support the indicated bearer type, it may treat this a failure and return a response PDU reporting a failure.

DEST_NETWORK_ID

public static final Tag DEST_NETWORK_ID

The dest_network_id assigned to a wireless network operator or ESME operator is a unique address that may be derived and assigned by the node owner without establishing a central assignment and management authority. When this TLV is specified, it must be accompanied with a dest_node_id TLV

DEST_NETWORK_TYPE

public static final Tag DEST_NETWORK_TYPE

The dest_network_type parameter is used to indicate a network type associated with the destination address of a message. In the case that the receiving system (e.g. MC) does not support the indicated network type, it may treat this a failure and return a response PDU reporting a failure.

DEST_NODE_ID

public static final Tag DEST_NODE_ID

The dest_node_id is a unique number assigned within a single ESME or SMSC network and must uniquely identify a destination node within the context of the MC or ESME. The content of a dest_node_id is comprised of decimal digits and is at the discretion of the owning ESME or MC.

DEST_SUBADDRESS

public static final Tag DEST_SUBADDRESS

The dest_subaddress parameter specifies a subaddress associated with the destination of the message.

DEST_TELEMATICS_ID

public static final Tag DEST_TELEMATICS_ID

This parameter defines the telematic interworking to be used by the delivering system for the destination address. This is only useful when a specific dest_bearer_type parameter has also been specified, as the value is bearer dependent. In the case that the receiving system (e.g. SMSC) does not support the indicated telematic interworking, it may treat this a failure and return a response PDU reporting a failure.

DEST_PORT

public static final Tag DEST_PORT

The dest_port parameter is used to indicate the application port number associated with the destination address of the message.

DISPLAY_TIME

public static final Tag DISPLAY_TIME

The display_time parameter is used to associate a display time of the short message on the MS.

DPF_RESULT

public static final Tag DPF_RESULT

The dpf_result parameter is used to indicate if delivery pending flag (DPF) was set for a delivery failure of a short message.

When used in conjunction with transaction mode, dpf_result can be returned in a submit_sm_resp or data_sm_resp PDU. Where store and forward or datagram modes are used in the original submission, dpf_result may be returned as part of a delivery receipt in the form of a deliver_sm or data_sm PDU.

If the dpf_result parameter is not returned, then the ESME should assume that DPF is not set.

ITS_REPLY_TYPE

public static final Tag ITS_REPLY_TYPE

The its_reply_type parameter is a required parameter for the CDMA Interactive Teleservice as defined by the Korean PCS carriers [KORITS]. It indicates and controls the MS user’s reply method to an SMS delivery message received from the ESME.

ITS_SESSION_INFO

public static final Tag ITS_SESSION_INFO

The its_session_info parameter is a required parameter for the CDMA Interactive Teleservice as defined by the Korean PCS carriers [KORITS]. It contains control information for the interactive session between an MS and an ESME.

LANGUAGE_INDICATOR

public static final Tag LANGUAGE_INDICATOR

The language_indicator parameter is used to indicate the language of the short message.

MESSAGE_PAYLOAD

public static final Tag MESSAGE_PAYLOAD

The message_payload parameter contains the user data. Its function is to provide an alternative means of carrying text lengths above the 255 octet limit of the short_message field.

Applications, which need to send messages longer than 255 octets, should use the message_payload TLV. When used in the context of a submit_sm PDU, the sm_length field should be set to zero.

MESSAGE_STATE

public static final Tag MESSAGE_STATE

The message_state TLV is used by the MC in the deliver_sm and data_sm PDUs to indicate to the ESME the final message state for a MC Delivery Receipt. The message_state TLV is also returned by the MC to the ESME as part of the query_broadcast_sm_resp PDU.

MORE_MESSAGES_TO_SEND

public static final Tag MORE_MESSAGES_TO_SEND

The more_messages_to_send parameter is used by the ESME in the submit_sm and data_sm operations to indicate to the MC that there are further messages for the same destination SME. The MC may use this setting for network resource optimisation.

MS_AVAILABILITY_STATUS

public static final Tag MS_AVAILABILITY_STATUS

The ms_availability_status parameter is used in the alert_notification operation to indicate the availability state of the MS to the ESME.

If the SMSC does not include the parameter in the alert_notification operation, the ESME should assume that the MS is in an “available” state.

MS_MSG_WAIT_FACILITIES

public static final Tag MS_MSG_WAIT_FACILITIES

The ms_msg_wait_facilities parameter allows an indication to be provided to an MS that there are messages waiting for the subscriber on systems on the PLMN. The indication can be an icon on the MS screen or other MMI indication.

The ms_msg_wait_facilities can also specify the type of message associated with the message waiting indication.

MS_VALIDITY

public static final Tag MS_VALIDITY

The ms_validity parameter is used to provide an MS with validity information associated with the received short message.

NETWORK_ERROR_CODE

public static final Tag NETWORK_ERROR_CODE

The network_error_code parameter is used to indicate the actual network error code for a delivery failure. The network error code is technology specific.

NUMBER_OF_MESSAGES

public static final Tag NUMBER_OF_MESSAGES

The number_of_messages parameter is used to indicate the number of messages stored in a mailbox.

PAYLOAD_TYPE

public static final Tag PAYLOAD_TYPE

The payload_type parameter defines the higher layer PDU type contained in the message payload.

PRIVACY_INDICATOR

public static final Tag PRIVACY_INDICATOR

The privacy_indicator indicates the privacy level of the message.

QOS_TIME_TO_LIVE

public static final Tag QOS_TIME_TO_LIVE

This parameter defines the number of seconds which the sender requests the MC to keep the message if undelivered before it is deemed expired. If the parameter is not present, the MC may apply a default value

RECEIPTED_MESSAGE_ID

public static final Tag RECEIPTED_MESSAGE_ID

SAR_MSG_REF_NUM

public static final Tag SAR_MSG_REF_NUM

SAR_SEGMENT_SEQNUM

public static final Tag SAR_SEGMENT_SEQNUM

SAR_TOTAL_SEGMENTS

public static final Tag SAR_TOTAL_SEGMENTS

SC_INTERFACE_VERSION

public static final Tag SC_INTERFACE_VERSION

SET_DPF

public static final Tag SET_DPF

SMS_SIGNAL

public static final Tag SMS_SIGNAL

SOURCE_ADDR_SUBUNIT

public static final Tag SOURCE_ADDR_SUBUNIT

SOURCE_BEARER_TYPE

public static final Tag SOURCE_BEARER_TYPE

SOURCE_NETWORK_ID

public static final Tag SOURCE_NETWORK_ID

SOURCE_NETWORK_TYPE

public static final Tag SOURCE_NETWORK_TYPE

SOURCE_NODE_ID

public static final Tag SOURCE_NODE_ID

SOURCE_PORT

public static final Tag SOURCE_PORT

SOURCE_SUBADDRESS

public static final Tag SOURCE_SUBADDRESS

SOURCE_TELEMATICS_ID

public static final Tag SOURCE_TELEMATICS_ID

USER_MESSAGE_REFERENCE

public static final Tag USER_MESSAGE_REFERENCE

USER_RESPONSE_CODE

public static final Tag USER_RESPONSE_CODE

USSD_SERVICE_OP

public static final Tag USSD_SERVICE_OP

Constructor Detail

Tag

public Tag(int tag)

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getTag

public int getTag()