org.springframework.integration.mqtt.outbound

Class AbstractMqttMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.mqtt.outbound.AbstractMqttMessageHandler

All Implemented Interfaces:

org.reactivestreams.Subscriber<Message<?>>, Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Ordered, ExpressionCapable, Orderable, IntegrationPattern, NamedComponent, IntegrationManagement, ManageableLifecycle, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>

Direct Known Subclasses:

MqttPahoMessageHandler

public abstract class AbstractMqttMessageHandler
extends AbstractMessageHandler
implements ManageableLifecycle

Abstract class for MQTT outbound channel adapters.

Since:

4.0

Author:

Gary Russell, Artem Bilan

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

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

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

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractMqttMessageHandler(String url, String clientId)

Method Summary

Modifier and Type	Method and Description
protected abstract void	doStart()
protected abstract void	doStop()
String	getClientId()
int	getClientInstance() Incremented each time the client is connected.
String	getComponentType() Subclasses may implement this method to provide component type information.
protected MessageConverter	getConverter()
protected String	getUrl()
protected void	handleMessageInternal(Message<?> message)
protected void	incrementClientInstance()
boolean	isRunning()
protected void	onInit() Subclasses may implement this for initialization logic.
protected abstract void	publish(String topic, Object mqttMessage, Message<?> message)
void	setConverter(MessageConverter converter) Set the message converter to use; if this is provided, the adapter qos and retained settings are ignored.
void	setDefaultQos(int defaultQos) Set the qos for messages if the qosExpression evaluates to null.
void	setDefaultRetained(boolean defaultRetained) Set the retained boolean for messages if the retainedExpression evaluates to null.
void	setDefaultTopic(String defaultTopic) Set the topic to which the message will be published if the topicExpression evaluates to `null`.
void	setQosExpression(Expression qosExpression) Set the qos expression; default "headers['mqtt_qos']".
void	setQosExpressionString(String qosExpression) Set the qos expression; default "headers['mqtt_qos']".
void	setRetainedExpression(Expression retainedExpression) Set the retained expression; default "headers['mqtt_retained']".
void	setRetainedExpressionString(String retainedExpression) Set the retained expression; default "headers['mqtt_retained']".
void	setTopicExpression(Expression topicExpression) Set the topic expression; default "headers['mqtt_topic']".
void	setTopicExpressionString(String topicExpression) Set the topic expression; default "headers['mqtt_topic']".
void	start()
void	stop()

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

handleMessage, onComplete, onError, onNext, onSubscribe

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

buildSendTimer, destroy, getIntegrationPatternType, getManagedName, getManagedType, getMetricsCaptor, getOrder, getOverrides, isLoggingEnabled, registerMetricsCaptor, 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, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, 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 reactor.core.CoreSubscriber

currentContext

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

getThisAs

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

getBeanName, getComponentName

Constructor Detail

AbstractMqttMessageHandler

public AbstractMqttMessageHandler(@Nullable
                                  String url,
                                  String clientId)

Method Detail

setDefaultTopic

public void setDefaultTopic(String defaultTopic)

Set the topic to which the message will be published if the topicExpression evaluates to `null`.

Parameters:

defaultTopic - the default topic.

setTopicExpression

public void setTopicExpression(Expression topicExpression)

Set the topic expression; default "headers['mqtt_topic']".

Parameters:

topicExpression - the expression.

Since:

5.0

setTopicExpressionString

public void setTopicExpressionString(String topicExpression)

Set the topic expression; default "headers['mqtt_topic']".

Parameters:

topicExpression - the expression.

Since:

5.0

setDefaultQos

public void setDefaultQos(int defaultQos)

Set the qos for messages if the qosExpression evaluates to null. Only applies if a message converter is not provided.

Parameters:

defaultQos - the default qos.

See Also:

setConverter(MessageConverter)

setQosExpression

public void setQosExpression(Expression qosExpression)

Set the qos expression; default "headers['mqtt_qos']". Only applies if a message converter is not provided.

Parameters:

qosExpression - the expression.

Since:

5.0

See Also:

setConverter(MessageConverter)

setQosExpressionString

public void setQosExpressionString(String qosExpression)

Set the qos expression; default "headers['mqtt_qos']". Only applies if a message converter is not provided.

Parameters:

qosExpression - the expression.

Since:

5.0

See Also:

setConverter(MessageConverter)

setDefaultRetained

public void setDefaultRetained(boolean defaultRetained)

Set the retained boolean for messages if the retainedExpression evaluates to null. Only applies if a message converter is not provided.

Parameters:

defaultRetained - the default defaultRetained.

See Also:

setConverter(MessageConverter)

setRetainedExpression

public void setRetainedExpression(Expression retainedExpression)

Set the retained expression; default "headers['mqtt_retained']". Only applies if a message converter is not provided.

Parameters:

retainedExpression - the expression.

Since:

5.0

See Also:

setConverter(MessageConverter)

setRetainedExpressionString

public void setRetainedExpressionString(String retainedExpression)

Set the retained expression; default "headers['mqtt_retained']". Only applies if a message converter is not provided.

Parameters:

retainedExpression - the expression.

Since:

5.0

See Also:

setConverter(MessageConverter)

setConverter

public void setConverter(MessageConverter converter)

Set the message converter to use; if this is provided, the adapter qos and retained settings are ignored.

Parameters:

converter - the converter.

getConverter

protected MessageConverter getConverter()

getUrl

@Nullable
protected String getUrl()

getClientId

public String getClientId()

getClientInstance

public int getClientInstance()

Incremented each time the client is connected.

Returns:

The instance;

Since:

4.1

getComponentType

public String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class MessageHandlerSupport

incrementClientInstance

protected void incrementClientInstance()

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

start

public final void start()

Specified by:

start in interface Lifecycle

Specified by:

start in interface ManageableLifecycle

doStart

protected abstract void doStart()

stop

public final void stop()

Specified by:

stop in interface Lifecycle

Specified by:

stop in interface ManageableLifecycle

doStop

protected abstract void doStop()

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

Specified by:

isRunning in interface ManageableLifecycle

handleMessageInternal

protected void handleMessageInternal(Message<?> message)

Specified by:

handleMessageInternal in class AbstractMessageHandler

publish

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