Interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- All Known Subinterfaces:
PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointBuilder
- Enclosing interface:
- PahoMqtt5EndpointBuilderFactory
public static interface PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Advanced builder for endpoint producers for the Paho MQTT 5 component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default PahoMqtt5EndpointBuilderFactory.PahoMqtt5EndpointProducerBuilder
basic()
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder
client(String client)
To use an existing mqtt client.default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder
client(org.eclipse.paho.mqttv5.client.MqttClient client)
To use an existing mqtt client.default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder
customWebSocketHeaders(String customWebSocketHeaders)
Sets the Custom WebSocket Headers for the WebSocket Connection.default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder
customWebSocketHeaders(Map<String,String> customWebSocketHeaders)
Sets the Custom WebSocket Headers for the WebSocket Connection.default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder
executorServiceTimeout(int executorServiceTimeout)
Set the time in seconds that the executor service should wait when terminating before forcefully terminating.default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder
executorServiceTimeout(String executorServiceTimeout)
Set the time in seconds that the executor service should wait when terminating before forcefully terminating.default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder
lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message).
-
-
-
Method Detail
-
basic
default PahoMqtt5EndpointBuilderFactory.PahoMqtt5EndpointProducerBuilder basic()
-
lazyStartProducer
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
client
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder client(org.eclipse.paho.mqttv5.client.MqttClient 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.AdvancedPahoMqtt5EndpointProducerBuilder 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.AdvancedPahoMqtt5EndpointProducerBuilder customWebSocketHeaders(Map<String,String> customWebSocketHeaders)
Sets the Custom WebSocket Headers for the WebSocket Connection. The option is a: <code>java.util.Map<java.lang.String, java.lang.String></code> type. Group: advanced- Parameters:
customWebSocketHeaders
- the value to set- Returns:
- the dsl builder
-
customWebSocketHeaders
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder customWebSocketHeaders(String customWebSocketHeaders)
Sets the Custom WebSocket Headers for the WebSocket Connection. The option will be converted to a <code>java.util.Map<java.lang.String, java.lang.String></code> type. Group: advanced- Parameters:
customWebSocketHeaders
- the value to set- Returns:
- the dsl builder
-
executorServiceTimeout
default PahoMqtt5EndpointBuilderFactory.AdvancedPahoMqtt5EndpointProducerBuilder 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.AdvancedPahoMqtt5EndpointProducerBuilder 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
-
-