org.springframework.integration.mqtt.inbound.AbstractMqttMessageDrivenChannelAdapter<T,C>

Type Parameters:: T - MQTT Client type; C - MQTT connection options type (v5 or v3)

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

Direct Known Subclasses:: MqttPahoMessageDrivenChannelAdapter, Mqttv5PahoMessageDrivenChannelAdapter

@Deprecated(since="7.2", forRemoval=true) @ManagedResource @IntegrationManagedResource public abstract class AbstractMqttMessageDrivenChannelAdapter<T,C> extends MessageProducerSupport implements ApplicationEventPublisherAware, ClientManager.ConnectCallback

Deprecated, for removal: This API element is subject to removal in a future version.

since 7.2 in favor of the spring-integration-mqtt-client module.

Abstract class for MQTT Message-Driven Channel Adapters.

Since:: 4.0
Author:: Gary Russell, Artem Bilan, Trung Pham, Mikhail Polivakha, Artem Vozhdayenko, Jiri Soucek, Glenn Renfro, Jaehong Park

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement
IntegrationManagement.ManagementOverrides
Field Summary

Fields

Modifier and Type

Field

Description

protected final Lock

topicLock

Deprecated, for removal: This API element is subject to removal in a future version.

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

AbstractMqttMessageDrivenChannelAdapter(@Nullable String url, String clientId, String... topic)

Deprecated, for removal: This API element is subject to removal in a future version.

AbstractMqttMessageDrivenChannelAdapter(ClientManager<T,C> clientManager, String... topic)

Deprecated, for removal: This API element is subject to removal in a future version.
Method Summary

Modifier and Type

Method

Description

void

addTopic(String... topics)

Deprecated, for removal: This API element is subject to removal in a future version.

Add a topic (or topics) to the subscribed list (qos=1).

void

addTopic(String topic, int qos)

Deprecated, for removal: This API element is subject to removal in a future version.

Add a topic to the subscribed list.

void

addTopics(String[] topics, int[] qos)

Deprecated, for removal: This API element is subject to removal in a future version.

Add topics to the subscribed list.

void

destroy()

Deprecated, for removal: This API element is subject to removal in a future version.

protected ApplicationEventPublisher

getApplicationEventPublisher()

Deprecated, for removal: This API element is subject to removal in a future version.

protected String

getClientId()

Deprecated, for removal: This API element is subject to removal in a future version.

protected @Nullable ClientManager<T,C>

getClientManager()

Deprecated, for removal: This API element is subject to removal in a future version.

protected long

getCompletionTimeout()

Deprecated, for removal: This API element is subject to removal in a future version.

String

getComponentType()

Deprecated, for removal: This API element is subject to removal in a future version.

protected @Nullable MqttMessageConverter

getConverter()

Deprecated, for removal: This API element is subject to removal in a future version.

protected long

getDisconnectCompletionTimeout()

Deprecated, for removal: This API element is subject to removal in a future version.

int[]

getQos()

Deprecated, for removal: This API element is subject to removal in a future version.

protected long

getQuiescentTimeout()

Deprecated, for removal: This API element is subject to removal in a future version.

String[]

getTopic()

Deprecated, for removal: This API element is subject to removal in a future version.

protected @Nullable String

getUrl()

Deprecated, for removal: This API element is subject to removal in a future version.

protected boolean

isManualAcks()

Deprecated, for removal: This API element is subject to removal in a future version.

protected void

onInit()

Deprecated, for removal: This API element is subject to removal in a future version.

Subclasses may implement this for initialization logic.

void

removeTopic(String... topic)

Deprecated, for removal: This API element is subject to removal in a future version.

Remove a topic (or topics) from the subscribed list.

void

setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Deprecated, for removal: This API element is subject to removal in a future version.

void

setCompletionTimeout(long completionTimeout)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the completion timeout for operations.

void

setConverter(MqttMessageConverter converter)

Deprecated, for removal: This API element is subject to removal in a future version.

void

setDisconnectCompletionTimeout(long completionTimeout)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the completion timeout when disconnecting.

void

setManualAcks(boolean manualAcks)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the acknowledgment mode to manual.

void

setQos(int... qos)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the QoS for each topic; a single value will apply to all topics otherwise the correct number of qos values must be provided.

void

setQuiescentTimeout(long quiescentTimeout)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the quiescentTimeout timeout when disconnecting.

Methods inherited from class org.springframework.integration.endpoint.MessageProducerSupport
afterSingletonsInstantiated, buildErrorMessage, doStart, doStop, 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.mqtt.core.ClientManager.ConnectCallback
connectComplete

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

Field Details
- topicLock
  
  protected final Lock topicLock
  
  Deprecated, for removal: This API element is subject to removal in a future version.
Constructor Details
- AbstractMqttMessageDrivenChannelAdapter
  
  public AbstractMqttMessageDrivenChannelAdapter(@Nullable String url, String clientId, String... topic)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
- AbstractMqttMessageDrivenChannelAdapter
  
  public AbstractMqttMessageDrivenChannelAdapter(ClientManager<T,C> clientManager, String... topic)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
Method Details
- setConverter
  
  public void setConverter(MqttMessageConverter converter)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
- getClientManager
  
  protected @Nullable ClientManager<T,C> getClientManager()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
