org.opengion.hayabusa.filter.AccessStopFilter

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

public final class AccessStopFilter extends Object implements Filter

AccessStopFilter は、Filter インターフェースを継承したアクセス制御クラスです。 web.xml で filter 設定することにより、Webアプリケーションへのアクセスを制御できます。また、SYSTEM ユーザーは、このフィルターを常に通過します。フィルターに対してweb.xml でパラメータを設定します。・startTime:停止開始時刻 (初期値:230000) ・stopTime :停止終了時刻 (初期値:070000) ・filename :停止時メッセージ表示ファイル名 (初期値:jsp/custom/stopFile.html) ・passUsers:停止中でもアクセス可能なユーザーID (初期値:SYSTEM,ADMIN) ・addUsers :停止中でもアクセス可能な追加ユーザーID (初期値:null) 【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>

機能分類: フィルター処理
導入されたバージョン:: JDK5.0,

コンストラクタの概要

コンストラクタ

コンストラクタ

説明

AccessStopFilter()

ﾃﾞﾌｫﾙﾄｺﾝｽﾄﾗｸﾀｰ
メソッドの概要

修飾子とタイプ

メソッド

説明

void

destroy()

フィルターの終了処理メソッドです。

void

doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

フィルター処理本体のメソッドです。

void

init(FilterConfig filterConfig)

フィルターの初期処理メソッドです。

static boolean

isUseFilter()

フィルターの内部状態(強制停止/解除)を取得するメソッドです。

static void

setUseFilter(boolean flag)

フィルターの実行/停止を設定するメソッドです。

String

toString()

内部状態を文字列で返します。

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

コンストラクタの詳細
- AccessStopFilter
  
  public AccessStopFilter()
  
  ﾃﾞﾌｫﾙﾄｺﾝｽﾄﾗｸﾀｰ
  
  変更履歴:
  
  8.5.3.2 (2023/10/13) JDK21対応。警告: デフォルトのコンストラクタの使用で、コメントが指定されていません
メソッドの詳細
- doFilter
  
  public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException
  
  フィルター処理本体のメソッドです。
  
  定義:
  
  doFilter インタフェース内 Filter
  
  パラメータ:
  
  request - ServletRequestオブジェクト
  
  response - ServletResponseオブジェクト
  
  chain - FilterChainオブジェクト
  
  例外:
  
  IOException - 入出力エラーが発生した場合、throw されます。
  
  ServletException - サーブレット関係のエラーが発生した場合、throw されます。
  
  変更履歴:
  
  3.1.3.0 (2003/04/10) UTF-8 決め打ちで、stopFile.html を返送する。, 3.1.8.0 (2003/05/16) 文字エンコードが、UTF-8 になっていないのを修正。, 6.2.0.0 (2015/02/27) new BufferedReader … を、FileUtil.getBufferedReader … に変更。, 6.3.1.0 (2015/06/28) nioを使用すると UTF-8とShuft-JISで、エラーになる。, 6.3.8.3 (2015/10/03) フィルターの停止処理。, 6.5.0.1 (2016/10/21) CharacterCodingException は、OgCharacterException に変換する。, 8.5.4.2 (2024/01/12) PMD 7.0.0 CloseResource 対応
- init
  
  public void init(FilterConfig filterConfig)
  
  フィルターの初期処理メソッドです。フィルターに対してweb.xml で初期パラメータを設定します。・startTime:停止開始時刻 (初期値:230000) ・stopTime :停止終了時刻 (初期値:070000) ・filename :停止時メッセージ表示ファイル名 (初期値:jsp/custom/stopFile.html) ・passUsers:停止中でもアクセス可能なユーザーID (初期値:SYSTEM,admin) ・addUsers :停止中でもアクセス可能な追加ユーザーID (初期値:null)
  
  定義:
  
  init インタフェース内 Filter
  
  パラメータ:
  
  filterConfig - FilterConfigオブジェクト
  
  変更履歴:
  
  5.7.3.2 (2014/02/28) Tomcat8 対応。getRealPath( "/" ) の互換性のための修正。, 6.2.4.1 (2015/05/22) REAL_PATH 対応。realPath は、HybsSystem経由で、取得する。, 6.3.8.0 (2015/09/11) パラメータの初期値設定と、passUsers、addUsers 属性追加, 7.1.0.0 (2020/01/27) フィルターが実行されているかどうかを、System.setProperty で設定しておきます。
- destroy
  
  public void destroy()
  
  フィルターの終了処理メソッドです。
  
  定義:
  
  destroy インタフェース内 Filter
- setUseFilter
  
  public static void setUseFilter(boolean flag)
  
  フィルターの実行/停止を設定するメソッドです。初期値は、true:実行です。
  
  パラメータ:
  
  flag - (true:実行 false:停止)
  
  変更履歴:
  
  4.0.0.0 (2005/01/31) synchronized の廃止, 6.3.8.3 (2015/10/03) フィルターの停止処理。メソッド名変更、引数の意味反転。
- isUseFilter
  
  public static boolean isUseFilter()
  
  フィルターの内部状態(強制停止/解除)を取得するメソッドです。これは、現在、アクセス制限がどうなっているかという状態ではなく、強制停止されているかどうかの確認メソッドです。
  
  戻り値:
  
  (true:実行 false:停止)
  
  変更履歴:
  
  4.0.0.0 (2007/11/29) getStopFilter() ⇒ isStopFilter() に変更, 6.3.8.3 (2015/10/03) フィルターの停止処理。メソッド名変更、戻り値の意味反転。
- toString
  
  public String toString()
  
  内部状態を文字列で返します。
  
  オーバーライド:
  
  toString クラス内 Object
  
  戻り値:
  
  このクラスの文字列表示
  
  このﾒｿｯﾄﾞは、nullを返しません

クラス AccessStopFilter

コンストラクタの概要

メソッドの概要

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

コンストラクタの詳細

AccessStopFilter

メソッドの詳細

doFilter

init

destroy

setUseFilter

isUseFilter

toString