アノテーションインターフェース FilterRegistration

@TargetSE({METHODSE,TYPESE}) @RetentionSE(RUNTIMESE) @DocumentedSE @Order public @interface FilterRegistration
Servlet 3.0+ コンテナーに FilterEE を登録します。FilterRegistrationBean のアノテーションベースの代替として使用できます。
導入:
3.5.0
作成者:
Moritz Halbritter, Daeho Kwon
関連事項:

  • オプション要素の概要

    オプション要素
    修飾子と型
    オプションの要素
    説明
    boolean
    asyncSupported
    この登録で非同期操作がサポートされているかどうか。
    DispatcherTypeEE[]
    dispatcherTypes
    登録で使用するディスパッチャー型。
    boolean
    enabled
    この登録が有効かどうか。
    boolean
    ignoreRegistrationFailure
    登録の失敗を無視するかどうか。
    WebInitParamEE[]
    initParameters
    フィルターで使用される初期パラメーター。
    boolean
    matchAfter
    フィルターマッピングを、ServletContext の宣言されたフィルターマッピングの後に一致させるかどうか。
    StringSE
    name
    この登録の名前。
    int
    order
    登録順序 Bean。
    ClassSE<?>[]
    servletClasses
    フィルターが登録されるサーブレットクラス。
    StringSE[]
    servletNames
    フィルターが登録されるサーブレット名。
    StringSE[]
    urlPatterns
    フィルターが登録される、サーブレット仕様で定義されている URL パターン。

  • 要素の詳細

    • enabled

      boolean enabled
      この登録が有効かどうか。
      戻り値:
      この登録が有効かどうか
      デフォルト:
      true

    • order

      @AliasFor(annotation=Order.class, attribute="value") int order
      登録順序 Bean。
      戻り値:
      登録順序 Bean
      デフォルト:
      2147483647

    • name

      StringSE name
      この登録の名前。指定されていない場合は、Bean 名が使用されます。
      戻り値:
      名前
      デフォルト:
      ""

    • asyncSupported

      boolean asyncSupported
      この登録で非同期操作がサポートされているかどうか。
      戻り値:
      非同期操作がサポートされているかどうか
      デフォルト:
      true

    • dispatcherTypes

      DispatcherTypeEE[] dispatcherTypes
      登録で使用するディスパッチャー型。
      戻り値:
      ディスパッチャーの型
      デフォルト:
      {}

    • ignoreRegistrationFailure

      boolean ignoreRegistrationFailure
      登録失敗を無視するかどうか。true に設定すると、失敗がログに記録されます。false に設定すると、IllegalStateExceptionSE がスローされます。
      戻り値:
      登録の失敗を無視すべきかどうか
      デフォルト:
      false

    • initParameters

      WebInitParamEE[] initParameters
      フィルターで使用される初期パラメーター。
      戻り値:
      初期化パラメーター
      デフォルト:
      {}

    • matchAfter

      boolean matchAfter
      フィルターマッピングを、ServletContext の宣言されたフィルターマッピングの後に一致させるかどうか。
      戻り値:
      フィルターマッピングを ServletContext の宣言されたフィルターマッピングの後に一致させるかどうか
      デフォルト:
      false

    • servletNames

      StringSE[] servletNames
      フィルターが登録されるサーブレット名。
      戻り値:
      サーブレット名
      デフォルト:
      {}

    • servletClasses

      ClassSE<?>[] servletClasses
      フィルターが登録されるサーブレットクラス。
      戻り値:
      サーブレットクラス
      デフォルト:
      {}

    • urlPatterns

      StringSE[] urlPatterns
      フィルターが登録される、サーブレット仕様で定義されている URL パターン。
      戻り値:
      URL パターン
      デフォルト:
      {}