org.apache.camel.component.paho

Class PahoEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.paho.PahoEndpoint

All Implemented Interfaces:

CamelContextAware, Endpoint, IsSingleton, Service, ShutdownableService, HasId, StatefulService, SuspendableService

@UriEndpoint(scheme="paho",
             title="Paho",
             consumerClass=PahoConsumer.class,
             label="messaging,iot",
             syntax="paho:topic")
public class PahoEndpoint
extends DefaultEndpoint

Component for communicating with MQTT M2M message brokers using Eclipse Paho MQTT Client.

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
PahoEndpoint(String uri, String topic, Component component)

Method Summary

Modifier and Type	Method and Description
Consumer	createConsumer(Processor processor) Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor
Exchange	createExchange(org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage, String topic)
Producer	createProducer() Creates a new producer which is used send messages into the endpoint
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
String	getBrokerUrl()
org.eclipse.paho.client.mqttv3.MqttClient	getClient()
String	getClientId()
PahoComponent	getComponent() Returns the component that created this endpoint.
org.eclipse.paho.client.mqttv3.MqttConnectOptions	getConnectOptions()
String	getFilePersistenceDirectory()
PahoPersistence	getPersistence()
int	getQos()
String	getTopic()
boolean	isRetained()
boolean	isSingleton() Whether this class supports being singleton or not.
protected org.eclipse.paho.client.mqttv3.MqttConnectOptions	resolveMqttConnectOptions()
protected org.eclipse.paho.client.mqttv3.MqttClientPersistence	resolvePersistence()
void	setBrokerUrl(String brokerUrl) The URL of the MQTT broker.
void	setClient(org.eclipse.paho.client.mqttv3.MqttClient client) To use the existing MqttClient instance as client.
void	setClientId(String clientId) MQTT client identifier.
void	setConnectOptions(org.eclipse.paho.client.mqttv3.MqttConnectOptions connOpts) Client connection options
void	setFilePersistenceDirectory(String filePersistenceDirectory) Base directory used by the file persistence provider.
void	setPersistence(PahoPersistence persistence) Client persistence to be used - memory or file.
void	setQos(int qos) Client quality of service level (0-2).
void	setRetained(boolean retained) Retain option
void	setTopic(String topic) Name of the topic

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

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

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

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, 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.Service

start, stop

Constructor Detail

PahoEndpoint

public PahoEndpoint(String uri,
                    String topic,
                    Component component)

Method Detail

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Overrides:

doStart in class DefaultEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Overrides:

doStop in class DefaultEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStart()

createProducer

public Producer createProducer()
                        throws Exception

Description copied from interface: Endpoint

Creates a new producer which is used send messages into the endpoint

Returns:

a newly created producer

Throws:

Exception - can be thrown

createConsumer

public Consumer createConsumer(Processor processor)
                        throws Exception

Description copied from interface: Endpoint

Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor

Parameters:

processor - the given processor

Returns:

a newly created consumer

Throws:

Exception - can be thrown

isSingleton

public boolean isSingleton()

Description copied from interface: IsSingleton

Whether this class supports being singleton or not.

Returns:

true to be a single shared instance, false to create new instances.

getComponent

public PahoComponent getComponent()

Description copied from class: DefaultEndpoint

Returns the component that created this endpoint.

Overrides:

getComponent in class DefaultEndpoint

Returns:

the component that created this endpoint, or null if none set

resolvePersistence

protected org.eclipse.paho.client.mqttv3.MqttClientPersistence resolvePersistence()

resolveMqttConnectOptions

protected org.eclipse.paho.client.mqttv3.MqttConnectOptions resolveMqttConnectOptions()

createExchange

public Exchange createExchange(org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage,
                               String topic)

getClientId

public String getClientId()

setClientId

public void setClientId(String clientId)

MQTT client identifier.

getBrokerUrl

public String getBrokerUrl()

setBrokerUrl

public void setBrokerUrl(String brokerUrl)

The URL of the MQTT broker.

getTopic

public String getTopic()

setTopic

public void setTopic(String topic)

Name of the topic

getQos

public int getQos()

setQos

public void setQos(int qos)

Client quality of service level (0-2).

isRetained

public boolean isRetained()

setRetained

public void setRetained(boolean retained)

Retain option

Parameters:

retained - true/false

getPersistence

public PahoPersistence getPersistence()

setPersistence

public void setPersistence(PahoPersistence persistence)

Client persistence to be used - memory or file.

getFilePersistenceDirectory

public String getFilePersistenceDirectory()

setFilePersistenceDirectory

public void setFilePersistenceDirectory(String filePersistenceDirectory)

Base directory used by the file persistence provider.

getClient

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

setClient

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

To use the existing MqttClient instance as client.

getConnectOptions

public org.eclipse.paho.client.mqttv3.MqttConnectOptions getConnectOptions()

setConnectOptions

public void setConnectOptions(org.eclipse.paho.client.mqttv3.MqttConnectOptions connOpts)

Client connection options