WebHttpHandlerBuilder (Spring Framework API)

java.lang.ObjectSE
- org.springframework.web.server.adapter.WebHttpHandlerBuilder

```
public final class WebHttpHandlerBuilder
extends ObjectSE
```
このビルダーには 2 つの目的があります。
1 つは、ターゲット WebHandler で構成される処理チェーンを組み立て、次に WebFilters のセットで装飾し、さらに WebExceptionHandlers のセットで装飾することです。
2 番目の目的は、結果の処理チェーンを HttpHandler に適合させることです。これは、サポートされる任意のランタイムで使用できる、最低レベルのリアクティブ HTTP 処理抽象化です。適応は HttpWebHandlerAdapter の助けを借りて行われます。
処理チェーンは、ビルダーメソッドを介して手動でアセンブルするか、Spring ApplicationContext から applicationContext を介して検出するか、両方を組み合わせて検出できます。
導入:
5.0
作成者:
Rossen Stoyanchev, Sebastien Deleuze
関連事項:
HttpWebHandlerAdapter

ネストされたクラスの要約
ネストされたクラス
修飾子と型クラスと説明
static class WebHttpHandlerBuilder.SpringWebBlockHoundIntegration
spring-web クラスの BlockHoundIntegration。

ネストされたクラス
修飾子と型	クラスと説明
`static class`	`WebHttpHandlerBuilder.SpringWebBlockHoundIntegration` spring-web クラスの `BlockHoundIntegration`。

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`FORWARDED_HEADER_TRANSFORMER_BEAN_NAME` Bean ファクトリの ForwardedHeaderTransformer のよく知られた名前。
`static StringSE`	`LOCALE_CONTEXT_RESOLVER_BEAN_NAME` Bean ファクトリの LocaleContextResolver のよく知られた名前。
`static StringSE`	`SERVER_CODEC_CONFIGURER_BEAN_NAME` Bean ファクトリの ServerCodecConfigurer のよく知られた名前。
`static StringSE`	`WEB_HANDLER_BEAN_NAME` Bean ファクトリのターゲット WebHandler の既知の名前。
`static StringSE`	`WEB_SESSION_MANAGER_BEAN_NAME` Bean ファクトリの WebSessionManager のよく知られた名前。

メソッドのサマリー

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`static WebHttpHandlerBuilder`	`applicationContext(ApplicationContext context)` `ApplicationContext` で Bean を検出して新しいビルダーインスタンスを作成する静的ファクトリメソッド。
`HttpHandler`	`build()` `HttpHandler` をビルドします。
`WebHttpHandlerBuilder`	`clone()` この `WebHttpHandlerBuilder` を複製します。
`WebHttpHandlerBuilder`	`codecConfigurer(ServerCodecConfigurer codecConfigurer)` `ServerCodecConfigurer` を構成して、`WebServerExchange` に設定します。
`WebHttpHandlerBuilder`	`exceptionHandler(WebExceptionHandler... handlers)` 指定された例外ハンドラーを追加します。
`WebHttpHandlerBuilder`	`exceptionHandlers(ConsumerSE<ListSE<WebExceptionHandler>> consumer)` 現在構成されている例外ハンドラーの「ライブ」リストを操作します。
`WebHttpHandlerBuilder`	`filter(WebFilter... filters)` 指定されたフィルターを追加します。
`WebHttpHandlerBuilder`	`filters(ConsumerSE<ListSE<WebFilter>> consumer)` 現在構成されているフィルターの「ライブ」リストを操作します。
`WebHttpHandlerBuilder`	`forwardedHeaderTransformer(ForwardedHeaderTransformer transformer)` 転送されたヘッダーを抽出または削除するために `ForwardedHeaderTransformer` を構成します。
`boolean`	`hasCodecConfigurer()` `ServerCodecConfigurer` が構成されているかどうかにかかわらず、`ApplicationContext` から検出されるか、`codecConfigurer` を介して明示的に構成されます。
`boolean`	`hasForwardedHeaderTransformer()` `ForwardedHeaderTransformer` が構成されているかどうかにかかわらず、`ApplicationContext` から検出されるか、`forwardedHeaderTransformer(ForwardedHeaderTransformer)` を介して明示的に構成されます。
`boolean`	`hasHttpHandlerDecorator()` `HttpHandler` のデコレータが `httpHandlerDecorator(Function)` を介して設定されているかどうか。
`boolean`	`hasLocaleContextResolver()` `LocaleContextResolver` が構成されているかどうかにかかわらず、`ApplicationContext` から検出されるか、`localeContextResolver` を介して明示的に構成されます。
`boolean`	`hasSessionManager()` `WebSessionManager` が構成されているかどうかにかかわらず、`ApplicationContext` から検出されるか、`sessionManager` を介して明示的に構成されます。
`WebHttpHandlerBuilder`	`httpHandlerDecorator(FunctionSE<HttpHandler, HttpHandler> handlerDecorator)` チェーンを処理する `WebExceptionHandler`-`WebFilter`-`WebHandler` 全体を効果的にラップするこのビルダーによって返される `HttpHandler` を装飾するように `Function`SE を構成します。
`WebHttpHandlerBuilder`	`localeContextResolver(LocaleContextResolver localeContextResolver)` `WebServerExchange` で設定するように `LocaleContextResolver` を構成します。
`WebHttpHandlerBuilder`	`sessionManager(WebSessionManager manager)` `WebServerExchange` で設定するように `WebSessionManager` を構成します。
`static WebHttpHandlerBuilder`	`webHandler(WebHandler webHandler)` 新しいビルダーインスタンスを作成する静的ファクトリメソッド。

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

- フィールドの詳細
  - WEB_HANDLER_BEAN_NAME
