nablarch.common.web.exclusivecontrol

クラス HttpExclusiveControlUtil

java.lang.Object

nablarch.common.web.exclusivecontrol.HttpExclusiveControlUtil

非推奨です。

本クラスはNablarchバージョン5以降では非推奨となっている。 バージョン5以降で排他制御機能を利用する場合には、UniversalDaoを利用すること。

@Deprecated
 @Published
public final class HttpExclusiveControlUtil
extends java.lang.Object

画面処理における排他制御機能(楽観的ロック)のユーティリティクラス。

楽観的ロックは、下記の機能により実現する。

• 処理対象データに対するバージョン番号を取得する。
• 取得済みのバージョン番号が更新されていないかチェックする。
• 取得済みのバージョン番号が更新されていないかチェックし、バージョン番号を更新する。

取得したバージョン番号は、フレームワークにより、ウィンドウスコープを使用して画面間を持回る。 このため、本クラスは、n:formタグとhiddenタグの暗号化機能の使用を前提とする。 本クラスは、画面処理に依存しない楽観的ロック機能の処理をExclusiveControlUtilに委譲する。

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static java.lang.String	VERSION_PARAM_NAME 非推奨です。 バージョン番号をhiddenタグに出力する際に使用するパラメータ名
static java.lang.String	VERSIONS_VARIABLE_NAME 非推奨です。 バージョン番号をリクエストスコープに設定する際に使用する変数名

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static void	checkVersion(HttpRequest request, ExecutionContext context, ExclusiveControlContext exclusiveControlContext) 非推奨です。 引数で渡された排他制御コンテキストに格納されたPK値に対してバージョン番号をチェックする。
static void	checkVersions(HttpRequest request, ExecutionContext context) 非推奨です。 バージョン番号をチェックする。
static void	checkVersions(HttpRequest request, ExecutionContext context, java.lang.String targetPkListParamName) 非推奨です。 指定されたウィンドウスコープ変数上の配列に格納された各PK値に対して バージョン番号をチェックする。
static boolean	prepareVersion(ExecutionContext context, ExclusiveControlContext exclusiveControlContext) 非推奨です。 バージョン番号を準備する。
static boolean	prepareVersions(ExecutionContext context, java.util.List<? extends ExclusiveControlContext> exclusiveControlContexts) 非推奨です。 バージョン番号を準備する。
static void	updateVersionsWithCheck(HttpRequest request) 非推奨です。 バージョン番号の更新チェックとバージョン番号の更新を行う。
static void	updateVersionsWithCheck(HttpRequest request, java.lang.String targetPkListParamName) 非推奨です。 指定されたウィンドウスコープ変数上の配列に格納された各PK値に対して バージョン番号の更新チェックとバージョン番号の更新を行う。
static void	updateVersionWithCheck(HttpRequest request, ExclusiveControlContext exclusiveControlContext) 非推奨です。 引数で渡された排他制御コンテキストに格納されたPK値に対してバージョン番号のチェックとバージョン情報の更新を行う。

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

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

フィールドの詳細

VERSION_PARAM_NAME

public static final java.lang.String VERSION_PARAM_NAME

非推奨です。

バージョン番号をhiddenタグに出力する際に使用するパラメータ名

関連項目:

定数フィールド値

VERSIONS_VARIABLE_NAME

public static final java.lang.String VERSIONS_VARIABLE_NAME

非推奨です。

バージョン番号をリクエストスコープに設定する際に使用する変数名

関連項目:

定数フィールド値

メソッドの詳細

prepareVersions

public static boolean prepareVersions(ExecutionContext context,
                                      java.util.List<? extends ExclusiveControlContext> exclusiveControlContexts)

非推奨です。

バージョン番号を準備する。

指定されたExclusiveControlContextリストを使用してバージョン番号を取得し、 次回リクエスト時にバージョン番号を送信するために、バージョン番号をリクエストスコープに設定する。 リクエストスコープに設定したバージョン番号は、n:formタグによりウィンドウスコープに設定される。

1つでもバージョン番号を準備できなかった場合は処理を中断しfalseを返す。

パラメータ:

context - 実行コンテキスト

exclusiveControlContexts - 排他制御コンテキストリスト

戻り値:

すべてのバージョン番号を準備できた場合はtrue

prepareVersion

public static boolean prepareVersion(ExecutionContext context,
                                     ExclusiveControlContext exclusiveControlContext)

非推奨です。

バージョン番号を準備する。

指定されたExclusiveControlContextを使用してバージョン番号を取得し、 次回リクエスト時にバージョン番号を送信するために、バージョン番号をリクエストスコープに設定する。 リクエストスコープに設定したバージョン番号は、n:formタグによりウィンドウスコープに設定される。

パラメータ:

context - 実行コンテキスト

exclusiveControlContext - 排他制御コンテキスト

戻り値:

バージョン番号を準備できた場合はtrue

checkVersions

public static void checkVersions(HttpRequest request,
                                 ExecutionContext context)
                          throws OptimisticLockException

非推奨です。

バージョン番号をチェックする。

