Package org.apache.camel.component.smpp

Interface SmppConstants

  • public interface SmppConstants
    Constants used in Camel SMPP module

    • Field Detail

      • ALPHABET

        @Metadata(label="producer",
          description="*For SubmitSm, SubmitMulti and ReplaceSm*  The data\ncoding according to the SMPP 3.4 specification, section 5.2.19. Use the\nURI option `alphabet` settings above.",
          javaType="Byte")
static final String ALPHABET
        See Also:
        Constant Field Values

      • COMMAND_ID

        @Metadata(label="consumer",
          description="*only for AlertNotification, DeliverSm and DataSm* The command id field\nidentifies the particular SMPP PDU. For the complete list of defined\nvalues see chapter 5.1.2.1 in the smpp specification v3.4.",
          javaType="Integer")
static final String COMMAND_ID
        See Also:
        Constant Field Values

      • COMMAND_STATUS

        @Metadata(label="consumer",
          description="*only for DataSm* The Command status of the message.",
          javaType="Integer")
static final String COMMAND_STATUS
        See Also:
        Constant Field Values

      • DATA_CODING

        @Metadata(label="producer",
          description="*For SubmitSm, SubmitMulti and ReplaceSm*  The data\ncoding according to the SMPP 3.4 specification, section 5.2.19. Use the\nURI option `alphabet` settings above.",
          javaType="Byte")
static final String DATA_CODING
        See Also:
        Constant Field Values

      • DATA_SPLITTER

        @Metadata(label="producer",
          description="The splitter",
          javaType="org.apache.camel.component.smpp.SmppSplitter")
static final String DATA_SPLITTER
        See Also:
        Constant Field Values

      • DELIVERED

        @Metadata(label="consumer",
          description="*only for smsc DeliveryReceipt* Number of short messages delivered. This\nis only relevant where the original message was submitted to a\ndistribution list.The value is padded with leading zeros if necessary.",
          javaType="Integer")
static final String DELIVERED
        See Also:
        Constant Field Values

      • DEST_ADDR

        @Metadata(description="*Producer:* *only for SubmitSm, SubmitMulti, CancelSm and DataSm* Defines the\ndestination SME address(es). For mobile terminated messages, this is the\ndirectory number of the recipient MS. It must be a `List<String>` for\nSubmitMulti and a `String` otherwise.\n*Consumer:* *only for DeliverSm and DataSm:* Defines the destination SME address.\nFor mobile terminated messages, this is the directory number of the\nrecipient MS.",
          javaType="List or String")
static final String DEST_ADDR
        See Also:
        Constant Field Values

      • DEST_ADDR_NPI

        @Metadata(description="*Producer:* *only for SubmitSm, SubmitMulti, CancelSm and DataSm* Defines the\nnumeric plan indicator (NPI) to be used in the SME destination address\nparameters. Use the URI option `sourceAddrNpi` values defined above.\n*Consumer:* *only for DataSm* Defines the numeric plan indicator (NPI) in the\ndestination address parameters. Use the URI option `sourceAddrNpi`\nvalues defined above.",
          javaType="Byte")
static final String DEST_ADDR_NPI
        See Also:
        Constant Field Values

      • DEST_ADDR_TON

        @Metadata(description="*Producer:* *only for SubmitSm, SubmitMulti, CancelSm and DataSm* Defines the type\nof number (TON) to be used in the SME destination address parameters.\nUse the `sourceAddrTon` URI option values defined above.\n*Consumer:* *only for DataSm* Defines the type of number (TON) in the destination\naddress parameters. Use the `sourceAddrTon` URI option values defined\nabove.",
          javaType="Byte")
static final String DEST_ADDR_TON
        See Also:
        Constant Field Values

      • DONE_DATE

        @Metadata(label="consumer",
          description="*only for smsc DeliveryReceipt* The time and date at which the short\nmessage reached it\'s final state. The format is as follows: YYMMDDhhmm.",
          javaType="Date")
static final String DONE_DATE
        See Also:
        Constant Field Values

      • ENCODING

        @Metadata(label="producer",
          description="*only for SubmitSm,\nSubmitMulti and DataSm*.  Specifies the encoding (character set name) of\nthe bytes in the message body.  If the message body is a string then\nthis is not relevant because Java Strings are always Unicode.  If the\nbody is a byte array then this header can be used to indicate that it is\nISO-8859-1 or some other value.  Default value is specified by the\nendpoint configuration parameter _encoding_",
          javaType="String")
