Package org.apache.camel.component.paho

Class PahoEndpoint

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultEndpoint

org.apache.camel.component.paho.PahoEndpoint

All Implemented Interfaces:

AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(firstVersion="2.16.0",
             scheme="paho",
             title="Paho",
             category={MESSAGING,IOT},
             syntax="paho:topic",
             headersClass=PahoConstants.class)
public class PahoEndpoint
extends org.apache.camel.support.DefaultEndpoint

Communicate with MQTT message brokers using Eclipse Paho MQTT Client.

Field Summary

Fields inherited from class org.apache.camel.support.service.BaseService

BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor	Description
PahoEndpoint(String uri, String topic, PahoComponent component, PahoConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
protected static org.eclipse.paho.client.mqttv3.MqttClientPersistence	createMqttClientPersistence(PahoConfiguration configuration)
protected static org.eclipse.paho.client.mqttv3.MqttConnectOptions	createMqttConnectOptions(PahoConfiguration config)
org.apache.camel.Producer	createProducer()
org.eclipse.paho.client.mqttv3.MqttClient	getClient()
PahoComponent	getComponent()
PahoConfiguration	getConfiguration()
String	getTopic()
void	setClient(org.eclipse.paho.client.mqttv3.MqttClient client)	To use an existing mqtt client

Methods inherited from class org.apache.camel.support.DefaultEndpoint

configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, doStart, doStop, equals, getCamelContext, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isPollingConsumerCopy, isSingleton, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerCopy, setPollingConsumerQueueSize, setProperties, toString

Methods inherited from class org.apache.camel.support.service.BaseService

build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Endpoint

getEndpointBaseUri, isSingletonProducer

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Methods inherited from interface org.apache.camel.StatefulService

getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Constructor Detail

PahoEndpoint

public PahoEndpoint(String uri,
                    String topic,
                    PahoComponent component,
                    PahoConfiguration configuration)

Method Detail

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Throws:

Exception

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Throws:

Exception

getComponent

public PahoComponent getComponent()

Overrides:

getComponent in class org.apache.camel.support.DefaultEndpoint

getTopic

public String getTopic()

createMqttConnectOptions

protected static org.eclipse.paho.client.mqttv3.MqttConnectOptions createMqttConnectOptions(PahoConfiguration config)

createMqttClientPersistence

protected static org.eclipse.paho.client.mqttv3.MqttClientPersistence createMqttClientPersistence(PahoConfiguration configuration)

getConfiguration

public PahoConfiguration getConfiguration()

getClient

public org.eclipse.paho.client.mqttv3.MqttClient getClient()

setClient

public void setClient(org.eclipse.paho.client.mqttv3.MqttClient client)

To use an existing mqtt client