jp.ne.mki.wedge.run.lib.servlet
クラス AbstractCommonProcessForRunServlet

java.lang.Object
  jp.ne.mki.wedge.run.lib.servlet.AbstractCommonProcessForRunServlet

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

RunServletCommonProcess

public abstract class AbstractCommonProcessForRunServlet
extends java.lang.Object
implements RunServletCommonProcess

RunServlet 用共通処理クラスの継承元として、共通処理に必要となる機能を提供します。

コンストラクタの概要

AbstractCommonProcessForRunServlet()

メソッドの概要

protected void	clearServerparameter() ServerParameer にセットする値をクリアします。
protected void	clearServerStatus() ServerStatus にセットする値をクリアします。
protected ExchangerInterface	createExchanger(RunServletConf config, EngineManagerInterface manager) RunServlet.wdg に指定された内容を元に Exchanger をインスタンス化して返します。
void	execOnFinally(RunServletFinallyCommonProcessRecord record) クライアントへのレスポンスを含む、すべての処理が終わった後に呼び出されます。
void	execOnInit(RunServletInitCommonProcessRecord record) サーブレット(RunServlet)が初期化処理中に共通処理を行う場合は、このメソッドをオーバーライドして、必要な処理を実装してください。
void	execOnRequest(RunServletRequestCommonProcessRecord record) サーブレットリクエスト時に共通前処理を行う場合は、このメソッドをオーバーライドして、必要な処理を実装してください。
void	execOnResponse(RunServletResponseCommonProcessRecord record) サーブレットレスポンス時に共通前後理を行う場合は、このメソッドをオーバーライドして、必要な処理を実装してください。
java.lang.String	getServerParameter() ServerParameter にセットされた値を返します。
java.lang.String	getServerStatus() ServerStatus にセットされた値を返します。
TransactionCallForRunServlet	getTransactionCallInstance(RunServletCommonProcessRecord record) トランザクション呼び出し用クラス TransactionCall のインスタンスを返します。
boolean	isSetServerParameter() ServerParameter に値がセットされているかどうかを返します。
boolean	isSetServerStatus() ServerStatus に値がセットされているかどうかを返します。
boolean	isSkipTransaction() トランザクションをスキップするかどうかを返します。
protected void	setServerParameter(java.lang.String param) ServerParameter セットする文字列を指定します。
protected void	setServerParameterOnError(java.lang.String param) クライアントに返す ControlRecord の ServerStatus に ERROR をセットし、ServerParameter に指定された文字列をセットします。
protected void	setServerStatusIsError() ServerStatus を ERROR にセットします。
protected void	setServerStatusIsOk() ServerStatus を OK にセットします。
protected void	setSkipTransaction(boolean skip) リクエスト時の共通前処理を実行した後、トランザクション処理をスキップするかどうかを指定します。
protected void	setSkipTransaction(boolean skip, java.lang.String msg) トランザクションをスキップするかどうかと、ServerParameter を指定します。

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

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

コンストラクタの詳細

AbstractCommonProcessForRunServlet

public AbstractCommonProcessForRunServlet()

メソッドの詳細

isSkipTransaction

public boolean isSkipTransaction()

トランザクションをスキップするかどうかを返します。

定義:

インタフェース RunServletCommonProcess 内の isSkipTransaction

戻り値:

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

関連項目:

RunServletCommonProcess.isSkipTransaction()

setSkipTransaction

protected void setSkipTransaction(boolean skip,
                                  java.lang.String msg)

トランザクションをスキップするかどうかと、ServerParameter を指定します。 リクエスト時の共通前処理でエラーが発生した場合は、このメソッドを呼び出すことにより、トランザクションを呼び出さずに ServerStatus に ERROR を、ServerParameter にエラーメッセージをセットすることにより、クライアントにエラーダイアログを表示させることができます。

パラメータ:

skip - true:トランザクションをスキップします、false:トランザクションを実行します。

msg - ServerParameter にセットするメッセージ

setSkipTransaction

protected void setSkipTransaction(boolean skip)

リクエスト時の共通前処理を実行した後、トランザクション処理をスキップするかどうかを指定します。

関連項目:

jp.ne.mki.wedge.run.interfaces.commonprocess.executer.RunServletCommonProcess#setSkipTransaction(boolean)

execOnInit

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

サーブレット(RunServlet)が初期化処理中に共通処理を行う場合は、このメソッドをオーバーライドして、必要な処理を実装してください。

定義:

インタフェース RunServletCommonProcess 内の execOnInit

パラメータ:

record - 共通処理レコード

例外:

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

java.lang.Exception

関連項目:

RunServletCommonProcess.execOnInit(jp.ne.mki.wedge.run.interfaces.commonprocess.record.RunServletInitCommonProcessRecord)

execOnRequest

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

サーブレットリクエスト時に共通前処理を行う場合は、このメソッドをオーバーライドして、必要な処理を実装してください。

定義:

インタフェース RunServletCommonProcess 内の execOnRequest

パラメータ:

record - 共通処理レコード

例外:

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

java.lang.Exception

関連項目:

RunServletCommonProcess.execOnRequest(jp.ne.mki.wedge.run.interfaces.commonprocess.record.RunServletRequestCommonProcessRecord)

execOnResponse

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

サーブレットレスポンス時に共通前後理を行う場合は、このメソッドをオーバーライドして、必要な処理を実装してください。

定義:

インタフェース RunServletCommonProcess 内の execOnResponse

パラメータ:

record - 共通処理レコード

例外:

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

java.lang.Exception

関連項目:

RunServletCommonProcess.execOnResponse(jp.ne.mki.wedge.run.interfaces.commonprocess.record.RunServletResponseCommonProcessRecord)

execOnFinally

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

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

