jp.ne.mki.wedge.run.interfaces.commonprocess.executer
インタフェース RunServletCommonProcess

既知の実装クラスの一覧:

AbstractCommonProcessForRunServlet

public interface RunServletCommonProcess

RunServlet が呼び出された時に共通処理を実行する場合は このインターフェースを実装してください。

メソッドの概要

void	execOnFinally(RunServletFinallyCommonProcessRecord record) クライアントへのレスポンスを含む、すべての処理が終わった後に呼び出されます。
void	execOnInit(RunServletInitCommonProcessRecord record) サーブレット初期化時に行う共通処理を実装してください。
void	execOnRequest(RunServletRequestCommonProcessRecord record) サーブレットがリクエストされた時に行う共通処理を実装してください。
void	execOnResponse(RunServletResponseCommonProcessRecord record) サーブレットがレスポンスを返す時に行う共通処理を実装してください。
java.lang.String	getServerParameter() ServerParameter を返します。
java.lang.String	getServerStatus() ServerStatus を返します。
boolean	isSetServerParameter() ServerParameter がセットされているかどうかを返します。
boolean	isSetServerStatus() ServerStatus がセットされているかどうかを返します。
boolean	isSkipTransaction() サーブレットがリクエストされた時の共通処理を実行した後、トランザクションの処理をスキップするかどうかを返します。

メソッドの詳細

execOnInit

public void execOnInit(RunServletInitCommonProcessRecord record)
                throws java.lang.Exception

サーブレット初期化時に行う共通処理を実装してください。

パラメータ:

record - 共通処理レコード

例外:

java.io.IOException - IOエラーが発生

execOnRequest

public void execOnRequest(RunServletRequestCommonProcessRecord record)
                   throws java.lang.Exception

サーブレットがリクエストされた時に行う共通処理を実装してください。

パラメータ:

record - 共通処理レコード

例外:

java.io.IOException - IOエラーが発生

execOnResponse

public void execOnResponse(RunServletResponseCommonProcessRecord record)
                    throws java.lang.Exception

サーブレットがレスポンスを返す時に行う共通処理を実装してください。

パラメータ:

record - 共通処理レコード

例外:

java.io.IOException - IOエラーが発生

execOnFinally

public void execOnFinally(RunServletFinallyCommonProcessRecord record)
                   throws java.lang.Exception

クライアントへのレスポンスを含む、すべての処理が終わった後に呼び出されます。
処理中に例外が発生した場合も呼び出されます。

例外:

java.lang.Exception -

isSkipTransaction

public boolean isSkipTransaction()

サーブレットがリクエストされた時の共通処理を実行した後、トランザクションの処理をスキップするかどうかを返します。 このメソッドはリクエスト時の共通処理を実行した後、トランザクションを実行する前に実行エンジン(RunServlet)から呼び出されます。
このメソッドが true を返した場合、トランザクションはスキップされます。
これにより、トランザクションの前処理を実行した後、トランザクションを実行するかどうかを条件分岐させることができます。

戻り値:

true:トランザクションの処理をスキップします。false:トランザクションを実行します。

isSetServerStatus

public boolean isSetServerStatus()

ServerStatus がセットされているかどうかを返します。 (ServerStatus は boolean 型で保持していることから、データを見ただけではセットされているのか、未セット状態なのかが判断できないため、このメソッドが用意されています。)

戻り値:

true:ServerStatus はセットされています。false:ServerStatus は未セットです。

getServerStatus

public java.lang.String getServerStatus()

ServerStatus を返します。 このメソッドが返す値がクライアントに返す ControlRecord にセットされます。
このメソッドが返す値は isSetServerStatus() メソッドが返す値が true の場合だけ有効です。

戻り値:

セットされた ServerStatus

isSetServerParameter

public boolean isSetServerParameter()

ServerParameter がセットされているかどうかを返します。 (ServerParameter は String 型で保持していることから、データを見ただけではセットされているのか、未セット状態なのかが判断できないため、このメソッドが用意されています。)

戻り値:

true:ServerParameter はセットされています。false:ServerParameter は未セットです。

getServerParameter

public java.lang.String getServerParameter()

ServerParameter を返します。 このメソッドが返す値がクライアントに返す ControlRecord にセットされます。
このメソッドが返す値は isSetServerParameter() メソッドが返す値が true の場合だけ有効です。

戻り値:

セットされた ServerParameter