jp.terasoluna.fw.web.thin
インタフェース BlockageController


public interface BlockageController

Filterでの業務閉塞チェックを行なうインタフェース。

このインタフェースを実装したクラスは業務閉塞チェック機能を提供する。

なお、このインタフェースの実装クラスはスレッドセーフである必要がある。

※このインタフェースの実装クラスの設定方法は BlockageControlFilter を参照のこと。

関連項目:
AuthenticationControlFilter, AuthenticationController, AuthorizationControlFilter, AuthorizationController, BlockageControlFilter, ServerBlockageControlFilter, ServerBlockageController

メソッドの概要
 void blockade(java.lang.String path)
          閉塞状態にするパスを設定する。
 void blockade(java.lang.String path, javax.servlet.ServletRequest req)
          閉塞状態にするパスを設定する。
 boolean isBlockaded(java.lang.String path)
          指定パスのアクションが業務閉塞状態であるかチェックする。
 boolean isBlockaded(java.lang.String path, javax.servlet.ServletRequest req)
          指定パスのアクションが業務閉塞状態であるかチェックする。
 boolean isCheckRequired(javax.servlet.ServletRequest req)
          業務閉塞チェックが必要かどうかを返す。
 void open(java.lang.String path)
          閉塞状態にあるパスを開放する。
 void open(java.lang.String path, javax.servlet.ServletRequest req)
          閉塞状態にあるパスを開放する。
 

メソッドの詳細

blockade

void blockade(java.lang.String path)
閉塞状態にするパスを設定する。

パラメータ:
path - 閉塞状態にするパス

blockade

void blockade(java.lang.String path,
              javax.servlet.ServletRequest req)
閉塞状態にするパスを設定する。

パラメータ:
path - パス情報
req - HTTPリクエスト

isBlockaded

boolean isBlockaded(java.lang.String path)
指定パスのアクションが業務閉塞状態であるかチェックする。

パラメータ:
path - パス情報
戻り値:
業務閉塞状態であればtrue

isBlockaded

boolean isBlockaded(java.lang.String path,
                    javax.servlet.ServletRequest req)
指定パスのアクションが業務閉塞状態であるかチェックする。

パラメータ:
path - パス情報
req - HTTPリクエスト
戻り値:
業務閉塞状態であれば true

isCheckRequired

boolean isCheckRequired(javax.servlet.ServletRequest req)
業務閉塞チェックが必要かどうかを返す。

パラメータ:
req - 判定対象となるServletRequestインスタンス
戻り値:
チェックが必要であればtrue

open

void open(java.lang.String path)
閉塞状態にあるパスを開放する。

パラメータ:
path - 開放対象のパス

open

void open(java.lang.String path,
          javax.servlet.ServletRequest req)
閉塞状態にあるパスを開放する。

パラメータ:
path - 開放対象のパス
req - HTTPリクエスト