static final String ENCODING
        See Also:
        Constant Field Values

      • ERROR

        @Metadata(description="*Producer:* *only for SubmitMultiSm* The errors which\noccurred by sending the short message(s) the form `Map<String, List<Map<String, Object>>>` (messageID : (destAddr :\naddress, error : errorCode)).\n*Consumer:* *only for smsc DeliveryReceipt* Where appropriate this may hold a\nNetwork specific error code or an SMSC error code for the attempted\ndelivery of the message. These errors are Network or SMSC specific and\nare not included here.",
          javaType="String or Map<String, List<Map<String, Object>>>")
static final String ERROR
        See Also:
        Constant Field Values

      • ESM_CLASS

        @Metadata(label="producer",
          description="the ASM class",
          javaType="org.jsmpp.bean.ESMClass")
static final String ESM_CLASS
        See Also:
        Constant Field Values

      • ESME_ADDR

        @Metadata(label="consumer",
          description="*only for AlertNotification* Defines the destination ESME address. For\nmobile terminated messages, this is the directory number of the\nrecipient MS.",
          javaType="String")
static final String ESME_ADDR
        See Also:
        Constant Field Values

      • ESME_ADDR_NPI

        @Metadata(label="consumer",
          description="*only for AlertNotification* Defines the numeric plan indicator (NPI) to\nbe used in the ESME originator address parameters. Use the URI option\n`sourceAddrNpi` values defined above.",
          javaType="Byte")
static final String ESME_ADDR_NPI
        See Also:
        Constant Field Values

      • ESME_ADDR_TON

        @Metadata(label="consumer",
          description="*only for AlertNotification* Defines the type of number (TON) to be used\nin the ESME originator address parameters. Use the `sourceAddrTon` URI\noption values defined above.",
          javaType="Byte")
static final String ESME_ADDR_TON
        See Also:
        Constant Field Values

      • FINAL_DATE

        @Metadata(label="producer",
          description="The final date",
          javaType="java.util.Date")
static final String FINAL_DATE
        See Also:
        Constant Field Values

      • FINAL_STATUS

        @Metadata(label="consumer",
          description="*only for smsc DeliveryReceipt:* The final status of the message.",
          javaType="org.jsmpp.util.DeliveryReceiptState")
static final String FINAL_STATUS
        See Also:
        Constant Field Values

      • ID

        @Metadata(description="*Producer:* The id to identify the submitted short message(s) for later use.\nIn case of a ReplaceSm, QuerySm, CancelSm and DataSm this\nheader value is a `String`. In case of a SubmitSm or SubmitMultiSm this\nheader value is a `List<String>`.\n*Consumer:* *only for smsc DeliveryReceipt and DataSm* The message ID allocated to\nthe message by the SMSC when originally submitted.",
          javaType="String or List<String>")
static final String ID
        See Also:
        Constant Field Values

      • MESSAGE_STATE

        @Metadata(label="producer",
          description="The message date",
          javaType="String")
static final String MESSAGE_STATE
        See Also:
        Constant Field Values

      • MESSAGE_TYPE

        @Metadata(label="consumer",
          description="Identifies the type of an incoming message:\n`AlertNotification`: an SMSC alert notification,\n`DataSm`: an SMSC data short message,\n`DeliveryReceipt`: an SMSC delivery receipt,\n`DeliverSm`: an SMSC deliver short message",
          javaType="String")
static final String MESSAGE_TYPE
        See Also:
        Constant Field Values

      • PRIORITY_FLAG

        @Metadata(label="producer",
          description="*only for SubmitSm and SubmitMulti* Allows the originating SME to assign\na priority level to the short message. Use the URI option `priorityFlag`\nsettings above.",
          javaType="Byte")
static final String PRIORITY_FLAG
        See Also:
        Constant Field Values

      • PROTOCOL_ID

        @Metadata(label="producer",
          description="The protocol id",
          javaType="Byte")
static final String PROTOCOL_ID
        See Also:
        Constant Field Values

      • REGISTERED_DELIVERY

        @Metadata(description="*Producer:* *only for SubmitSm, ReplaceSm, SubmitMulti and DataSm* Is used to\nrequest an SMSC delivery receipt and/or SME originated acknowledgements.\nUse the URI option `registeredDelivery` settings above.\n*Consumer:* *only for DataSm* Is used to request an delivery receipt and/or SME\noriginated acknowledgements. Same values as in Producer header list\nabove.",
          javaType="Byte")
static final String REGISTERED_DELIVERY
        See Also:
        Constant Field Values

      • SINGLE_DLR

        @Metadata(label="producer",
          description="*only for SubmitSm, SubmitMulti* Is used to\nrequest the SMSC delivery receipt only on the last segment of multi-segment (long) messages.\nUse the URI option `singleDLR` settings above.",
          javaType="Boolean")
static final String SINGLE_DLR
        See Also:
        Constant Field Values

      • REPLACE_IF_PRESENT_FLAG

        @Metadata(label="producer",
          description="*only for SubmitSm and SubmitMulti* The replace if present flag\nparameter is used to request the SMSC to replace a previously submitted\nmessage, that is still pending delivery. The SMSC will replace an\nexisting message provided that the source address, destination address\nand service type match the same fields in the new message. The following\nvalues are defined: `0`, Don\'t replace and `1`, Replace",
          javaType="Boolean")
static final String REPLACE_IF_PRESENT_FLAG
        See Also:
        Constant Field Values

      • SCHEDULE_DELIVERY_TIME

        @Metadata(description="*Producer:* only for SubmitSm, SubmitMulti and ReplaceSm* This parameter specifies\nthe scheduled time at which the message delivery should be first\nattempted. It defines either the absolute date and time or relative time\nfrom the current SMSC time at which delivery of this message will be\nattempted by the SMSC. It can be specified in either absolute time\nformat or relative time format. The encoding of a time format is\nspecified in chapter 7.1.1. in the smpp specification v3.4.\n*Consumer:* *only for DeliverSm:* This parameter specifies the scheduled time at\nwhich the message delivery should be first attempted. It defines either\nthe absolute date and time or relative time from the current SMSC time\nat which delivery of this message will be attempted by the SMSC. It can\nbe specified in either absolute time format or relative time format. The\nencoding of a time format is specified in Section 7.1.1. in the smpp\nspecification v3.4.",
          javaType="Date")
static final String SCHEDULE_DELIVERY_TIME
        See Also:
        Constant Field Values

      • SENT_MESSAGE_COUNT

        @Metadata(label="producer",
          description="*only for SubmitSm and SubmitMultiSm* The total\nnumber of messages which has been sent.",
          javaType="Integer")
static final String SENT_MESSAGE_COUNT
        See Also:
        Constant Field Values

      • SEQUENCE_NUMBER

        @Metadata(label="consumer",
          description="*only for AlertNotification, DeliverSm and DataSm* A sequence number\nallows a response PDU to be correlated with a request PDU. The\nassociated SMPP response PDU must preserve this field.",
          javaType="int")
static final String SEQUENCE_NUMBER
        See Also:
        Constant Field Values

      • SERVICE_TYPE

        @Metadata(description="*Producer:* The service type parameter can be used to indicate the SMS Application\nservice associated with the message. Use the URI option `serviceType`\nsettings above.\n*Consumer:* *only for DeliverSm and DataSm* The service type parameter indicates the\nSMS Application service associated with the message.",
          javaType="String")
static final String SERVICE_TYPE
        See Also:
        Constant Field Values

      • SOURCE_ADDR

        @Metadata(description="*Producer:* Defines the address of SME (Short Message Entity) which originated this message.\n*Consumer:* *Only for AlertNotification, DeliverSm and DataSm* Defines the address\nof SME (Short Message Entity) which originated this message.",
          javaType="String")
static final String SOURCE_ADDR
        See Also:
        Constant Field Values

      • SOURCE_ADDR_NPI

        @Metadata(description="*Producer:* Defines the numeric plan indicator (NPI) to be used in the SME\noriginator address parameters. Use the URI option `sourceAddrNpi` values\ndefined above.\n*Consumer:* *only for AlertNotification and DataSm* Defines the numeric plan\nindicator (NPI) to be used in the SME originator address parameters. Use\nthe URI option `sourceAddrNpi` values defined above.",
          javaType="Byte")
static final String SOURCE_ADDR_NPI
        See Also:
        Constant Field Values

      • SOURCE_ADDR_TON

        @Metadata(description="*Producer:* Defines the type of number (TON) to be used in the SME originator\naddress parameters. Use the `sourceAddrTon` URI option values defined\nabove.\n*Consumer:* *only for AlertNotification and DataSm* Defines the type of number (TON)\nto be used in the SME originator address parameters. Use the\n`sourceAddrTon` URI option values defined above.",
          javaType="Byte")
