MqttPahoMessageHandler (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.handler.MessageHandlerSupport
  - - org.springframework.integration.handler.AbstractMessageHandler
    - - org.springframework.integration.mqtt.outbound.AbstractMqttMessageHandler
      - org.springframework.integration.mqtt.outbound.MqttPahoMessageHandler

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

ネストされたクラスのサマリー
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース
  IntegrationManagement.ManagementOverrides

フィールドのサマリー

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

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

インターフェース org.springframework.core.Ordered から継承されたフィールド
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド
METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

コンストラクターの概要

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

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`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 message)`
`protected void`	`onInit()` サブクラスは、初期化ロジック用にこれを実装できます。
`protected void`	`publish(StringSE topic, ObjectSE mqttMessage, Message<?> message)`
`void`	`setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)`
`void`	`setAsync(boolean async)` メッセージを送信するときにブロックしない場合は、true に設定します。
`void`	`setAsyncEvents(boolean asyncEvents)` `setAsync(boolean)` が true の場合、これを true に設定すると、`MqttMessageSentEvent` および `MqttMessageDeliveredEvent` の発行が発行されます。
`void`	`setCompletionTimeout(long completionTimeout)` 非同期操作の完了タイムアウトを設定します。
`void`	`setDisconnectCompletionTimeout(long completionTimeout)` 切断時の完了タイムアウトを設定します。

クラス org.springframework.integration.mqtt.outbound.AbstractMqttMessageHandler から継承されたメソッド
getClientId, getClientInstance, getComponentType, getConverter, getUrl, handleMessageInternal, incrementClientInstance, isRunning, setConverter, setDefaultQos, setDefaultRetained, setDefaultTopic, setQosExpression, setQosExpressionString, setRetainedExpression, setRetainedExpressionString, setTopicExpression, setTopicExpressionString, start, stop

クラス org.springframework.integration.handler.AbstractMessageHandler から継承されたメソッド
handleMessage, onComplete, onError, onNext, onSubscribe

クラス org.springframework.integration.handler.MessageHandlerSupport から継承されたメソッド
buildSendTimer, destroy, getIntegrationPatternType, getManagedName, getManagedType, getMetricsCaptor, getOrder, getOverrides, isLoggingEnabled, registerMetricsCaptor, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

クラス 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

インターフェース reactor.core.CoreSubscriber から継承されたメソッド
currentContext

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

インターフェース 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
```
    ミリ秒単位のデフォルトの切断完了タイムアウト。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - MqttPahoMessageHandler
```
public MqttPahoMessageHandler(StringSE url,
                              StringSE clientId,
                              MqttPahoClientFactory clientFactory)
```
    単一の URL に対してこのコンストラクターを使用します（ただし、サーバー URI が MqttPahoClientFactory によって提供される MqttConnectOptions.getServerURIs() によって提供される場合はオーバーライドされる場合があります）。
    パラメーター:
    url - URL。
    clientId - クライアント ID。
    clientFactory - クライアントファクトリ。
  - MqttPahoMessageHandler
```
public MqttPahoMessageHandler(StringSE clientId,
                              MqttPahoClientFactory clientFactory)
```
    サーバー URI が MqttPahoClientFactory によって提供される MqttConnectOptions.getServerURIs() によって提供される場合、このコンストラクターを使用します。
    パラメーター:
    clientId - クライアント ID。
    clientFactory - クライアントファクトリ。
    導入:
    4.1
  - MqttPahoMessageHandler
```
public MqttPahoMessageHandler(StringSE url,
                              StringSE clientId)
```
    追加の MqttConnectOptions が必要ない場合は、このコンストラクターを使用します。
    パラメーター:
    url - URL。
    clientId - クライアント ID。
- メソッドの詳細
  - setAsync
```
public void setAsync(boolean async)
```
    メッセージを送信するときにブロックしない場合は、true に設定します。デフォルトは false。true の場合、メッセージ送信 / 配信イベントは、適切に構成された "ApplicationListener" またはイベント inbound-channel-adapter による受信のために公開されます。
    パラメーター:
    async - 非同期の場合は true。
    導入:
    4.1
  - setAsyncEvents
```
public void setAsyncEvents(boolean asyncEvents)
```
    setAsync(boolean) が true の場合、これを true に設定すると、MqttMessageSentEvent および MqttMessageDeliveredEvent の発行が発行されます。デフォルトは false。
    パラメーター:
    asyncEvents - asyncEvents。
    導入:
    4.1
  - setCompletionTimeout
```
public void setCompletionTimeout(long completionTimeout)
```
    非同期操作の完了タイムアウトを設定します。名前空間を使用して設定できません。デフォルトの 30000L ミリ秒。
    パラメーター:
    completionTimeout - タイムアウト。
    導入:
    4.1
  - setDisconnectCompletionTimeout
```
public void setDisconnectCompletionTimeout(long completionTimeout)
```
    切断時の完了タイムアウトを設定します。名前空間を使用して設定することはできません。デフォルトの 5000L ミリ秒。
    パラメーター:
    completionTimeout - タイムアウト。
    導入:
    5.1.10
  - setApplicationEventPublisher
```
public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
```
    次で指定:
    インターフェース ApplicationEventPublisherAware の setApplicationEventPublisher
  - getConnectionInfo
```
public org.eclipse.paho.client.mqttv3.MqttConnectOptions getConnectionInfo()
```
    インターフェースからコピーされた説明: MqttComponent
    接続に関する情報を返します。
    次で指定:
    インターフェース MqttComponent<org.eclipse.paho.client.mqttv3.MqttConnectOptions> の getConnectionInfo
    次で指定:
    インターフェース MqttPahoComponent の getConnectionInfo
    戻り値:
    情報。
  - onInit
```
protected void onInit()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスは、初期化ロジック用にこれを実装できます。
    オーバーライド:
    クラス AbstractMqttMessageHandler の onInit
  - doStart
```
protected void doStart()
```
    次で指定:
    クラス AbstractMqttMessageHandler の doStart
  - doStop
```
protected void doStop()
```
    次で指定:
    クラス AbstractMqttMessageHandler の doStop
  - publish
```
protected void publish(StringSE topic,
                       ObjectSE mqttMessage,
                       Message<?> message)
```
    次で指定:
    クラス AbstractMqttMessageHandler の publish
  - 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 message)
```
    次で指定:
    インターフェース 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

クラス MqttPahoMessageHandler

ネストされたクラスのサマリー

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース

フィールドのサマリー

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

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

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

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

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

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

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

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

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

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

インターフェース reactor.core.CoreSubscriber から継承されたメソッド

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

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

フィールドの詳細

DEFAULT_COMPLETION_TIMEOUT

DISCONNECT_COMPLETION_TIMEOUT

コンストラクターの詳細

MqttPahoMessageHandler

MqttPahoMessageHandler

MqttPahoMessageHandler

メソッドの詳細

setAsync

setAsyncEvents

setCompletionTimeout

setDisconnectCompletionTimeout

setApplicationEventPublisher

getConnectionInfo

onInit

doStart

doStop

publish

connectionLost

messageArrived

deliveryComplete