java.lang.Object
- org.apache.camel.builder.endpoint.dsl.SmppEndpointBuilderFactory.SmppHeaderNameBuilder

Enclosing interface:

SmppEndpointBuilderFactory
```
public static class SmppEndpointBuilderFactory.SmppHeaderNameBuilder
extends Object
```
The builder of headers' name for the SMPP component.

Constructor Summary

Constructors
Constructor Description

SmppHeaderNameBuilder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`smppAlphabet()`	For SubmitSm, SubmitMulti and ReplaceSm The data coding according to the SMPP 3.4 specification, section 5.2.19.
`String`	`smppClass()`	the ASM class.
`String`	`smppCommand()`	The command.
`String`	`smppCommandId()`	only for AlertNotification, DeliverSm and DataSm The command id field identifies the particular SMPP PDU.
`String`	`smppCommandStatus()`	only for DataSm The Command status of the message.
`String`	`smppDataCoding()`	For SubmitSm, SubmitMulti and ReplaceSm The data coding according to the SMPP 3.4 specification, section 5.2.19.
`String`	`smppDelivered()`	only for smsc DeliveryReceipt Number of short messages delivered.
`String`	`smppDestAddr()`	Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the destination SME address(es).
`String`	`smppDestAddrNpi()`	Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the numeric plan indicator (NPI) to be used in the SME destination address parameters.
`String`	`smppDestAddrTon()`	Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the type of number (TON) to be used in the SME destination address parameters.
`String`	`smppDoneDate()`	only for smsc DeliveryReceipt The time and date at which the short message reached it's final state.
`String`	`smppEncoding()`	only for SubmitSm, SubmitMulti and DataSm.
`String`	`smppError()`	Producer: only for SubmitMultiSm The errors which occurred by sending the short message(s) the form Map (messageID : (destAddr : address, error : errorCode)).
`String`	`smppEsmeAddr()`	only for AlertNotification Defines the destination ESME address.
`String`	`smppEsmeAddrNpi()`	only for AlertNotification Defines the numeric plan indicator (NPI) to be used in the ESME originator address parameters.
`String`	`smppEsmeAddrTon()`	only for AlertNotification Defines the type of number (TON) to be used in the ESME originator address parameters.
`String`	`smppFinalDate()`	The final date.
`String`	`smppId()`	Producer: The id to identify the submitted short message(s) for later use.
`String`	`smppMessageState()`	The message date.
`String`	`smppMessageType()`	Identifies the type of an incoming message: AlertNotification: an SMSC alert notification, DataSm: an SMSC data short message, DeliveryReceipt: an SMSC delivery receipt, DeliverSm: an SMSC deliver short message.
`String`	`smppOptionalParameter()`	Producer: only for SubmitSm, SubmitMulti and DataSm The optional parameter which are send to the SMSC.
`String`	`smppOptionalParameters()`	The optional parameters by name.
`String`	`smppPassword()`	The password.
`String`	`smppPriorityFlag()`	only for SubmitSm and SubmitMulti Allows the originating SME to assign a priority level to the short message.
`String`	`smppProtocolId()`	The protocol id.
`String`	`smppRegisteredDelivery()`	Producer: only for SubmitSm, ReplaceSm, SubmitMulti and DataSm Is used to request an SMSC delivery receipt and/or SME originated acknowledgements.
`String`	`smppReplaceIfPresentFlag()`	only for SubmitSm and SubmitMulti The replace if present flag parameter is used to request the SMSC to replace a previously submitted message, that is still pending delivery.
`String`	`smppScheduleDeliveryTime()`	Producer: only for SubmitSm, SubmitMulti and ReplaceSm This parameter specifies the scheduled time at which the message delivery should be first attempted.
`String`	`smppSentMessageCount()`	only for SubmitSm and SubmitMultiSm The total number of messages which has been sent.
`String`	`smppSequenceNumber()`	only for AlertNotification, DeliverSm and DataSm A sequence number allows a response PDU to be correlated with a request PDU.
`String`	`smppServiceType()`	Producer: The service type parameter can be used to indicate the SMS Application service associated with the message.
`String`	`smppSingleDLR()`	only for SubmitSm, SubmitMulti Is used to request the SMSC delivery receipt only on the last segment of multi-segment (long) messages.
`String`	`smppSourceAddr()`	Producer: Defines the address of SME (Short Message Entity) which originated this message.
`String`	`smppSourceAddrNpi()`	Producer: Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters.
`String`	`smppSourceAddrTon()`	Producer: Defines the type of number (TON) to be used in the SME originator address parameters.
`String`	`smppSplitter()`	The splitter.
`String`	`smppSplittingPolicy()`	only for SubmitSm, SubmitMulti and DataSm.
`String`	`smppStatus()`	only for smsc DeliveryReceipt: The final status of the message.
`String`	`smppSubmitDate()`	only for smsc DeliveryReceipt The time and date at which the short message was submitted.
`String`	`smppSubmitted()`	only for smsc DeliveryReceipt Number of short messages originally submitted.
`String`	`smppSystemId()`	The system id.
`String`	`smppValidityPeriod()`	Producer: only for SubmitSm, SubmitMulti and ReplaceSm The validity period parameter indicates the SMSC expiration time, after which the message should be discarded if not delivered to the destination.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SmppHeaderNameBuilder
```
public SmppHeaderNameBuilder()
```
- Method Detail
  - smppAlphabet
