MqttPahoMessageDrivenChannelAdapter (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.endpoint.AbstractEndpoint
  - - org.springframework.integration.endpoint.MessageProducerSupport
    - - org.springframework.integration.mqtt.inbound.AbstractMqttMessageDrivenChannelAdapter
      - org.springframework.integration.mqtt.inbound.MqttPahoMessageDrivenChannelAdapter

実装されたすべてのインターフェース:
org.eclipse.paho.client.mqttv3.MqttCallback, Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, SmartInitializingSingleton, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, MessageProducer, IntegrationPattern, MqttComponent<org.eclipse.paho.client.mqttv3.MqttConnectOptions>, MqttPahoComponent, NamedComponent, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent
```
public class MqttPahoMessageDrivenChannelAdapter
extends AbstractMqttMessageDrivenChannelAdapter
implements org.eclipse.paho.client.mqttv3.MqttCallback, MqttPahoComponent, ApplicationEventPublisherAware
```
Eclipse Paho の実装。このコンポーネントによって公開された MqttIntegrationEvent を使用する場合は、MqttPahoComponent adapter = event.getSourceAsType() を使用して参照を取得し、Bean 名と MqttConnectOptions を取得できるようにします。この手法により、同じイベントリスナー内の受信エンドポイントと送信エンドポイントの両方からのイベントを利用できます。
導入:
4.0
作成者:
Gary Russell, Artem Bilan

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`static long`	`DEFAULT_COMPLETION_TIMEOUT` ミリ秒単位のデフォルトの完了タイムアウト。
`static long`	`DISCONNECT_COMPLETION_TIMEOUT` ミリ秒単位のデフォルトの切断完了タイムアウト。

クラス org.springframework.integration.mqtt.inbound.AbstractMqttMessageDrivenChannelAdapter から継承されたフィールド
topicLock

クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたフィールド
lifecycleCondition, lifecycleLock

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
EXPRESSION_PARSER, logger

インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
DEFAULT_PHASE

コンストラクターの概要

コンストラクター
コンストラクターと説明
`MqttPahoMessageDrivenChannelAdapter(StringSE clientId, MqttPahoClientFactory clientFactory, StringSE... topic)` サーバー URI が `MqttPahoClientFactory` によって提供される `MqttConnectOptions.getServerURIs()` によって提供される場合、このコンストラクターを使用します。
`MqttPahoMessageDrivenChannelAdapter(StringSE url, StringSE clientId, MqttPahoClientFactory clientFactory, StringSE... topic)` 単一の URL に対してこのコンストラクターを使用します（ただし、サーバー URI が `MqttPahoClientFactory` によって提供される `MqttConnectOptions.getServerURIs()` によって提供される場合はオーバーライドされる場合があります）。
`MqttPahoMessageDrivenChannelAdapter(StringSE url, StringSE clientId, StringSE... topic)` 追加の `MqttConnectOptions` が必要ない場合は、このコンストラクターを使用します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`addTopic(StringSE topic, int qos)` トピックを購読リストに追加します。
`void`	`connectionLost(ThrowableSE cause)`
`void`	`deliveryComplete(org.eclipse.paho.client.mqttv3.IMqttDeliveryToken token)`
`protected void`	`doStart()` デフォルトでは何もしません。
`protected void`	`doStop()` デフォルトでは何もしません。
`org.eclipse.paho.client.mqttv3.MqttConnectOptions`	`getConnectionInfo()` 接続に関する情報を返します。
`void`	`messageArrived(StringSE topic, org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage)`
`void`	`removeTopic(StringSE... topic)` 購読リストからトピックを削除します。
`void`	`setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)`
`void`	`setCompletionTimeout(long completionTimeout)` 操作の完了タイムアウトを設定します。
`void`	`setDisconnectCompletionTimeout(long completionTimeout)` 切断時の完了タイムアウトを設定します。
`void`	`setManualAcks(boolean manualAcks)` 確認モードを手動に設定します。
`void`	`setRecoveryInterval(int recoveryInterval)` 再接続の試行の間に待機する時間（ミリ秒）。

クラス org.springframework.integration.mqtt.inbound.AbstractMqttMessageDrivenChannelAdapter から継承されたメソッド
addTopic, addTopics, getClientId, getComponentType, getConverter, getQos, getTopic, getUrl, onInit, setConverter, setQos

クラス org.springframework.integration.endpoint.MessageProducerSupport から継承されたメソッド
afterSingletonsInstantiated, buildErrorMessage, getErrorChannel, getErrorMessageAttributes, getIntegrationPatternType, getMessagingTemplate, getOutputChannel, sendErrorMessageIfNecessary, sendMessage, setErrorChannel, setErrorChannelName, setErrorMessageStrategy, setOutputChannel, setOutputChannelName, setSendTimeout, setShouldTrack, subscribeToPublisher

クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたメソッド
destroy, doStop, getPhase, getRole, isAutoStartup, isRunning, setAutoStartup, setPhase, setRole, start, stop, stop

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド
afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

インターフェース org.springframework.integration.mqtt.core.MqttComponent から継承されたメソッド
getBeanName

インターフェース org.springframework.beans.factory.BeanNameAware から継承されたメソッド
setBeanName

インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド
getBeanName, getComponentName

- フィールドの詳細
  - DEFAULT_COMPLETION_TIMEOUT
```
public static final long DEFAULT_COMPLETION_TIMEOUT
```
    ミリ秒単位のデフォルトの完了タイムアウト。
    関連事項:
    定数フィールド値
  - DISCONNECT_COMPLETION_TIMEOUT
```
public static final long DISCONNECT_COMPLETION_TIMEOUT
```
    ミリ秒単位のデフォルトの切断完了タイムアウト。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - MqttPahoMessageDrivenChannelAdapter
```
public MqttPahoMessageDrivenChannelAdapter(StringSE url,
                                           StringSE clientId,
                                           MqttPahoClientFactory clientFactory,
                                           StringSE... topic)
```
    単一の URL に対してこのコンストラクターを使用します（ただし、サーバー URI が MqttPahoClientFactory によって提供される MqttConnectOptions.getServerURIs() によって提供される場合はオーバーライドされる場合があります）。
    パラメーター:
    url - URL。
    clientId - クライアント ID。
    clientFactory - クライアントファクトリ。
    topic - トピック。
  - MqttPahoMessageDrivenChannelAdapter
```
public MqttPahoMessageDrivenChannelAdapter(StringSE clientId,
                                           MqttPahoClientFactory clientFactory,
                                           StringSE... topic)
```
    サーバー URI が MqttPahoClientFactory によって提供される MqttConnectOptions.getServerURIs() によって提供される場合、このコンストラクターを使用します。
    パラメーター:
    clientId - クライアント ID。
    clientFactory - クライアントファクトリ。
    topic - トピック。
    導入:
    4.1
  - MqttPahoMessageDrivenChannelAdapter
```
public MqttPahoMessageDrivenChannelAdapter(StringSE url,
                                           StringSE clientId,
                                           StringSE... topic)
```
    追加の MqttConnectOptions が必要ない場合は、このコンストラクターを使用します。
    パラメーター:
    url - URL。
    clientId - クライアント ID。
    topic - トピック。
- メソッドの詳細
  - setCompletionTimeout
```
public void setCompletionTimeout(long completionTimeout)
```
    操作の完了タイムアウトを設定します。名前空間を使用して設定することはできません。デフォルトの 30000L ミリ秒。
    パラメーター:
    completionTimeout - タイムアウト。
    導入:
    4.1
  - setDisconnectCompletionTimeout
```
public void setDisconnectCompletionTimeout(long completionTimeout)
```
    切断時の完了タイムアウトを設定します。名前空間を使用して設定することはできません。デフォルトの 5000L ミリ秒。
    パラメーター:
    completionTimeout - タイムアウト。
    導入:
    5.1.10
  - setRecoveryInterval
```
public void setRecoveryInterval(int recoveryInterval)
```
    再接続の試行の間に待機する時間（ミリ秒）。デフォルト。
    パラメーター:
    recoveryInterval - 間隔。
    導入:
    4.2.2
  - setManualAcks
```
public void setManualAcks(boolean manualAcks)
```
    確認モードを手動に設定します。
    パラメーター:
    manualAcks - 手動の ack に当てはまります。
    導入:
    5.3
  - setApplicationEventPublisher
```
public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
```
    次で指定:
    インターフェース ApplicationEventPublisherAware の setApplicationEventPublisher
    導入:
    4.2.2
  - getConnectionInfo
```
public org.eclipse.paho.client.mqttv3.MqttConnectOptions getConnectionInfo()
```
    インターフェースからコピーされた説明: MqttComponent
    接続に関する情報を返します。
    次で指定:
    インターフェース MqttComponent<org.eclipse.paho.client.mqttv3.MqttConnectOptions> の getConnectionInfo
    次で指定:
    インターフェース MqttPahoComponent の getConnectionInfo
    戻り値:
    情報。
  - doStart
```
protected void doStart()
```
    クラスからコピーされた説明: MessageProducerSupport
    デフォルトでは何も実行されません。ライフサイクル管理された動作が必要な場合、サブクラスはこれをオーバーライドできます。'lifecycleLock' によって保護されています。
    オーバーライド:
    クラス MessageProducerSupport の doStart
  - doStop
```
protected void doStop()
```
    クラスからコピーされた説明: MessageProducerSupport
    デフォルトでは何もしません。サブクラスは、ライフサイクル管理の動作が必要な場合、これをオーバーライドできます。
    オーバーライド:
    クラス MessageProducerSupport の doStop
  - addTopic
```
public void addTopic(StringSE topic,
                     int qos)
```
    クラスからコピーされた説明: AbstractMqttMessageDrivenChannelAdapter
    トピックを購読リストに追加します。
    オーバーライド:
    クラス AbstractMqttMessageDrivenChannelAdapter の addTopic
    パラメーター:
    topic - トピック。
    qos - QoS。
  - removeTopic
```
public void removeTopic(StringSE... topic)
```
    クラスからコピーされた説明: AbstractMqttMessageDrivenChannelAdapter
    購読リストからトピックを削除します。
    オーバーライド:
    クラス AbstractMqttMessageDrivenChannelAdapter の removeTopic
    パラメーター:
    topic - トピック。
  - connectionLost
```
public void connectionLost(ThrowableSE cause)
```
    次で指定:
    インターフェース org.eclipse.paho.client.mqttv3.MqttCallback の connectionLost
  - messageArrived
```
public void messageArrived(StringSE topic,
                           org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage)
```
    次で指定:
    インターフェース org.eclipse.paho.client.mqttv3.MqttCallback の messageArrived
  - deliveryComplete
```
public void deliveryComplete(org.eclipse.paho.client.mqttv3.IMqttDeliveryToken token)
```
    次で指定:
    インターフェース org.eclipse.paho.client.mqttv3.MqttCallback の deliveryComplete

クラス MqttPahoMessageDrivenChannelAdapter

フィールドのサマリー

クラス org.springframework.integration.mqtt.inbound.AbstractMqttMessageDrivenChannelAdapter から継承されたフィールド

クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたフィールド

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド

インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.integration.mqtt.inbound.AbstractMqttMessageDrivenChannelAdapter から継承されたメソッド

クラス org.springframework.integration.endpoint.MessageProducerSupport から継承されたメソッド

クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたメソッド

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.springframework.integration.mqtt.core.MqttComponent から継承されたメソッド

インターフェース org.springframework.beans.factory.BeanNameAware から継承されたメソッド

インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド

フィールドの詳細

DEFAULT_COMPLETION_TIMEOUT

DISCONNECT_COMPLETION_TIMEOUT

コンストラクターの詳細

MqttPahoMessageDrivenChannelAdapter

MqttPahoMessageDrivenChannelAdapter

MqttPahoMessageDrivenChannelAdapter

メソッドの詳細

setCompletionTimeout

setDisconnectCompletionTimeout

setRecoveryInterval

setManualAcks

setApplicationEventPublisher

getConnectionInfo

doStart

doStop

addTopic

removeTopic

connectionLost

messageArrived

deliveryComplete