nga.servlet.spi
クラス CongaServletAdapter

java.lang.Object
  nga.servlet.spi.CongaServletAdapter

直系の既知のサブクラス:

ExceptionLogger, InfoLogger

public abstract class CongaServletAdapter
extends Object

CongaServlet アダプタ。
CongaServlet の処理中に呼び出したい処理を記述する。

コンストラクタの概要

protected

CongaServletAdapter() CongaServletAdapter を作成する。

メソッドの概要

void	abort(ServiceInfo serviceInfo, Throwable exception) リクエスト処理が例外を発生したときに呼び出される。
void	begin(ServiceInfo serviceInfo) ひとつのリクエストの処理開始時に（service メソッド の先頭で）呼び出される。
boolean	checkParameter(ServiceInfo serviceInfo, Object controller, Method method, Object[] param) コントローラ実行の直前に呼び出される。
void	destroy(CongaServlet servlet) サーブレットの終了時に (CongaServlet.destroy() の中で) 呼び出される。
void	editResult(ServiceInfo serviceInfo, Object controller, Method method, Object resultObject) コントローラ実行が正常終了した場合に呼び出される。
void	end(ServiceInfo serviceInfo, String requestId) リクエスト処理が終了する時に（service メソッド の末尾で) 呼び出される。
void	forwarding(ServiceInfo serviceInfo, String oldRequestId, String newRequestId) 他のリクエストへの転送の直前に呼び出される。
void	init(CongaServlet servlet) サーブレットの開始時に (CongaServlet.init の中で) 呼び出される。
void	sessionCreated(ServiceInfo serviceInfo) セションが作成されたときに呼び出される。
void	sessionDestroyed(CongaServlet servlet, HttpSession session) セションが消滅するときに呼び出される。

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

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

コンストラクタの詳細

CongaServletAdapter

protected CongaServletAdapter()

CongaServletAdapter を作成する。

メソッドの詳細

init

public void init(CongaServlet servlet)
          throws ServletException

サーブレットの開始時に (CongaServlet.init の中で) 呼び出される。

パラメータ:

servlet - CongaServlet インスタンス。

例外:

ServletException

destroy

public void destroy(CongaServlet servlet)

サーブレットの終了時に (CongaServlet.destroy() の中で) 呼び出される。

パラメータ:

servlet - CongaServlet インスタンス。

sessionCreated

public void sessionCreated(ServiceInfo serviceInfo)
                    throws ServletException

セションが作成されたときに呼び出される。
このメソッドは，begin(ServiceInfo) メソッドよりも先に呼び出される。

パラメータ:

serviceInfo - 現在実行されている service に関する情報。

例外:

ServletException

sessionDestroyed

public void sessionDestroyed(CongaServlet servlet,
                             HttpSession session)

セションが消滅するときに呼び出される。

パラメータ:

servlet - CongaServlet インスタンス。

session - 消滅するセション。

begin

public void begin(ServiceInfo serviceInfo)
           throws ServletException

ひとつのリクエストの処理開始時に（service メソッド の先頭で）呼び出される。

パラメータ:

serviceInfo - 現在実行されている service に関する情報。

例外:

ServletException

end

public void end(ServiceInfo serviceInfo,
                String requestId)

リクエスト処理が終了する時に（service メソッド の末尾で) 呼び出される。

パラメータ:

serviceInfo - 現在実行されている service に関する情報。

requestId - 終了したリクエストID。

abort

public void abort(ServiceInfo serviceInfo,
                  Throwable exception)
           throws ServletException

リクエスト処理が例外を発生したときに呼び出される。

パラメータ:

serviceInfo - 現在実行されている service に関する情報。

exception - 発生した例外。

例外:

ServletException

checkParameter

public boolean checkParameter(ServiceInfo serviceInfo,
                              Object controller,
                              Method method,
                              Object[] param)
                       throws ServletException

コントローラ実行の直前に呼び出される。
このメソッドでは，戻り値で，true / false を返すことにより，コントローラを実行するか， コントローラ実行を中止するかを制御できる。
また，このメソッドの中で，ServiceInfo.setRequestId を 呼び出して，新しいリクエストIDを設定することにより，別のリクエストへ強制転送することも可能。

パラメータ:

serviceInfo - 現在実行されている service に関する情報。

controller - コントローラオブジェクト。

method - 実行するメソッド。

param - 実行するメソッドの引数。

戻り値:

コントローラ実行を許可する場合は true。コントローラ実行を中止する場合は false。

例外:

ServletException

editResult

public void editResult(ServiceInfo serviceInfo,
                       Object controller,
                       Method method,
                       Object resultObject)
                throws ServletException

コントローラ実行が正常終了した場合に呼び出される。

パラメータ:

serviceInfo - 現在実行されている service に関する情報。

controller - コントローラオブジェクト。

method - 実行するメソッド。

resultObject - コントローラの処理結果。

例外:

ServletException

forwarding

public void forwarding(ServiceInfo serviceInfo,
                       String oldRequestId,
                       String newRequestId)
                throws ServletException

他のリクエストへの転送の直前に呼び出される。

パラメータ:

serviceInfo - 現在実行されている service に関する情報。

oldRequestId - 転送元リクエストID。

newRequestId - 転送先リクエストID。

例外:

ServletException