概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## org.seasar.cubby.filter
クラス SendErrorFilter

    java.lang.Object
      org.seasar.cubby.filter.SendErrorFilter

すべての実装されたインタフェース:
  Filter

    public class SendErrorFilter

extends Object
implements Filter

適用された要求に対して、異常系の HTTP ステータスコードを返す `Filter` です。

作成者:
  baba

フィールドの概要
`static String` | `IGNORE_PATH_PATTERN` 対象外とするパスの初期パラメータ名。
`static String` | `STATUS_CODE` 応答の HTTP ステータスコードの初期パラメータ名。

コンストラクタの概要
`SendErrorFilter()`

メソッドの概要
`void` | `destroy()`
`void` | `doFilter(ServletRequest req, ServletResponse res, FilterChain chain)` `HttpServletResponse.sendError(int)` によって、異常系の HTTP ステータスコードを返します。
`void` | `init(FilterConfig config)` このフィルタを初期化します。

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

フィールドの詳細

### STATUS_CODE

    public static final String STATUS_CODE

  応答の HTTP ステータスコードの初期パラメータ名。

  関連項目:
    定数フィールド値

### IGNORE_PATH_PATTERN

    public static final String IGNORE_PATH_PATTERN

  対象外とするパスの初期パラメータ名。

  関連項目:
    定数フィールド値

コンストラクタの詳細

### SendErrorFilter

    public SendErrorFilter()

メソッドの詳細

### init

    public void init(FilterConfig config)
              throws ServletException

  このフィルタを初期化します。

  使用可能な初期化パラメータ
  初期化パラメータ名 | 初期化パラメータの値 | 例
  `STATUS_CODE` | 応答の HTTP ステータスコードを指定します。指定しなかった場合は `HttpServletResponse.SC_FORBIDDEN` を返します。 |
  `IGNORE_PATH_PATTERN` | 対象外とするパスの正規表現をカンマ区切りで指定します。 filter-mapping の url-pattern で指定する、このフィルタを適用する URL のうち、適用を除外したいパスを指定してください。 |
       <filter>
         <filter-name>sendErrorFilter</filter-name>
         <filter-class>org.seasar.cubby.filter.SendErrorFilter</filter-class>
         <init-param>
           <param-name>statusCode;</param-name>
           <param-value>404<param-name>
         </init-param>
         <init-param>
           <param-name>ignorePathPattern</param-name>
           <param-value>/index.jsp<param-name>
         </init-param>
       </filter>

       <filter-mapping>
         <filter-name>sendErrorFilter<filter-name>
         <url-pattern>*.jsp<url-pattern>
         <dispatcher>REQUEST</dispatcher>
       </filter-mapping>
  この例では、 /index.jsp を除く *.jsp に要求があった場合に HTTP ステータスコード 404 (Not Found) を返します。

  定義:
    インタフェース `Filter` 内の `init`
  パラメータ:
    `config` - Filter 設定のためのオブジェクト
  例外:
    `ServletException` - 初期化処理で例外が発生した場合

### destroy

    public void destroy()

  定義:
    インタフェース `Filter` 内の `destroy`

### doFilter

    public void doFilter(ServletRequest req,
                         ServletResponse res,
                         FilterChain chain)
                  throws IOException,
                         ServletException

  `HttpServletResponse.sendError(int)` によって、異常系の HTTP ステータスコードを返します。

  定義:
    インタフェース `Filter` 内の `doFilter`
  パラメータ:
    `req` - 要求
    `res` - 応答
    `chain` - フィルターチェーン
  例外:
    `IOException` - 要求の転送や要求のチェーンがこの例外をスローする場合
    `ServletException` - 要求の転送や要求のチェーンがこの例外をスローする場合

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

Copyright © 2006-2009 The Seasar Foundation. All Rights Reserved.