CorrelationHandlerSpec (Spring Integration API)

java.lang.ObjectSE
- org.springframework.beans.factory.config.AbstractFactoryBean<T>
- - org.springframework.integration.dsl.IntegrationComponentSpec<S,reactor.util.function.Tuple2<F,H>>
  - - org.springframework.integration.dsl.EndpointSpec<S,ConsumerEndpointFactoryBean,H>
    - - org.springframework.integration.dsl.ConsumerEndpointSpec<S,H>
      - org.springframework.integration.dsl.CorrelationHandlerSpec<S,H>

型パラメーター:
S - ターゲット CorrelationHandlerSpec 実装型。
H - AbstractCorrelatingMessageHandler 実装型。
実装されているすべてのインターフェース:
Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<reactor.util.function.Tuple2<ConsumerEndpointFactoryBean,H>>, InitializingBean, Lifecycle, Phased, SmartLifecycle, ComponentsRegistration
既知の直属サブクラス
AggregatorSpec, ResequencerSpec
```
public abstract class CorrelationHandlerSpec<S extends CorrelationHandlerSpec<S,H>,H extends AbstractCorrelatingMessageHandler>
extends ConsumerEndpointSpec<S,H>
```
AbstractCorrelatingMessageHandler の MessageHandlerSpec。
導入:
5.0
作成者:
Artem Bilan, Gary Russell

フィールドのサマリー
- クラス org.springframework.integration.dsl.ConsumerEndpointSpec から継承されたフィールド
  adviceChain
- クラス org.springframework.integration.dsl.EndpointSpec から継承されたフィールド
  componentsToRegister, endpointFactoryBean, handler
- クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたフィールド
  PARSER, target
- クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたフィールド
  logger
- インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
  DEFAULT_PHASE
- インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド
  OBJECT_TYPE_ATTRIBUTE

コンストラクターの概要
コンストラクター
修飾子コンストラクターと説明
protected CorrelationHandlerSpec(H messageHandler)

