DelayHandler (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.handler.DelayHandler

実装されたすべてのインターフェース:
EventListenerSE, org.reactivestreams.Subscriber<Message<?>>, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, ApplicationListener<ContextRefreshedEvent>, Ordered, ExpressionCapable, Orderable, MessageProducer, DelayHandlerManagement, HeaderPropagationAware, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>
```
@ManagedResource
 @IntegrationManagedResource
public class DelayHandler
extends AbstractReplyProducingMessageHandler
implements DelayHandlerManagement, ApplicationListener<ContextRefreshedEvent>
```
受信 Message での delayExpression の評価結果、またはこのハンドラーで構成されたデフォルトの遅延値に基づいて、メッセージフローの継続を遅延させることができる MessageHandler。フローの継続は TaskScheduler に委譲されるため、呼び出しスレッドはブロックしないことに注意してください。このアプローチの利点は、ブロックされたスレッドの蓄積を生成することなく、非常に長い遅延であっても、多くの遅延を同時に管理できることです。
ただし、覚えておくべきことの 1 つは、アクティブなトランザクションコンテキストが元の送信者から最終的な受信者に伝播されないことです。これは、制御中の別のスレッドでの遅延後にメッセージを出力チャネルに渡すことの副作用です。
このハンドラーの delayExpression プロパティが構成されている場合、その評価結果値はハンドラーの defaultDelay 値よりも優先されます。実際の評価結果の値は、long、long として解析できる文字列、Date の場合があります。長い場合は、現在の時刻から数えてミリ秒単位で遅延する時間の長さとして解釈されます（たとえば、値 5000 は、現在の時刻から 5 秒でメッセージを解放できることを示します）。値が日付の場合、少なくともその日付が発生するまで遅延します（つまり、その場合の遅延は headerDate.getTime() - new Date().getTime() と同等です）。
導入:
1.0.3
作成者:
Mark Fisher, Artem Bilan, Gary Russell

ネストされたクラスのサマリー
ネストされたクラス
修飾子と型クラスと説明
static class DelayHandler.DelayedMessageWrapper
- クラス org.springframework.integration.handler.AbstractReplyProducingMessageHandler から継承されたネストクラス / インターフェース
  AbstractReplyProducingMessageHandler.RequestHandler
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース
  IntegrationManagement.ManagementOverrides

ネストされたクラス
修飾子と型	クラスと説明
`static class`	`DelayHandler.DelayedMessageWrapper`

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
static int DEFAULT_MAX_ATTEMPTS
static long DEFAULT_RETRY_DELAY
- クラス 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

フィールド
修飾子と型	フィールドと説明
`static int`	`DEFAULT_MAX_ATTEMPTS`
`static long`	`DEFAULT_RETRY_DELAY`

コンストラクターの概要

コンストラクター
コンストラクターと説明
`DelayHandler(StringSE messageGroupId)` 指定された "messageGroupId" を使用して DelayHandler を作成し、これを `MessageGroup` の「キー」として使用して、遅延されたメッセージを `MessageGroupStore` に格納します。
`DelayHandler(StringSE messageGroupId, TaskScheduler taskScheduler)` 指定されたデフォルトの遅延で DelayHandler を作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected void`	`doInit()`
`StringSE`	`getComponentType()` サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
`int`	`getDelayedMessageCount()`
`IntegrationPatternType`	`getIntegrationPatternType()` このコンポーネントが実装するパターン型を返します。
`protected ObjectSE`	`handleRequestMessage(Message<?> requestMessage)` 'requestMessage' が以前に遅延されていなかったかどうかを確認します ( `releaseMessageAfterDelay(org.springframework.messaging.Message<?>, long)` および `DelayHandler.DelayedMessageWrapper` )。
`void`	`onApplicationEvent(ContextRefreshedEvent event)` `ContextRefreshedEvent` を処理して、アプリケーションコンテキストの起動後できるだけ遅く `reschedulePersistedMessages()` を呼び出します。
`protected void`	`rescheduleAt(Message<?> message, DateSE startTime)`
`void`	`reschedulePersistedMessages()` 'messageStore' 内の永続的なメッセージを読み取って再スケジュールするために使用されます (例:
`void`	`setDefaultDelay(long defaultDelay)` デフォルトの遅延をミリ秒単位で設定します。
`void`	`setDelayedAdviceChain(ListSE<Advice> delayedAdviceChain)` `List<Advice>` を指定して、`DelayHandler.ReleaseMessageHandler` プロキシに通知します。
`void`	`setDelayedMessageErrorChannel(MessageChannel delayedMessageErrorChannel)` リリースされたメッセージの送信に失敗した場合に `ErrorMessage` が送信されるメッセージチャネルを設定します。
`void`	`setDelayedMessageErrorChannelName(StringSE delayedMessageErrorChannelName)` 解放されたメッセージの送信に失敗した場合に `ErrorMessage` が送信されるメッセージチャネル名を設定します。
`void`	`setDelayExpression(Expression delayExpression)` 遅延期間（ミリ秒単位）または遅延する日付をチェックする必要がある `Expression` を指定します。
`void`	`setDelayExpressionString(StringSE delayExpression)` 遅延期間（ミリ秒単位）または遅延する日付をチェックする必要がある `Expression` を指定します。
`void`	`setIgnoreExpressionFailures(boolean ignoreExpressionFailures)` `delayExpression` 評価によってスローされた `Exceptions` を無視するかどうかを指定します（ログに記録されるだけです）。
`void`	`setMaxAttempts(int maxAttempts)` メッセージのリリースが失敗した場合のリリースの最大試行回数を設定します。
`void`	`setMessageStore(MessageGroupStore messageStore)` 遅延を待機している間にメッセージを保管するために使用する必要がある `MessageGroupStore` を指定します。
`void`	`setRetryDelay(long retryDelay)` リリース失敗後に再試行するときに適用する追加の遅延を設定します。
`protected boolean`	`shouldCopyRequestHeaders()` サブクラスはこれをオーバーライドできます。

クラス org.springframework.integration.handler.AbstractReplyProducingMessageHandler から継承されたメソッド
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, 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.context.ApplicationListener から継承されたメソッド
forPayload

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

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

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

- フィールドの詳細
  - DEFAULT_MAX_ATTEMPTS
```
public static final int DEFAULT_MAX_ATTEMPTS
```
    関連事項:
    定数フィールド値
  - DEFAULT_RETRY_DELAY
```
public static final long DEFAULT_RETRY_DELAY
```
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - DelayHandler
```
public DelayHandler(StringSE messageGroupId)
```
    指定された "messageGroupId" を使用して DelayHandler を作成し、MessageGroup が遅延メッセージを MessageGroupStore に保存するための「キー」として使用します。遅延後のメッセージの送信は、ApplicationContext のデフォルト ThreadPoolTaskScheduler に登録されて処理されます。
    パラメーター:
    messageGroupId - メッセージグループ識別子。
    関連事項:
    IntegrationObjectSupport.getTaskScheduler()
  - DelayHandler
```
public DelayHandler(StringSE messageGroupId,
                    TaskScheduler taskScheduler)
```
    指定されたデフォルトの遅延で DelayHandler を作成します。遅延後のメッセージの送信は、提供された TaskScheduler によって処理されます。
    パラメーター:
    messageGroupId - メッセージグループ識別子。
    taskScheduler - タスクスケジューラ。
- メソッドの詳細
  - setDefaultDelay
```
public void setDefaultDelay(long defaultDelay)
```
    デフォルトの遅延をミリ秒単位で設定します。delayExpression プロパティが指定されていない場合、デフォルトの遅延がすべてのメッセージに適用されます。評価結果が delayExpression のメッセージにのみ遅延を適用する必要がある場合は、この値を 0 に設定します。
    パラメーター:
    defaultDelay - ミリ秒単位のデフォルトの遅延。
  - setDelayExpression
```
public void setDelayExpression(Expression delayExpression)
```
    遅延期間（ミリ秒単位）または遅延する日付をチェックする必要がある Expression を指定します。このプロパティが設定されている場合、式の評価の結果（null でない場合）は、このハンドラーのデフォルトの遅延よりも優先されます。
    パラメーター:
    delayExpression - 遅延式。
  - setDelayExpressionString
```
public void setDelayExpressionString(StringSE delayExpression)
```
    遅延期間（ミリ秒単位）または遅延する日付をチェックする必要がある Expression を指定します。このプロパティが設定されている場合、式の評価の結果（null でない場合）は、このハンドラーのデフォルトの遅延よりも優先されます。
    パラメーター:
    delayExpression - 遅延式。
    導入:
    5.0
  - setIgnoreExpressionFailures
```
public void setIgnoreExpressionFailures(boolean ignoreExpressionFailures)
```
    delayExpression 評価によってスローされた Exceptions を無視するかどうかを指定します（ログに記録されるだけです）。この場合、遅延は defaultDelay にフォールバックします。このプロパティが false として指定されている場合、delayExpression 評価 Exception は、defaultDelay にフォールバックせずに呼び出し元にスローされます。デフォルトは true です。
    パラメーター:
    ignoreExpressionFailures - 式の評価の失敗を無視する必要がある場合は true。
    関連事項:
    determineDelayForMessage(org.springframework.messaging.Message<?>)
  - setMessageStore
```
public void setMessageStore(MessageGroupStore messageStore)
```
    遅延を待機している間にメッセージを保管するために使用する必要がある MessageGroupStore を指定します。
    パラメーター:
    messageStore - メッセージストア。
  - setDelayedAdviceChain
```
public void setDelayedAdviceChain(ListSE<Advice> delayedAdviceChain)
```
    List<Advice> を指定して、DelayHandler.ReleaseMessageHandler プロキシに通知します。通常、トランザクションメッセージストアから取得した遅延メッセージにトランザクションを追加するために使用されます。
    パラメーター:
    delayedAdviceChain - アドバイスチェーン。
    関連事項:
    createReleaseMessageTask()
  - setDelayedMessageErrorChannel
```
public void setDelayedMessageErrorChannel(MessageChannel delayedMessageErrorChannel)
```
    リリースされたメッセージの送信に失敗した場合に ErrorMessage が送信されるメッセージチャネルを設定します。エラーフローが正常に戻った場合、リリースは完了です。エラーフローが例外をスローした場合、リリースは再試行されます。リリースタスクに関するトランザクションアドバイスがある場合、エラーフローはトランザクション内で呼び出されます。
    パラメーター:
    delayedMessageErrorChannel - チャンネル。
    導入:
    5.0.8
    関連事項:
    setMaxAttempts(int), setRetryDelay(long)
  - setDelayedMessageErrorChannelName
```
public void setDelayedMessageErrorChannelName(StringSE delayedMessageErrorChannelName)
```
    解放されたメッセージの送信に失敗した場合に ErrorMessage が送信されるメッセージチャネル名を設定します。エラーフローが正常に戻った場合、リリースは完了です。エラーフローが例外をスローした場合、リリースは再試行されます。リリースタスクに関するトランザクションアドバイスがある場合、エラーフローはトランザクション内で呼び出されます。
    パラメーター:
    delayedMessageErrorChannelName - チャンネル名。
    導入:
    5.0.8
    関連事項:
    setMaxAttempts(int), setRetryDelay(long)
  - setMaxAttempts
```
public void setMaxAttempts(int maxAttempts)
```
    メッセージのリリースが失敗した場合のリリースの最大試行回数を設定します。デフォルトの 5.
    パラメーター:
    maxAttempts - 最大試行回数。
    導入:
    5.0.8
    関連事項:
    setRetryDelay(long)
  - setRetryDelay
```
public void setRetryDelay(long retryDelay)
```
    リリースが失敗した後に再試行するときに適用する追加の遅延を設定します。デフォルトの 1000L。
    パラメーター:
    retryDelay - 再試行遅延。
    導入:
    5.0.8
    関連事項:
    setMaxAttempts(int)
  - getComponentType
```
public StringSE getComponentType()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
    次で指定:
    インターフェース NamedComponent の getComponentType
    オーバーライド:
    クラス MessageHandlerSupport の getComponentType
  - getIntegrationPatternType
```
public IntegrationPatternType getIntegrationPatternType()
```
    インターフェースからコピーされた説明: IntegrationPattern
    このコンポーネントが実装するパターン型を返します。
    次で指定:
    インターフェース IntegrationPattern の getIntegrationPatternType
    オーバーライド:
    クラス AbstractReplyProducingMessageHandler の getIntegrationPatternType
    戻り値:
    このコンポーネントが実装する IntegrationPatternType
  - doInit
```
protected void doInit()
```
    オーバーライド:
    クラス AbstractReplyProducingMessageHandler の doInit
  - shouldCopyRequestHeaders
```
protected boolean shouldCopyRequestHeaders()
```
    クラスからコピーされた説明: AbstractMessageProducingHandler
    サブクラスはこれをオーバーライドできます。デフォルトでは true。
    オーバーライド:
    クラス AbstractMessageProducingHandler の shouldCopyRequestHeaders
    戻り値:
    リクエストヘッダーをコピーする必要がある場合は true。
  - handleRequestMessage
```
protected ObjectSE handleRequestMessage(Message<?> requestMessage)
```
    'requestMessage' が以前 ( releaseMessageAfterDelay(org.springframework.messaging.Message<?>, long) および DelayHandler.DelayedMessageWrapper ) に遅延されていないかどうかを確認します。次に、'requestMessage' ( determineDelayForMessage(org.springframework.messaging.Message<?>) ) の 'delay' を決定し、delay > 0 が 'delay' の後に 'releaseMessage' タスクをスケジュールするかどうかを決定します。
    次で指定:
    クラス AbstractReplyProducingMessageHandler の handleRequestMessage
    パラメーター:
    requestMessage - - 遅延する可能性のあるメッセージ。
    戻り値:
    - 'requestMessage' が遅延している場合は null、それ以外の場合は 'requestMessage' からの 'payload'。
    関連事項:
    releaseMessage(org.springframework.messaging.Message<?>)
  - rescheduleAt
```
protected void rescheduleAt(Message<?> message,
                            DateSE startTime)
```
  - getDelayedMessageCount
```
public int getDelayedMessageCount()
```
    次で指定:
    インターフェース DelayHandlerManagement の getDelayedMessageCount
  - reschedulePersistedMessages
```
public void reschedulePersistedMessages()
```
    'messageStore' に永続化されたメッセージを読み取って、アプリケーションの再起動時などに再スケジュールするために使用されます。ロジックは messageGroup.getMessages() の反復処理に基づいており、'delay' ロジックのタスクをスケジュールします。この動作は、呼び出しスレッドのオーバーロードを回避することによって決定されます。
    次で指定:
    インターフェース DelayHandlerManagement の reschedulePersistedMessages
  - onApplicationEvent
```
public void onApplicationEvent(ContextRefreshedEvent event)
```
    ContextRefreshedEvent を処理して、アプリケーションコンテキストの起動後にできるだけ遅く reschedulePersistedMessages() を呼び出すようにします。また、initialized をチェックして、たとえば Spring-MVC アプリケーションのような ' 親子 ' コンテキストで公開されているかもしれない他の ContextRefreshedEvent を無視します。
    次で指定:
    インターフェース ApplicationListener<ContextRefreshedEvent> の onApplicationEvent
    パラメーター:
    event - - アプリケーションコンテキストが完全に初期化された後に発生する ContextRefreshedEvent。
    関連事項:
    reschedulePersistedMessages()

クラス DelayHandler

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

クラス 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.context.ApplicationListener から継承されたメソッド

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

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

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

フィールドの詳細

DEFAULT_MAX_ATTEMPTS

DEFAULT_RETRY_DELAY

コンストラクターの詳細

DelayHandler

DelayHandler

メソッドの詳細

setDefaultDelay

setDelayExpression

setDelayExpressionString

setIgnoreExpressionFailures

setMessageStore

setDelayedAdviceChain

setDelayedMessageErrorChannel

setDelayedMessageErrorChannelName

setMaxAttempts

setRetryDelay

getComponentType

getIntegrationPatternType

doInit

shouldCopyRequestHeaders

handleRequestMessage

rescheduleAt

getDelayedMessageCount

reschedulePersistedMessages

onApplicationEvent