org.apache.camel.builder.endpoint.dsl

Interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointBuilder

Enclosing interface:

PahoMqtt5EndpointBuilderFactory

public static interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Advanced builder for endpoint consumers for the Paho MQTT 5 component.

Method Summary

Modifier and Type	Method and Description
default PahoMqtt5EndpointBuilderFactory.PahoMqtt5EndpointConsumerBuilder	basic()
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder	client(Object client) To use an existing mqtt client.
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder	client(String client) To use an existing mqtt client.
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder	customWebSocketHeaders(Map<String,String> customWebSocketHeaders) Sets the Custom WebSocket Headers for the WebSocket Connection.
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder	customWebSocketHeaders(String customWebSocketHeaders) Sets the Custom WebSocket Headers for the WebSocket Connection.
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder	exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler) To let the consumer use a custom ExceptionHandler.
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder	exceptionHandler(String exceptionHandler) To let the consumer use a custom ExceptionHandler.
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder	exchangePattern(org.apache.camel.ExchangePattern exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder	exchangePattern(String exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder	executorServiceTimeout(int executorServiceTimeout) Set the time in seconds that the executor service should wait when terminating before forcefully terminating.
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder	executorServiceTimeout(String executorServiceTimeout) Set the time in seconds that the executor service should wait when terminating before forcefully terminating.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

basic

default PahoMqtt5EndpointBuilderFactory.PahoMqtt5EndpointConsumerBuilder basic()

exceptionHandler

default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder 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 PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder 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 PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder 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 PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder 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 PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder client(Object client)

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

Parameters:

client - the value to set

Returns:

the dsl builder

client

default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder client(String client)

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

Parameters:

client - the value to set

Returns:

the dsl builder

customWebSocketHeaders

default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder customWebSocketHeaders(Map<String,String> customWebSocketHeaders)

Sets the Custom WebSocket Headers for the WebSocket Connection. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.String&gt;</code> type. Group: advanced

Parameters:

customWebSocketHeaders - the value to set

Returns:

the dsl builder

customWebSocketHeaders

default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder customWebSocketHeaders(String customWebSocketHeaders)

Sets the Custom WebSocket Headers for the WebSocket Connection. The option will be converted to a <code>java.util.Map&lt;java.lang.String, java.lang.String&gt;</code> type. Group: advanced

Parameters:

customWebSocketHeaders - the value to set

Returns:

the dsl builder

executorServiceTimeout

default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder 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 PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder 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