org.apache.camel.builder.endpoint.dsl

Interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

SmppEndpointBuilderFactory.SmppEndpointBuilder

Enclosing interface:

SmppEndpointBuilderFactory

public static interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint consumers for the SMPP component.

Method Summary

Modifier and Type	Method and Description
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	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 SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder	advanced()
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	alphabet(byte alphabet) Defines encoding of data according the SMPP 3.4 specification, section 5.2.19.
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	alphabet(String alphabet) Defines encoding of data according the SMPP 3.4 specification, section 5.2.19.
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	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 SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	bridgeErrorHandler(String 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 SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	dataCoding(byte dataCoding) Defines the data coding according the SMPP 3.4 specification, section 5.2.19.
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	dataCoding(String dataCoding) Defines the data coding according the SMPP 3.4 specification, section 5.2.19.
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	encoding(String encoding) Defines the encoding scheme of the short message user data.
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	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 SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	httpProxyPassword(String httpProxyPassword) If your HTTP proxy requires basic authentication, set this attribute to the password required for your HTTP proxy.
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	httpProxyPort(Integer httpProxyPort) If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy.
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	httpProxyPort(String httpProxyPort) If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy.
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	httpProxyUsername(String httpProxyUsername) If your HTTP proxy requires basic authentication, set this attribute to the username required for your HTTP proxy.
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	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 SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	initialReconnectDelay(String initialReconnectDelay) Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost.
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	maxReconnect(int maxReconnect) Defines the maximum number of attempts to reconnect to the SMSC, if SMSC returns a negative bind response.
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	maxReconnect(String maxReconnect) Defines the maximum number of attempts to reconnect to the SMSC, if SMSC returns a negative bind response.
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	password(String password) The password for connecting to SMSC server.
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	proxyHeaders(Map<String,String> proxyHeaders) These headers will be passed to the proxy server while establishing the connection.
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	proxyHeaders(String proxyHeaders) These headers will be passed to the proxy server while establishing the connection.
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	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 SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	reconnectDelay(String 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 SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	splittingPolicy(SmppEndpointBuilderFactory.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 SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	splittingPolicy(String 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 SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	systemId(String systemId) The system id (username) for connecting to SMSC server.
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	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 SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	usingSSL(boolean usingSSL) Whether using SSL with the smpps protocol.
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder	usingSSL(String usingSSL) Whether using SSL with the smpps protocol.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

advanced

default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder advanced()

initialReconnectDelay

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder 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

initialReconnectDelay

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder initialReconnectDelay(String initialReconnectDelay)

Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost. The option will be converted to a long type. Default: 5000 Group: common

maxReconnect

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder 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

maxReconnect

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder maxReconnect(String maxReconnect)

Defines the maximum number of attempts to reconnect to the SMSC, if SMSC returns a negative bind response. The option will be converted to a int type. Default: 2147483647 Group: common

reconnectDelay

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder 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

reconnectDelay

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder reconnectDelay(String 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 will be converted to a long type. Default: 5000 Group: common

splittingPolicy

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder splittingPolicy(SmppEndpointBuilderFactory.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

splittingPolicy

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder splittingPolicy(String 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 will be converted to a org.apache.camel.component.smpp.SmppSplittingPolicy type. Default: ALLOW Group: common

systemType

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder 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 SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder 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 SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder 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

bridgeErrorHandler

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder bridgeErrorHandler(String 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 will be converted to a boolean type. Default: false Group: consumer

alphabet

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder 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

alphabet

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder alphabet(String 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 will be converted to a byte type. Group: codec

dataCoding

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder 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

dataCoding

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder dataCoding(String 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 will be converted to a byte type. Group: codec

encoding

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder 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 SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder 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 SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder 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 SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder 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

httpProxyPort

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder httpProxyPort(String httpProxyPort)

If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy. The option will be converted to a java.lang.Integer type. Default: 3128 Group: proxy

httpProxyUsername

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder 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 SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder 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<java.lang.String, java.lang.String> type. Group: proxy

proxyHeaders

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder proxyHeaders(String proxyHeaders)

These headers will be passed to the proxy server while establishing the connection. The option will be converted to a java.util.Map<java.lang.String, java.lang.String> type. Group: proxy

password

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder password(String password)

The password for connecting to SMSC server. The option is a: java.lang.String type. Group: security

systemId

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder 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 SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder usingSSL(boolean usingSSL)

Whether using SSL with the smpps protocol. The option is a: boolean type. Default: false Group: security

usingSSL

default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder usingSSL(String usingSSL)

Whether using SSL with the smpps protocol. The option will be converted to a boolean type. Default: false Group: security