org.springframework.integration.mqtt.outbound

Class AbstractMqttMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.mqtt.outbound.AbstractMqttMessageHandler

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.core.Ordered, ExpressionCapable, Orderable, NamedComponent, ConfigurableMetricsAware<AbstractMessageHandlerMetrics>, IntegrationManagement, IntegrationStatsManagement, MessageHandlerMetrics, TrackableComponent, org.springframework.messaging.MessageHandler

Direct Known Subclasses:

MqttPahoMessageHandler

public abstract class AbstractMqttMessageHandler
extends AbstractMessageHandler
implements org.springframework.context.Lifecycle

Abstract class for MQTT outbound channel adapters.

Since:

4.0

Author:

Gary Russell, Artem Bilan

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

Constructor Summary

Constructors

Constructor and Description
AbstractMqttMessageHandler(java.lang.String url, java.lang.String clientId)

Method Summary

Modifier and Type	Method and Description
protected void	connectIfNeeded() Deprecated. subclasses should check the connection in publish(String, Object, Message).
protected abstract void	doStart()
protected abstract void	doStop()
java.lang.String	getClientId()
int	getClientInstance() Incremented each time the client is connected.
java.lang.String	getComponentType() Subclasses may implement this method to provide component type information.
protected org.springframework.messaging.converter.MessageConverter	getConverter()
protected java.lang.String	getUrl()
protected void	handleMessageInternal(org.springframework.messaging.Message<?> message)
protected void	incrementClientInstance()
boolean	isRunning()
protected void	onInit() Subclasses may implement this for initialization logic.
protected abstract void	publish(java.lang.String topic, java.lang.Object mqttMessage, org.springframework.messaging.Message<?> message)
void	setConverter(org.springframework.messaging.converter.MessageConverter converter)
void	setDefaultQos(int defaultQos)
void	setDefaultRetained(boolean defaultRetain)
void	setDefaultTopic(java.lang.String defaultTopic)
void	start()
void	stop()

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

configureMetrics, getActiveCount, getActiveCountLong, getDuration, getErrorCount, getErrorCountLong, getHandleCount, getHandleCountLong, getManagedName, getManagedType, getMaxDuration, getMeanDuration, getMinDuration, getOrder, getStandardDeviationDuration, handleMessage, isCountsEnabled, isLoggingEnabled, isStatsEnabled, reset, setCountsEnabled, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, setStatsEnabled

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

afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, 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 org.springframework.integration.support.context.NamedComponent

getComponentName

Constructor Detail

AbstractMqttMessageHandler

public AbstractMqttMessageHandler(java.lang.String url,
                                  java.lang.String clientId)

Method Detail

setDefaultTopic

public void setDefaultTopic(java.lang.String defaultTopic)

setDefaultQos

public void setDefaultQos(int defaultQos)

setDefaultRetained

public void setDefaultRetained(boolean defaultRetain)

setConverter

public void setConverter(org.springframework.messaging.converter.MessageConverter converter)

getConverter

protected org.springframework.messaging.converter.MessageConverter getConverter()

getUrl

protected java.lang.String getUrl()

getClientId

public java.lang.String getClientId()

getClientInstance

public int getClientInstance()

Incremented each time the client is connected.

Returns:

The instance;

Since:

4.1

getComponentType

public java.lang.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 AbstractMessageHandler

incrementClientInstance

protected void incrementClientInstance()

onInit

protected void onInit()
               throws java.lang.Exception

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class AbstractMessageHandler

Throws:

java.lang.Exception - Any exception.

start

public final void start()

Specified by:

start in interface org.springframework.context.Lifecycle

doStart

protected abstract void doStart()

stop

public final void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

doStop

protected abstract void doStop()

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

handleMessageInternal

protected void handleMessageInternal(org.springframework.messaging.Message<?> message)
                              throws java.lang.Exception

Specified by:

handleMessageInternal in class AbstractMessageHandler

Throws:

java.lang.Exception

connectIfNeeded

@Deprecated
protected void connectIfNeeded()

Deprecated. subclasses should check the connection in publish(String, Object, Message).

Invoked before publish(String, Object, Message).

publish

protected abstract void publish(java.lang.String topic,
                                java.lang.Object mqttMessage,
                                org.springframework.messaging.Message<?> message)
                         throws java.lang.Exception

Throws:

java.lang.Exception