Class Mqtt5MessageDrivenChannelAdapter

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<com.hivemq.client.mqtt.mqtt5.Mqtt5Client>

org.springframework.integration.mqtt.client.inbound.Mqtt5MessageDrivenChannelAdapter

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

public class Mqtt5MessageDrivenChannelAdapter
extends AbstractMqttMessageDrivenChannelAdapter<com.hivemq.client.mqtt.mqtt5.Mqtt5Client>

The AbstractMqttMessageDrivenChannelAdapter implementation for MQTT v5.

Since:

7.2

Author:

Jiandong Ma

Nested Class Summary

Nested classes/interfaces inherited from interface IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class AbstractMqttMessageDrivenChannelAdapter

isSubscribed, isSubscribing, messageConverter, mqttClientManager

Fields inherited from class AbstractEndpoint

lifecycleLock

Fields inherited from class IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
Mqtt5MessageDrivenChannelAdapter(ClientManager<com.hivemq.client.mqtt.mqtt5.Mqtt5Client> mqttClientManager, com.hivemq.client.mqtt.mqtt5.message.subscribe.Mqtt5Subscription... subscriptions)
Mqtt5MessageDrivenChannelAdapter(ClientManager<com.hivemq.client.mqtt.mqtt5.Mqtt5Client> mqttClientManager, String... topics)

Method Summary

Modifier and Type	Method	Description
protected void	doStart()	Take no action by default.
protected void	doStop()	Take no action by default.
void	onClientConnected(com.hivemq.client.mqtt.lifecycle.MqttClientConnectedContext context)	Called when the client to the server is connected successfully.
protected void	onInit()	Subclasses may implement this for initialization logic.
void	setHeaderMapper(HeaderMapper<com.hivemq.client.mqtt.mqtt5.message.publish.Mqtt5Publish> headerMapper)	Set the HeaderMapper to map the Mqtt5Publish optional data
void	setNoLocal(boolean noLocal)	Set whether the client must not receive messages published by itself.
void	setRetainAsPublished(boolean retainAsPublished)	Set whether the retain flag for incoming Publish messages must be set to its original value.
void	setRetainHandling(com.hivemq.client.mqtt.mqtt5.message.subscribe.Mqtt5RetainHandling retainHandling)	Set the handling of retained message for this Subscription.

Methods inherited from class AbstractMqttMessageDrivenChannelAdapter

destroy, getApplicationEventPublisher, getClient, getComponentType, getExecutor, getMessageConverter, getPayloadType, getQos, getTopics, isConnected, isManualAck, setApplicationEventPublisher, setExecutor, setManualAck, setMessageConverter, setPayloadType, setQos

Methods inherited from class MessageProducerSupport

afterSingletonsInstantiated, buildErrorMessage, 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 AbstractEndpoint

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

Methods inherited from class 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 Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface IntegrationManagement

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

Methods inherited from interface NamedComponent

getBeanName, getComponentName

Methods inherited from interface SmartLifecycle

isPauseable

Constructor Details

Mqtt5MessageDrivenChannelAdapter

public Mqtt5MessageDrivenChannelAdapter(ClientManager<com.hivemq.client.mqtt.mqtt5.Mqtt5Client> mqttClientManager,
 String... topics)

Mqtt5MessageDrivenChannelAdapter

public Mqtt5MessageDrivenChannelAdapter(ClientManager<com.hivemq.client.mqtt.mqtt5.Mqtt5Client> mqttClientManager,
 com.hivemq.client.mqtt.mqtt5.message.subscribe.Mqtt5Subscription... subscriptions)

Method Details

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class AbstractMqttMessageDrivenChannelAdapter<com.hivemq.client.mqtt.mqtt5.Mqtt5Client>

setHeaderMapper

public void setHeaderMapper(HeaderMapper<com.hivemq.client.mqtt.mqtt5.message.publish.Mqtt5Publish> headerMapper)

Set the HeaderMapper to map the Mqtt5Publish optional data

Parameters:

headerMapper - the headMapper

setNoLocal

public void setNoLocal(boolean noLocal)

Set whether the client must not receive messages published by itself.

Parameters:

noLocal - whether the subscription is not local.

setRetainHandling

public void setRetainHandling(com.hivemq.client.mqtt.mqtt5.message.subscribe.Mqtt5RetainHandling retainHandling)

Set the handling of retained message for this Subscription.

Parameters:

retainHandling - the retain handling.

setRetainAsPublished

public void setRetainAsPublished(boolean retainAsPublished)

Set whether the retain flag for incoming Publish messages must be set to its original value.

Parameters:

retainAsPublished - the retainAsPublished.

doStart

protected void doStart()

Description copied from class: MessageProducerSupport

Take no action by default. Subclasses may override this if they need lifecycle-managed behavior. Protected by 'lifecycleLock'.

Overrides:

doStart in class MessageProducerSupport

doStop

protected void doStop()

Description copied from class: MessageProducerSupport

Take no action by default. Subclasses may override this if they need lifecycle-managed behavior.

Overrides:

doStop in class MessageProducerSupport

onClientConnected

public void onClientConnected(com.hivemq.client.mqtt.lifecycle.MqttClientConnectedContext context)

Description copied from interface: ClientManager.ConnectCallback

Called when the client to the server is connected successfully.

Parameters:

context - the mqttClientConnectedContext.