```
public String smppAlphabet()
```
    For SubmitSm, SubmitMulti and ReplaceSm The data coding according to the SMPP 3.4 specification, section 5.2.19. Use the URI option alphabet settings above. The option is a: Byte type. Group: producer
    
    Returns:
    
    the name of the header SmppAlphabet.
  - smppCommand
```
public String smppCommand()
```
    The command. The option is a: String type. Group: common
    
    Returns:
    
    the name of the header SmppCommand.
  - smppCommandId
```
public String smppCommandId()
```
    only for AlertNotification, DeliverSm and DataSm The command id field identifies the particular SMPP PDU. For the complete list of defined values see chapter 5.1.2.1 in the smpp specification v3.4. The option is a: Integer type. Group: consumer
    
    Returns:
    
    the name of the header SmppCommandId.
  - smppCommandStatus
```
public String smppCommandStatus()
```
    only for DataSm The Command status of the message. The option is a: Integer type. Group: consumer
    
    Returns:
    
    the name of the header SmppCommandStatus.
  - smppDataCoding
```
public String smppDataCoding()
```
    For SubmitSm, SubmitMulti and ReplaceSm The data coding according to the SMPP 3.4 specification, section 5.2.19. Use the URI option alphabet settings above. The option is a: Byte type. Group: producer
    
    Returns:
    
    the name of the header SmppDataCoding.
  - smppSplitter
```
public String smppSplitter()
```
    The splitter. The option is a: org.apache.camel.component.smpp.SmppSplitter type. Group: producer
    
    Returns:
    
    the name of the header SmppSplitter.
  - smppDelivered
```
public String smppDelivered()
```
    only for smsc DeliveryReceipt Number of short messages delivered. This is only relevant where the original message was submitted to a distribution list.The value is padded with leading zeros if necessary. The option is a: Integer type. Group: consumer
    
    Returns:
    
    the name of the header SmppDelivered.
  - smppDestAddr
```
public String smppDestAddr()
```
    Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the destination SME address(es). For mobile terminated messages, this is the directory number of the recipient MS. It must be a List for SubmitMulti and a String otherwise. Consumer: only for DeliverSm and DataSm: Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS. The option is a: List or String type. Group: common
    
    Returns:
    
    the name of the header SmppDestAddr.
  - smppDestAddrNpi
```
public String smppDestAddrNpi()
```
    Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the numeric plan indicator (NPI) to be used in the SME destination address parameters. Use the URI option sourceAddrNpi values defined above. Consumer: only for DataSm Defines the numeric plan indicator (NPI) in the destination address parameters. Use the URI option sourceAddrNpi values defined above. The option is a: Byte type. Group: common
    
    Returns:
    
    the name of the header SmppDestAddrNpi.
  - smppDestAddrTon
```
public String smppDestAddrTon()
```
    Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the type of number (TON) to be used in the SME destination address parameters. Use the sourceAddrTon URI option values defined above. Consumer: only for DataSm Defines the type of number (TON) in the destination address parameters. Use the sourceAddrTon URI option values defined above. The option is a: Byte type. Group: common
    
    Returns:
    
    the name of the header SmppDestAddrTon.
  - smppDoneDate
```
public String smppDoneDate()
```
    only for smsc DeliveryReceipt The time and date at which the short message reached it's final state. The format is as follows: YYMMDDhhmm. The option is a: Date type. Group: consumer
    
    Returns:
    
    the name of the header SmppDoneDate.
  - smppEncoding
