SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder (Camel

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

All Methods Instance Methods Default Methods
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, expr, 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: <code>long</code> type. Default: 5000 Group: common
    
    Parameters:
    
    initialReconnectDelay - the value to set
    
    Returns:
    
    the dsl builder
  - 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 <code>long</code> type. Default: 5000 Group: common
    
    Parameters:
    
    initialReconnectDelay - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>int</code> type. Default: 2147483647 Group: common
    
    Parameters:
    
    maxReconnect - the value to set
    
    Returns:
    
    the dsl builder
  - 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 <code>int</code> type. Default: 2147483647 Group: common
    
    Parameters:
    
    maxReconnect - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>long</code> type. Default: 5000 Group: common
    
    Parameters:
    
    reconnectDelay - the value to set
    
    Returns:
    
    the dsl builder
  - 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 <code>long</code> type. Default: 5000 Group: common
    
    Parameters:
    
    reconnectDelay - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>org.apache.camel.component.smpp.SmppSplittingPolicy</code> type. Default: ALLOW Group: common
    
    Parameters:
    
    splittingPolicy - the value to set
    
    Returns:
    
    the dsl builder
  - 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 <code>org.apache.camel.component.smpp.SmppSplittingPolicy</code> type. Default: ALLOW Group: common
    
    Parameters:
    
    splittingPolicy - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    systemType - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.lang.String</code> type. Group: consumer
    
    Parameters:
    
    addressRange - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - 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 <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>byte</code> type. Group: codec
    
    Parameters:
    
    alphabet - the value to set
    
    Returns:
    
    the dsl builder
  - 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 <code>byte</code> type. Group: codec
    
    Parameters:
    
    alphabet - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>byte</code> type. Group: codec
    
    Parameters:
    
    dataCoding - the value to set
    
    Returns:
    
    the dsl builder
  - 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 <code>byte</code> type. Group: codec
    
    Parameters:
    
    dataCoding - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.lang.String</code> type. Default: ISO-8859-1 Group: codec
    
    Parameters:
    
    encoding - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.lang.String</code> type. Group: proxy
    
    Parameters:
    
    httpProxyHost - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.lang.String</code> type. Group: proxy
    
    Parameters:
    
    httpProxyPassword - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.lang.Integer</code> type. Default: 3128 Group: proxy
    
    Parameters:
    
    httpProxyPort - the value to set
    
    Returns:
    
    the dsl builder
  - 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 <code>java.lang.Integer</code> type. Default: 3128 Group: proxy
    
    Parameters:
    
    httpProxyPort - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.lang.String</code> type. Group: proxy
    
    Parameters:
    
    httpProxyUsername - the value to set
    
    Returns:
    
    the dsl builder
  - 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: <code>java.util.Map<java.lang.String, java.lang.String></code> type. Group: proxy
    
    Parameters:
    
    proxyHeaders - the value to set
    
    Returns:
    
    the dsl builder
  - 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 <code>java.util.Map<java.lang.String, java.lang.String></code> type. Group: proxy
    
    Parameters:
    
    proxyHeaders - the value to set
    
    Returns:
    
    the dsl builder
  - password
```
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder password(String password)
```
    The password for connecting to SMSC server. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    password - the value to set
    
    Returns:
    
    the dsl builder
  - systemId
```
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder systemId(String systemId)
```
    The system id (username) for connecting to SMSC server. The option is a: <code>java.lang.String</code> type. Default: smppclient Group: security
    
    Parameters:
    
    systemId - the value to set
    
    Returns:
    
    the dsl builder
  - usingSSL
```
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder usingSSL(boolean usingSSL)
```
    Whether using SSL with the smpps protocol. The option is a: <code>boolean</code> type. Default: false Group: security
    
    Parameters:
    
    usingSSL - the value to set
    
    Returns:
    
    the dsl builder
  - usingSSL
```
default SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder usingSSL(String usingSSL)
```
    Whether using SSL with the smpps protocol. The option will be converted to a <code>boolean</code> type. Default: false Group: security
    
    Parameters:
    
    usingSSL - the value to set
    
    Returns:
    
    the dsl builder

Interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

initialReconnectDelay

initialReconnectDelay

maxReconnect

maxReconnect

reconnectDelay

reconnectDelay

splittingPolicy

splittingPolicy

systemType

addressRange

bridgeErrorHandler

bridgeErrorHandler

alphabet

alphabet

dataCoding

dataCoding

encoding

httpProxyHost

httpProxyPassword

httpProxyPort

httpProxyPort

httpProxyUsername

proxyHeaders

proxyHeaders

password

systemId

usingSSL

usingSSL