```
public static final StringSE WEB_HANDLER_BEAN_NAME
```
    Bean ファクトリのターゲット WebHandler の既知の名前。
    関連事項:
    定数フィールド値
  - WEB_SESSION_MANAGER_BEAN_NAME
```
public static final StringSE WEB_SESSION_MANAGER_BEAN_NAME
```
    Bean ファクトリの WebSessionManager のよく知られた名前。
    関連事項:
    定数フィールド値
  - SERVER_CODEC_CONFIGURER_BEAN_NAME
```
public static final StringSE SERVER_CODEC_CONFIGURER_BEAN_NAME
```
    Bean ファクトリの ServerCodecConfigurer のよく知られた名前。
    関連事項:
    定数フィールド値
  - LOCALE_CONTEXT_RESOLVER_BEAN_NAME
```
public static final StringSE LOCALE_CONTEXT_RESOLVER_BEAN_NAME
```
    Bean ファクトリの LocaleContextResolver のよく知られた名前。
    関連事項:
    定数フィールド値
  - FORWARDED_HEADER_TRANSFORMER_BEAN_NAME
```
public static final StringSE FORWARDED_HEADER_TRANSFORMER_BEAN_NAME
```
    Bean ファクトリの ForwardedHeaderTransformer のよく知られた名前。
    関連事項:
    定数フィールド値
- メソッドの詳細
  - webHandler
```
public static WebHttpHandlerBuilder webHandler(WebHandler webHandler)
```
    新しいビルダーインスタンスを作成する静的ファクトリメソッド。
    パラメーター:
    webHandler - リクエストのターゲットハンドラー
    戻り値:
    準備されたビルダー
  - applicationContext
```
public static WebHttpHandlerBuilder applicationContext(ApplicationContext context)
```
    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
```
public WebHttpHandlerBuilder filter(WebFilter... filters)
```
    指定されたフィルターを追加します。
    パラメーター:
    filters - 追加するフィルター
  - filters
```
public WebHttpHandlerBuilder filters(ConsumerSE<ListSE<WebFilter>> consumer)
```
    現在構成されているフィルターの「ライブ」リストを操作します。
    パラメーター:
    consumer - 使用するコンシューマー
  - exceptionHandler
```
public WebHttpHandlerBuilder exceptionHandler(WebExceptionHandler... handlers)
```
    指定された例外ハンドラーを追加します。
    パラメーター:
    handlers - 例外ハンドラー
  - exceptionHandlers
```
public WebHttpHandlerBuilder exceptionHandlers(ConsumerSE<ListSE<WebExceptionHandler>> consumer)
```
    現在構成されている例外ハンドラーの「ライブ」リストを操作します。
    パラメーター:
    consumer - 使用するコンシューマー
  - sessionManager
```
public WebHttpHandlerBuilder sessionManager(WebSessionManager manager)
```
    WebServerExchange で設定するように WebSessionManager を構成します。
    デフォルトでは、DefaultWebSessionManager が使用されます。
    パラメーター:
    manager - セッションマネージャー
    関連事項:
    HttpWebHandlerAdapter.setSessionManager(WebSessionManager)
  - hasSessionManager
```
public boolean hasSessionManager()
```
    WebSessionManager が構成されているかどうかにかかわらず、ApplicationContext から検出されるか、sessionManager を介して明示的に構成されます。
    導入:
    5.0.9
  - codecConfigurer
```
public WebHttpHandlerBuilder codecConfigurer(ServerCodecConfigurer codecConfigurer)
```
    ServerCodecConfigurer を構成して、WebServerExchange に設定します。
    パラメーター:
    codecConfigurer - コーデック設定
  - hasCodecConfigurer
```
public boolean hasCodecConfigurer()
```
    ServerCodecConfigurer が構成されているかどうかにかかわらず、ApplicationContext から検出されるか、codecConfigurer を介して明示的に構成されます。
    導入:
    5.0.9
  - localeContextResolver
```
public WebHttpHandlerBuilder localeContextResolver(LocaleContextResolver localeContextResolver)
```
    WebServerExchange で設定するように LocaleContextResolver を構成します。
    パラメーター:
    localeContextResolver - ロケールコンテキストリゾルバー
  - hasLocaleContextResolver
```
public boolean hasLocaleContextResolver()
```
    LocaleContextResolver が構成されているかどうかにかかわらず、ApplicationContext から検出されるか、localeContextResolver を介して明示的に構成されます。
    導入:
    5.0.9
  - forwardedHeaderTransformer
```
public WebHttpHandlerBuilder forwardedHeaderTransformer(ForwardedHeaderTransformer transformer)
```
    転送されたヘッダーを抽出または削除するために 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
```
public HttpHandler build()
```
    HttpHandler をビルドします。
  - clone
```
public WebHttpHandlerBuilder clone()
```
    この WebHttpHandlerBuilder を複製します。
    オーバーライド:
    クラス ObjectSE の cloneSE
    戻り値:
    複製されたビルダーインスタンス

クラス WebHttpHandlerBuilder

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

フィールドのサマリー

メソッドのサマリー

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

フィールドの詳細

WEB_HANDLER_BEAN_NAME

WEB_SESSION_MANAGER_BEAN_NAME

SERVER_CODEC_CONFIGURER_BEAN_NAME

LOCALE_CONTEXT_RESOLVER_BEAN_NAME

FORWARDED_HEADER_TRANSFORMER_BEAN_NAME

メソッドの詳細

webHandler

applicationContext

filter

filters

exceptionHandler

exceptionHandlers

sessionManager

hasSessionManager

codecConfigurer

hasCodecConfigurer

localeContextResolver

hasLocaleContextResolver

forwardedHeaderTransformer

hasForwardedHeaderTransformer

httpHandlerDecorator

hasHttpHandlerDecorator

build

clone