Interface SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
SmppEndpointBuilderFactory.AdvancedSmppEndpointBuilder
- Enclosing interface:
SmppEndpointBuilderFactory
public static interface SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the SMPP component.
-
Method Summary
Modifier and TypeMethodDescriptionbasic()
bridgeErrorHandler
(boolean bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.bridgeErrorHandler
(String bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.enquireLinkTimer
(Integer enquireLinkTimer) Defines the interval in milliseconds between the confidence checks.enquireLinkTimer
(String enquireLinkTimer) Defines the interval in milliseconds between the confidence checks.exceptionHandler
(String exceptionHandler) To let the consumer use a custom ExceptionHandler.exceptionHandler
(org.apache.camel.spi.ExceptionHandler exceptionHandler) To let the consumer use a custom ExceptionHandler.exchangePattern
(String exchangePattern) Sets the exchange pattern when the consumer creates an exchange.exchangePattern
(org.apache.camel.ExchangePattern exchangePattern) Sets the exchange pattern when the consumer creates an exchange.interfaceVersion
(String interfaceVersion) Defines the interface version to be used in the binding request with the SMSC.pduProcessorDegree
(Integer pduProcessorDegree) Sets the number of threads which can read PDU and process them in parallel.pduProcessorDegree
(String pduProcessorDegree) Sets the number of threads which can read PDU and process them in parallel.pduProcessorQueueCapacity
(Integer pduProcessorQueueCapacity) Sets the capacity of the working queue for PDU processing.pduProcessorQueueCapacity
(String pduProcessorQueueCapacity) Sets the capacity of the working queue for PDU processing.sessionStateListener
(String sessionStateListener) You can refer to a org.jsmpp.session.SessionStateListener in the Registry to receive callbacks when the session state changed.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.singleDLR
(boolean singleDLR) When true, the SMSC delivery receipt would be requested only for the last segment of a multi-segment (long) message.When true, the SMSC delivery receipt would be requested only for the last segment of a multi-segment (long) message.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.transactionTimer
(String 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.Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
-
Method Details
-
basic
-
bridgeErrorHandler
default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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 (advanced)- Parameters:
bridgeErrorHandler
- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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 (advanced)- Parameters:
bridgeErrorHandler
- the value to set- Returns:
- the dsl builder
-
exceptionHandler
default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler) To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)- Parameters:
exceptionHandler
- the value to set- Returns:
- the dsl builder
-
exceptionHandler
default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder exceptionHandler(String exceptionHandler) To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)- Parameters:
exceptionHandler
- the value to set- Returns:
- the dsl builder
-
exchangePattern
default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern) Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)- Parameters:
exchangePattern
- the value to set- Returns:
- the dsl builder
-
exchangePattern
default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder exchangePattern(String exchangePattern) Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)- Parameters:
exchangePattern
- the value to set- Returns:
- the dsl builder
-
enquireLinkTimer
default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder 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: <code>java.lang.Integer</code> type. Default: 60000 Group: advanced- Parameters:
enquireLinkTimer
- the value to set- Returns:
- the dsl builder
-
enquireLinkTimer
default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder enquireLinkTimer(String 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 will be converted to a <code>java.lang.Integer</code> type. Default: 60000 Group: advanced- Parameters:
enquireLinkTimer
- the value to set- Returns:
- the dsl builder
-
interfaceVersion
default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder interfaceVersion(String interfaceVersion) Defines the interface version to be used in the binding request with the SMSC. The following values are allowed, as defined in the SMPP protocol (and the underlying implementation using the jSMPP library, respectively): legacy (0x00), 3.3 (0x33), 3.4 (0x34), and 5.0 (0x50). The default (fallback) value is version 3.4. The option is a: <code>java.lang.String</code> type. Default: 3.4 Group: advanced- Parameters:
interfaceVersion
- the value to set- Returns:
- the dsl builder
-
pduProcessorDegree
default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder pduProcessorDegree(Integer pduProcessorDegree) Sets the number of threads which can read PDU and process them in parallel. The option is a: <code>java.lang.Integer</code> type. Default: 3 Group: advanced- Parameters:
pduProcessorDegree
- the value to set- Returns:
- the dsl builder
-
pduProcessorDegree
default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder pduProcessorDegree(String pduProcessorDegree) Sets the number of threads which can read PDU and process them in parallel. The option will be converted to a <code>java.lang.Integer</code> type. Default: 3 Group: advanced- Parameters:
pduProcessorDegree
- the value to set- Returns:
- the dsl builder
-
pduProcessorQueueCapacity
default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder pduProcessorQueueCapacity(Integer pduProcessorQueueCapacity) Sets the capacity of the working queue for PDU processing. The option is a: <code>java.lang.Integer</code> type. Default: 100 Group: advanced- Parameters:
pduProcessorQueueCapacity
- the value to set- Returns:
- the dsl builder
-
pduProcessorQueueCapacity
default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder pduProcessorQueueCapacity(String pduProcessorQueueCapacity) Sets the capacity of the working queue for PDU processing. The option will be converted to a <code>java.lang.Integer</code> type. Default: 100 Group: advanced- Parameters:
pduProcessorQueueCapacity
- the value to set- Returns:
- the dsl builder
-
sessionStateListener
default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder 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: <code>org.jsmpp.session.SessionStateListener</code> type. Group: advanced- Parameters:
sessionStateListener
- the value to set- Returns:
- the dsl builder
-
sessionStateListener
default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder sessionStateListener(String sessionStateListener) You can refer to a org.jsmpp.session.SessionStateListener in the Registry to receive callbacks when the session state changed. The option will be converted to a <code>org.jsmpp.session.SessionStateListener</code> type. Group: advanced- Parameters:
sessionStateListener
- the value to set- Returns:
- the dsl builder
-
singleDLR
When true, the SMSC delivery receipt would be requested only for the last segment of a multi-segment (long) message. For short messages, with only 1 segment the behaviour is unchanged. The option is a: <code>boolean</code> type. Default: false Group: advanced- Parameters:
singleDLR
- the value to set- Returns:
- the dsl builder
-
singleDLR
When true, the SMSC delivery receipt would be requested only for the last segment of a multi-segment (long) message. For short messages, with only 1 segment the behaviour is unchanged. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced- Parameters:
singleDLR
- the value to set- Returns:
- the dsl builder
-
transactionTimer
default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder 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: <code>java.lang.Integer</code> type. Default: 10000 Group: advanced- Parameters:
transactionTimer
- the value to set- Returns:
- the dsl builder
-
transactionTimer
default SmppEndpointBuilderFactory.AdvancedSmppEndpointConsumerBuilder transactionTimer(String 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 will be converted to a <code>java.lang.Integer</code> type. Default: 10000 Group: advanced- Parameters:
transactionTimer
- the value to set- Returns:
- the dsl builder
-