static final String SOURCE_ADDR_TON
        See Also:
        Constant Field Values

      • SUBMITTED

        @Metadata(label="consumer",
          description="*only for smsc DeliveryReceipt* Number of short messages originally\nsubmitted. This is only relevant when the original message was submitted\nto a distribution list.The value is padded with leading zeros if\nnecessary.",
          javaType="Integer")
static final String SUBMITTED
        See Also:
        Constant Field Values

      • SUBMIT_DATE

        @Metadata(label="consumer",
          description="*only for smsc DeliveryReceipt* The time and date at which the short\nmessage was submitted. In the case of a message which has been replaced,\nthis is the date that the original message was replaced. The format is\nas follows: YYMMDDhhmm.",
          javaType="Date")
static final String SUBMIT_DATE
        See Also:
        Constant Field Values

      • SYSTEM_ID

        @Metadata(label="producer",
          description="The system id.",
          javaType="String")
static final String SYSTEM_ID
        See Also:
        Constant Field Values

      • PASSWORD

        @Metadata(label="producer",
          description="The password.",
          javaType="String")
static final String PASSWORD
        See Also:
        Constant Field Values

      • VALIDITY_PERIOD

        @Metadata(description="*Producer:* *only for SubmitSm, SubmitMulti and ReplaceSm* The validity period\nparameter indicates the SMSC expiration time, after which the message\nshould be discarded if not delivered to the destination. If it\'s\nprovided as `Date`, it\'s interpreted as absolute time or relative time\nformat if you provide it as `String` as specified in chapter 7.1.1 in\nthe smpp specification v3.4.\n*Consumer:* *only for DeliverSm* The validity period parameter indicates the SMSC\nexpiration time, after which the message should be discarded if not\ndelivered to the destination. It can be defined in absolute time format\nor relative time format. The encoding of absolute and relative time\nformat is specified in Section 7.1.1 in the smpp specification v3.4.",
          javaType="String or Date")
static final String VALIDITY_PERIOD
        See Also:
        Constant Field Values

      • OPTIONAL_PARAMETERS

        @Metadata(label="consumer",
          description="The optional parameters by name.",
          javaType="Map<String, Object>",
          deprecationNote="Use CamelSmppOptionalParameter instead")
static final String OPTIONAL_PARAMETERS
        See Also:
        Constant Field Values

      • OPTIONAL_PARAMETER

        @Metadata(description="*Producer:* *only for SubmitSm, SubmitMulti and\nDataSm* The optional parameter which are send to the SMSC. The value is\nconverted in the following way: `String` -> `org.jsmpp.bean.OptionalParameter.COctetString`, \n`byte[]` -> `org.jsmpp.bean.OptionalParameter.OctetString`, \n`Byte` -> `org.jsmpp.bean.OptionalParameter.Byte`,\n`Integer` -> `org.jsmpp.bean.OptionalParameter.Int`,\n`Short` -> `org.jsmpp.bean.OptionalParameter.Short`, \n`null` -> `org.jsmpp.bean.OptionalParameter.Null`\n*Consumer:* *only for DeliverSm* The optional\nparameters send back by the SMSC. The key is the `Short` code for the\noptional parameter. The value is converted in the following way: \n`org.jsmpp.bean.OptionalParameter.COctetString` -> `String`,\n`org.jsmpp.bean.OptionalParameter.OctetString` -> `byte[]`,\n`org.jsmpp.bean.OptionalParameter.Byte` -> `Byte`,\n`org.jsmpp.bean.OptionalParameter.Int` -> `Integer`,\n`org.jsmpp.bean.OptionalParameter.Short` -> `Short`,\n`org.jsmpp.bean.OptionalParameter.Null` -> `null`",
          javaType="Map<Short, Object>")
static final String OPTIONAL_PARAMETER
        See Also:
        Constant Field Values

      • SPLITTING_POLICY

        @Metadata(label="producer",
          description="*only for SubmitSm,\nSubmitMulti and DataSm*.  Specifies the policy for message splitting for\nthis exchange.  Possible values are described in the endpoint\nconfiguration parameter _splittingPolicy_",
          javaType="String")
static final String SPLITTING_POLICY
        See Also:
        Constant Field Values