```
public String smppEncoding()
```
    only for SubmitSm, SubmitMulti and DataSm. Specifies the encoding (character set name) of the bytes in the message body. If the message body is a string then this is not relevant because Java Strings are always Unicode. If the body is a byte array then this header can be used to indicate that it is ISO-8859-1 or some other value. Default value is specified by the endpoint configuration parameter _encoding_. The option is a: String type. Group: producer
    
    Returns:
    
    the name of the header SmppEncoding.
  - smppError
```
public String smppError()
```
    Producer: only for SubmitMultiSm The errors which occurred by sending the short message(s) the form Map (messageID : (destAddr : address, error : errorCode)). Consumer: only for smsc DeliveryReceipt Where appropriate this may hold a Network specific error code or an SMSC error code for the attempted delivery of the message. These errors are Network or SMSC specific and are not included here. The option is a: String or Map<String, List<Map<String, Object>>> type. Group: common
    
    Returns:
    
    the name of the header SmppError.
  - smppClass
```
public String smppClass()
```
    the ASM class. The option is a: org.jsmpp.bean.ESMClass type. Group: producer
    
    Returns:
    
    the name of the header SmppClass.
  - smppEsmeAddr
```
public String smppEsmeAddr()
```
    only for AlertNotification Defines the destination ESME address. For mobile terminated messages, this is the directory number of the recipient MS. The option is a: String type. Group: consumer
    
    Returns:
    
    the name of the header SmppEsmeAddr.
  - smppEsmeAddrNpi
```
public String smppEsmeAddrNpi()
```
    only for AlertNotification Defines the numeric plan indicator (NPI) to be used in the ESME originator address parameters. Use the URI option sourceAddrNpi values defined above. The option is a: Byte type. Group: consumer
    
    Returns:
    
    the name of the header SmppEsmeAddrNpi.
  - smppEsmeAddrTon
```
public String smppEsmeAddrTon()
```
    only for AlertNotification Defines the type of number (TON) to be used in the ESME originator address parameters. Use the sourceAddrTon URI option values defined above. The option is a: Byte type. Group: consumer
    
    Returns:
    
    the name of the header SmppEsmeAddrTon.
  - smppFinalDate
```
public String smppFinalDate()
```
    The final date. The option is a: java.util.Date type. Group: producer
    
    Returns:
    
    the name of the header SmppFinalDate.
  - smppStatus
```
public String smppStatus()
```
    only for smsc DeliveryReceipt: The final status of the message. The option is a: org.jsmpp.util.DeliveryReceiptState type. Group: consumer
    
    Returns:
    
    the name of the header SmppStatus.
  - smppId
```
public String smppId()
```
    Producer: The id to identify the submitted short message(s) for later use. In case of a ReplaceSm, QuerySm, CancelSm and DataSm this header value is a String. In case of a SubmitSm or SubmitMultiSm this header value is a List. Consumer: only for smsc DeliveryReceipt and DataSm The message ID allocated to the message by the SMSC when originally submitted. The option is a: String or List<String> type. Group: common
    
    Returns:
    
    the name of the header SmppId.
  - smppMessageState
```
public String smppMessageState()
```
    The message date. The option is a: String type. Group: producer
    
    Returns:
    
    the name of the header SmppMessageState.
  - smppMessageType
```
public String smppMessageType()
```
    Identifies the type of an incoming message: AlertNotification: an SMSC alert notification, DataSm: an SMSC data short message, DeliveryReceipt: an SMSC delivery receipt, DeliverSm: an SMSC deliver short message. The option is a: String type. Group: consumer
    
    Returns:
    
    the name of the header SmppMessageType.
  - smppPriorityFlag
```
public String smppPriorityFlag()
```
    only for SubmitSm and SubmitMulti Allows the originating SME to assign a priority level to the short message. Use the URI option priorityFlag settings above. The option is a: Byte type. Group: producer
    
    Returns:
    
    the name of the header SmppPriorityFlag.
  - smppProtocolId
```
public String smppProtocolId()
```
    The protocol id. The option is a: Byte type. Group: producer
    
    Returns:
    
    the name of the header SmppProtocolId.
  - smppRegisteredDelivery
```
public String smppRegisteredDelivery()
```
    Producer: only for SubmitSm, ReplaceSm, SubmitMulti and DataSm Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. Use the URI option registeredDelivery settings above. Consumer: only for DataSm Is used to request an delivery receipt and/or SME originated acknowledgements. Same values as in Producer header list above. The option is a: Byte type. Group: common
    
    Returns:
    
    the name of the header SmppRegisteredDelivery.
  - smppSingleDLR