コンストラクター
修飾子	コンストラクターと説明
`protected`	`CorrelationHandlerSpec(H messageHandler)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`S`	`correlationExpression(StringSE correlationExpression)` 指定された式の `ExpressionEvaluatingCorrelationStrategy` でハンドラーを構成します。
`S`	`correlationStrategy(CorrelationStrategy correlationStrategy)`
`S`	`correlationStrategy(ObjectSE target, StringSE methodName)` ターゲットオブジェクトとメソッド名の `MethodInvokingCorrelationStrategy` でハンドラーを構成します。
`S`	`discardChannel(MessageChannel discardChannel)`
`S`	`discardChannel(StringSE discardChannelName)`
`S`	`expireGroupsUponTimeout(boolean expireGroupsUponTimeout)` タイムアウトのためにグループが完了した場合、グループを期限切れ（完全に削除）します。
`S`	`forceReleaseAdvice(Advice... advice)` `forceComplete()` 操作に適用する `Advice` オブジェクトのリストを構成します。
`S`	`groupTimeout(java.util.function.FunctionSE<MessageGroup, LongSE> groupTimeoutFunction)` メッセージグループに基づいて、グループタイムアウトを解決するために呼び出される関数でハンドラーを構成します。
`S`	`groupTimeout(long groupTimeout)` この定数値に評価されるグループタイムアウト式でハンドラーを構成します。
`S`	`groupTimeoutExpression(StringSE groupTimeoutExpression)`
`S`	`lockRegistry(LockRegistry lockRegistry)` `MessageGroup` での同時操作のために、`groupId` に基づいて `Lock` を取得するために使用されます。
`S`	`messageStore(MessageGroupStore messageStore)`
`S`	`minimumTimeoutForEmptyGroups(long minimumTimeoutForEmptyGroups)`
`S`	`popSequence(boolean popSequence)` 出力メッセージに対して `MessageBuilder.popSequenceDetails()` を実行するかどうか。
`S`	`processor(ObjectSE target)` 各関数に適切にアノテーションが付けられたメソッドを持つ必要があるターゲットオブジェクトを使用して、`MethodInvokingCorrelationStrategy` および `MethodInvokingReleaseStrategy` でハンドラーを構成します。
`S`	`releaseExpression(StringSE releaseExpression)` 指定された式の `ExpressionEvaluatingReleaseStrategy` でハンドラーを構成します。
`S`	`releaseStrategy(ObjectSE target, StringSE methodName)` ターゲットオブジェクトとメソッド名の `MethodInvokingReleaseStrategy` でハンドラーを構成します。
`S`	`releaseStrategy(ReleaseStrategy releaseStrategy)`
`S`	`sendPartialResultOnExpiry(boolean sendPartialResultOnExpiry)`
`S`	`setExpireDuration(java.time.Duration expireDuration)` スケジュールされたパージタスクを実行する頻度を `Duration` に構成します。
`S`	`setExpireTimeout(long expireTimeout)` ストア内の古いグループがパージするタイムアウトを構成します。
`S`	`taskScheduler(TaskScheduler taskScheduler)` ポーリングコンシューマーなどで、タスクをスケジュールするために `TaskScheduler` を構成します。

クラス org.springframework.integration.dsl.ConsumerEndpointSpec から継承されたメソッド
advice, async, autoStartup, customizeMonoReply, doGet, handleMessageAdvice, notPropagatedHeaders, order, phase, poller, requiresReply, role, sendTimeout, transactional, transactional, transactional, transactional, transactional

クラス org.springframework.integration.dsl.EndpointSpec から継承されたメソッド
assertHandler, getComponentsToRegister, id, obtainInputChannelFromFlow, obtainInputChannelFromFlow, poller, poller

クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたメソッド
_this, createInstance, destroyInstance, get, getId, getObjectType, getPhase, isAutoStartup, isRunning, start, stop, stop

クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたメソッド
afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

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

- コンストラクターの詳細
  - CorrelationHandlerSpec
```
protected CorrelationHandlerSpec(H messageHandler)
```
- メソッドの詳細
  - messageStore
```
public S messageStore(MessageGroupStore messageStore)
```
    パラメーター:
    messageStore - メッセージグループストア。
    戻り値:
    ハンドラーの仕様。
    関連事項:
    AbstractCorrelatingMessageHandler.setMessageStore(MessageGroupStore)
  - sendPartialResultOnExpiry
```
public S sendPartialResultOnExpiry(boolean sendPartialResultOnExpiry)
```
    パラメーター:
    sendPartialResultOnExpiry - sendPartialResultOnExpiry。
    戻り値:
    ハンドラーの仕様。
    関連事項:
    AbstractCorrelatingMessageHandler.setSendPartialResultOnExpiry(boolean)
  - minimumTimeoutForEmptyGroups
```
public S minimumTimeoutForEmptyGroups(long minimumTimeoutForEmptyGroups)
```
    パラメーター:
    minimumTimeoutForEmptyGroups - minimumTimeoutForEmptyGroups
    戻り値:
    ハンドラーの仕様。
    関連事項:
    AbstractCorrelatingMessageHandler.setMinimumTimeoutForEmptyGroups(long)
  - groupTimeout
```
public S groupTimeout(long groupTimeout)
```
    この定数値に評価されるグループタイムアウト式でハンドラーを構成します。
    パラメーター:
    groupTimeout - グループのタイムアウト（ミリ秒）。
    戻り値:
    ハンドラーの仕様。
    関連事項:
    AbstractCorrelatingMessageHandler.setGroupTimeoutExpression(org.springframework.expression.Expression), ValueExpression
  - groupTimeoutExpression
```
public S groupTimeoutExpression(StringSE groupTimeoutExpression)
```
    パラメーター:
    groupTimeoutExpression - グループタイムアウト式文字列。
    戻り値:
    ハンドラーの仕様。
    関連事項:
    AbstractCorrelatingMessageHandler.setGroupTimeoutExpression(org.springframework.expression.Expression)
  - groupTimeout
```
public S groupTimeout(java.util.function.FunctionSE<MessageGroup,LongSE> groupTimeoutFunction)
```
    メッセージグループに基づいて、グループタイムアウトを解決するために呼び出される関数でハンドラーを構成します。通常、JDK8 ラムダで使用されます。
    .groupTimeout(g -> g.size() * 2000L).
    パラメーター:
    groupTimeoutFunction - グループのタイムアウトをミリ秒単位で解決するために呼び出される関数。
    戻り値:
    ハンドラーの仕様。
    関連事項:
    AbstractCorrelatingMessageHandler.setGroupTimeoutExpression(org.springframework.expression.Expression)
  - taskScheduler
```
public S taskScheduler(TaskScheduler taskScheduler)
```
    クラスからコピーされた説明: ConsumerEndpointSpec
    ポーリングコンシューマーなどで、タスクをスケジュールするために TaskScheduler を構成します。デフォルトでは、グローバル ThreadPoolTaskScheduler Bean が使用されます。この構成は、たとえば、ポーリングタスク専用のスレッドを用意する必要がある場合に役立ちます。
    オーバーライド:
    クラス ConsumerEndpointSpec<S extends CorrelationHandlerSpec<S, H>,H extends AbstractCorrelatingMessageHandler> の taskScheduler
    パラメーター:
    taskScheduler - タスクスケジューラ。
    戻り値:
    ハンドラーの仕様。
    関連事項:
    IntegrationObjectSupport.setTaskScheduler(TaskScheduler)
  - discardChannel
```
public S discardChannel(MessageChannel discardChannel)
```
    パラメーター:
    discardChannel - 廃棄チャネル。
    戻り値:
    ハンドラーの仕様。
    関連事項:
    AbstractCorrelatingMessageHandler.setDiscardChannel(MessageChannel)
  - discardChannel
```
public S discardChannel(StringSE discardChannelName)
```
    パラメーター:
    discardChannelName - 廃棄チャネル。
    戻り値:
    ハンドラーの仕様。
    関連事項:
    AbstractCorrelatingMessageHandler.setDiscardChannelName(String)
  - processor
```
public S processor(ObjectSE target)
```
    各関数に適切にアノテーションが付けられたメソッドを持つ必要があるターゲットオブジェクトを使用して、MethodInvokingCorrelationStrategy および MethodInvokingReleaseStrategy でハンドラーを構成します。
    パラメーター:
    target - ターゲットオブジェクト
    戻り値:
    ハンドラーの仕様。
    関連事項:
    AbstractCorrelatingMessageHandler.setCorrelationStrategy(CorrelationStrategy), AbstractCorrelatingMessageHandler.setReleaseStrategy(ReleaseStrategy)
  - correlationExpression
```
public S correlationExpression(StringSE correlationExpression)
```
    指定された式の ExpressionEvaluatingCorrelationStrategy でハンドラーを構成します。
    パラメーター:
    correlationExpression - 相関式。
    戻り値:
    ハンドラーの仕様。
    関連事項:
    AbstractCorrelatingMessageHandler.setCorrelationStrategy(CorrelationStrategy)
  - correlationStrategy
```
public S correlationStrategy(ObjectSE target,
                             StringSE methodName)
