クラス WebHttpHandlerBuilder
java.lang.ObjectSE
org.springframework.web.server.adapter.WebHttpHandlerBuilder
このビルダーには 2 つの目的があります。
1 つは、ターゲット WebHandler で構成される処理チェーンを組み立て、次に WebFilters のセットで装飾し、さらに WebExceptionHandlers のセットで装飾することです。
2 番目の目的は、結果の処理チェーンを HttpHandler に適合させることです。これは、サポートされる任意のランタイムで使用できる、最低レベルのリアクティブ HTTP 処理抽象化です。適応は HttpWebHandlerAdapter の助けを借りて行われます。
処理 チェーンは、ビルダーメソッドを介して手動でアセンブルするか、applicationContext を介して Spring ApplicationContext から検出するか、その両方を組み合わせて行うことができます。
- 導入:
- 5.0
- 作成者:
- Rossen Stoyanchev, Sebastien Deleuze
- 関連事項:
ネストされたクラスの要約
ネストされたクラス修飾子と型クラス説明static classspring-web クラスのBlockHoundIntegration。フィールドのサマリー
フィールド修飾子と型フィールド説明static final StringSEBean ファクトリの ForwardedHeaderTransformer のよく知られた名前。static final StringSEBean ファクトリの LocaleContextResolver のよく知られた名前。static final StringSEBean ファクトリの ServerCodecConfigurer のよく知られた名前。static final StringSEBean ファクトリのターゲット WebHandler の既知の名前。static final StringSEBean ファクトリの WebSessionManager のよく知られた名前。メソッドのサマリー
修飾子と型メソッド説明static WebHttpHandlerBuilderapplicationContext(ApplicationContext context) ApplicationContextで Bean を検出して新しいビルダーインスタンスを作成する静的ファクトリメソッド。build()HttpHandlerをビルドします。clone()このWebHttpHandlerBuilderを複製します。codecConfigurer(ServerCodecConfigurer codecConfigurer) ServerCodecConfigurerを構成して、WebServerExchangeに設定します。exceptionHandler(WebExceptionHandler... handlers) 指定された例外ハンドラーを追加します。exceptionHandlers(ConsumerSE<ListSE<WebExceptionHandler>> consumer) 現在構成されている例外ハンドラーの「ライブ」リストを操作します。指定されたフィルターを追加します。filters(ConsumerSE<ListSE<WebFilter>> consumer) 現在構成されているフィルターの「ライブ」リストを操作します。forwardedHeaderTransformer(ForwardedHeaderTransformer transformer) 転送されたヘッダーを抽出または削除するためにForwardedHeaderTransformerを構成します。booleanServerCodecConfigurerが構成されているかどうか (ApplicationContextから検出されたか、codecConfigurerを介して明示的に構成されたか)。booleanForwardedHeaderTransformerが構成されているかどうかにかかわらず、ApplicationContextから検出されるか、forwardedHeaderTransformer(ForwardedHeaderTransformer)を介して明示的に構成されます。booleanHttpHandlerのデコレータがhttpHandlerDecorator(Function)を介して設定されているかどうか。booleanLocaleContextResolverが構成されているかどうか (ApplicationContextから検出されたか、localeContextResolverを介して明示的に構成されたか)。booleanWebSessionManagerが構成されているかどうか (ApplicationContextから検出されたか、sessionManagerを介して明示的に構成されたか)。httpHandlerDecorator(FunctionSE<HttpHandler, HttpHandler> handlerDecorator) チェーンを処理するWebExceptionHandler-WebFilter-WebHandler全体を効果的にラップするこのビルダーによって返されるHttpHandlerを装飾するようにFunctionSE を構成します。localeContextResolver(LocaleContextResolver localeContextResolver) WebServerExchangeで設定するようにLocaleContextResolverを構成します。sessionManager(WebSessionManager manager) WebServerExchangeで設定するようにWebSessionManagerを構成します。static WebHttpHandlerBuilderwebHandler(WebHandler webHandler) 新しいビルダーインスタンスを作成する静的ファクトリメソッド。
フィールドの詳細
WEB_HANDLER_BEAN_NAME
Bean ファクトリのターゲット WebHandler の既知の名前。- 関連事項:
WEB_SESSION_MANAGER_BEAN_NAME
Bean ファクトリの WebSessionManager のよく知られた名前。- 関連事項:
SERVER_CODEC_CONFIGURER_BEAN_NAME
Bean ファクトリの ServerCodecConfigurer のよく知られた名前。- 関連事項:
LOCALE_CONTEXT_RESOLVER_BEAN_NAME
Bean ファクトリの LocaleContextResolver のよく知られた名前。- 関連事項:
FORWARDED_HEADER_TRANSFORMER_BEAN_NAME
Bean ファクトリの ForwardedHeaderTransformer のよく知られた名前。- 関連事項:
メソッドの詳細
webHandler
新しいビルダーインスタンスを作成する静的ファクトリメソッド。- パラメーター:
webHandler- リクエストのターゲットハンドラー- 戻り値:
- 準備されたビルダー
applicationContext
ApplicationContextで Bean を検出することによって新しいビルダーインスタンスを作成する静的ファクトリメソッド。以下が検出されます:WebHandler[1]-WEB_HANDLER_BEAN_NAMEという名前で検索されます。WebFilter[0..N]- 型によって検出され、順序付けされます。AnnotationAwareOrderComparatorを参照してください。WebExceptionHandler[0..N]- 型によって検出され、オーダーされました。HttpHandlerDecoratorFactory[0..N]- 型によって検出され、オーダーされました。WebSessionManager[0..1]-WEB_SESSION_MANAGER_BEAN_NAMEという名前で検索されます。ServerCodecConfigurer[0..1]-SERVER_CODEC_CONFIGURER_BEAN_NAMEという名前で検索されます。LocaleContextResolver[0..1]-LOCALE_CONTEXT_RESOLVER_BEAN_NAMEという名前で検索されます。
- パラメーター:
context- 検索に使用するアプリケーションコンテキスト- 戻り値:
- 準備されたビルダー
filter
指定されたフィルターを追加します。- パラメーター:
filters- 追加するフィルター
filters
現在構成されているフィルターの「ライブ」リストを操作します。- パラメーター:
consumer- 使用するコンシューマー
exceptionHandler
指定された例外ハンドラーを追加します。- パラメーター:
handlers- 例外ハンドラー
exceptionHandlers
現在構成されている例外ハンドラーの「ライブ」リストを操作します。- パラメーター:
consumer- 使用するコンシューマー
sessionManager
- パラメーター:
manager- セッションマネージャー- 関連事項:
hasSessionManager
public boolean hasSessionManager()WebSessionManagerが構成されているかどうか (ApplicationContextから検出されたか、sessionManagerを介して明示的に構成されたか)。- 導入:
- 5.0.9
codecConfigurer
ServerCodecConfigurerを構成して、WebServerExchangeに設定します。- パラメーター:
codecConfigurer- コーデック設定
hasCodecConfigurer
public boolean hasCodecConfigurer()ServerCodecConfigurerが構成されているかどうか (ApplicationContextから検出されたか、codecConfigurerを介して明示的に構成されたか)。- 導入:
- 5.0.9
localeContextResolver
WebServerExchangeで設定するようにLocaleContextResolverを構成します。- パラメーター:
localeContextResolver- ロケールコンテキストリゾルバー
hasLocaleContextResolver
public boolean hasLocaleContextResolver()LocaleContextResolverが構成されているかどうか (ApplicationContextから検出されたか、localeContextResolverを介して明示的に構成されたか)。- 導入:
- 5.0.9
forwardedHeaderTransformer
転送されたヘッダーを抽出または削除するためにForwardedHeaderTransformerを構成します。- パラメーター:
transformer- トランスフォーマー- 導入:
- 5.1
hasForwardedHeaderTransformer
public boolean hasForwardedHeaderTransformer()ForwardedHeaderTransformerが構成されているかどうかにかかわらず、ApplicationContextから検出されるか、forwardedHeaderTransformer(ForwardedHeaderTransformer)を介して明示的に構成されます。- 導入:
- 5.1
httpHandlerDecorator
public WebHttpHandlerBuilder httpHandlerDecorator(FunctionSE<HttpHandler, HttpHandler> handlerDecorator) チェーンを処理するWebExceptionHandler-WebFilter-WebHandler全体を効果的にラップするこのビルダーによって返されるHttpHandlerを装飾するようにFunctionSE を構成します。これにより、チェーン全体の前にリクエストとレスポンスにアクセスでき、同様にチェーン全体の結果を監視することができます。- パラメーター:
handlerDecorator- 適用するデコレータ- 導入:
- 5.3
hasHttpHandlerDecorator
public boolean hasHttpHandlerDecorator()HttpHandlerのデコレータがhttpHandlerDecorator(Function)を介して設定されているかどうか。- 導入:
- 5.3
build
HttpHandlerをビルドします。clone
このWebHttpHandlerBuilderを複製します。