Package org.apache.camel.builder.endpoint.dsl

Interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder, PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder

Enclosing interface:

PahoMqtt5EndpointBuilderFactory

public static interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointBuilder
extends PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder, PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder

Advanced builder for endpoint for the Paho MQTT 5 component.

Method Summary

Modifier and Type	Method	Description
default PahoMqtt5EndpointBuilderFactory.PahoMqtt5EndpointBuilder	basic()
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointBuilder	client(Object client)	To use an existing mqtt client.
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointBuilder	client(String client)	To use an existing mqtt client.
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointBuilder	customWebSocketHeaders(String customWebSocketHeaders)	Sets the Custom WebSocket Headers for the WebSocket Connection.
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointBuilder	customWebSocketHeaders(Map<String,String> customWebSocketHeaders)	Sets the Custom WebSocket Headers for the WebSocket Connection.
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointBuilder	executorServiceTimeout(int executorServiceTimeout)	Set the time in seconds that the executor service should wait when terminating before forcefully terminating.
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointBuilder	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, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder

exceptionHandler, exceptionHandler, exchangePattern, exchangePattern

Method Detail

basic

default PahoMqtt5EndpointBuilderFactory.PahoMqtt5EndpointBuilder basic()

Specified by:

basic in interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder

Specified by:

basic in interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder

client

default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointBuilder client(Object client)

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

Specified by:

client in interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder

Specified by:

client in interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder

Parameters:

client - the value to set

Returns:

the dsl builder

client

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

Specified by:

client in interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder

Specified by:

client in interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder

Parameters:

client - the value to set

Returns:

the dsl builder

customWebSocketHeaders

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

Specified by:

customWebSocketHeaders in interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder

Specified by:

customWebSocketHeaders in interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder

Parameters:

customWebSocketHeaders - the value to set

Returns:

the dsl builder

customWebSocketHeaders

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

Specified by:

customWebSocketHeaders in interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder

Specified by:

customWebSocketHeaders in interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder

Parameters:

customWebSocketHeaders - the value to set

Returns:

the dsl builder

executorServiceTimeout

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

Specified by:

executorServiceTimeout in interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder

Specified by:

executorServiceTimeout in interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder

Parameters:

executorServiceTimeout - the value to set

Returns:

the dsl builder

executorServiceTimeout

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

Specified by:

executorServiceTimeout in interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointConsumerBuilder

Specified by:

executorServiceTimeout in interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder

Parameters:

executorServiceTimeout - the value to set

Returns:

the dsl builder