org.apache.camel.builder.component.dsl

Interface PahoComponentBuilderFactory.PahoComponentBuilder

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.paho.PahoComponent>

All Known Implementing Classes:

PahoComponentBuilderFactory.PahoComponentBuilderImpl

Enclosing interface:

PahoComponentBuilderFactory

public static interface PahoComponentBuilderFactory.PahoComponentBuilder
extends ComponentBuilder<org.apache.camel.component.paho.PahoComponent>

Builder for the Paho component.

Method Summary

Modifier and Type	Method and Description
default PahoComponentBuilderFactory.PahoComponentBuilder	basicPropertyBinding(boolean basicPropertyBinding) Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
default PahoComponentBuilderFactory.PahoComponentBuilder	bridgeErrorHandler(boolean bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
default PahoComponentBuilderFactory.PahoComponentBuilder	brokerUrl(String brokerUrl) The URL of the MQTT broker.
default PahoComponentBuilderFactory.PahoComponentBuilder	client(org.eclipse.paho.client.mqttv3.MqttClient client) To use a shared Paho client.
default PahoComponentBuilderFactory.PahoComponentBuilder	configuration(org.apache.camel.component.paho.PahoConfiguration configuration) To use the shared Paho configuration.
default PahoComponentBuilderFactory.PahoComponentBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

build, build, doSetProperty, register

Method Detail

brokerUrl

default PahoComponentBuilderFactory.PahoComponentBuilder brokerUrl(String brokerUrl)

The URL of the MQTT broker. The option is a: java.lang.String type. Group: common

configuration

default PahoComponentBuilderFactory.PahoComponentBuilder configuration(org.apache.camel.component.paho.PahoConfiguration configuration)

To use the shared Paho configuration. The option is a: org.apache.camel.component.paho.PahoConfiguration type. Group: common

bridgeErrorHandler

default PahoComponentBuilderFactory.PahoComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: boolean type. Default: false Group: consumer

lazyStartProducer

default PahoComponentBuilderFactory.PahoComponentBuilder 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: boolean type. Default: false Group: producer

basicPropertyBinding

default PahoComponentBuilderFactory.PahoComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced

client

default PahoComponentBuilderFactory.PahoComponentBuilder client(org.eclipse.paho.client.mqttv3.MqttClient client)

To use a shared Paho client. The option is a: org.eclipse.paho.client.mqttv3.MqttClient type. Group: advanced