org.opengion.hayabusa.filter

## クラス AccessStopFilter

- java.lang.Object
- - org.opengion.hayabusa.filter.AccessStopFilter

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

      public final class AccessStopFilter
      extends java.lang.Object
      implements Filter

  AccessStopFilter は、Filter インターフェースを継承した アクセス制御クラスです。 web.xml で filter 設定することにより、Webアプリケーションへのアクセスを制御できます。 また、SYSTEM ユーザーは、このフィルターを常に通過します。 フィルターに対してweb.xml でパラメータを設定します。 ・startTime:停止開始時刻 ・stopTime :停止終了時刻 ・filename :停止時メッセージ表示ファイル名 【WEB-INF/web.xml】 <filter> <filter-name>AccessStopFilter</filter-name> <filter-class>org.opengion.hayabusa.filter.AccessStopFilter</filter-class> <init-param> <param-name>startTime</param-name> <param-value>070000</param-value> </init-param> <init-param> <param-name>stopTime</param-name> <param-value>070000</param-value> </init-param> <init-param> <param-name>filename</param-name> <param-value>jsp/custom/stopFile.html</param-value> </init-param> </filter> <filter-mapping> <filter-name>AccessStopFilter</filter-name> <url-pattern>/jsp/*</url-pattern> </filter-mapping>
  機能分類
    フィルター処理
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `AccessStopFilter()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `destroy()` フィルターの終了処理メソッドです。
    `void` | `doFilter(ServletRequest request, ServletResponse response, FilterChain chain)` フィルター処理本体のメソッドです。
    `void` | `init(FilterConfig filterConfig)` フィルターの初期処理メソッドです。
    `static boolean` | `isStopFilter()` フィルターの内部状態(強制停止/解除)を取得するメソッドです。
    `static void` | `setStopFilter(boolean flag)` フィルターの強制停止/解除を設定するメソッドです。
    `java.lang.String` | `toString()` 内部状態を文字列で返します。

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

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### AccessStopFilter

          public AccessStopFilter()

  - ### メソッドの詳細

    - #### doFilter

          public void doFilter(ServletRequest request,
                      ServletResponse response,
                      FilterChain chain)
                        throws java.io.IOException,
                               ServletException

      フィルター処理本体のメソッドです。
      定義:
        `doFilter` インタフェース内 `Filter`
      パラメータ:
        `request` - ServletRequestオブジェクト
        `response` - ServletResponseオブジェクト
        `chain` - FilterChainオブジェクト
      例外:
        `java.io.IOException` - 入出力エラーが発生した場合、throw されます。
        `ServletException` - サーブレット関係のエラーが発生した場合、throw されます。
      変更履歴:

        3.1.3.0 (2003/04/10) UTF-8 決め打ちで、stopFile.html を返送する。
        3.1.8.0 (2003/05/16) 文字エンコードが、UTF-8 になっていないのを修正。

    - #### init

          public void init(FilterConfig filterConfig)

      フィルターの初期処理メソッドです。 フィルターに対してweb.xml で初期パラメータを設定します。 ・startTime:停止開始時刻 ・stopTime :停止終了時刻 ・filename :停止時メッセージ表示ファイル名
      定義:
        `init` インタフェース内 `Filter`
      パラメータ:
        `filterConfig` - FilterConfigオブジェクト
      変更履歴:

        5.7.3.2 (2014/02/28) Tomcat8 対応。getRealPath( "/" ) の互換性のための修正。

    - #### destroy

          public void destroy()

      フィルターの終了処理メソッドです。
      定義:
        `destroy` インタフェース内 `Filter`

    - #### setStopFilter

          public static void setStopFilter(boolean flag)

      フィルターの強制停止/解除を設定するメソッドです。
      パラメータ:
        `flag` - (true:停止 false:実行許可)
      変更履歴:

        4.0.0.0 (2005/01/31) synchronized の廃止

    - #### isStopFilter

          public static boolean isStopFilter()

      フィルターの内部状態(強制停止/解除)を取得するメソッドです。 これは、現在、アクセス制限がどうなっているかという状態ではなく、 強制停止されているかどうかの確認メソッドです。
      戻り値:
        (true:停止 false:実行許可)
      変更履歴:

        4.0.0.0 (2007/11/29) getStopFilter() ⇒ isStopFilter() に変更

    - #### toString

          public java.lang.String toString()

      内部状態を文字列で返します。
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        このクラスの文字列表示

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.