Package | Description |
---|---|
nablarch.common.authorization.role |
ロールを単位とした簡易な認可機能を提供するパッケージ。
|
nablarch.common.authorization.role.session |
ロールを単位とした認可機能において、セッションストアにロールを保存する実装を提供するパッケージ。
|
nablarch.common.handler.threadcontext |
スレッドコンテキストに各種属性の設定を行うハンドラを提供する。
|
nablarch.common.web |
Webアプリケーションの作成に必要となる共通機能を提供する。
|
nablarch.common.web.exclusivecontrol |
画面処理における排他制御機能(楽観的ロック)を提供する。
|
nablarch.common.web.session |
本パッケージでは、HTTPSessionを抽象化した機能を提供する。
HTTPSessionと同等の機能に加え、従来の枠組みでは実現できなかった各種機能を追加する。
|
nablarch.fw |
本フレームワークの処理方式に共通する概念やアーキテクチャに関連する
インターフェース及びモジュールを収めたパッケージ。
|
nablarch.fw.action |
業務処理を実装する際に利用できる、アクションハンドラの共通基底クラス
(テンプレート)を格納するパッケージ。
|
nablarch.fw.messaging.action |
応答なし電文を受送信するアクションを提供する。
|
nablarch.fw.reader |
汎用的なデータリーダの実装および、データリーダを独自実装する際に
利用できる基底クラスやユーティリティクラスを収めたパッケージ。
|
nablarch.fw.web |
画面オンライン処理方式の主要APIを収めたパッケージ。
|
nablarch.test.core.http |
Modifier and Type | Method and Description |
---|---|
static boolean |
CheckRoleUtil.checkRole(java.lang.String role,
ExecutionContext context)
現在のアクセスユーザが指定されたロールを有することを判定する。
|
static boolean |
CheckRoleUtil.checkRoleAllOf(java.util.Collection roles,
ExecutionContext context)
現在のアクセスユーザが指定されたロールを全て有することを判定する。
|
static boolean |
CheckRoleUtil.checkRoleAnyOf(java.util.Collection roles,
ExecutionContext context)
現在のアクセスユーザが指定されたロールを1つでも有することを判定する。
|
Modifier and Type | Method and Description |
---|---|
static void |
SessionStoreUserRoleUtil.save(java.util.Collection roles,
ExecutionContext context)
現在のセッションに紐づくユーザが持つロールをセッションストアに保存する。
|
Modifier and Type | Method and Description |
---|---|
protected java.lang.Object |
UserIdAttribute.getUserIdSession(ExecutionContext ctx,
java.lang.String skey)
セッションからユーザIDを取得する。
デフォルトではHTTPセッションからユーザIDを取得する。
必要に応じてオーバーライドすること。
|
java.lang.Object |
UserIdAttribute.getValue(java.lang.Object req,
ExecutionContext ctx)
スレッドコンテキストに格納するプロパティの値を返す。
|
java.lang.Object |
ThreadContextAttribute.getValue(T req,
ExecutionContext ctx)
スレッドコンテキストに格納するプロパティの値を返す。
|
Modifier and Type | Method and Description |
---|---|
static void |
WebUtil.notifyMessages(ExecutionContext context,
Message... messages)
メッセージをユーザに通知する。
|
Modifier and Type | Method and Description |
---|---|
static void |
HttpExclusiveControlUtil.checkVersion(HttpRequest request,
ExecutionContext context,
ExclusiveControlContext exclusiveControlContext)
引数で渡された排他制御コンテキストに格納されたPK値に対してバージョン番号をチェックする。
排他制御コンテキストに格納されたバージョン番号を使用して、バージョン番号が更新されていないかをチェックする。
どれか一つでもバージョン番号が更新されていた場合は、更新されているバージョン番号を設定した
OptimisticLockException を送出する。
全てのバージョン番号が更新されていない場合は、
次回リクエスト時にバージョン番号を送信するために、バージョン番号をリクエストスコープに設定する。
リクエストスコープに設定したバージョン番号は、n:formタグによりウィンドウスコープに設定される。 |
static void |
HttpExclusiveControlUtil.checkVersions(HttpRequest request,
ExecutionContext context)
バージョン番号をチェックする。
リクエストパラメータに含まれるバージョン番号を使用して、
バージョン番号が更新されていないかをチェックする。
どれか一つでもバージョン番号が更新されていた場合は、
更新されているバージョン番号を設定した
OptimisticLockException を送出する。
全てのバージョン番号が更新されていない場合は、
次回リクエスト時にバージョン番号を送信するために、バージョン番号をリクエストスコープに設定する。
リクエストスコープに設定したバージョン番号は、n:formタグによりウィンドウスコープに設定される。 |
static void |
HttpExclusiveControlUtil.checkVersions(HttpRequest request,
ExecutionContext context,
java.lang.String targetPkListParamName)
指定されたウィンドウスコープ変数上の配列に格納された各PK値に対して
バージョン番号をチェックする。
リクエストパラメータに含まれるバージョン番号を使用して、
バージョン番号が更新されていないかをチェックする。
どれか一つでもバージョン番号が更新されていた場合は、
更新されているバージョン番号を設定した
OptimisticLockException を送出する。
全てのバージョン番号が更新されていない場合は、
次回リクエスト時にバージョン番号を送信するために、バージョン番号をリクエストスコープに設定する。
リクエストスコープに設定したバージョン番号は、n:formタグによりウィンドウスコープに設定される。
なお、PKが組み合わせキーとなる場合はHttpExclusiveControlUtil.checkVersion(HttpRequest, ExecutionContext, ExclusiveControlContext)
を使用すること。 |
static boolean |
HttpExclusiveControlUtil.prepareVersion(ExecutionContext context,
ExclusiveControlContext exclusiveControlContext)
バージョン番号を準備する。
指定された
ExclusiveControlContext を使用してバージョン番号を取得し、
次回リクエスト時にバージョン番号を送信するために、バージョン番号をリクエストスコープに設定する。
リクエストスコープに設定したバージョン番号は、n:formタグによりウィンドウスコープに設定される。 |
static boolean |
HttpExclusiveControlUtil.prepareVersions(ExecutionContext context,
java.util.List<? extends ExclusiveControlContext> exclusiveControlContexts)
バージョン番号を準備する。
指定された
ExclusiveControlContext リストを使用してバージョン番号を取得し、
次回リクエスト時にバージョン番号を送信するために、バージョン番号をリクエストスコープに設定する。
リクエストスコープに設定したバージョン番号は、n:formタグによりウィンドウスコープに設定される。
1つでもバージョン番号を準備できなかった場合は処理を中断しfalseを返す。 |
Modifier and Type | Method and Description |
---|---|
static void |
SessionUtil.changeId(ExecutionContext ctx)
セッションIDを変更する。
|
static <T> T |
SessionUtil.delete(ExecutionContext ctx,
java.lang.String name)
セッションを削除する。
指定した名称のセッションオブジェクトが存在しない場合は無視される。
|
static <T> T |
SessionUtil.get(ExecutionContext ctx,
java.lang.String name)
名称を指定してセッションからオブジェクトを取得する。
セッションに指定した名称をもつオブジェクトが存在しない場合、
SessionKeyNotFoundException を送出する。 |
static void |
SessionUtil.invalidate(ExecutionContext ctx)
セッションを無効化する。
|
static <T> T |
SessionUtil.or(ExecutionContext ctx,
java.lang.String name,
T defaultValue)
名称を指定してセッションからオブジェクトを取得する。
セッションに指定した名称をもつオブジェクトが存在しない場合、デフォルト値を返す。
|
static <T> T |
SessionUtil.orNull(ExecutionContext ctx,
java.lang.String name)
名称を指定してセッションからオブジェクトを取得する。
セッションに指定した名称をもつオブジェクトが存在しない場合、nullを返す。
|
static void |
SessionUtil.put(ExecutionContext ctx,
java.lang.String name,
java.lang.Object value)
SessionStore に変数を保存する。
オブジェクトの保存先はSessionManager で指定したSessionStore が選択される。
同一の登録名をもつオブジェクトは上書きされる。
よって、複数のSessionStore を利用する場合でも、
同一の登録名をもつオブジェクトは一つしか登録できない。
注意:セッションで管理できるオブジェクトの制限について、
SessionUtil.put(ExecutionContext, String, Object, String) を参照すること。
|
static void |
SessionUtil.put(ExecutionContext ctx,
java.lang.String name,
java.lang.Object value,
java.lang.String storeName)
保存先の
SessionStore を指定して、セッションに変数を保存する。
同一の登録名をもつオブジェクトは上書きされる。
よって、複数のSessionStore を利用する場合でも、
同一の登録名をもつオブジェクトは一つしか登録できない。
注意:セッションに直接格納し、復元ができるオブジェクトの制限についてセッションに直接格納できるのは、下記条件を満たすJava Beanオブジェクトのみである。 デフォルトコンストラクタが定義されていること 値を保持したいプロパティに対し、setter及びgetterが定義されていること シリアライズ可能であること 上記条件を満たさないオブジェクトを登録した場合、格納/復元処理が正常に動作しない。 例えば、配列型のオブジェクトを直接セッションに格納した場合、復元できない。 その場合、配列を直接格納するのではなくBeanオブジェクトのプロパティとして保持し、 Beanオブジェクトをセッションに格納すること。 |
Modifier and Type | Method and Description |
---|---|
ExecutionContext |
ExecutionContext.invalidateSession()
現在のリクエストに紐付けられたセッションスコープを無効化する。
|
ExecutionContext |
ExecutionContext.setRequestScopedVar(java.lang.String varName,
java.lang.Object varValue)
リクエストスコープ上の変数の値を設定する。
既に定義済みの変数は上書きされる。
|
ExecutionContext |
ExecutionContext.setSessionScopedVar(java.lang.String varName,
java.lang.Object varValue)
セッションスコープ上の変数の値を設定する。
既に定義済みの変数は上書きされる。
|
Modifier and Type | Method and Description |
---|---|
abstract nablarch.fw.DataReader<D> |
BatchAction.createReader(ExecutionContext ctx)
このタスクの入力データを読み込むデータリーダを生成して返す。
|
protected void |
BatchActionBase.error(java.lang.Throwable error,
ExecutionContext context)
実行時例外/エラーの発生によって本処理が終了した場合に一度だけ実行される。
デフォルトでは何もしない。
必要に応じてオーバライドすること。
|
abstract Result |
BatchAction.handle(D inputData,
ExecutionContext ctx)
データリーダによって読み込まれた1件分の入力データに対する業務処理を実行する。
|
protected void |
BatchActionBase.initialize(CommandLine command,
ExecutionContext context)
実行管理ハンドラ(
ExecutionHandler )の本処理開始前に一度だけ実行される。
デフォルトでは何もしない。
必要に応じてオーバライドすること。 |
protected void |
BatchActionBase.terminate(Result result,
ExecutionContext context)
本処理が終了した場合に一度だけ実行される。
(エラー終了した場合でも実行される。)
デフォルトでは何もしない。
必要に応じてオーバライドすること。
|
protected void |
BatchActionBase.transactionFailure(D inputData,
ExecutionContext context)
トランザクション処理が異常終了した場合に実行される。
デフォルトでは何もしない。
必要に応じてオーバライドすること。
|
protected void |
BatchActionBase.transactionSuccess(D inputData,
ExecutionContext context)
トランザクション処理が正常終了した場合に実行される。
デフォルトでは何もしない。
必要に応じてオーバライドすること。
|
Modifier and Type | Method and Description |
---|---|
protected nablarch.fw.messaging.ResponseMessage |
MessagingAction.onError(java.lang.Throwable e,
RequestMessage request,
ExecutionContext context)
業務トランザクションが異常終了した場合の処理を実行する。
本メソッドは、業務トランザクションがロールバックされると起動される。
任意のエラー応答電文(
ResponseMessage )を返却したい場合は、本メソッドをオーバーライドすること。
デフォルト実装ではなにもしない。
注意:
以下のケースでは業務アクションへのディスパッチが行われる前にエラーが
発生するため、エラー応答電文の内容を制御することはできない。
フレームワーク制御ヘッダの形式不正
MOMミドルウェアのレイヤーで発生したエラー (JMSException等)
|
protected abstract nablarch.fw.messaging.ResponseMessage |
MessagingAction.onReceive(RequestMessage request,
ExecutionContext context)
要求電文毎にフレームワークから起動され、要求電文の内容をもとに業務処理を実行する。
|
Modifier and Type | Method and Description |
---|---|
void |
ValidatableFileDataReader.FileValidatorAction.onFileEnd(ExecutionContext ctx)
ファイル全件の読み込みが正常終了し、
ファイル終端に達するとコールバックされる
|
Modifier and Type | Method and Description |
---|---|
HttpResponse |
HttpResponse.Status.handle(HttpRequest req,
ExecutionContext ctx)
入力データに対する処理を実行する。
このクラスの実装では、以下のHTTPレスポンスメッセージに相当する
HttpResponse オブジェクトを返す。 |
Modifier and Type | Method and Description |
---|---|
HttpResponse |
SimpleRestTestSupport.sendRequestWithContext(HttpRequest request,
ExecutionContext context)
ExecutionContext を設定しテストリクエストを内蔵サーバに渡しレスポンスを返す。
ExecutionContext の設定はHttpRequestTestSupportHandler を利用する。 |
HttpResponse |
SimpleRestTestSupport.sendRequestWithContext(HttpRequest request,
ExecutionContext context,
nablarch.test.core.http.RequestResponseProcessor processor)
ExecutionContext を設定しテストリクエストを内蔵サーバに渡しレスポンスを返す。
ExecutionContext の設定はHttpRequestTestSupportHandler を利用する。 |