Uses of Interface
nablarch.fw.Result

Packages that use Result

Package	Description
nablarch.common.mail	メール送信ライブラリ。
nablarch.common.web.download	ダウンロード機能を提供する。
nablarch.fw	本フレームワークの処理方式に共通する概念やアーキテクチャに関連する インターフェース及びモジュールを収めたパッケージ。
nablarch.fw.action	業務処理を実装する際に利用できる、アクションハンドラの共通基底クラス （テンプレート）を格納するパッケージ。
nablarch.fw.handler	処理方式に依存しないフレームワーク標準ハンドラを収めたパッケージ。
nablarch.fw.invoker	ハンドラリストの実行機能を提供する。
nablarch.fw.launcher	アプリケーションが動作するJavaプロセスの起動とフレームワークの初期化を行う ランチャーに関連するモジュールを収めたパッケージ。
nablarch.fw.messaging	メッセージング処理方式の実装に直接関連するモジュールを格納するパッケージ。
nablarch.fw.messaging.action	応答なし電文を受送信するアクションを提供する。
nablarch.fw.results
nablarch.fw.web	画面オンライン処理方式の主要APIを収めたパッケージ。
nablarch.fw.web.handler	画面オンライン処理方式向けフレームワーク標準ハンドラ。
nablarch.fw.web.servlet	J2EEコンテナサポートAPI群。

Uses of Result in nablarch.common.mail

Methods in nablarch.common.mail that return Result

Modifier and Type	Method and Description
protected Result	MailSender.handleException(SqlRow data, ExecutionContext context, nablarch.common.mail.MailRequestTable.MailRequest mailRequest, MailConfig mailConfig, java.lang.Exception e) メール送信時の例外のハンドル処理を行う。 本クラスでは、障害ログを出力し、送信ステータスを送信失敗にしてリトライを行う。 本メソッドでは、すべての例外をリトライ対象としてSendMailRetryableExceptionを送出している。 独自の処理を実施したい場合は本メソッドをオーバーライドすることで行うことができる。

Uses of Result in nablarch.common.web.download

Classes in nablarch.common.web.download that implement Result

Modifier and Type	Class and Description
class	DataRecordResponse Map型のデータレコードのリストを一定のフォーマットに従って直列化し、 その内容をレスポンスボディとするHTTPレスポンスオブジェクト。
class	FileResponse FileオブジェクトからHTTPレスポンスを生成するHttpResponse継承クラス。
class	StreamResponse ストリームからHTTPレスポンスメッセージを生成するクラス。 本クラスは、ファイルシステム上のファイルやデータベースのBLOB型のカラムに格納した バイナリデータのダウンロードに使用する。

Uses of Result in nablarch.fw

Classes in nablarch.fw that implement Result

Modifier and Type	Class and Description
static class	DataReader.NoMoreRecord これ以上読み取るデータが無いことを示す例外。
class	NoMoreHandlerException ハンドラーキュー上に処理を委譲するためのハンドラが存在しない場合に 送出される例外。
static class	Result.ClientError サービス呼出側に起因すると思われる問題により、処理が継続できないことを示す例外。 問題解決には、呼び出し側による対処が必要となるので、エラーメッセージの 内容として、呼び出し側に要求する対処の内容を明記する必要がある。
static class	Result.Error ハンドラの処理が異常終了したことを示す実行時例外。 本クラスの具象クラスは以下の3つに類別することができる。
static class	Result.MultiStatus 処理結果が複数のステータスを含んでいることを表す。 これは、バッチ処理やアップロード処理のように、 1つのリクエストに対して複数の処理が実行される場合に返される。 個々の処理結果には、エラー結果(4xx/5xx)が含まれうる。
static class	Result.NotFound 要求されたリソースが存在しないため、 処理を継続することができないことを示す例外。
static class	Result.Success ハンドラの処理が正常終了したことを表す。

Methods in nablarch.fw that return types with arguments of type Result

Modifier and Type	Method and Description
java.util.List<Result>	Result.MultiStatus.getResults() 処理結果のリストを取得する。

Methods in nablarch.fw with parameters of type Result

Modifier and Type	Method and Description
Result.MultiStatus	Result.MultiStatus.addResults(Result... results) 処理結果を追加する。

Uses of Result in nablarch.fw.action

Methods in nablarch.fw.action that return Result

Modifier and Type	Method and Description
abstract Result	BatchAction.handle(D inputData, ExecutionContext ctx) データリーダによって読み込まれた1件分の入力データに対する業務処理を実行する。

Methods in nablarch.fw.action with parameters of type Result

Modifier and Type	Method and Description
void	BatchActionBase.postExecution(Result result, ExecutionContext context)
protected void	BatchActionBase.terminate(Result result, ExecutionContext context) 本処理が終了した場合に一度だけ実行される。 （エラー終了した場合でも実行される。） デフォルトでは何もしない。 必要に応じてオーバライドすること。

Uses of Result in nablarch.fw.handler

Classes in nablarch.fw.handler that implement Result

Modifier and Type	Class and Description
static class	DuplicateProcessCheckHandler.DuplicateProcess プロセスが２重に起動された場合に送出される例外クラス。
static class	ProcessStopHandler.ProcessStop プロセス停止を示す例外。

Uses of Result in nablarch.fw.invoker

Methods in nablarch.fw.invoker that return Result

