AbstractMessageBusBinderPlugin (Spring XD 1.3.2.RELEASE API)

java.lang.Object
- org.springframework.xd.dirt.plugins.AbstractPlugin
- - org.springframework.xd.dirt.plugins.AbstractMessageBusBinderPlugin

実装済みのインターフェース一覧:
org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, Plugin
既知の直属サブクラス
AbstractJobPlugin, AbstractStreamPlugin
```
public abstract class AbstractMessageBusBinderPlugin
extends AbstractPlugin
```
Module のメッセージプロデューサーとコンシューマーを MessageBus にバインド / アンバインドするための共通の実装メソッドを持つ抽象 Plugin。
作成者:
Mark Fisher, Gary Russell, David Turanski, Jennifer Hickey, Glenn Renfro, Ilayaperumal Gopinathan

フィールド概要

フィールド
修飾子と型	フィールドと説明
`protected static java.lang.String`	`JOB_CHANNEL_PREFIX`
`protected MessageBus`	`messageBus`
`protected static java.lang.String`	`MODULE_INPUT_CHANNEL`
`protected static java.lang.String`	`MODULE_OUTPUT_CHANNEL`

クラス org.springframework.xd.dirt.plugins.AbstractPlugin から継承されたフィールド
logger, PLUGIN_CONTEXT_CONFIG_ROOT

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

コンストラクター概要

コンストラクター
コンストラクターと説明
`AbstractMessageBusBinderPlugin(MessageBus messageBus)`
`AbstractMessageBusBinderPlugin(MessageBus messageBus, ZooKeeperConnection zkConnection)`

方法の概要

メソッド
修飾子と型	メソッドと説明
`void`	`beforeShutdown(Module module)` モジュールをシャットダウンする前に必要なクリーンアップを実行します
`protected void`	`bindConsumerAndProducers(Module module)` モジュールのメッセージコンシューマー / プロデューサーの入力 / 出力チャネルを `MessageBus` のメッセージソース / ターゲットエンティティにバインドします。
`protected abstract java.lang.String`	`buildTapChannelName(Module module)`
`protected java.util.Properties[]`	`extractConsumerProducerProperties(Module module)`
`protected java.util.Map<java.lang.String,java.lang.Object>`	`extractHistoryProperties(Module module)`
`protected abstract java.lang.String`	`getInputChannelName(Module module)`
`int`	`getOrder()`
`protected abstract java.lang.String`	`getOutputChannelName(Module module)`
`void`	`removeModule(Module module)` システムからモジュールを削除するために必要なアクションを実行します。
`protected void`	`unbindConsumer(Module module)` モジュールの入力チャネルを `MessageBus` からバインド解除します (モジュールを停止できるように、モジュールへの新しいメッセージの送信を停止します)。
`protected void`	`unbindProducers(Module module)` モジュールの出力チャネル（および存在する場合はタップ）を `MessageBus` からバインド解除します（停止後）。

クラス org.springframework.xd.dirt.plugins.AbstractPlugin から継承されたメソッド
getApplicationContext, postProcessModule, preProcessModule, setApplicationContext, supports

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - MODULE_INPUT_CHANNEL
```
protected static final java.lang.String MODULE_INPUT_CHANNEL
```
    関連事項:
    定数フィールド値
  - MODULE_OUTPUT_CHANNEL
```
protected static final java.lang.String MODULE_OUTPUT_CHANNEL
```
    関連事項:
    定数フィールド値
  - JOB_CHANNEL_PREFIX
```
protected static final java.lang.String JOB_CHANNEL_PREFIX
```
    関連事項:
    定数フィールド値
  - messageBus
```
protected final MessageBus messageBus
```
- コンストラクターの詳細
  - AbstractMessageBusBinderPlugin
```
public AbstractMessageBusBinderPlugin(MessageBus messageBus)
```
  - AbstractMessageBusBinderPlugin
```
public AbstractMessageBusBinderPlugin(MessageBus messageBus,
                              ZooKeeperConnection zkConnection)
```
- メソッドの詳細
  - bindConsumerAndProducers
```
protected final void bindConsumerAndProducers(Module module)
```
    モジュールのメッセージコンシューマー / プロデューサーの入力 / 出力チャネルを MessageBus のメッセージソース / ターゲットエンティティにバインドします。メッセージがコンシューマーからすぐに流れ始めるように、最初にプロデューサーをバインドする必要があります。
    パラメーター:
    module - コンシューマーとプロデューサーを MessageBus にバインドするモジュール。
  - extractConsumerProducerProperties
```
protected final java.util.Properties[] extractConsumerProducerProperties(Module module)
```
  - extractHistoryProperties
```
protected final java.util.Map<java.lang.String,java.lang.Object> extractHistoryProperties(Module module)
```
  - beforeShutdown
```
public void beforeShutdown(Module module)
```
    インターフェースからコピーされた説明: Plugin
    モジュールをシャットダウンする前に必要なクリーンアップを実行します
    次で指定:
    インターフェース Plugin 内の beforeShutdown
    オーバーライド:
    クラス AbstractPlugin の beforeShutdown
    パラメーター:
    module - クリーンアップするモジュール
  - removeModule
```
public void removeModule(Module module)
```
    インターフェースからコピーされた説明: Plugin
    システムからモジュールを削除するために必要なアクションを実行します。
    次で指定:
    インターフェース Plugin 内の removeModule
    オーバーライド:
    クラス AbstractPlugin の removeModule
    パラメーター:
    module - 削除するモジュール
  - getInputChannelName
```
protected abstract java.lang.String getInputChannelName(Module module)
```
  - getOutputChannelName
```
protected abstract java.lang.String getOutputChannelName(Module module)
```
  - buildTapChannelName
```
protected abstract java.lang.String buildTapChannelName(Module module)
```
  - unbindConsumer
```
protected void unbindConsumer(Module module)
```
    モジュールの入力チャネルを MessageBus からバインド解除します (モジュールを停止できるように、モジュールへの新しいメッセージの送信を停止します)。
    パラメーター:
    module - コンシューマーが MessageBus からアンバインドされるモジュール。
  - unbindProducers
```
protected void unbindProducers(Module module)
```
    モジュールの出力チャネル（および存在する場合はタップ）を MessageBus からバインド解除します（停止後）。
    パラメーター:
    module - プロデューサーが MessageBus からアンバインドされるモジュール。
  - getOrder
```
public int getOrder()
```
    次で指定:
    インターフェース org.springframework.core.Ordered 内の getOrder
    オーバーライド:
    クラス AbstractPlugin の getOrder

クラス AbstractMessageBusBinderPlugin

フィールド概要

クラス org.springframework.xd.dirt.plugins.AbstractPlugin から継承されたフィールド

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

コンストラクター概要

方法の概要

クラス org.springframework.xd.dirt.plugins.AbstractPlugin から継承されたメソッド

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

フィールドの詳細

MODULE_INPUT_CHANNEL

MODULE_OUTPUT_CHANNEL

JOB_CHANNEL_PREFIX

messageBus

コンストラクターの詳細

AbstractMessageBusBinderPlugin

AbstractMessageBusBinderPlugin

メソッドの詳細

bindConsumerAndProducers

extractConsumerProducerProperties

extractHistoryProperties

beforeShutdown

removeModule

getInputChannelName

getOutputChannelName

buildTapChannelName

unbindConsumer

unbindProducers

getOrder