```
public String smppSingleDLR()
```
    only for SubmitSm, SubmitMulti Is used to request the SMSC delivery receipt only on the last segment of multi-segment (long) messages. Use the URI option singleDLR settings above. The option is a: Boolean type. Group: producer
    
    Returns:
    
    the name of the header SmppSingleDLR.
  - smppReplaceIfPresentFlag
```
public String smppReplaceIfPresentFlag()
```
    only for SubmitSm and SubmitMulti The replace if present flag parameter is used to request the SMSC to replace a previously submitted message, that is still pending delivery. The SMSC will replace an existing message provided that the source address, destination address and service type match the same fields in the new message. The following values are defined: 0, Don't replace and 1, Replace. The option is a: Boolean type. Group: producer
    
    Returns:
    
    the name of the header SmppReplaceIfPresentFlag.
  - smppScheduleDeliveryTime
```
public String smppScheduleDeliveryTime()
```
    Producer: only for SubmitSm, SubmitMulti and ReplaceSm This parameter specifies the scheduled time at which the message delivery should be first attempted. It defines either the absolute date and time or relative time from the current SMSC time at which delivery of this message will be attempted by the SMSC. It can be specified in either absolute time format or relative time format. The encoding of a time format is specified in chapter 7.1.1. in the smpp specification v3.4. Consumer: only for DeliverSm: This parameter specifies the scheduled time at which the message delivery should be first attempted. It defines either the absolute date and time or relative time from the current SMSC time at which delivery of this message will be attempted by the SMSC. It can be specified in either absolute time format or relative time format. The encoding of a time format is specified in Section 7.1.1. in the smpp specification v3.4. The option is a: Date type. Group: common
    
    Returns:
    
    the name of the header SmppScheduleDeliveryTime.
  - smppSentMessageCount
```
public String smppSentMessageCount()
```
    only for SubmitSm and SubmitMultiSm The total number of messages which has been sent. The option is a: Integer type. Group: producer
    
    Returns:
    
    the name of the header SmppSentMessageCount.
  - smppSequenceNumber
```
public String smppSequenceNumber()
```
    only for AlertNotification, DeliverSm and DataSm A sequence number allows a response PDU to be correlated with a request PDU. The associated SMPP response PDU must preserve this field. The option is a: int type. Group: consumer
    
    Returns:
    
    the name of the header SmppSequenceNumber.
  - smppServiceType
```
public String smppServiceType()
```
    Producer: The service type parameter can be used to indicate the SMS Application service associated with the message. Use the URI option serviceType settings above. Consumer: only for DeliverSm and DataSm The service type parameter indicates the SMS Application service associated with the message. The option is a: String type. Group: common
    
    Returns:
    
    the name of the header SmppServiceType.
  - smppSourceAddr
```
public String smppSourceAddr()
```
    Producer: Defines the address of SME (Short Message Entity) which originated this message. Consumer: Only for AlertNotification, DeliverSm and DataSm Defines the address of SME (Short Message Entity) which originated this message. The option is a: String type. Group: common
    
    Returns:
    
    the name of the header SmppSourceAddr.
  - smppSourceAddrNpi
```
public String smppSourceAddrNpi()
```
    Producer: Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. Use the URI option sourceAddrNpi values defined above. Consumer: only for AlertNotification and DataSm Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. Use the URI option sourceAddrNpi values defined above. The option is a: Byte type. Group: common
    
    Returns:
    
    the name of the header SmppSourceAddrNpi.
  - smppSourceAddrTon
```
public String smppSourceAddrTon()
```
    Producer: Defines the type of number (TON) to be used in the SME originator address parameters. Use the sourceAddrTon URI option values defined above. Consumer: only for AlertNotification and DataSm Defines the type of number (TON) to be used in the SME originator address parameters. Use the sourceAddrTon URI option values defined above. The option is a: Byte type. Group: common
    
    Returns:
    
    the name of the header SmppSourceAddrTon.
  - smppSubmitted
```
public String smppSubmitted()
```
    only for smsc DeliveryReceipt Number of short messages originally submitted. This is only relevant when the original message was submitted to a distribution list.The value is padded with leading zeros if necessary. The option is a: Integer type. Group: consumer
    
    Returns:
    
    the name of the header SmppSubmitted.
  - smppSubmitDate