定義:

インタフェース RunServletCommonProcess 内の execOnFinally

例外:

java.lang.Exception

setServerStatusIsOk

protected final void setServerStatusIsOk()

ServerStatus を OK にセットします。
クライアントに返す ControlRecord の ServerStatus に OK がセットされます。

関連項目:

jp.ne.mki.wedge.run.interfaces.commonprocess.executer.RunServletCommonProcess#setServerStatusIsOk()

setServerStatusIsError

protected final void setServerStatusIsError()

ServerStatus を ERROR にセットします。
クライアントに返す ControlRecord の ServerStatus に ERROR がセットされます。

関連項目:

jp.ne.mki.wedge.run.interfaces.commonprocess.executer.RunServletCommonProcess#setServerStatusIsError()

clearServerStatus

protected final void clearServerStatus()

ServerStatus にセットする値をクリアします。
このメソッドを呼び出すと、クライアントに返す ControlRecord の ServerStatus には何も値はセットされなくなります。
つまりトランザクションを呼び出した処理結果がそのままクライアントに返るようになります。
いったセットした ServerStatus を取り消す場合にこのメソッドを呼び出してください。

関連項目:

jp.ne.mki.wedge.run.interfaces.commonprocess.executer.RunServletCommonProcess#clearServerStatus()

isSetServerStatus

public final boolean isSetServerStatus()

ServerStatus に値がセットされているかどうかを返します。
このメソッドが true を返す場合のみ、ServerStatus にセットされた値が有効になり、クライアントに返す ControlRecord の ServerStatus に値がセットされるようになります。

定義:

インタフェース RunServletCommonProcess 内の isSetServerStatus

戻り値:

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

関連項目:

RunServletCommonProcess.isSetServerStatus()

getServerStatus

public final java.lang.String getServerStatus()

ServerStatus にセットされた値を返します。
この値がクライアントに返す ControlRecord の ServerStatus にセットされます。
このメソッドは実行エンジンから呼び出されます。

定義:

インタフェース RunServletCommonProcess 内の getServerStatus

戻り値:

セットされた ServerStatus

関連項目:

RunServletCommonProcess.getServerStatus()

setServerParameter

protected final void setServerParameter(java.lang.String param)

ServerParameter セットする文字列を指定します。
このメソッドに渡された引数がクライアントに返す ControlRecord の ServerParameter にセットされます。

関連項目:

jp.ne.mki.wedge.run.interfaces.commonprocess.executer.RunServletCommonProcess#setServerParameter(java.lang.String)

clearServerparameter

protected final void clearServerparameter()

ServerParameer にセットする値をクリアします。
このメソッドを呼び出すと、クライアントに返す ControlRecord の ServerParameter には何も値はセットされなくなります。
つまりトランザクションを呼び出した処理結果がそのままクライアントに返るようになります。
いったセットした ServerParameter を取り消す場合にこのメソッドを呼び出してください。

関連項目:

jp.ne.mki.wedge.run.interfaces.commonprocess.executer.RunServletCommonProcess#clearServerparameter()

isSetServerParameter

public boolean isSetServerParameter()

ServerParameter に値がセットされているかどうかを返します。
このメソッドが true を返す場合のみ、ServerParameter にセットされた値が有効になり、クライアントに返す ControlRecord の ServerParameter に値がセットされるようになります。

定義:

インタフェース RunServletCommonProcess 内の isSetServerParameter

戻り値:

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

関連項目:

RunServletCommonProcess.isSetServerParameter()

getServerParameter

public java.lang.String getServerParameter()

ServerParameter にセットされた値を返します。
この値がクライアントに返す ControlRecord の ServerParameter にセットされます。
このメソッドは実行エンジンから呼び出されます。

定義:

インタフェース RunServletCommonProcess 内の getServerParameter

戻り値:

セットされた ServerParameter

関連項目:

RunServletCommonProcess.getServerParameter()

setServerParameterOnError

protected void setServerParameterOnError(java.lang.String param)

クライアントに返す ControlRecord の ServerStatus に ERROR をセットし、ServerParameter に指定された文字列をセットします。
共通処理でエラーが発生した場合等、このメソッドを呼び出すことにより、クライアントにエラーダイアログを表示させることができます。

関連項目:

jp.ne.mki.wedge.run.interfaces.commonprocess.executer.RunServletCommonProcess#setServerParameterOnError(java.lang.String)

getTransactionCallInstance

public TransactionCallForRunServlet getTransactionCallInstance(RunServletCommonProcessRecord record)
                                                        throws java.lang.ClassNotFoundException,
                                                               java.lang.InstantiationException,
                                                               java.lang.IllegalAccessException

トランザクション呼び出し用クラス TransactionCall のインスタンスを返します。

パラメータ:

mgr - RunServlet の Manager への参照

戻り値:

TransactionCall のインスタンス

例外:

java.lang.IllegalAccessException - RunServlet.wdg のロード、Exchangerのインスタンスでエラーが発生。

java.lang.InstantiationException - RunServlet.wdg のロード、Exchangerのインスタンスでエラーが発生。

java.lang.ClassNotFoundException - RunServlet.wdg のロード、Exchangerのインスタンスでエラーが発生。

createExchanger

protected ExchangerInterface createExchanger(RunServletConf config,
                                             EngineManagerInterface manager)
                                      throws java.lang.ClassNotFoundException,
                                             java.lang.InstantiationException,
                                             java.lang.IllegalAccessException

RunServlet.wdg に指定された内容を元に Exchanger をインスタンス化して返します。

パラメータ:

config - RunServlet.wdg の内容を保持するクラス

manager - RunServlet の Manager クラス

戻り値:

RunServlet 用 Exchanger のインスタンス

例外:

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException