Package org.springframework.integration.mqtt.client.inbound

Class AbstractMqttMessageDrivenChannelAdapter<T extends com.hivemq.client.mqtt.MqttClient>

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

org.springframework.integration.endpoint.MessageProducerSupport

org.springframework.integration.mqtt.client.inbound.AbstractMqttMessageDrivenChannelAdapter<T>

Type Parameters:

T - MQTT Client type

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, SmartInitializingSingleton, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, Phased, SmartLifecycle, ComponentSourceAware, ExpressionCapable, MessageProducer, IntegrationPattern, ClientManager.ConnectCallback, NamedComponent, IntegrationInboundManagement, IntegrationManagement, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent

Direct Known Subclasses:

Mqtt3MessageDrivenChannelAdapter, Mqtt5MessageDrivenChannelAdapter

public abstract class AbstractMqttMessageDrivenChannelAdapter<T extends com.hivemq.client.mqtt.MqttClient>
extends MessageProducerSupport
implements ApplicationEventPublisherAware, ClientManager.ConnectCallback

Abstract class for MQTT Message-Driven Channel Adapters.

Since:

7.2

Author:

Jiandong Ma, WooSeung Kim

Nested Class Summary

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

IntegrationManagement.ManagementOverrides

Field Summary

Fields

Modifier and Type	Field	Description
protected final AtomicBoolean	isSubscribed
protected final AtomicBoolean	isSubscribing
protected SmartMessageConverter	messageConverter
protected final ClientManager<T>	mqttClientManager

Fields inherited from class org.springframework.integration.endpoint.AbstractEndpoint

lifecycleLock

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.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMqttMessageDrivenChannelAdapter(ClientManager<T> mqttClientManager)
protected	AbstractMqttMessageDrivenChannelAdapter(ClientManager<T> mqttClientManager, String... topics)

Method Summary

Modifier and Type	Method	Description
void	destroy()
protected ApplicationEventPublisher	getApplicationEventPublisher()
protected T	getClient()
String	getComponentType()
protected @Nullable Executor	getExecutor()
protected SmartMessageConverter	getMessageConverter()
protected Class<?>	getPayloadType()
protected com.hivemq.client.mqtt.datatypes.MqttQos	getQos()
protected String @Nullable []	getTopics()
boolean	isConnected()	Return whether the mqttClient isConnected.
protected boolean	isManualAck()
protected void	onInit()	Subclasses may implement this for initialization logic.
protected void	sendReceivedMessage(Object mqttPublish, Supplier<Message<?>> messageSupplier, SimpleAcknowledgment acknowledgment, Function<RuntimeException,MqttIntegrationEvent> conversionFailedEventFactory)	Send a message built from a received MQTT publish.
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
void	setExecutor(Executor executor)	Set the executor where the message callback is executed on.
void	setManualAck(boolean manualAck)	Set whether the Publish messages are acknowledged manually.
void	setMessageConverter(SmartMessageConverter messageConverter)	Set the messageConverter to convert the payload to the expected payloadType.
void	setPayloadType(Class<?> payloadType)	Set the type of the target message payload to produce after conversion from MQTT message.
void	setQos(com.hivemq.client.mqtt.datatypes.MqttQos qos)	Set the QoS for the topic

Methods inherited from class org.springframework.integration.endpoint.MessageProducerSupport

afterSingletonsInstantiated, buildErrorMessage, doStart, doStop, getErrorChannel, getErrorMessageAttributes, getErrorMessageStrategy, getIntegrationPatternType, getMessagingTemplate, getOutputChannel, getOutputChannelName, getRequiredOutputChannel, isObserved, registerObservationRegistry, sendErrorMessageIfNecessary, sendMessage, setErrorChannel, setErrorChannelName, setErrorMessageStrategy, setObservationConvention, setOutputChannel, setOutputChannelName, setSendTimeout, setShouldTrack, subscribeToPublisher

