org.springframework.integration.mqtt.outbound

Class MqttPahoMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.mqtt.outbound.AbstractMqttMessageHandler

org.springframework.integration.mqtt.outbound.MqttPahoMessageHandler

All Implemented Interfaces:

org.eclipse.paho.client.mqttv3.MqttCallback, Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, Ordered, Orderable, TrackableComponent, NamedComponent, MessageHandler

public class MqttPahoMessageHandler
extends AbstractMqttMessageHandler
implements org.eclipse.paho.client.mqttv3.MqttCallback, ApplicationEventPublisherAware

Eclipse Paho implementation.

Since:

4.0

Author:

Gary Russell

Field Summary

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
MqttPahoMessageHandler(String clientId, MqttPahoClientFactory clientFactory) Use this constructor if the server URI(s) are provided by the MqttConnectOptions.getServerURIs() provided by the MqttPahoClientFactory.
MqttPahoMessageHandler(String url, String clientId) Use this URL when you don't need additional MqttConnectOptions.
MqttPahoMessageHandler(String url, String clientId, MqttPahoClientFactory clientFactory) Use this constructor for a single url (although it may be overridden if the server URI(s) are provided by the MqttConnectOptions.getServerURIs() provided by the MqttPahoClientFactory).

Method Summary

Modifier and Type	Method and Description
protected void	connectIfNeeded()
void	connectionLost(Throwable cause)
void	deliveryComplete(org.eclipse.paho.client.mqttv3.IMqttDeliveryToken token)
protected void	doStart()
protected void	doStop()
void	messageArrived(String topic, org.eclipse.paho.client.mqttv3.MqttMessage message)
protected void	onInit() Subclasses may implement this for initialization logic.
protected void	publish(String topic, Object mqttMessage, Message<?> message)
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
void	setAsync(boolean async) Set to true if you don't want to block when sending messages.
void	setAsyncEvents(boolean asyncEvents) When setAsync(boolean) is true, setting this to true enables publication of MqttMessageSentEvent and MqttMessageDeliveredEvent to be emitted.
void	setCompletionTimeout(int completionTimeout) Set the completion timeout for async operations.

Methods inherited from class org.springframework.integration.mqtt.outbound.AbstractMqttMessageHandler

getClientId, getClientInstance, getComponentType, getConverter, getUrl, handleMessageInternal, incrementClientInstance, isRunning, setConverter, setDefaultQos, setDefaultRetained, setDefaultTopic, start, stop

Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler

getOrder, handleMessage, setOrder, setShouldTrack

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getComponentName, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setConversionService, setMessageBuilderFactory, setTaskScheduler, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getComponentName

Constructor Detail

MqttPahoMessageHandler

public MqttPahoMessageHandler(String url,
                              String clientId,
                              MqttPahoClientFactory clientFactory)

Use this constructor for a single url (although it may be overridden if the server URI(s) are provided by the MqttConnectOptions.getServerURIs() provided by the MqttPahoClientFactory).

Parameters:

url - the URL.

clientId - The client id.

clientFactory - The client factory.

MqttPahoMessageHandler

public MqttPahoMessageHandler(String clientId,
                              MqttPahoClientFactory clientFactory)

Use this constructor if the server URI(s) are provided by the MqttConnectOptions.getServerURIs() provided by the MqttPahoClientFactory.

Parameters:

clientId - The client id.

clientFactory - The client factory.

Since:

4.1

MqttPahoMessageHandler

public MqttPahoMessageHandler(String url,
                              String clientId)

Use this URL when you don't need additional MqttConnectOptions.

Parameters:

url - The URL.

clientId - The client id.

Method Detail

setAsync

public void setAsync(boolean async)

Set to true if you don't want to block when sending messages. Default false. When true, message sent/delivered events will be published for reception by a suitably configured 'ApplicationListener' or an event inbound-channel-adapter.

Parameters:

async - true for async.

Since:

4.1

setAsyncEvents

public void setAsyncEvents(boolean asyncEvents)

When setAsync(boolean) is true, setting this to true enables publication of MqttMessageSentEvent and MqttMessageDeliveredEvent to be emitted. Default false.

Parameters:

asyncEvents - the asyncEvents.

Since:

4.1

setCompletionTimeout

public void setCompletionTimeout(int completionTimeout)

Set the completion timeout for async operations. Not settable using the namespace. Default 30000 milliseconds.

Parameters:

completionTimeout - The timeout.

Since:

4.1

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

onInit

protected void onInit()
               throws Exception

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class AbstractMqttMessageHandler

Throws:

Exception - Any exception.

doStart

protected void doStart()

Specified by:

doStart in class AbstractMqttMessageHandler

doStop

protected void doStop()

Specified by:

doStop in class AbstractMqttMessageHandler

connectIfNeeded

protected void connectIfNeeded()

Specified by:

connectIfNeeded in class AbstractMqttMessageHandler

publish

protected void publish(String topic,
                       Object mqttMessage,
                       Message<?> message)
                throws Exception

Specified by:

publish in class AbstractMqttMessageHandler

Throws:

Exception

connectionLost

public void connectionLost(Throwable cause)

Specified by:

connectionLost in interface org.eclipse.paho.client.mqttv3.MqttCallback

messageArrived

public void messageArrived(String topic,
                           org.eclipse.paho.client.mqttv3.MqttMessage message)
                    throws Exception

Specified by:

messageArrived in interface org.eclipse.paho.client.mqttv3.MqttCallback

Throws:

Exception

deliveryComplete

public void deliveryComplete(org.eclipse.paho.client.mqttv3.IMqttDeliveryToken token)

Specified by:

deliveryComplete in interface org.eclipse.paho.client.mqttv3.MqttCallback