パッケージ | 説明 |
---|---|
nablarch.common.handler.threadcontext |
スレッドコンテキストに各種属性の設定を行うハンドラを提供する。
|
nablarch.common.mail |
メール送信ライブラリ。
|
nablarch.common.web |
Webアプリケーションの作成に必要となる共通機能を提供する。
|
nablarch.common.web.exclusivecontrol |
画面処理における排他制御機能(楽観的ロック)を提供する。
|
nablarch.common.web.handler.threadcontext |
画面処理用のスレッドコンテキストに各種属性の設定を行うハンドラを提供する。
|
nablarch.common.web.session |
本パッケージでは、HTTPSessionを抽象化した機能を提供する。
|
nablarch.common.web.token |
トークンを使用した二重サブミットの防止機能を提供する。
|
nablarch.fw |
本フレームワークの処理方式に共通する概念やアーキテクチャに関連する
インターフェース及びモジュールを収めたパッケージ。
|
nablarch.fw.action |
業務処理を実装する際に利用できる、アクションハンドラの共通基底クラス
(テンプレート)を格納するパッケージ。
|
nablarch.fw.handler |
処理方式に依存しないフレームワーク標準ハンドラを収めたパッケージ。
|
nablarch.fw.invoker |
ハンドラリストの実行機能を提供する。
|
nablarch.fw.jaxrs |
NablarchのActionハンドラをJAX-RSのリソースクラスとして呼び出す事ができる機能を提供する。
|
nablarch.fw.messaging.action |
応答なし電文を受送信するアクションを提供する。
|
nablarch.fw.messaging.handler |
外部システムとのメッセージング処理において使用するハンドラを格納するパッケージ。
|
nablarch.fw.reader |
汎用的なデータリーダの実装および、データリーダを独自実装する際に
利用できる基底クラスやユーティリティクラスを収めたパッケージ。
|
nablarch.fw.results | |
nablarch.fw.web |
画面オンライン処理方式の主要APIを収めたパッケージ。
|
nablarch.fw.web.handler |
画面オンライン処理方式向けフレームワーク標準ハンドラ。
|
nablarch.fw.web.servlet |
J2EEコンテナサポートAPI群。
|
修飾子とタイプ | メソッドと説明 |
---|---|
Object |
ThreadContextAttribute.getValue(T req,
ExecutionContext ctx)
スレッドコンテキストに格納するプロパティの値を返す。
|
修飾子とタイプ | メソッドと説明 |
---|---|
protected void |
MailSender.addBodyContent(javax.mail.internet.MimeMessage mimeMessage,
nablarch.common.mail.MailRequestTable.MailRequest mailRequest,
List<?> attachedFiles,
ExecutionContext context)
指定された
MimeMessage にメールメッセージ本文(添付ファイル含む)を追加する。 |
DataReader<SqlRow> |
MailSender.createReader(ExecutionContext ctx)
このタスクの入力データを読み込むデータリーダを生成して返す。
|
protected void |
MailSender.transactionFailure(SqlRow data,
ExecutionContext context)
トランザクション処理が異常終了した場合に実行される。
|
protected void |
MailSender.transactionSuccess(SqlRow data,
ExecutionContext context)
トランザクション処理が正常終了した場合に実行される。
|
修飾子とタイプ | メソッドと説明 |
---|---|
static void |
WebUtil.notifyMessages(ExecutionContext context,
Message... messages)
メッセージをユーザに通知する。
|
修飾子とタイプ | メソッドと説明 |
---|---|
static void |
HttpExclusiveControlUtil.checkVersion(HttpRequest request,
ExecutionContext context,
ExclusiveControlContext exclusiveControlContext)
非推奨です。
引数で渡された排他制御コンテキストに格納されたPK値に対してバージョン番号をチェックする。
|
static void |
HttpExclusiveControlUtil.checkVersions(HttpRequest request,
ExecutionContext context)
非推奨です。
バージョン番号をチェックする。
|
static void |
HttpExclusiveControlUtil.checkVersions(HttpRequest request,
ExecutionContext context,
String targetPkListParamName)
非推奨です。
指定されたウィンドウスコープ変数上の配列に格納された各PK値に対して
バージョン番号をチェックする。
|
static boolean |
HttpExclusiveControlUtil.prepareVersion(ExecutionContext context,
ExclusiveControlContext exclusiveControlContext)
非推奨です。
バージョン番号を準備する。
|
static boolean |
HttpExclusiveControlUtil.prepareVersions(ExecutionContext context,
List<? extends ExclusiveControlContext> exclusiveControlContexts)
非推奨です。
バージョン番号を準備する。
|
修飾子とタイプ | メソッドと説明 |
---|---|
Object |
TimeZoneAttributeInHttpSupport.getValue(Request<?> req,
ExecutionContext ctx)
コンテキストスレッドに格納するこのプロパティの値を返す。
|
static void |
LanguageAttributeInHttpUtil.keepLanguage(HttpRequest request,
ExecutionContext context,
String language)
指定された言語の保持と
java.lang.ThreadLocal への設定を行う。 |
static void |
TimeZoneAttributeInHttpUtil.keepTimeZone(HttpRequest request,
ExecutionContext context,
String timeZone)
指定されたタイムゾーンの保持とスレッドローカルへの設定を行う。
|
修飾子とタイプ | メソッドと説明 |
---|---|
static <T> T |
SessionUtil.delete(ExecutionContext ctx,
String name)
セッションを削除する。
|
abstract void |
SessionStore.delete(String sessionId,
ExecutionContext executionContext)
セッションの内容をストアから削除する。
|
static <T> T |
SessionUtil.get(ExecutionContext ctx,
String name)
名称を指定してセッションからオブジェクトを取得する。
|
static void |
SessionUtil.invalidate(ExecutionContext ctx)
セッションを無効化する。
|
abstract void |
SessionStore.invalidate(String sessionId,
ExecutionContext executionContext)
セッションストアを無効にする。
|
abstract List<SessionEntry> |
SessionStore.load(String sessionId,
ExecutionContext executionContext)
セッションの内容をストアからロードする。
|
static <T> T |
SessionUtil.or(ExecutionContext ctx,
String name,
T defaultValue)
名称を指定してセッションからオブジェクトを取得する。
|
static <T> T |
SessionUtil.orNull(ExecutionContext ctx,
String name)
名称を指定してセッションからオブジェクトを取得する。
|
static void |
SessionUtil.put(ExecutionContext ctx,
String name,
Object value)
SessionStore に変数を保存する。 |
static void |
SessionUtil.put(ExecutionContext ctx,
String name,
Object value,
String storeName)
保存先の
SessionStore を指定して、セッションに変数を保存する。 |
abstract void |
SessionStore.save(String sessionId,
List<SessionEntry> entries,
ExecutionContext executionContext)
セッションの内容をストアに保存する。
|
修飾子とタイプ | メソッドと説明 |
---|---|
HttpResponse |
DoubleSubmissionHandler.handle(HttpRequest request,
ExecutionContext context,
Handler<HttpRequest,HttpResponse> httpRequestHandler,
OnDoubleSubmission annotation)
OnDoubleSubmissionアノテーションに対する処理を行う。
|
修飾子とタイプ | メソッドと説明 |
---|---|
ExecutionContext |
ExecutionContext.invalidateSession()
現在のリクエストに紐付けられたセッションスコープを無効化する。
|
ExecutionContext |
ExecutionContext.setRequestScopedVar(String varName,
Object varValue)
リクエストスコープ上の変数の値を設定する。
|
ExecutionContext |
ExecutionContext.setSessionScopedVar(String varName,
Object varValue)
セッションスコープ上の変数の値を設定する。
|
修飾子とタイプ | メソッドと説明 |
---|---|
void |
DataReader.close(ExecutionContext ctx)
このリーダの利用を停止し、内部的に保持している各種リソースを解放する。
|
DataReader<TData> |
DataReaderFactory.createReader(ExecutionContext context)
新たなデータリーダを作成する。
|
TResult |
Handler.handle(TData data,
ExecutionContext context)
入力データに対する処理を実行する。
|
boolean |
DataReader.hasNext(ExecutionContext ctx)
次に読み込むデータが存在するかどうかを返却する。
|
TData |
DataReader.read(ExecutionContext ctx)
Handler が処理する入力データを読み込んで返却する。 |
修飾子とタイプ | メソッドと説明 |
---|---|
abstract DataReader<D> |
BatchAction.createReader(ExecutionContext ctx)
このタスクの入力データを読み込むデータリーダを生成して返す。
|
protected void |
BatchActionBase.error(Throwable error,
ExecutionContext context)
実行時例外/エラーの発生によって本処理が終了した場合に一度だけ実行される。
|
void |
BatchActionBase.errorInExecution(Throwable error,
ExecutionContext context) |
abstract Result |
BatchAction.handle(D inputData,
ExecutionContext ctx)
データリーダによって読み込まれた1件分の入力データに対する業務処理を実行する。
|
protected void |
BatchActionBase.initialize(CommandLine command,
ExecutionContext context)
実行管理ハンドラ(
nablarch.fw.handler.ExecutionHandler )の本処理開始前に一度だけ実行される。 |
void |
BatchActionBase.postExecution(Result result,
ExecutionContext context) |
void |
BatchActionBase.preExecution(CommandLine commandLine,
ExecutionContext context) |
protected void |
BatchActionBase.terminate(Result result,
ExecutionContext context)
本処理が終了した場合に一度だけ実行される。
|
void |
BatchActionBase.transactionAbnormalEnd(Throwable e,
D data,
ExecutionContext ctx) |
protected void |
BatchActionBase.transactionFailure(D inputData,
ExecutionContext context)
トランザクション処理が異常終了した場合に実行される。
|
void |
BatchActionBase.transactionNormalEnd(D data,
ExecutionContext ctx) |
protected void |
BatchActionBase.transactionSuccess(D inputData,
ExecutionContext context)
トランザクション処理が正常終了した場合に実行される。
|
修飾子とタイプ | メソッドと説明 |
---|---|
void |
ExecutionHandlerCallback.errorInExecution(Throwable error,
ExecutionContext context)
実行制御ハンドラが後続処理を実行した後、
後続のハンドラでエラーが発生した場合に呼ばれる。
|
protected void |
RewriteRule.exportParam(String scope,
String name,
String value,
TData data,
ExecutionContext context)
変数を定義する。
|
protected Method |
RecordTypeBinding.getMethodBoundTo(DataRecord record,
ExecutionContext ctx)
入力データおよび実行コンテキストの内容に応じて、委譲対象のメソッドを決定する。
|
protected Object |
RewriteRule.getParam(String scope,
String name,
TData data,
ExecutionContext context)
変数の値を返す。
|
void |
ExecutionHandlerCallback.postExecution(TResult result,
ExecutionContext context)
実行制御ハンドラが後続処理を実行した後、正常、異常終了を問わず
処理が全て完了した直後に呼ばれる。
|
void |
ExecutionHandlerCallback.preExecution(TData data,
ExecutionContext context)
実行制御ハンドラが後続処理を実行する前にコールバックされる。
|
String |
RewriteRule.rewrite(TData data,
ExecutionContext context)
このオブジェクトの設定に従ってパスの置換処理をおこない、
置換後のパス文字列を返す。
|
修飾子とタイプ | メソッドと説明 |
---|---|
protected Callable<TResult> |
AsyncHandlerListInvoker.createCallable(HandlerListInvoker<TData,TResult> handlerListInvoker,
TData input,
ExecutionContext context)
ハンドラリストを起動する
Callable インスタンスを生成する。 |
protected Set |
PipelineInvoker.getProcessedHandlers(ExecutionContext context)
処理済ハンドラのSetを取得する。
|
protected Result |
PipelineInvoker.handleError(ExecutionContext context,
Error e)
Error の例外処理を行う。
|
protected Result |
PipelineInvoker.handleException(ExecutionContext context,
Throwable t)
例外処理を行う
|
protected Result |
PipelineInvoker.handleRuntimeException(ExecutionContext context,
RuntimeException e)
RuntimeExceptionの例外処理を行う。
|
TResult |
HandlerListInvoker.invokeHandlerList(TData input,
ExecutionContext context)
ハンドラリストの起動を行う。
|
TResult |
BasicHandlerListInvoker.invokeHandlerList(TData input,
ExecutionContext context) |
Result |
PipelineInvoker.invokeInbound(ExecutionContext context)
事前処理を実行する。
|
Result |
PipelineInvoker.invokeOutbound(ExecutionContext context)
事前処理を実行する。
|
修飾子とタイプ | メソッドと説明 |
---|---|
HttpResponse |
ErrorResponseBuilder.build(HttpRequest request,
ExecutionContext context,
Throwable throwable)
エラーレスポンスを生成する。
|
protected Object |
JaxbBodyConverter.convertRequest(HttpRequest request,
ExecutionContext context) |
protected abstract Object |
BodyConverterSupport.convertRequest(HttpRequest request,
ExecutionContext context)
リクエストを変換する。
|
protected HttpResponse |
JaxbBodyConverter.convertResponse(Object response,
ExecutionContext context) |
protected abstract HttpResponse |
BodyConverterSupport.convertResponse(Object response,
ExecutionContext context)
レスポンスを変換する。
|
Object |
BodyConverterSupport.read(HttpRequest request,
ExecutionContext executionContext) |
void |
JaxRsErrorLogWriter.write(HttpRequest request,
HttpResponse response,
ExecutionContext context,
Throwable throwable)
エラー情報をログに出力する。
|
HttpResponse |
BodyConverterSupport.write(Object response,
ExecutionContext executionContext) |
protected void |
JaxRsErrorLogWriter.writeApplicationExceptionLog(HttpRequest request,
HttpResponse response,
ExecutionContext context,
ApplicationException exception)
ApplicationException の情報をログ出力する。 |
修飾子とタイプ | メソッドと説明 |
---|---|
DataReader<SqlRow> |
AsyncMessageSendAction.createReader(ExecutionContext ctx)
送信対象のデータを抽出するための
DatabaseRecordReader を生成する。 |
DataReader<RequestMessage> |
AsyncMessageReceiveAction.createReader(ExecutionContext ctx)
このタスクの入力データを読み込むデータリーダを生成して返す。
|
Result |
AsyncMessageReceiveAction.handle(RequestMessage inputData,
ExecutionContext ctx)
データリーダによって読み込まれた1件分の入力データに対する業務処理を実行する。
|
Result |
AsyncMessageSendAction.handle(SqlRow inputData,
ExecutionContext ctx)
入力データからヘッダ部及び業務データ部からなるメッセージオブジェクトを生成し、
送信処理(キューへのPUT)を行う。
|
protected void |
AsyncMessageSendAction.initialize(CommandLine command,
ExecutionContext context)
初期処理を行う。
|
protected ResponseMessage |
MessagingAction.onError(Throwable e,
RequestMessage request,
ExecutionContext context)
業務トランザクションが異常終了した場合の処理を実行する。
|
protected abstract ResponseMessage |
MessagingAction.onReceive(RequestMessage request,
ExecutionContext context)
要求電文毎にフレームワークから起動され、要求電文の内容をもとに業務処理を実行する。
|
void |
AsyncMessageSendAction.transactionAbnormalEnd(Throwable e,
SqlRow inputData,
ExecutionContext ctx)
インプットテーブルの対象レコードのステータスをエラーに更新する。
|
void |
AsyncMessageSendAction.transactionNormalEnd(SqlRow inputData,
ExecutionContext ctx)
インプットテーブルの対象レコードのステータスを処理済みに更新する。
|
修飾子とタイプ | メソッドと説明 |
---|---|
protected ResponseMessage |
MessageReplyHandler.errorResponseOf(Throwable e,
ExecutionContext ctx)
後続ハンドラの処理中に未捕捉の例外が発生した場合に応答するエラー電文を作成する。
|
修飾子とタイプ | メソッドと説明 |
---|---|
void |
ValidatableFileDataReader.FileValidatorAction.onFileEnd(ExecutionContext ctx)
ファイル全件の読み込みが正常終了し、
ファイル終端に達するとコールバックされる
|
修飾子とタイプ | メソッドと説明 |
---|---|
void |
ServiceError.writeLog(ExecutionContext context)
この障害の内容について運用ログに出力する。
|
修飾子とタイプ | メソッドと説明 |
---|---|
HttpResponse |
HttpRequestHandler.handle(HttpRequest request,
ExecutionContext context)
HTTPリクエストに対する処理を実行する。
|
HttpResponse |
HttpResponse.Status.handle(HttpRequest req,
ExecutionContext ctx)
入力データに対する処理を実行する。
|
修飾子とタイプ | メソッドと説明 |
---|---|
protected void |
HttpRequestRewriteRule.exportParam(String scope,
String name,
String value,
HttpRequest req,
ExecutionContext context) |
protected Object |
HttpRequestRewriteRule.getParam(String type,
String name,
HttpRequest request,
ExecutionContext context) |
protected Object |
ContentPathRewriteRule.getParam(String type,
String name,
HttpResponse response,
ExecutionContext context) |
修飾子とタイプ | クラスと説明 |
---|---|
class |
ServletExecutionContext
サーブレットコンテナ上でのリクエスト処理における実行コンテキスト
|