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

Class Mqtt3MessageDrivenChannelAdapter

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.mqtt3.Mqtt3Client>

org.springframework.integration.mqtt.client.inbound.Mqtt3MessageDrivenChannelAdapter

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 Mqtt3MessageDrivenChannelAdapter
extends AbstractMqttMessageDrivenChannelAdapter<com.hivemq.client.mqtt.mqtt3.Mqtt3Client>

The AbstractMqttMessageDrivenChannelAdapter implementation for MQTT v3.

Since:

7.2

Author:

Jiandong Ma

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.mqtt.client.inbound.AbstractMqttMessageDrivenChannelAdapter

isSubscribed, isSubscribing, messageConverter, 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

Constructor	Description
Mqtt3MessageDrivenChannelAdapter(ClientManager<com.hivemq.client.mqtt.mqtt3.Mqtt3Client> mqttClientManager, com.hivemq.client.mqtt.mqtt3.message.subscribe.Mqtt3Subscription... subscriptions)
Mqtt3MessageDrivenChannelAdapter(ClientManager<com.hivemq.client.mqtt.mqtt3.Mqtt3Client> 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 mqttClientConnectedContext)	Called when the client to the server is connected successfully.
protected void	onInit()	Subclasses may implement this for initialization logic.

Methods inherited from class org.springframework.integration.mqtt.client.inbound.AbstractMqttMessageDrivenChannelAdapter

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

Methods inherited from class org.springframework.integration.endpoint.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 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.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

Constructor Details

Mqtt3MessageDrivenChannelAdapter

public Mqtt3MessageDrivenChannelAdapter(ClientManager<com.hivemq.client.mqtt.mqtt3.Mqtt3Client> mqttClientManager,
 String... topics)

Mqtt3MessageDrivenChannelAdapter

public Mqtt3MessageDrivenChannelAdapter(ClientManager<com.hivemq.client.mqtt.mqtt3.Mqtt3Client> mqttClientManager,
 com.hivemq.client.mqtt.mqtt3.message.subscribe.Mqtt3Subscription... 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.mqtt3.Mqtt3Client>

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 mqttClientConnectedContext)

Description copied from interface: ClientManager.ConnectCallback

Called when the client to the server is connected successfully.

Parameters:

mqttClientConnectedContext - the mqttClientConnectedContext.