Methods inherited from class org.springframework.integration.endpoint.AbstractEndpoint

doStop, getPhase, getRole, isActive, isAutoStartup, isRunning, setAutoStartup, setPhase, setRole, start, stop, stop

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.integration.mqtt.client.core.ClientManager.ConnectCallback

onClientConnected

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

getManagedName, getManagedType, getOverrides, getThisAs, isLoggingEnabled, registerMetricsCaptor, setLoggingEnabled, setManagedName, setManagedType

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

getBeanName, getComponentName

Methods inherited from interface org.springframework.context.SmartLifecycle

isPauseable

Field Details

mqttClientManager

protected final ClientManager<T extends com.hivemq.client.mqtt.MqttClient> mqttClientManager

isSubscribing

protected final AtomicBoolean isSubscribing

isSubscribed

protected final AtomicBoolean isSubscribed

messageConverter

protected SmartMessageConverter messageConverter

Constructor Details

AbstractMqttMessageDrivenChannelAdapter

protected AbstractMqttMessageDrivenChannelAdapter(ClientManager<T> mqttClientManager)

AbstractMqttMessageDrivenChannelAdapter

protected AbstractMqttMessageDrivenChannelAdapter(ClientManager<T> mqttClientManager,
 String... topics)

Method Details

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

getApplicationEventPublisher

protected ApplicationEventPublisher getApplicationEventPublisher()

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class MessageProducerSupport

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

Specified by:

destroy in interface IntegrationManagement

Overrides:

destroy in class AbstractEndpoint

getClient

protected T getClient()

setMessageConverter

public void setMessageConverter(SmartMessageConverter messageConverter)

Set the messageConverter to convert the payload to the expected payloadType.

Parameters:

messageConverter - the messageConverter

getMessageConverter

protected SmartMessageConverter getMessageConverter()

getTopics

protected String @Nullable [] getTopics()

setQos

public void setQos(com.hivemq.client.mqtt.datatypes.MqttQos qos)

Set the QoS for the topic

Parameters:

qos - The qos value

getQos

protected com.hivemq.client.mqtt.datatypes.MqttQos getQos()

setManualAck

public void setManualAck(boolean manualAck)

Set whether the Publish messages are acknowledged manually.

Parameters:

manualAck - true for manual ack.

isManualAck

protected boolean isManualAck()

setExecutor

public void setExecutor(Executor executor)

Set the executor where the message callback is executed on.

Parameters:

executor - the executor.

getExecutor

protected @Nullable Executor getExecutor()

setPayloadType

public void setPayloadType(Class<?> payloadType)

Set the type of the target message payload to produce after conversion from MQTT message. Defaults to byte[].class. Can be set to Mqtt5Publish for v5 or Mqtt3Publish to produce the whole MQTT message as a payload.

Parameters:

payloadType - the expected payload type to convert MQTT message to.

getPayloadType

protected Class<?> getPayloadType()

isConnected

public boolean isConnected()

Return whether the mqttClient isConnected.

Returns:

whether the mqttClient isConnected.

sendReceivedMessage

protected void sendReceivedMessage(Object mqttPublish,
 Supplier<Message<?>> messageSupplier,
 SimpleAcknowledgment acknowledgment,
 Function<RuntimeException,MqttIntegrationEvent> conversionFailedEventFactory)

Send a message built from a received MQTT publish. An exception must not be thrown into the MQTT client callback since it terminates the subscription. If the message cannot be built, the failure is logged, the publish is acknowledged in manual acknowledgment mode, and a conversion failure event is emitted. A downstream failure is sent to the error channel, if any; otherwise, or if the error flow fails, it is logged.

Parameters:

mqttPublish - the received MQTT publish.

messageSupplier - the supplier for the message to send.

acknowledgment - the acknowledgment for the received MQTT publish.

conversionFailedEventFactory - the factory for the event to emit when the message cannot be built.

getComponentType

public String getComponentType()

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class MessageProducerSupport