org.apache.camel.builder.endpoint.dsl

Interface PahoEndpointBuilderFactory.AdvancedPahoEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder, PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder

Enclosing interface:

PahoEndpointBuilderFactory

public static interface PahoEndpointBuilderFactory.AdvancedPahoEndpointBuilder
extends PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder, PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder

Advanced builder for endpoint for the Paho component.

Method Summary

Modifier and Type	Method and Description
default PahoEndpointBuilderFactory.PahoEndpointBuilder	basic()
default PahoEndpointBuilderFactory.AdvancedPahoEndpointBuilder	client(Object client) To use an existing mqtt client.
default PahoEndpointBuilderFactory.AdvancedPahoEndpointBuilder	client(String client) To use an existing mqtt client.
default PahoEndpointBuilderFactory.AdvancedPahoEndpointBuilder	customWebSocketHeaders(Properties customWebSocketHeaders) Sets the Custom WebSocket Headers for the WebSocket Connection.
default PahoEndpointBuilderFactory.AdvancedPahoEndpointBuilder	customWebSocketHeaders(String customWebSocketHeaders) Sets the Custom WebSocket Headers for the WebSocket Connection.
default PahoEndpointBuilderFactory.AdvancedPahoEndpointBuilder	executorServiceTimeout(int executorServiceTimeout) Set the time in seconds that the executor service should wait when terminating before forcefully terminating.
default PahoEndpointBuilderFactory.AdvancedPahoEndpointBuilder	executorServiceTimeout(String executorServiceTimeout) Set the time in seconds that the executor service should wait when terminating before forcefully terminating.
default PahoEndpointBuilderFactory.AdvancedPahoEndpointBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default PahoEndpointBuilderFactory.AdvancedPahoEndpointBuilder	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.endpoint.dsl.PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder

exceptionHandler, exceptionHandler, exchangePattern, exchangePattern

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

basic

default PahoEndpointBuilderFactory.PahoEndpointBuilder basic()

Specified by:

basic in interface PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder

Specified by:

basic in interface PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder

client

default PahoEndpointBuilderFactory.AdvancedPahoEndpointBuilder client(Object client)

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

Specified by:

client in interface PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder

Specified by:

client in interface PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder

Parameters:

client - the value to set

Returns:

the dsl builder

client

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

Specified by:

client in interface PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder

Specified by:

client in interface PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder

Parameters:

client - the value to set

Returns:

the dsl builder

customWebSocketHeaders

default PahoEndpointBuilderFactory.AdvancedPahoEndpointBuilder customWebSocketHeaders(Properties customWebSocketHeaders)

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

Specified by:

customWebSocketHeaders in interface PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder

Specified by:

customWebSocketHeaders in interface PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder

Parameters:

customWebSocketHeaders - the value to set

Returns:

the dsl builder

customWebSocketHeaders

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

Specified by:

customWebSocketHeaders in interface PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder

Specified by:

customWebSocketHeaders in interface PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder

Parameters:

customWebSocketHeaders - the value to set

Returns:

the dsl builder

executorServiceTimeout

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

Specified by:

executorServiceTimeout in interface PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder

Parameters:

executorServiceTimeout - the value to set

Returns:

the dsl builder

executorServiceTimeout

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

Specified by:

executorServiceTimeout in interface PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder

Parameters:

executorServiceTimeout - the value to set

Returns:

the dsl builder

synchronous

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

Specified by:

synchronous in interface PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder

Specified by:

synchronous in interface PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

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

Specified by:

synchronous in interface PahoEndpointBuilderFactory.AdvancedPahoEndpointConsumerBuilder

Specified by:

synchronous in interface PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder

Parameters:

synchronous - the value to set

Returns:

the dsl builder