リクエストパラメータに含まれるバージョン番号を使用して、 バージョン番号が更新されていないかをチェックする。 どれか一つでもバージョン番号が更新されていた場合は、 更新されているバージョン番号を設定したOptimisticLockExceptionを送出する。

全てのバージョン番号が更新されていない場合は、 次回リクエスト時にバージョン番号を送信するために、バージョン番号をリクエストスコープに設定する。 リクエストスコープに設定したバージョン番号は、n:formタグによりウィンドウスコープに設定される。

パラメータ:

request - リクエスト

context - 実行コンテキスト

例外:

OptimisticLockException - バージョン番号が更新されていた場合

checkVersions

public static void checkVersions(HttpRequest request,
                                 ExecutionContext context,
                                 java.lang.String targetPkListParamName)
                          throws OptimisticLockException

非推奨です。

指定されたウィンドウスコープ変数上の配列に格納された各PK値に対して バージョン番号をチェックする。

リクエストパラメータに含まれるバージョン番号を使用して、 バージョン番号が更新されていないかをチェックする。 どれか一つでもバージョン番号が更新されていた場合は、 更新されているバージョン番号を設定したOptimisticLockExceptionを送出する。

全てのバージョン番号が更新されていない場合は、 次回リクエスト時にバージョン番号を送信するために、バージョン番号をリクエストスコープに設定する。 リクエストスコープに設定したバージョン番号は、n:formタグによりウィンドウスコープに設定される。

なお、PKが組み合わせキーとなる場合はcheckVersion(HttpRequest, ExecutionContext, ExclusiveControlContext) を使用すること。

パラメータ:

request - リクエスト

context - 実行コンテキスト

targetPkListParamName - 更新対象のPK値の配列を格納したウィンドウスコープ変数名

例外:

OptimisticLockException - バージョン番号が更新されていた場合

checkVersion

public static void checkVersion(HttpRequest request,
                                ExecutionContext context,
                                ExclusiveControlContext exclusiveControlContext)
                         throws OptimisticLockException

非推奨です。

引数で渡された排他制御コンテキストに格納されたPK値に対してバージョン番号をチェックする。

排他制御コンテキストに格納されたバージョン番号を使用して、バージョン番号が更新されていないかをチェックする。 どれか一つでもバージョン番号が更新されていた場合は、更新されているバージョン番号を設定したOptimisticLockExceptionを送出する。

全てのバージョン番号が更新されていない場合は、 次回リクエスト時にバージョン番号を送信するために、バージョン番号をリクエストスコープに設定する。 リクエストスコープに設定したバージョン番号は、n:formタグによりウィンドウスコープに設定される。

パラメータ:

request - リクエスト

context - 実行コンテキスト

exclusiveControlContext - 排他制御コンテキスト

例外:

OptimisticLockException - バージョン番号が更新されていた場合

updateVersionsWithCheck

public static void updateVersionsWithCheck(HttpRequest request)
                                    throws OptimisticLockException

非推奨です。

バージョン番号の更新チェックとバージョン番号の更新を行う。

リクエストパラメータに含まれるバージョン番号を使用して、 バージョン番号が更新されていないかのチェックと更新を行う。 どれか一つでもバージョン番号が更新されていた場合は、 更新されているバージョン番号を設定したOptimisticLockExceptionを送出する。

パラメータ:

request - リクエスト

例外:

OptimisticLockException - バージョン番号が更新されていた場合

updateVersionsWithCheck

public static void updateVersionsWithCheck(HttpRequest request,
                                           java.lang.String targetPkListParamName)
                                    throws OptimisticLockException

非推奨です。

指定されたウィンドウスコープ変数上の配列に格納された各PK値に対して バージョン番号の更新チェックとバージョン番号の更新を行う。

リクエストパラメータに含まれるバージョン番号を使用して、 バージョン番号が更新されていないかのチェックと更新を行う。 どれか一つでもバージョン番号が更新されていた場合は、 更新されているバージョン番号を設定したOptimisticLockExceptionを送出する。

なお、PKが組み合わせキーとなる場合は、updateVersionWithCheck(HttpRequest, ExclusiveControlContext) を使用すること。

パラメータ:

request - リクエスト

targetPkListParamName - 更新対象のPK値の配列を格納したウィンドウスコープ変数名

例外:

OptimisticLockException - バージョン番号が更新されていた場合

updateVersionWithCheck

public static void updateVersionWithCheck(HttpRequest request,
                                          ExclusiveControlContext exclusiveControlContext)
                                   throws OptimisticLockException

非推奨です。

引数で渡された排他制御コンテキストに格納されたPK値に対してバージョン番号のチェックとバージョン情報の更新を行う。

排他制御コンテキストに格納されたバージョン番号を使用して、バージョン番号が更新されていないかのチェックと更新を行う。 どれか一つでもバージョン番号が更新されていた場合は、更新されているバージョン番号を設定したOptimisticLockExceptionを送出する。

パラメータ:

request - リクエスト

exclusiveControlContext - 排他制御コンテキスト

例外:

OptimisticLockException - バージョン番号が更新されていた場合