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:

Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, Ordered, Orderable, TrackableComponent, NamedComponent, MessageHandler

Direct Known Subclasses:

MqttPahoMessageHandler

public abstract class AbstractMqttMessageHandler
extends AbstractMessageHandler
implements SmartLifecycle

Abstract class for MQTT outbound channel adapters.

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
AbstractMqttMessageHandler(String url, String clientId)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	connectIfNeeded()
protected abstract void	doStart()
protected abstract void	doStop()
protected String	getClientId()
String	getComponentType() Subclasses may implement this method to provide component type information.
int	getPhase()
protected String	getUrl()
protected void	handleMessageInternal(Message<?> message)
boolean	isAutoStartup()
boolean	isRunning()
protected void	onInit() Subclasses may implement this for initialization logic.
protected abstract void	publish(String topic, Object mqttMessage)
void	setAutoStartup(boolean autoStartup)
void	setConverter(MqttMessageConverter converter)
void	setDefaultQos(int defaultQos)
void	setDefaultRetained(boolean defaultRetain)
void	setDefaultTopic(String defaultTopic)
void	setPhase(int phase)
void	start()
void	stop()
void	stop(Runnable callback)

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

getOrder, handleMessage, setOrder, setShouldTrack

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

afterPropertiesSet, 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

AbstractMqttMessageHandler

public AbstractMqttMessageHandler(String url,
                          String clientId)

Method Detail

setDefaultTopic

public void setDefaultTopic(String defaultTopic)

setDefaultQos

public void setDefaultQos(int defaultQos)

setDefaultRetained

public void setDefaultRetained(boolean defaultRetain)

setConverter

public void setConverter(MqttMessageConverter converter)

getUrl

protected String getUrl()

getClientId

protected String getClientId()

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 AbstractMessageHandler

onInit

protected void onInit()
               throws Exception

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

Throws:

Exception - Any exception.

start

public final void start()

Specified by:

start in interface Lifecycle

doStart

protected abstract void doStart()

stop

public final void stop()

Specified by:

stop in interface Lifecycle

doStop

protected abstract void doStop()

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface Phased

setPhase

public void setPhase(int phase)

setAutoStartup

public void setAutoStartup(boolean autoStartup)

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface SmartLifecycle

handleMessageInternal

protected void handleMessageInternal(Message<?> message)
                              throws Exception

Specified by:

handleMessageInternal in class AbstractMessageHandler

Throws:

Exception

connectIfNeeded

protected abstract void connectIfNeeded()

publish

protected abstract void publish(String topic,
           Object mqttMessage)
                         throws Exception

Throws:

Exception