Interface PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- All Known Subinterfaces:
PahoEndpointBuilderFactory.AdvancedPahoEndpointBuilder
- Enclosing interface:
- PahoEndpointBuilderFactory
public static interface PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Advanced builder for endpoint producers for the Paho component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default PahoEndpointBuilderFactory.PahoEndpointProducerBuilder
basic()
default PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder
client(String client)
To use an existing mqtt client.default PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder
client(org.eclipse.paho.client.mqttv3.MqttClient client)
To use an existing mqtt client.default PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder
customWebSocketHeaders(String customWebSocketHeaders)
Sets the Custom WebSocket Headers for the WebSocket Connection.default PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder
customWebSocketHeaders(Properties customWebSocketHeaders)
Sets the Custom WebSocket Headers for the WebSocket Connection.default PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder
executorServiceTimeout(int executorServiceTimeout)
Set the time in seconds that the executor service should wait when terminating before forcefully terminating.default PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder
executorServiceTimeout(String executorServiceTimeout)
Set the time in seconds that the executor service should wait when terminating before forcefully terminating.default PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder
lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message).
-
-
-
Method Detail
-
basic
default PahoEndpointBuilderFactory.PahoEndpointProducerBuilder basic()
-
lazyStartProducer
default PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder 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 PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder 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 PahoEndpointBuilderFactory.AdvancedPahoEndpointProducerBuilder client(org.eclipse.paho.client.mqttv3.MqttClient 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.AdvancedPahoEndpointProducerBuilder 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.AdvancedPahoEndpointProducerBuilder 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.AdvancedPahoEndpointProducerBuilder 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.AdvancedPahoEndpointProducerBuilder 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.AdvancedPahoEndpointProducerBuilder 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
-
-