org.apache.camel.builder.endpoint.dsl

Interface PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

PahoEndpointBuilderFactory.AdvancedPahoEndpointBuilder

Enclosing interface:

PahoEndpointBuilderFactory

public static interface PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Advanced builder for endpoint consumers for the Paho component.

Method Summary

Modifier and Type	Method and Description
default PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder	basic()
default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder	client(Object client) To use an existing mqtt client.
default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder	client(String client) To use an existing mqtt client.
default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder	customWebSocketHeaders(Properties customWebSocketHeaders) Sets the Custom WebSocket Headers for the WebSocket Connection.
default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder	customWebSocketHeaders(String customWebSocketHeaders) Sets the Custom WebSocket Headers for the WebSocket Connection.
default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder	exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler) To let the consumer use a custom ExceptionHandler.
default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder	exceptionHandler(String exceptionHandler) To let the consumer use a custom ExceptionHandler.
default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder	exchangePattern(org.apache.camel.ExchangePattern exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder	exchangePattern(String exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder	executorServiceTimeout(int executorServiceTimeout) Set the time in seconds that the executor service should wait when terminating before forcefully terminating.
default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder	executorServiceTimeout(String executorServiceTimeout) Set the time in seconds that the executor service should wait when terminating before forcefully terminating.
default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder	synchronous(String synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

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

basic

default PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder basic()

exceptionHandler

default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder 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 PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder 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 PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder 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 PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder 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

client

default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder client(Object client)

To use an existing mqtt client. The option is a: <code>org.eclipse.paho.client.mqttv3.MqttClient</code> type. Group: advanced

Parameters:

client - the value to set

Returns:

the dsl builder

client

default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder client(String client)

To use an existing mqtt client. The option will be converted to a <code>org.eclipse.paho.client.mqttv3.MqttClient</code> type. Group: advanced

Parameters:

client - the value to set

Returns:

the dsl builder

customWebSocketHeaders

default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder customWebSocketHeaders(Properties customWebSocketHeaders)

Sets the Custom WebSocket Headers for the WebSocket Connection. The option is a: <code>java.util.Properties</code> type. Group: advanced

Parameters:

customWebSocketHeaders - the value to set

Returns:

the dsl builder

customWebSocketHeaders

default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder customWebSocketHeaders(String customWebSocketHeaders)

Sets the Custom WebSocket Headers for the WebSocket Connection. The option will be converted to a <code>java.util.Properties</code> type. Group: advanced

Parameters:

customWebSocketHeaders - the value to set

Returns:

the dsl builder

executorServiceTimeout

default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder executorServiceTimeout(int executorServiceTimeout)

Set the time in seconds that the executor service should wait when terminating before forcefully terminating. It is not recommended to change this value unless you are absolutely sure that you need to. The option is a: <code>int</code> type. Default: 1 Group: advanced

Parameters:

executorServiceTimeout - the value to set

Returns:

the dsl builder

executorServiceTimeout

default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder executorServiceTimeout(String executorServiceTimeout)

Set the time in seconds that the executor service should wait when terminating before forcefully terminating. It is not recommended to change this value unless you are absolutely sure that you need to. The option will be converted to a <code>int</code> type. Default: 1 Group: advanced

Parameters:

executorServiceTimeout - the value to set

Returns:

the dsl builder

synchronous

default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder synchronous(boolean synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

default PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder synchronous(String synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

synchronous - the value to set

Returns:

the dsl builder