Package org.springframework.integration.mqtt.outbound

Class MqttPahoMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.mqtt.outbound.AbstractMqttMessageHandler<org.eclipse.paho.client.mqttv3.IMqttAsyncClient,org.eclipse.paho.client.mqttv3.MqttConnectOptions>

org.springframework.integration.mqtt.outbound.MqttPahoMessageHandler

All Implemented Interfaces:

org.eclipse.paho.client.mqttv3.MqttCallback, org.reactivestreams.Subscriber<Message<?>>, Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, Ordered, ComponentSourceAware, ExpressionCapable, Orderable, IntegrationPattern, MqttComponent<org.eclipse.paho.client.mqttv3.MqttConnectOptions>, MqttPahoComponent, NamedComponent, IntegrationManagement, ManageableLifecycle, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>

@Deprecated(since="7.2",
            forRemoval=true)
public class MqttPahoMessageHandler
extends AbstractMqttMessageHandler<org.eclipse.paho.client.mqttv3.IMqttAsyncClient,org.eclipse.paho.client.mqttv3.MqttConnectOptions>
implements org.eclipse.paho.client.mqttv3.MqttCallback, MqttPahoComponent

Deprecated, for removal: This API element is subject to removal in a future version.

since 7.2 in favor of the spring-integration-mqtt-client module.

Eclipse Paho Implementation. When consuming MqttIntegrationEvents published by this component use MqttPahoComponent handler = event.getSourceAsType() to get a reference, allowing you to obtain the bean name and MqttConnectOptions. This technique allows consumption of events from both inbound and outbound endpoints in the same event listener.

Since:

4.0

Author:

Gary Russell, Artem Bilan, Artem Vozhdayenko, Christian Tzolov, Jaehong Park

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

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

DEFAULT_COMPLETION_TIMEOUT, DISCONNECT_COMPLETION_TIMEOUT, lock

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

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
MqttPahoMessageHandler(String url, String clientId)	Deprecated, for removal: This API element is subject to removal in a future version. Use this constructor when you don't need additional MqttConnectOptions.
MqttPahoMessageHandler(String url, String clientId, MqttPahoClientFactory clientFactory)	Deprecated, for removal: This API element is subject to removal in a future version. 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).
MqttPahoMessageHandler(String clientId, MqttPahoClientFactory clientFactory)	Deprecated, for removal: This API element is subject to removal in a future version. Use this constructor if the server URI(s) are provided by the MqttConnectOptions.getServerURIs() provided by the MqttPahoClientFactory.
MqttPahoMessageHandler(ClientManager<org.eclipse.paho.client.mqttv3.IMqttAsyncClient,org.eclipse.paho.client.mqttv3.MqttConnectOptions> clientManager)	Deprecated, for removal: This API element is subject to removal in a future version. Use this constructor when you need to use a single ClientManager (for instance, to reuse an MQTT connection).

Method Summary

Modifier and Type	Method	Description
void	connectionLost(Throwable cause)	Deprecated, for removal: This API element is subject to removal in a future version.
void	deliveryComplete(org.eclipse.paho.client.mqttv3.IMqttDeliveryToken token)	Deprecated, for removal: This API element is subject to removal in a future version.
protected void	doStart()	Deprecated, for removal: This API element is subject to removal in a future version.
protected void	doStop()	Deprecated, for removal: This API element is subject to removal in a future version.
org.eclipse.paho.client.mqttv3.MqttConnectOptions	getConnectionInfo()	Deprecated, for removal: This API element is subject to removal in a future version. Return information about the connection.
void	messageArrived(String topic, org.eclipse.paho.client.mqttv3.MqttMessage message)	Deprecated, for removal: This API element is subject to removal in a future version.
protected void	onInit()	Deprecated, for removal: This API element is subject to removal in a future version. Subclasses may implement this for initialization logic.
protected void	publish(String topic, Object mqttMessage, Message<?> message)	Deprecated, for removal: This API element is subject to removal in a future version.

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

getApplicationEventPublisher, getClientId, getClientInstance, getClientManager, getCompletionTimeout, getComponentType, getConverter, getDefaultQos, getDefaultRetained, getDefaultTopic, getDisconnectCompletionTimeout, getQosProcessor, getRetainedProcessor, getTopicProcessor, getUrl, handleMessageInternal, incrementClientInstance, isAsync, isRunning, messageSentEvent, sendDeliveryCompleteEvent, sendFailedDeliveryEvent, setApplicationEventPublisher, setAsync, setAsyncEvents, setCompletionTimeout, setConverter, setDefaultQos, setDefaultRetained, setDefaultTopic, setDisconnectCompletionTimeout, setQosExpression, setQosExpressionString, setRetainedExpression, setRetainedExpressionString, setTopicExpression, setTopicExpressionString, start, stop

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

handleMessage, onComplete, onError, onNext, onSubscribe, setObservationConvention

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

buildSendTimer, destroy, getIntegrationPatternType, getManagedName, getManagedType, getMetricsCaptor, getObservationRegistry, getOrder, getOverrides, isLoggingEnabled, isObserved, registerMetricsCaptor, registerObservationRegistry, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

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

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, setConversionService, setMessageBuilderFactory, setPrimaryExpression, 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.beans.factory.BeanNameAware

setBeanName

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

getThisAs

Methods inherited from interface org.springframework.integration.mqtt.core.MqttComponent

getBeanName

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

getBeanName, getComponentName

Constructor Details

MqttPahoMessageHandler

public MqttPahoMessageHandler(String url,
 String clientId)

Deprecated, for removal: This API element is subject to removal in a future version.

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

Parameters:

url - The URL.

clientId - The client id.

MqttPahoMessageHandler

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

Deprecated, for removal: This API element is subject to removal in a future version.

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)

Deprecated, for removal: This API element is subject to removal in a future version.

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(ClientManager<org.eclipse.paho.client.mqttv3.IMqttAsyncClient,org.eclipse.paho.client.mqttv3.MqttConnectOptions> clientManager)

Deprecated, for removal: This API element is subject to removal in a future version.

Use this constructor when you need to use a single ClientManager (for instance, to reuse an MQTT connection).

Parameters:

clientManager - The client manager.

Since:

6.0

Method Details

getConnectionInfo

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

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: MqttComponent

Return information about the connection.

Specified by:

getConnectionInfo in interface MqttComponent<org.eclipse.paho.client.mqttv3.MqttConnectOptions>

Specified by:

getConnectionInfo in interface MqttPahoComponent

Returns:

the information.

onInit

protected void onInit()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class AbstractMqttMessageHandler<org.eclipse.paho.client.mqttv3.IMqttAsyncClient,org.eclipse.paho.client.mqttv3.MqttConnectOptions>

doStart

protected void doStart()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

doStart in class AbstractMqttMessageHandler<org.eclipse.paho.client.mqttv3.IMqttAsyncClient,org.eclipse.paho.client.mqttv3.MqttConnectOptions>

doStop

protected void doStop()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

doStop in class AbstractMqttMessageHandler<org.eclipse.paho.client.mqttv3.IMqttAsyncClient,org.eclipse.paho.client.mqttv3.MqttConnectOptions>

publish

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

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

publish in class AbstractMqttMessageHandler<org.eclipse.paho.client.mqttv3.IMqttAsyncClient,org.eclipse.paho.client.mqttv3.MqttConnectOptions>

connectionLost

public void connectionLost(Throwable cause)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

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

messageArrived

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

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

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

deliveryComplete

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

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

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