SmppsComponentBuilderFactory.SmppsComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.smpp.SmppComponent>

All Known Implementing Classes:

SmppsComponentBuilderFactory.SmppsComponentBuilderImpl

Enclosing interface:

SmppsComponentBuilderFactory
```
public static interface SmppsComponentBuilderFactory.SmppsComponentBuilder
extends ComponentBuilder<org.apache.camel.component.smpp.SmppComponent>
```
Builder for the SMPP (Secure) component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`addressRange(String addressRange)` You can specify the address range for the SmppConsumer as defined in section 5.2.7 of the SMPP 3.4 specification.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`alphabet(byte alphabet)` Defines encoding of data according the SMPP 3.4 specification, section 5.2.19.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)` Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`bridgeErrorHandler(boolean bridgeErrorHandler)` Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`configuration(org.apache.camel.component.smpp.SmppConfiguration configuration)` To use the shared SmppConfiguration as configuration.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`dataCoding(byte dataCoding)` Defines the data coding according the SMPP 3.4 specification, section 5.2.19.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`destAddr(String destAddr)` Defines the destination SME address.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`destAddrNpi(byte destAddrNpi)` Defines the type of number (TON) to be used in the SME destination address parameters.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`destAddrTon(byte destAddrTon)` Defines the type of number (TON) to be used in the SME destination address parameters.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`encoding(String encoding)` Defines the encoding scheme of the short message user data.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`enquireLinkTimer(Integer enquireLinkTimer)` Defines the interval in milliseconds between the confidence checks.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`httpProxyHost(String httpProxyHost)` If you need to tunnel SMPP through a HTTP proxy, set this attribute to the hostname or ip address of your HTTP proxy.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`httpProxyPassword(String httpProxyPassword)` If your HTTP proxy requires basic authentication, set this attribute to the password required for your HTTP proxy.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`httpProxyPort(Integer httpProxyPort)` If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`httpProxyUsername(String httpProxyUsername)` If your HTTP proxy requires basic authentication, set this attribute to the username required for your HTTP proxy.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`initialReconnectDelay(long initialReconnectDelay)` Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`lazySessionCreation(boolean lazySessionCreation)` Sessions can be lazily created to avoid exceptions, if the SMSC is not available when the Camel producer is started.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`maxReconnect(int maxReconnect)` Defines the maximum number of attempts to reconnect to the SMSC, if SMSC returns a negative bind response.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`numberingPlanIndicator(byte numberingPlanIndicator)` Defines the numeric plan indicator (NPI) to be used in the SME.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`password(String password)` The password for connecting to SMSC server.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`priorityFlag(byte priorityFlag)` Allows the originating SME to assign a priority level to the short message.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`protocolId(byte protocolId)` The protocol id.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`proxyHeaders(Map<String,String> proxyHeaders)` These headers will be passed to the proxy server while establishing the connection.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`reconnectDelay(long reconnectDelay)` Defines the interval in milliseconds between the reconnect attempts, if the connection to the SMSC was lost and the previous was not succeed.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`registeredDelivery(byte registeredDelivery)` Is used to request an SMSC delivery receipt and/or SME originated acknowledgements.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`replaceIfPresentFlag(byte replaceIfPresentFlag)` Used to request the SMSC to replace a previously submitted message, that is still pending delivery.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`serviceType(String serviceType)` The service type parameter can be used to indicate the SMS Application service associated with the message.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`sessionStateListener(org.jsmpp.session.SessionStateListener sessionStateListener)` You can refer to a org.jsmpp.session.SessionStateListener in the Registry to receive callbacks when the session state changed.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`sourceAddr(String sourceAddr)` Defines the address of SME (Short Message Entity) which originated this message.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`sourceAddrNpi(byte sourceAddrNpi)` Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`sourceAddrTon(byte sourceAddrTon)` Defines the type of number (TON) to be used in the SME originator address parameters.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`splittingPolicy(org.apache.camel.component.smpp.SmppSplittingPolicy splittingPolicy)` You can specify a policy for handling long messages: ALLOW - the default, long messages are split to 140 bytes per message TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`systemId(String systemId)` The system id (username) for connecting to SMSC server.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`systemType(String systemType)` This parameter is used to categorize the type of ESME (External Short Message Entity) that is binding to the SMSC (max.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`transactionTimer(Integer transactionTimer)` Defines the maximum period of inactivity allowed after a transaction, after which an SMPP entity may assume that the session is no longer active.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`typeOfNumber(byte typeOfNumber)` Defines the type of number (TON) to be used in the SME.
`default SmppsComponentBuilderFactory.SmppsComponentBuilder`	`usingSSL(boolean usingSSL)` Whether using SSL with the smpps protocol.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - initialReconnectDelay
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder initialReconnectDelay(long initialReconnectDelay)
```
    Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost. The option is a: long type. Default: 5000 Group: common
  - maxReconnect
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder maxReconnect(int maxReconnect)
```
    Defines the maximum number of attempts to reconnect to the SMSC, if SMSC returns a negative bind response. The option is a: int type. Default: 2147483647 Group: common
  - reconnectDelay
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder reconnectDelay(long reconnectDelay)
```
    Defines the interval in milliseconds between the reconnect attempts, if the connection to the SMSC was lost and the previous was not succeed. The option is a: long type. Default: 5000 Group: common
  - splittingPolicy
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder splittingPolicy(org.apache.camel.component.smpp.SmppSplittingPolicy splittingPolicy)
```
    You can specify a policy for handling long messages: ALLOW - the default, long messages are split to 140 bytes per message TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC. Some carriers drop subsequent fragments so this reduces load on the SMPP connection sending parts of a message that will never be delivered. REJECT - if a message would need to be split, it is rejected with an SMPP NegativeResponseException and the reason code signifying the message is too long. The option is a: org.apache.camel.component.smpp.SmppSplittingPolicy type. Default: ALLOW Group: common
  - systemType
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder systemType(String systemType)
```
    This parameter is used to categorize the type of ESME (External Short Message Entity) that is binding to the SMSC (max. 13 characters). The option is a: java.lang.String type. Group: common
  - addressRange
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder addressRange(String addressRange)
```
    You can specify the address range for the SmppConsumer as defined in section 5.2.7 of the SMPP 3.4 specification. The SmppConsumer will receive messages only from SMSC's which target an address (MSISDN or IP address) within this range. The option is a: java.lang.String type. Group: consumer
  - bridgeErrorHandler
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
```
    Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: boolean type. Default: false Group: consumer
  - destAddr
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder destAddr(String destAddr)
```
    Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The option is a: java.lang.String type. Default: 1717 Group: producer
  - destAddrNpi
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder destAddrNpi(byte destAddrNpi)
```
    Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum). The option is a: byte type. Group: producer
  - destAddrTon
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder destAddrTon(byte destAddrTon)
```
    Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated. The option is a: byte type. Group: producer
  - lazySessionCreation
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder lazySessionCreation(boolean lazySessionCreation)
```
    Sessions can be lazily created to avoid exceptions, if the SMSC is not available when the Camel producer is started. Camel will check the in message headers 'CamelSmppSystemId' and 'CamelSmppPassword' of the first exchange. If they are present, Camel will use these data to connect to the SMSC. The option is a: boolean type. Default: false Group: producer
  - lazyStartProducer
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder lazyStartProducer(boolean lazyStartProducer)
```
    Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: boolean type. Default: false Group: producer
  - numberingPlanIndicator
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder numberingPlanIndicator(byte numberingPlanIndicator)
```
    Defines the numeric plan indicator (NPI) to be used in the SME. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum). The option is a: byte type. Group: producer
  - priorityFlag
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder priorityFlag(byte priorityFlag)
```
    Allows the originating SME to assign a priority level to the short message. Only for SubmitSm and SubmitMulti. Four Priority Levels are supported: 0: Level 0 (lowest) priority 1: Level 1 priority 2: Level 2 priority 3: Level 3 (highest) priority. The option is a: byte type. Group: producer
  - protocolId
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder protocolId(byte protocolId)
```
    The protocol id. The option is a: byte type. Group: producer
  - registeredDelivery
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder registeredDelivery(byte registeredDelivery)
```
    Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. The following values are defined: 0: No SMSC delivery receipt requested. 1: SMSC delivery receipt requested where final delivery outcome is success or failure. 2: SMSC delivery receipt requested where the final delivery outcome is delivery failure. The option is a: byte type. Group: producer
  - replaceIfPresentFlag
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder replaceIfPresentFlag(byte replaceIfPresentFlag)
```
    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 replace if present flag values are defined: 0: Don't replace 1: Replace. The option is a: byte type. Group: producer
  - serviceType
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder serviceType(String serviceType)
```
    The service type parameter can be used to indicate the SMS Application service associated with the message. The following generic service_types are defined: CMT: Cellular Messaging CPT: Cellular Paging VMN: Voice Mail Notification VMA: Voice Mail Alerting WAP: Wireless Application Protocol USSD: Unstructured Supplementary Services Data. The option is a: java.lang.String type. Group: producer
  - sourceAddr
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder sourceAddr(String sourceAddr)
```
    Defines the address of SME (Short Message Entity) which originated this message. The option is a: java.lang.String type. Default: 1616 Group: producer
  - sourceAddrNpi
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder sourceAddrNpi(byte sourceAddrNpi)
```
    Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum). The option is a: byte type. Group: producer
  - sourceAddrTon
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder sourceAddrTon(byte sourceAddrTon)
```
    Defines the type of number (TON) to be used in the SME originator address parameters. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated. The option is a: byte type. Group: producer
  - typeOfNumber
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder typeOfNumber(byte typeOfNumber)
```
    Defines the type of number (TON) to be used in the SME. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated. The option is a: byte type. Group: producer
  - basicPropertyBinding
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)
```
    Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced
  - configuration
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder configuration(org.apache.camel.component.smpp.SmppConfiguration configuration)
```
    To use the shared SmppConfiguration as configuration. The option is a: org.apache.camel.component.smpp.SmppConfiguration type. Group: advanced
  - enquireLinkTimer
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder enquireLinkTimer(Integer enquireLinkTimer)
```
    Defines the interval in milliseconds between the confidence checks. The confidence check is used to test the communication path between an ESME and an SMSC. The option is a: java.lang.Integer type. Default: 5000 Group: advanced
  - sessionStateListener
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder sessionStateListener(org.jsmpp.session.SessionStateListener sessionStateListener)
```
    You can refer to a org.jsmpp.session.SessionStateListener in the Registry to receive callbacks when the session state changed. The option is a: org.jsmpp.session.SessionStateListener type. Group: advanced
  - transactionTimer
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder transactionTimer(Integer transactionTimer)
```
    Defines the maximum period of inactivity allowed after a transaction, after which an SMPP entity may assume that the session is no longer active. This timer may be active on either communicating SMPP entity (i.e. SMSC or ESME). The option is a: java.lang.Integer type. Default: 10000 Group: advanced
  - alphabet
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder alphabet(byte alphabet)
```
    Defines encoding of data according the SMPP 3.4 specification, section 5.2.19. 0: SMSC Default Alphabet 4: 8 bit Alphabet 8: UCS2 Alphabet. The option is a: byte type. Group: codec
  - dataCoding
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder dataCoding(byte dataCoding)
```
    Defines the data coding according the SMPP 3.4 specification, section 5.2.19. Example data encodings are: 0: SMSC Default Alphabet 3: Latin 1 (ISO-8859-1) 4: Octet unspecified (8-bit binary) 8: UCS2 (ISO/IEC-10646) 13: Extended Kanji JIS(X 0212-1990). The option is a: byte type. Group: codec
  - encoding
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder encoding(String encoding)
```
    Defines the encoding scheme of the short message user data. Only for SubmitSm, ReplaceSm and SubmitMulti. The option is a: java.lang.String type. Default: ISO-8859-1 Group: codec
  - httpProxyHost
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder httpProxyHost(String httpProxyHost)
```
    If you need to tunnel SMPP through a HTTP proxy, set this attribute to the hostname or ip address of your HTTP proxy. The option is a: java.lang.String type. Group: proxy
  - httpProxyPassword
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder httpProxyPassword(String httpProxyPassword)
```
    If your HTTP proxy requires basic authentication, set this attribute to the password required for your HTTP proxy. The option is a: java.lang.String type. Group: proxy
  - httpProxyPort
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder httpProxyPort(Integer httpProxyPort)
```
    If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy. The option is a: java.lang.Integer type. Default: 3128 Group: proxy
  - httpProxyUsername
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder httpProxyUsername(String httpProxyUsername)
```
    If your HTTP proxy requires basic authentication, set this attribute to the username required for your HTTP proxy. The option is a: java.lang.String type. Group: proxy
  - proxyHeaders
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder proxyHeaders(Map<String,String> proxyHeaders)
```
    These headers will be passed to the proxy server while establishing the connection. The option is a: java.util.Map type. Group: proxy
  - password
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder password(String password)
```
    The password for connecting to SMSC server. The option is a: java.lang.String type. Group: security
  - systemId
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder systemId(String systemId)
```
    The system id (username) for connecting to SMSC server. The option is a: java.lang.String type. Default: smppclient Group: security
  - usingSSL
```
default SmppsComponentBuilderFactory.SmppsComponentBuilder usingSSL(boolean usingSSL)
```
    Whether using SSL with the smpps protocol. The option is a: boolean type. Default: false Group: security

Interface SmppsComponentBuilderFactory.SmppsComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

initialReconnectDelay

maxReconnect

reconnectDelay

splittingPolicy

systemType

addressRange

bridgeErrorHandler

destAddr

destAddrNpi

destAddrTon

lazySessionCreation

lazyStartProducer

numberingPlanIndicator

priorityFlag

protocolId

registeredDelivery

replaceIfPresentFlag

serviceType

sourceAddr

sourceAddrNpi

sourceAddrTon

typeOfNumber

basicPropertyBinding

configuration

enquireLinkTimer

sessionStateListener

transactionTimer

alphabet

dataCoding

encoding

httpProxyHost

httpProxyPassword

httpProxyPort

httpProxyUsername

proxyHeaders

password

systemId

usingSSL