```
public String smppSubmitDate()
```
    only for smsc DeliveryReceipt The time and date at which the short message was submitted. In the case of a message which has been replaced, this is the date that the original message was replaced. The format is as follows: YYMMDDhhmm. The option is a: Date type. Group: consumer
    
    Returns:
    
    the name of the header SmppSubmitDate.
  - smppSystemId
```
public String smppSystemId()
```
    The system id. The option is a: String type. Group: producer
    
    Returns:
    
    the name of the header SmppSystemId.
  - smppPassword
```
public String smppPassword()
```
    The password. The option is a: String type. Group: producer
    
    Returns:
    
    the name of the header SmppPassword.
  - smppValidityPeriod
```
public String smppValidityPeriod()
```
    Producer: only for SubmitSm, SubmitMulti and ReplaceSm The validity period parameter indicates the SMSC expiration time, after which the message should be discarded if not delivered to the destination. If it's provided as Date, it's interpreted as absolute time or relative time format if you provide it as String as specified in chapter 7.1.1 in the smpp specification v3.4. Consumer: only for DeliverSm The validity period parameter indicates the SMSC expiration time, after which the message should be discarded if not delivered to the destination. It can be defined in absolute time format or relative time format. The encoding of absolute and relative time format is specified in Section 7.1.1 in the smpp specification v3.4. The option is a: String or Date type. Group: common
    
    Returns:
    
    the name of the header SmppValidityPeriod.
  - smppOptionalParameters
```
public String smppOptionalParameters()
```
    The optional parameters by name. Deprecation note: Use CamelSmppOptionalParameter instead. The option is a: Map<String, Object> type. Group: consumer
    
    Returns:
    
    the name of the header SmppOptionalParameters.
  - smppOptionalParameter
```
public String smppOptionalParameter()
```
    Producer: only for SubmitSm, SubmitMulti and DataSm The optional parameter which are send to the SMSC. The value is converted in the following way: String - org.jsmpp.bean.OptionalParameter.COctetString, byte - org.jsmpp.bean.OptionalParameter.OctetString, Byte - org.jsmpp.bean.OptionalParameter.Byte, Integer - org.jsmpp.bean.OptionalParameter.Int, Short - org.jsmpp.bean.OptionalParameter.Short, null - org.jsmpp.bean.OptionalParameter.Null Consumer: only for DeliverSm The optional parameters send back by the SMSC. The key is the Short code for the optional parameter. The value is converted in the following way: org.jsmpp.bean.OptionalParameter.COctetString - String, org.jsmpp.bean.OptionalParameter.OctetString - byte, org.jsmpp.bean.OptionalParameter.Byte - Byte, org.jsmpp.bean.OptionalParameter.Int - Integer, org.jsmpp.bean.OptionalParameter.Short - Short, org.jsmpp.bean.OptionalParameter.Null - null. The option is a: Map<Short, Object> type. Group: common
    
    Returns:
    
    the name of the header SmppOptionalParameter.
  - smppSplittingPolicy
```
public String smppSplittingPolicy()
```
    only for SubmitSm, SubmitMulti and DataSm. Specifies the policy for message splitting for this exchange. Possible values are described in the endpoint configuration parameter _splittingPolicy_. The option is a: String type. Group: producer
    
    Returns:
    
    the name of the header SmppSplittingPolicy.

Class SmppEndpointBuilderFactory.SmppHeaderNameBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SmppHeaderNameBuilder

Method Detail

smppAlphabet

smppCommand

smppCommandId

smppCommandStatus

smppDataCoding

smppSplitter

smppDelivered

smppDestAddr

smppDestAddrNpi

smppDestAddrTon

smppDoneDate

smppEncoding

smppError

smppClass

smppEsmeAddr

smppEsmeAddrNpi

smppEsmeAddrTon

smppFinalDate

smppStatus

smppId

smppMessageState

smppMessageType

smppPriorityFlag

smppProtocolId

smppRegisteredDelivery

smppSingleDLR

smppReplaceIfPresentFlag

smppScheduleDeliveryTime

smppSentMessageCount

smppSequenceNumber

smppServiceType

smppSourceAddr

smppSourceAddrNpi

smppSourceAddrTon

smppSubmitted

smppSubmitDate

smppSystemId

smppPassword

smppValidityPeriod

smppOptionalParameters

smppOptionalParameter

smppSplittingPolicy