クラス WebHttpHandlerBuilder

メソッドの詳細

• 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]- 型によって検出され、オーダーされました。
  • ObservationRegistry -- 型によって検出され、一意であれば構成されます。
  • ServerRequestObservationConvention -- 型によって検出され、一意であれば構成されます。
  • 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 - 使用するコンシューマー

• 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

• 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

• observationRegistry

  public WebHttpHandlerBuilder observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)

  サーバー交換の観測を記録するために ObservationRegistry を構成します。デフォルトでは、no-op レジストリが構成されます。

  パラメーター:

  observationRegistry - 観測記録

  導入:

  6.1

• observationConvention

  public WebHttpHandlerBuilder observationConvention(ServerRequestObservationConvention observationConvention)

  サーバー監視に使用するように ServerRequestObservationConvention を構成します。デフォルトでは、DefaultServerRequestObservationConvention が使用されます。

  パラメーター:

  observationConvention - 記録されたすべての観測に使用する規則

  導入:

  6.1

• defaultHtmlEscape

  public WebHttpHandlerBuilder defaultHtmlEscape(@Nullable BooleanSE defaultHtmlEscape)

  Web アプリケーションでデフォルトの HTML エスケープを有効にするかどうかを設定します。この設定は、エクスチェンジャー属性 ServerWebExchange.HTML_ESCAPE_ATTRIBUTE として公開されます。

  この方法は、設定が全く指定されていない場合と、実際にブール値が指定されている場合を区別し、グローバルレベルで設定がない場合に、状況に応じたデフォルト値を設定できるようにします。

  パラメーター:

  defaultHtmlEscape - デフォルトの HTML エスケープを有効にするかどうか

  導入:

  7.0.6

• getDefaultHtmlEscape

  public @Nullable BooleanSE getDefaultHtmlEscape()

  Web アプリケーションで HTML エスケープが有効になっているかどうか。

  導入:

  7.0.6

• build

  public HttpHandler build()

  HttpHandler をビルドします。

• clone

  public WebHttpHandlerBuilder clone()

  この WebHttpHandlerBuilder を複製します。

  オーバーライド:

  クラス ObjectSE の clone 

  戻り値:

  複製されたビルダーインスタンス