Modifier and Type	Method and Description
protected Result	PipelineInvoker.handleError(ExecutionContext context, java.lang.Error e) Error の例外処理を行う。 例外をNablarchのハンドラでレスポンスとして処理する場合、 このハンドラより外部のハンドラが処理できるレスポンスオブジェクトを返す。
protected Result	PipelineInvoker.handleException(ExecutionContext context, java.lang.Throwable t) 例外処理を行う
protected Result	PipelineInvoker.handleRuntimeException(ExecutionContext context, java.lang.RuntimeException e) RuntimeExceptionの例外処理を行う。 例外をNablarchのハンドラでレスポンスとして処理する場合、 このハンドラより外部のハンドラが処理できるレスポンスオブジェクトを返す。
Result	PipelineInvoker.invokeInbound(ExecutionContext context) 事前処理を実行する。
Result	PipelineInvoker.invokeOutbound(ExecutionContext context) 事前処理を実行する。

Uses of Result in nablarch.fw.launcher

Classes in nablarch.fw.launcher that implement Result

Modifier and Type	Class and Description
class	ProcessAbnormalEnd アプリケーションを異常終了させる際に送出する例外クラス。 この例外が送出された場合、フレームワークは以下の処理を行う。

Uses of Result in nablarch.fw.messaging

Classes in nablarch.fw.messaging that implement Result

Modifier and Type	Class and Description
class	ErrorResponseMessage エラー応答として送信する電文情報を含んだ実行時例外。 本クラスを送出することで、業務トランザクションはロールバックしつつ、 任意の内容の応答電文を送信することができる。
class	MessageReadError メッセージデータリーダによる受信電文の読み込み処理の最中にエラーが発生した場合に 送出される例外。 受信電文のGETには成功したが、フレームワークヘッダ領域の読み込みに失敗した場合に 送出される。 この例外が送出された場合、業務処理へのディスパッチは発生しない。
class	ResponseMessage 本システムに対する要求電文への応答電文を表すクラス。 本クラスでは、RequestMessageと同様、応答電文の内容をフレームワークヘッダ部と 業務データ部に分離して管理しており、業務ロジックからは業務データ部しか操作できない ようになっている。 メッセージボディを直列化する際には、フレームワークヘッダ部と業務データ部をそれぞれ 直列化して連結したものを返す。
class	StructuredResponseMessage 構造化されたデータを取り扱うために、addRecord時にデータをすぐに書き込まず、メモリ上にキャッシュする応答メッセージ。

Uses of Result in nablarch.fw.messaging.action

Methods in nablarch.fw.messaging.action that return Result

Modifier and Type	Method and Description
Result	AsyncMessageReceiveAction.handle(RequestMessage inputData, ExecutionContext ctx) データリーダによって読み込まれた1件分の入力データに対する業務処理を実行する。
Result	AsyncMessageSendAction.handle(SqlRow inputData, ExecutionContext ctx) 入力データからヘッダ部及び業務データ部からなるメッセージオブジェクトを生成し、 送信処理（キューへのPUT）を行う。 処理詳細は、以下のとおり。 ヘッダ部は、AsyncMessageSendAction.createHeaderRecord(nablarch.core.db.statement.SqlRow)で生成する。 業務データ部は、インプットデータ(本メソッドの引数)をそのまま使用する。 送信先のキューは、AsyncMessageSendAction.getQueueName()から取得する。

Uses of Result in nablarch.fw.results

Classes in nablarch.fw.results that implement Result

Modifier and Type	Class and Description
class	BadRequest 入力データの内容に問題がある為に処理が継続できないことを示す例外。
class	Conflicted 要求された処理が既に行われた(もしくは並行して実行されている) 処理の結果と競合しているため、処理を継続することができないことを示す例外。
class	Forbidden 必要な権限が無いため、処理を継続することができない ことを示す例外。
class	InternalError ハンドラの内部処理で発生した問題により、処理が継続できないことを 示す例外。
class	RequestEntityTooLarge 要求されたリクエストが大きすぎるため、処理を継続できないことを示す例外。
class	ServiceError サービス側で生じた問題により処理が継続できないことを示す例外。 問題解決には、サービス側での対処が必要となるため、エラーメッセージの内容として、 呼び出し側が問題が発生したことをサービス管理者に連絡する方法と、 管理者に伝えるべき内容を含める必要がある。 また、メッセージIDを設定することにより、 運用ログへの出力に関する制御を行うことができる。
class	ServiceUnavailable 一時的に処理の受付を停止していることを表す例外。
class	TransactionAbnormalEnd 業務処理が異常終了したことを示す例外クラス。
class	Unauthorized 必要な認証プロセスを経ていないため、処理を継続することができない ことを示す例外。

Uses of Result in nablarch.fw.web

Classes in nablarch.fw.web that implement Result

Modifier and Type	Class and Description
class	HttpResponse HTTPレスポンスメッセージを生成する際に必要な情報を格納したクラス。 HTTPクライアントに対するレスポンス処理をフレームワークが行うために必要な 以下の情報を保持する。 レスポンスステータスコード レスポンスヘッダ レスポンスボディ レスポンスボディの内容は、以下のいずれかの方式によって保持する。 内容をこのオブジェクトに直接保持する方式(バッファ方式) ボディに書き込むコンテンツファイルのパスのみを指定する方式(コンテンツパス方式) HttpResponse.setContentPath(String) の値を設定することで後者の方式がとられるようになる。 メモリ消費の観点や、コンテンツファイル管理の容易さから、 通常はコンテンツパスによる方式を使用すべきである。

Uses of Result in nablarch.fw.web.handler

Classes in nablarch.fw.web.handler that implement Result

Modifier and Type	Class and Description
static class	SessionConcurrentAccessHandler.SessionConfliction Deprecated. セッション書き込みに競合が発生したことを表す例外。

Uses of Result in nablarch.fw.web.servlet

Classes in nablarch.fw.web.servlet that implement Result

Modifier and Type	Class and Description
static class	NablarchHttpServletRequestWrapper.PostParameterReadError ポストパラメータの読み込みに失敗したことを表す実行時例外。