BarrierMessageHandler (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.handler.MessageHandlerSupport
  - - org.springframework.integration.handler.AbstractMessageHandler
    - - org.springframework.integration.handler.AbstractMessageProducingHandler
      - org.springframework.integration.handler.AbstractReplyProducingMessageHandler
        
        org.springframework.integration.aggregator.BarrierMessageHandler

実装されているすべてのインターフェース:
org.reactivestreams.Subscriber<Message<?>>, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ExpressionCapable, Orderable, MessageProducer, DiscardingMessageHandler, HeaderPropagationAware, MessageTriggerAction, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>
```
public class BarrierMessageHandler
extends AbstractReplyProducingMessageHandler
implements MessageTriggerAction, DiscardingMessageHandler
```
対応する相関関係を持つメッセージが trigger メソッドに渡されるか、タイムアウトが発生するまでスレッドを一時停止するメッセージハンドラー。特定の相関関係（CorrelationStrategy を呼び出した結果）を持つ 1 つのスレッドのみを一度に中断できます。受信スレッドがトリガースレッドの前に到着しない場合、トリガースレッドは到着するまで中断されるか、タイムアウトが発生します。リクエストメッセージとトリガーメッセージに別々のタイムアウトを構成できます。
デフォルトの CorrelationStrategy は HeaderAttributeCorrelationStrategy です。
デフォルトの出力プロセッサーは DefaultAggregatingMessageGroupProcessor です。
導入:
4.2
作成者:
Gary Russell, Artem Bilan, Michel Jung

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

フィールドのサマリー
- クラス org.springframework.integration.handler.AbstractMessageProducingHandler から継承されたフィールド
  messagingTemplate
- クラス 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

コンストラクターの概要

コンストラクター
コンストラクターと説明
`BarrierMessageHandler(long timeout)` 提供されたタイムアウトとデフォルトの相関および出力戦略を使用してインスタンスを構築します。
`BarrierMessageHandler(long timeout, CorrelationStrategy correlationStrategy)` 提供されたタイムアウトと相関戦略、およびデフォルトの出力プロセッサーを使用してインスタンスを構築します。
`BarrierMessageHandler(long requestTimeout, long triggerTimeout)` 提供されたタイムアウトとデフォルトの相関および出力戦略を使用してインスタンスを構築します。
`BarrierMessageHandler(long requestTimeout, long triggerTimeout, CorrelationStrategy correlationStrategy)` 提供されたタイムアウトと相関戦略、およびデフォルトの出力プロセッサーを使用してインスタンスを構築します。
`BarrierMessageHandler(long requestTimeout, long triggerTimeout, MessageGroupProcessor outputProcessor)` 提供されたタイムアウトと出力プロセッサー、およびデフォルトの相関戦略を使用してインスタンスを構築します。
`BarrierMessageHandler(long requestTimeout, long triggerTimeout, MessageGroupProcessor outputProcessor, CorrelationStrategy correlationStrategy)` 提供されたタイムアウトと出力プロセッサー、およびデフォルトの相関戦略を使用してインスタンスを構築します。
`BarrierMessageHandler(long timeout, MessageGroupProcessor outputProcessor)` 提供されたタイムアウトと出力プロセッサー、およびデフォルトの相関戦略を使用してインスタンスを構築します。
`BarrierMessageHandler(long timeout, MessageGroupProcessor outputProcessor, CorrelationStrategy correlationStrategy)` 提供されたタイムアウトと出力プロセッサー、およびデフォルトの相関戦略を使用してインスタンスを構築します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected ObjectSE`	`buildResult(ObjectSE key, Message<?> requestMessage, Message<?> releaseMessage)` オーバーライドして、結果として受信メッセージとリリースメッセージが返されるデフォルトのメカニズムを変更します。
`StringSE`	`getComponentType()` サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
`MessageChannel`	`getDiscardChannel()` 破棄チャネルを返します。
`IntegrationPatternType`	`getIntegrationPatternType()` このコンポーネントが実装するパターン型を返します。
`protected ObjectSE`	`handleRequestMessage(Message<?> requestMessage)` サブクラスはこのメソッドを実装して、リクエストメッセージを処理する必要があります。
`void`	`setDiscardChannel(MessageChannel discardChannel)` 遅れて到着するトリガーメッセージが送信されるチャネルを設定します。
`void`	`setDiscardChannelName(StringSE discardChannelName)` 遅れて到着するトリガーメッセージが送信されるチャネルの名前を設定します。
`void`	`trigger(Message<?> message)` メッセージに基づいて何らかのアクションを実行します。

クラス org.springframework.integration.handler.AbstractReplyProducingMessageHandler から継承されたメソッド
doInit, doInvokeAdvisedRequestHandler, getBeanClassLoader, getRequiresReply, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReply

クラス org.springframework.integration.handler.AbstractMessageProducingHandler から継承されたメソッド
addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeaders

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

クラス org.springframework.integration.handler.MessageHandlerSupport から継承されたメソッド
buildSendTimer, destroy, 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.messaging.MessageHandler から継承されたメソッド
handleMessage

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

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

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

- コンストラクターの詳細
  - BarrierMessageHandler
```
public BarrierMessageHandler(long timeout)
```
    提供されたタイムアウトとデフォルトの相関および出力戦略を使用してインスタンスを構築します。
    パラメーター:
    timeout - リクエストメッセージとトリガーメッセージの両方のミリ秒単位のタイムアウト。
  - BarrierMessageHandler
```
public BarrierMessageHandler(long timeout,
                             MessageGroupProcessor outputProcessor)
```
    提供されたタイムアウトと出力プロセッサー、およびデフォルトの相関戦略を使用してインスタンスを構築します。
    パラメーター:
    timeout - リクエストメッセージとトリガーメッセージの両方のミリ秒単位のタイムアウト。
    outputProcessor - 出力 MessageGroupProcessor。
  - BarrierMessageHandler
```
public BarrierMessageHandler(long timeout,
                             CorrelationStrategy correlationStrategy)
```
    提供されたタイムアウトと相関戦略、およびデフォルトの出力プロセッサーを使用してインスタンスを構築します。
    パラメーター:
    timeout - リクエストメッセージとトリガーメッセージの両方のミリ秒単位のタイムアウト。
    correlationStrategy - 相関戦略。
  - BarrierMessageHandler
```
public BarrierMessageHandler(long timeout,
                             MessageGroupProcessor outputProcessor,
                             CorrelationStrategy correlationStrategy)
```
    提供されたタイムアウトと出力プロセッサー、およびデフォルトの相関戦略を使用してインスタンスを構築します。
    パラメーター:
    timeout - リクエストメッセージとトリガーメッセージの両方のミリ秒単位のタイムアウト。
    outputProcessor - 出力 MessageGroupProcessor。
    correlationStrategy - 相関戦略。
  - BarrierMessageHandler
```
public BarrierMessageHandler(long requestTimeout,
                             long triggerTimeout)
```
    提供されたタイムアウトとデフォルトの相関および出力戦略を使用してインスタンスを構築します。
    パラメーター:
    requestTimeout - トリガーメッセージを待機するときのミリ秒単位のタイムアウト。
    triggerTimeout - リクエストメッセージを待機するときのミリ秒単位のタイムアウト。
    導入:
    5.4
  - BarrierMessageHandler
```
public BarrierMessageHandler(long requestTimeout,
                             long triggerTimeout,
                             MessageGroupProcessor outputProcessor)
```
    提供されたタイムアウトと出力プロセッサー、およびデフォルトの相関戦略を使用してインスタンスを構築します。
    パラメーター:
    requestTimeout - トリガーメッセージを待機するときのミリ秒単位のタイムアウト。
    triggerTimeout - リクエストメッセージを待機するときのミリ秒単位のタイムアウト。
    outputProcessor - 出力 MessageGroupProcessor。
    導入:
    5.4
  - BarrierMessageHandler
```
public BarrierMessageHandler(long requestTimeout,
                             long triggerTimeout,
                             CorrelationStrategy correlationStrategy)
```
    提供されたタイムアウトと相関戦略、およびデフォルトの出力プロセッサーを使用してインスタンスを構築します。
    パラメーター:
    requestTimeout - トリガーメッセージを待機するときのミリ秒単位のタイムアウト。
    triggerTimeout - リクエストメッセージを待機するときのミリ秒単位のタイムアウト。
    correlationStrategy - 相関戦略。
    導入:
    5.4
  - BarrierMessageHandler
```
public BarrierMessageHandler(long requestTimeout,
                             long triggerTimeout,
                             MessageGroupProcessor outputProcessor,
                             CorrelationStrategy correlationStrategy)
```
    提供されたタイムアウトと出力プロセッサー、およびデフォルトの相関戦略を使用してインスタンスを構築します。
    パラメーター:
    requestTimeout - トリガーメッセージを待機するときのミリ秒単位のタイムアウト。
    triggerTimeout - リクエストメッセージを待機するときのミリ秒単位のタイムアウト。
    outputProcessor - 出力 MessageGroupProcessor。
    correlationStrategy - 相関戦略。
    導入:
    5.4
- メソッドの詳細
  - setDiscardChannelName
```
public void setDiscardChannelName(StringSE discardChannelName)
```
    遅れて到着するトリガーメッセージが送信されるチャネルの名前を設定します。
    パラメーター:
    discardChannelName - 廃棄チャネル。
    導入:
    5.0
  - setDiscardChannel
```
public void setDiscardChannel(MessageChannel discardChannel)
```
    遅れて到着するトリガーメッセージが送信されるチャネルを設定します。
    パラメーター:
    discardChannel - 廃棄チャネル。
    導入:
    5.0
  - getDiscardChannel
```
public MessageChannel getDiscardChannel()
```
    インターフェースからコピーされた説明: DiscardingMessageHandler
    破棄チャネルを返します。
    次で指定:
    インターフェース DiscardingMessageHandler の getDiscardChannel
    戻り値:
    チャンネル。
    導入:
    5.0
  - getComponentType
```
public StringSE getComponentType()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
    次で指定:
    インターフェース NamedComponent の getComponentType
    オーバーライド:
    クラス MessageHandlerSupport の getComponentType
  - getIntegrationPatternType
```
public IntegrationPatternType getIntegrationPatternType()
```
    インターフェースからコピーされた説明: IntegrationPattern
    このコンポーネントが実装するパターン型を返します。
    次で指定:
    インターフェース IntegrationPattern の getIntegrationPatternType
    オーバーライド:
    クラス AbstractReplyProducingMessageHandler の getIntegrationPatternType
    戻り値:
    このコンポーネントが実装する IntegrationPatternType
  - handleRequestMessage
```
protected ObjectSE handleRequestMessage(Message<?> requestMessage)
```
    クラスからコピーされた説明: AbstractReplyProducingMessageHandler
    サブクラスはこのメソッドを実装して、リクエストメッセージを処理する必要があります。戻り値は、メッセージ、MessageBuilder、任意のプレーンオブジェクトです。基本クラスは、これらの開始点のいずれかからの返信メッセージの最終的な作成を処理します。戻り値が null の場合、メッセージフローはここで終了します。
    次で指定:
    クラス AbstractReplyProducingMessageHandler の handleRequestMessage
    パラメーター:
    requestMessage - リクエストメッセージ。
    戻り値:
    メッセージを処理した結果、または null
  - buildResult
```
protected ObjectSE buildResult(ObjectSE key,
                             Message<?> requestMessage,
                             Message<?> releaseMessage)
```
    オーバーライドして、結果として受信メッセージとリリースメッセージが返されるデフォルトのメカニズムを変更します。
    パラメーター:
    key - 相関キー。
    requestMessage - 受信メッセージ。
    releaseMessage - リリースメッセージ。
    戻り値:
    結果。
  - trigger
```
public void trigger(Message<?> message)
```
    インターフェースからコピーされた説明: MessageTriggerAction
    メッセージに基づいて何らかのアクションを実行します。
    次で指定:
    インターフェース MessageTriggerAction の trigger
    パラメーター:
    message - メッセージ。

クラス BarrierMessageHandler

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

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

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

フィールドのサマリー

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

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

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

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

コンストラクターの概要

メソッドのサマリー

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

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

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

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

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

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

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

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

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

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

コンストラクターの詳細

BarrierMessageHandler

BarrierMessageHandler

BarrierMessageHandler

BarrierMessageHandler

BarrierMessageHandler

BarrierMessageHandler

BarrierMessageHandler

BarrierMessageHandler

メソッドの詳細

setDiscardChannelName

setDiscardChannel

getDiscardChannel

getComponentType

getIntegrationPatternType

handleRequestMessage

buildResult

trigger