- setQos
  
  public void setQos(int... qos)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Set the QoS for each topic; a single value will apply to all topics otherwise the correct number of qos values must be provided.
  
  Parameters:
  
  qos - The qos value(s).
  
  Since:
  
  4.1
- getQos
  
  @ManagedAttribute public int[] getQos()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
- getUrl
  
  protected @Nullable String getUrl()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
- getClientId
  
  protected String getClientId()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
- getConverter
  
  protected @Nullable MqttMessageConverter getConverter()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
- getTopic
  
  @ManagedAttribute public String[] getTopic()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
- setDisconnectCompletionTimeout
  
  public void setDisconnectCompletionTimeout(long completionTimeout)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Set the completion timeout when disconnecting. Default 5000L milliseconds.
  
  Parameters:
  
  completionTimeout - The timeout.
  
  Since:
  
  5.1.10
- getDisconnectCompletionTimeout
  
  protected long getDisconnectCompletionTimeout()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
- setQuiescentTimeout
  
  public void setQuiescentTimeout(long quiescentTimeout)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Set the quiescentTimeout timeout when disconnecting. Default is ClientManager.QUIESCENT_TIMEOUT milliseconds.
  
  Parameters:
  
  quiescentTimeout - The timeout.
  
  Since:
  
  7.0.0
- getQuiescentTimeout
  
  protected long getQuiescentTimeout()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
- onInit
  
  protected void onInit()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from class: IntegrationObjectSupport
  
  Subclasses may implement this for initialization logic.
  
  Overrides:
  
  onInit in class MessageProducerSupport
- destroy
  
  public void destroy()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Specified by:
  
  destroy in interface DisposableBean
  
  Specified by:
  
  destroy in interface IntegrationManagement
  
  Overrides:
  
  destroy in class AbstractEndpoint
- getComponentType
  
  public String getComponentType()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Specified by:
  
  getComponentType in interface NamedComponent
  
  Overrides:
  
  getComponentType in class MessageProducerSupport
- setApplicationEventPublisher
  
  public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Specified by:
  
  setApplicationEventPublisher in interface ApplicationEventPublisherAware
- getApplicationEventPublisher
  
  protected ApplicationEventPublisher getApplicationEventPublisher()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
- setManualAcks
  
  public void setManualAcks(boolean manualAcks)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Set the acknowledgment mode to manual.
  
  Parameters:
  
  manualAcks - true for manual acks.
  
  Since:
  
  5.3
- isManualAcks
  
  protected boolean isManualAcks()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
- setCompletionTimeout
  
  public void setCompletionTimeout(long completionTimeout)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Set the completion timeout for operations. Default 30000L milliseconds.
  
  Parameters:
  
  completionTimeout - The timeout.
  
  Since:
  
  4.1
- getCompletionTimeout
  
  protected long getCompletionTimeout()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
- addTopic
  
  @ManagedOperation public void addTopic(String topic, int qos)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Add a topic to the subscribed list.
  
  Parameters:
  
  topic - The topic.
  
  qos - The qos.
  
  Throws:
  
  MessagingException - if the topic is already in the list.
  
  Since:
  
  4.1
- addTopic
  
  @ManagedOperation public void addTopic(String... topics)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Add a topic (or topics) to the subscribed list (qos=1).
  
  Parameters:
  
  topics - The topics.
  
  Throws:
  
  MessagingException - if the topics is already in the list.
  
  Since:
  
  4.1
- addTopics
  
  @ManagedOperation public void addTopics(String[] topics, int[] qos)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Add topics to the subscribed list.
  
  Parameters:
  
  topics - The topics.
  
  qos - The qos for each topic.
  
  Throws:
  
  MessagingException - if a topics is already in the list.
  
  Since:
  
  4.1
- removeTopic
  
  @ManagedOperation public void removeTopic(String... topic)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Remove a topic (or topics) from the subscribed list.
  
  Parameters:
  
  topic - The topic.
  
  Throws:
  
  MessagingException - if the topic is not in the list.
  
  Since:
  
  4.1

Class AbstractMqttMessageDrivenChannelAdapter<T,C>

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

Field Summary

Fields inherited from class org.springframework.integration.endpoint.AbstractEndpoint

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

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

Fields inherited from interface org.springframework.context.SmartLifecycle

Constructor Summary

Method Summary

Methods inherited from class org.springframework.integration.endpoint.MessageProducerSupport

Methods inherited from class org.springframework.integration.endpoint.AbstractEndpoint

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.integration.mqtt.core.ClientManager.ConnectCallback

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

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

Methods inherited from interface org.springframework.context.SmartLifecycle

Field Details

topicLock

Constructor Details

AbstractMqttMessageDrivenChannelAdapter

AbstractMqttMessageDrivenChannelAdapter

Method Details

setConverter

getClientManager

setQos

getQos

getUrl

getClientId

getConverter

getTopic

setDisconnectCompletionTimeout

getDisconnectCompletionTimeout

setQuiescentTimeout

getQuiescentTimeout

onInit

destroy

getComponentType

setApplicationEventPublisher

getApplicationEventPublisher

setManualAcks

isManualAcks

setCompletionTimeout

getCompletionTimeout

addTopic

addTopic

addTopics

removeTopic