```
    ターゲットオブジェクトとメソッド名の MethodInvokingCorrelationStrategy でハンドラーを構成します。
    パラメーター:
    target - ターゲットオブジェクト。
    methodName - メソッド名。
    戻り値:
    ハンドラーの仕様。
    関連事項:
    AbstractCorrelatingMessageHandler.setCorrelationStrategy(CorrelationStrategy)
  - correlationStrategy
```
public S correlationStrategy(CorrelationStrategy correlationStrategy)
```
    パラメーター:
    correlationStrategy - 相関戦略。
    戻り値:
    ハンドラーの仕様。
    関連事項:
    AbstractCorrelatingMessageHandler.setCorrelationStrategy(CorrelationStrategy)
  - releaseExpression
```
public S releaseExpression(StringSE releaseExpression)
```
    指定された式の ExpressionEvaluatingReleaseStrategy でハンドラーを構成します。
    パラメーター:
    releaseExpression - 相関式。
    戻り値:
    ハンドラーの仕様。
    関連事項:
    AbstractCorrelatingMessageHandler.setReleaseStrategy(ReleaseStrategy)
  - releaseStrategy
```
public S releaseStrategy(ObjectSE target,
                         StringSE methodName)
```
    ターゲットオブジェクトとメソッド名の MethodInvokingReleaseStrategy でハンドラーを構成します。
    パラメーター:
    target - ターゲットオブジェクト。
    methodName - メソッド名。
    戻り値:
    ハンドラーの仕様。
    関連事項:
    AbstractCorrelatingMessageHandler.setReleaseStrategy(ReleaseStrategy)
  - releaseStrategy
```
public S releaseStrategy(ReleaseStrategy releaseStrategy)
```
    パラメーター:
    releaseStrategy - リリース戦略。
    戻り値:
    ハンドラーの仕様。
    関連事項:
    AbstractCorrelatingMessageHandler.setReleaseStrategy(ReleaseStrategy)
  - expireGroupsUponTimeout
```
public S expireGroupsUponTimeout(boolean expireGroupsUponTimeout)
```
    タイムアウトのためにグループが完了した場合、グループを期限切れにします（完全に削除します）。アグリゲーターのデフォルトの true とリシーケンサーの false。
    パラメーター:
    expireGroupsUponTimeout - 設定する expireGroupsUponTimeout
    戻り値:
    ハンドラーの仕様。
    関連事項:
    AbstractCorrelatingMessageHandler.setExpireGroupsUponTimeout(boolean)
  - forceReleaseAdvice
```
public S forceReleaseAdvice(Advice... advice)
```
    forceComplete() 操作に適用する Advice オブジェクトのリストを構成します。
    パラメーター:
    advice - アドバイスチェーン。
    戻り値:
    エンドポイント仕様。
  - lockRegistry
```
public S lockRegistry(LockRegistry lockRegistry)
```
    MessageGroup での同時操作のために groupId に基づいて Lock を取得するために使用されます。デフォルトでは、内部 DefaultLockRegistry が使用されます。RedisLockRegistry などの分散 LockRegistry を使用すると、アグリゲーターの 1 つのインスタンスのみがグループで同時に動作することが保証されます。
    パラメーター:
    lockRegistry - 使用する LockRegistry。
    戻り値:
    エンドポイント仕様。
  - popSequence
```
public S popSequence(boolean popSequence)
```
    出力メッセージに対して MessageBuilder.popSequenceDetails() を実行するかどうか。
    パラメーター:
    popSequence - 使用するブールフラグ。
    戻り値:
    エンドポイント仕様。
    導入:
    5.1
    関連事項:
    AbstractCorrelatingMessageHandler.setPopSequence(boolean)
  - setExpireTimeout
```
public S setExpireTimeout(long expireTimeout)
```
    ストア内の古いグループがパージするタイムアウトを構成します。
    パラメーター:
    expireTimeout - 使用するミリ秒単位のタイムアウト。
    戻り値:
    エンドポイント仕様。
    導入:
    5.4
    関連事項:
    AbstractCorrelatingMessageHandler.setExpireTimeout(long)
  - setExpireDuration
```
public S setExpireDuration(java.time.Duration expireDuration)
```
    スケジュールされたパージタスクを実行する頻度を Duration に構成します。
    パラメーター:
    expireDuration - スケジュールされたパージタスクの期間。
    戻り値:
    エンドポイント仕様。
    導入:
    5.4
    関連事項:
    AbstractCorrelatingMessageHandler.setExpireDuration(Duration)

クラス CorrelationHandlerSpec<S extends CorrelationHandlerSpec<S,H>,H extends AbstractCorrelatingMessageHandler>

フィールドのサマリー

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

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

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

クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたフィールド

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

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

コンストラクターの概要

メソッドのサマリー

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

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

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

クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたメソッド

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

コンストラクターの詳細

CorrelationHandlerSpec

メソッドの詳細

messageStore

sendPartialResultOnExpiry

minimumTimeoutForEmptyGroups

groupTimeout

groupTimeoutExpression

groupTimeout

taskScheduler

discardChannel

discardChannel

processor

correlationExpression

correlationStrategy

correlationStrategy

releaseExpression

releaseStrategy

releaseStrategy

expireGroupsUponTimeout

forceReleaseAdvice

lockRegistry

popSequence

setExpireTimeout

setExpireDuration