AbstractMqttMessageHandler (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.reactivestreams.Subscriber<Message<?>>, Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Ordered, ExpressionCapable, Orderable, IntegrationPattern, NamedComponent, IntegrationManagement, ManageableLifecycle, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>
既知の直属サブクラス
MqttPahoMessageHandler
```
public abstract class AbstractMqttMessageHandler
extends AbstractMessageHandler
implements ManageableLifecycle
```
MQTT 送信・チャネルアダプターの抽象クラス。
導入:
4.0
作成者:
Gary Russell, Artem Bilan

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

フィールドのサマリー
- クラス 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

コンストラクターの概要
コンストラクター
コンストラクターと説明
AbstractMqttMessageHandler(StringSE url, StringSE clientId)

コンストラクター
コンストラクターと説明
`AbstractMqttMessageHandler(StringSE url, StringSE clientId)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`protected abstract void`	`doStart()`
`protected abstract void`	`doStop()`
`StringSE`	`getClientId()`
`int`	`getClientInstance()` クライアントが接続されるたびに増加します。
`StringSE`	`getComponentType()` サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
`protected MessageConverter`	`getConverter()`
`protected StringSE`	`getUrl()`
`protected void`	`handleMessageInternal(Message<?> message)`
`protected void`	`incrementClientInstance()`
`boolean`	`isRunning()`
`protected void`	`onInit()` サブクラスは、初期化ロジック用にこれを実装できます。
`protected abstract void`	`publish(StringSE topic, ObjectSE mqttMessage, Message<?> message)`
`void`	`setConverter(MessageConverter converter)` 使用するメッセージコンバーターを設定します。これが指定されている場合、アダプターの QoS および保持されている設定は無視されます。
`void`	`setDefaultQos(int defaultQos)` `qosExpression` が null と評価される場合、メッセージの qos を設定します。
`void`	`setDefaultRetained(boolean defaultRetained)` `retainedExpression` が null と評価された場合、メッセージの保持ブール値を設定します。
`void`	`setDefaultTopic(StringSE defaultTopic)` `topicExpression` が `null` と評価された場合にメッセージが公開されるトピックを設定します。
`void`	`setQosExpression(Expression qosExpression)` qos 式を設定します。デフォルトは "headers ['mqtt_qos' ]" です。
`void`	`setQosExpressionString(StringSE qosExpression)` qos 式を設定します。デフォルトは "headers ['mqtt_qos' ]" です。
`void`	`setRetainedExpression(Expression retainedExpression)` 保持された式を設定します。デフォルトは "headers ['mqtt_retained' ]" です。
`void`	`setRetainedExpressionString(StringSE retainedExpression)` 保持された式を設定します。デフォルトは "headers ['mqtt_retained' ]" です。
`void`	`setTopicExpression(Expression topicExpression)` トピック式を設定します。デフォルトは "headers ['mqtt_topic' ]" です。
`void`	`setTopicExpressionString(StringSE topicExpression)` トピック式を設定します。デフォルトは "headers ['mqtt_topic' ]" です。
`void`	`start()`
`void`	`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

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

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

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

- コンストラクターの詳細
  - AbstractMqttMessageHandler
```
public AbstractMqttMessageHandler(@Nullable
                                  StringSE url,
                                  StringSE clientId)
```
- メソッドの詳細
  - setDefaultTopic
```
public void setDefaultTopic(StringSE defaultTopic)
```
    topicExpression が `null` と評価された場合にメッセージが公開されるトピックを設定します。
    パラメーター:
    defaultTopic - デフォルトのトピック。
  - setTopicExpression
```
public void setTopicExpression(Expression topicExpression)
```
    トピック式を設定します。デフォルトは "headers ['mqtt_topic' ]" です。
    パラメーター:
    topicExpression - 表現。
    導入:
    5.0
  - setTopicExpressionString
```
public void setTopicExpressionString(StringSE topicExpression)
```
    トピック式を設定します。デフォルトは "headers ['mqtt_topic' ]" です。
    パラメーター:
    topicExpression - 表現。
    導入:
    5.0
  - setDefaultQos
```
public void setDefaultQos(int defaultQos)
```
    qosExpression が null と評価される場合、メッセージの qos を設定します。メッセージコンバーターが提供されていない場合にのみ適用されます。
    パラメーター:
    defaultQos - デフォルトの QoS。
    関連事項:
    setConverter(MessageConverter)
  - setQosExpression
```
public void setQosExpression(Expression qosExpression)
```
    qos 式を設定します。デフォルトは "headers ['mqtt_qos' ]" です。メッセージコンバーターが提供されていない場合にのみ適用されます。
    パラメーター:
    qosExpression - 表現。
    導入:
    5.0
    関連事項:
    setConverter(MessageConverter)
  - setQosExpressionString
```
public void setQosExpressionString(StringSE qosExpression)
```
    qos 式を設定します。デフォルトは "headers ['mqtt_qos' ]" です。メッセージコンバーターが提供されていない場合にのみ適用されます。
    パラメーター:
    qosExpression - 表現。
    導入:
    5.0
    関連事項:
    setConverter(MessageConverter)
  - setDefaultRetained
```
public void setDefaultRetained(boolean defaultRetained)
```
    retainedExpression が null と評価された場合、メッセージの保持ブール値を設定します。メッセージコンバーターが提供されていない場合にのみ適用されます。
    パラメーター:
    defaultRetained - デフォルトの defaultRetained。
    関連事項:
    setConverter(MessageConverter)
  - setRetainedExpression
```
public void setRetainedExpression(Expression retainedExpression)
```
    保持された式を設定します。デフォルトは "headers ['mqtt_retained' ]" です。メッセージコンバーターが提供されていない場合にのみ適用されます。
    パラメーター:
    retainedExpression - 表現。
    導入:
    5.0
    関連事項:
    setConverter(MessageConverter)
  - setRetainedExpressionString
```
public void setRetainedExpressionString(StringSE retainedExpression)
```
    保持された式を設定します。デフォルトは "headers ['mqtt_retained' ]" です。メッセージコンバーターが提供されていない場合にのみ適用されます。
    パラメーター:
    retainedExpression - 表現。
    導入:
    5.0
    関連事項:
    setConverter(MessageConverter)
  - setConverter
```
public void setConverter(MessageConverter converter)
```
    使用するメッセージコンバーターを設定します。これが指定されている場合、アダプターの QoS および保持されている設定は無視されます。
    パラメーター:
    converter - コンバーター。
  - getConverter
```
protected MessageConverter getConverter()
```
  - getUrl
```
@Nullable
protected StringSE getUrl()
```
  - getClientId
```
public StringSE getClientId()
```
  - getClientInstance
```
public int getClientInstance()
```
    クライアントが接続されるたびに増加します。
    戻り値:
    インスタンス。
    導入:
    4.1
  - getComponentType
```
public StringSE getComponentType()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
    次で指定:
    インターフェース NamedComponent の getComponentType
    オーバーライド:
    クラス MessageHandlerSupport の getComponentType
  - incrementClientInstance
```
protected void incrementClientInstance()
```
  - onInit
```
protected void onInit()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスは、初期化ロジック用にこれを実装できます。
    オーバーライド:
    クラス IntegrationObjectSupport の onInit
  - start
```
public final void start()
```
    次で指定:
    インターフェース Lifecycle の start
    次で指定:
    インターフェース ManageableLifecycle の start
  - doStart
```
protected abstract void doStart()
```
  - stop
```
public final void stop()
```
    次で指定:
    インターフェース Lifecycle の stop
    次で指定:
    インターフェース ManageableLifecycle の stop
  - doStop
```
protected abstract void doStop()
```
  - isRunning
```
public boolean isRunning()
```
    次で指定:
    インターフェース Lifecycle の isRunning
    次で指定:
    インターフェース ManageableLifecycle の isRunning
  - handleMessageInternal
```
protected void handleMessageInternal(Message<?> message)
```
    次で指定:
    クラス AbstractMessageHandler の handleMessageInternal
  - publish
```
protected abstract void publish(StringSE topic,
                                ObjectSE mqttMessage,
                                Message<?> message)
```

クラス AbstractMqttMessageHandler

ネストされたクラスの要約

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

フィールドのサマリー

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

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

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

コンストラクターの概要

メソッドのサマリー

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

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

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

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

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

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

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

コンストラクターの詳細

AbstractMqttMessageHandler

メソッドの詳細

setDefaultTopic

setTopicExpression

setTopicExpressionString

setDefaultQos

setQosExpression

setQosExpressionString

setDefaultRetained

setRetainedExpression

setRetainedExpressionString

setConverter

getConverter

getUrl

getClientId

getClientInstance

getComponentType

incrementClientInstance

onInit

start

doStart

stop

doStop

isRunning

handleMessageInternal

publish