RateLimiterRequestHandlerAdvice (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.handler.advice.AbstractRequestHandlerAdvice
  - - org.springframework.integration.handler.advice.RateLimiterRequestHandlerAdvice

実装されているすべてのインターフェース:
Advice, Interceptor, MethodInterceptor, Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, ExpressionCapable, NamedComponent
```
public class RateLimiterRequestHandlerAdvice
extends AbstractRequestHandlerAdvice
```
サービスメソッド呼び出しにレート制限するための AbstractRequestHandlerAdvice 拡張。実装は Resilience4j に基づいています。
導入:
5.2
作成者:
Artem Bilan, Gary Russell

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

ネストされたクラス
修飾子と型	クラスと説明
`static class`	`RateLimiterRequestHandlerAdvice.RateLimitExceededException` `requestMessage` および `target` コンテキストを持つ `RequestNotPermitted` の `MessagingException` ラッパー。

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

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
static StringSE DEFAULT_NAME
- クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
  EXPRESSION_PARSER, logger

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`DEFAULT_NAME`

コンストラクターの概要

コンストラクター
コンストラクターと説明
`RateLimiterRequestHandlerAdvice()` デフォルトのレートリミッターオプションとレートリミッター名としての "RateLimiterRequestHandlerAdvice" に基づいてインスタンスを構築します。
`RateLimiterRequestHandlerAdvice(io.github.resilience4j.ratelimiter.RateLimiter rateLimiter)` 提供された `RateLimiter` に基づいてインスタンスを構築します。
`RateLimiterRequestHandlerAdvice(io.github.resilience4j.ratelimiter.RateLimiterConfig rateLimiterConfig)` レートリミッター名として提供された `RateLimiterConfig` および "RateLimiterRequestHandlerAdvice" に基づいてインスタンスを構築します。
`RateLimiterRequestHandlerAdvice(io.github.resilience4j.ratelimiter.RateLimiterConfig rateLimiterConfig, StringSE name)` 提供された `RateLimiterConfig` と名前に基づいてインスタンスを構築します。
`RateLimiterRequestHandlerAdvice(StringSE name)` デフォルトのレートリミッターオプションと指定された名前に基づいてインスタンスを構築します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected ObjectSE`	`doInvoke(AbstractRequestHandlerAdvice.ExecutionCallback callback, ObjectSE target, Message<?> message)` サブクラスは、このメソッドを実装して、`MessageHandler` に動作を適用します。
`io.github.resilience4j.ratelimiter.RateLimiter.Metrics`	`getMetrics()` レートリミッターからメトリクスを取得します。
`io.github.resilience4j.ratelimiter.RateLimiter`	`getRateLimiter()` このアドバイス用に構成された `RateLimiter` を取得します。
`void`	`setLimitForPeriod(int limitForPeriod)` `rateLimiter` の `limitForPeriod` オプションを変更します。
`void`	`setTimeoutDuration(java.time.Duration timeoutDuration)` `rateLimiter` の `timeoutDuration` オプションを変更します。

クラス org.springframework.integration.handler.advice.AbstractRequestHandlerAdvice から継承されたメソッド
invoke, unwrapExceptionIfNecessary, unwrapThrowableIfNecessary

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド
afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getComponentType, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, onInit, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

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

- フィールドの詳細
  - DEFAULT_NAME
```
public static final StringSE DEFAULT_NAME
```
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - RateLimiterRequestHandlerAdvice
```
public RateLimiterRequestHandlerAdvice()
```
    デフォルトのレートリミッターオプションとレートリミッター名としての "RateLimiterRequestHandlerAdvice" に基づいてインスタンスを構築します。
    関連事項:
    RateLimiter.ofDefaults(java.lang.String)
  - RateLimiterRequestHandlerAdvice
```
public RateLimiterRequestHandlerAdvice(StringSE name)
```
    デフォルトのレートリミッターオプションと指定された名前に基づいてインスタンスを構築します。
    パラメーター:
    name - レートリミッターの名前。
  - RateLimiterRequestHandlerAdvice
```
public RateLimiterRequestHandlerAdvice(io.github.resilience4j.ratelimiter.RateLimiter rateLimiter)
```
    提供された RateLimiter に基づいてインスタンスを構築します。
    パラメーター:
    rateLimiter - 使用する RateLimiter。
  - RateLimiterRequestHandlerAdvice
```
public RateLimiterRequestHandlerAdvice(io.github.resilience4j.ratelimiter.RateLimiterConfig rateLimiterConfig)
```
    レートリミッター名として提供された RateLimiterConfig および "RateLimiterRequestHandlerAdvice" に基づいてインスタンスを構築します。
    パラメーター:
    rateLimiterConfig - 使用する RateLimiterConfig。
  - RateLimiterRequestHandlerAdvice
```
public RateLimiterRequestHandlerAdvice(io.github.resilience4j.ratelimiter.RateLimiterConfig rateLimiterConfig,
                                       StringSE name)
```
    提供された RateLimiterConfig と名前に基づいてインスタンスを構築します。
    パラメーター:
    rateLimiterConfig - 使用する RateLimiterConfig。
    name - レートリミッターの名前。
- メソッドの詳細
  - setLimitForPeriod
```
public void setLimitForPeriod(int limitForPeriod)
```
    rateLimiter の limitForPeriod オプションを変更します。
    パラメーター:
    limitForPeriod - 使用する limitForPeriod。
    関連事項:
    RateLimiter.changeLimitForPeriod(int)
  - setTimeoutDuration
```
public void setTimeoutDuration(java.time.Duration timeoutDuration)
```
    rateLimiter の timeoutDuration オプションを変更します。
    パラメーター:
    timeoutDuration - 使用する timeoutDuration。
    関連事項:
    RateLimiter.changeTimeoutDuration(Duration)
  - getMetrics
```
public io.github.resilience4j.ratelimiter.RateLimiter.Metrics getMetrics()
```
    レートリミッターからメトリクスを取得します。
    戻り値:
    レートリミッターからの RateLimiter.Metrics。
    関連事項:
    RateLimiter.getMetrics()
  - getRateLimiter
```
public io.github.resilience4j.ratelimiter.RateLimiter getRateLimiter()
```
    このアドバイス用に構成された RateLimiter を取得します。
    戻り値:
    このアドバイスのための RateLimiter。
  - doInvoke
```
protected ObjectSE doInvoke(AbstractRequestHandlerAdvice.ExecutionCallback callback,
                          ObjectSE target,
                          Message<?> message)
```
    クラスからコピーされた説明: AbstractRequestHandlerAdvice
    サブクラスは、このメソッドを実装して、MessageHandler に動作を適用します。
    callback.execute() はハンドラーメソッドを呼び出し、その結果、null を返します。
    次で指定:
    クラス AbstractRequestHandlerAdvice の doInvoke
    パラメーター:
    callback - サブクラスは、このインターフェースで execute() メソッドを呼び出して、ハンドラーメソッドを呼び出します。
    target - ターゲットハンドラー。
    message - ハンドラーに送信されるメッセージ。
    戻り値:
    MessageHandler を呼び出した後の結果。

クラス RateLimiterRequestHandlerAdvice

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

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

フィールドのサマリー

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

コンストラクターの概要

メソッドのサマリー

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

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

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

フィールドの詳細

DEFAULT_NAME

コンストラクターの詳細

RateLimiterRequestHandlerAdvice

RateLimiterRequestHandlerAdvice

RateLimiterRequestHandlerAdvice

RateLimiterRequestHandlerAdvice

RateLimiterRequestHandlerAdvice

メソッドの詳細

setLimitForPeriod

setTimeoutDuration

getMetrics

getRateLimiter

doInvoke