nablarch.fw

Class Result.Error

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

nablarch.fw.Result.Error

All Implemented Interfaces:

java.io.Serializable, Result

Direct Known Subclasses:

ErrorResponseMessage, MessageReadError, Result.ClientError, ServiceError

Enclosing interface:

Result

@Published(tag="architect")
public abstract static class Result.Error
extends java.lang.RuntimeException
implements Result

ハンドラの処理が異常終了したことを示す実行時例外。

本クラスの具象クラスは以下の3つに類別することができる。

 1. Result.ClientError (ステータスコード:4xx)
   呼び出し側に起因する問題によりエラー終了したことを表す実行時例外。
   入力値のバリデーションエラー、認証認可エラーなどがこれに属し、
   ユーザ側の再試行により処理継続が見込める場合に使用する。
   ハンドラ側から見れば正常系であるため、障害ログ出力を行う必要は無い。
 
 2. Result.InternalError (ステータスコード:500)
   ハンドラ側の内部処理に起因する未知の問題(バグやインフラレベルの障害など)
   によって異常終了したことを表す実行時例外。
   NullPointerException等の一般実行時例外/Errorと同等の扱いとなり、
   エラーハンドラにより障害ログの出力が行われる。
   
 3. Result.Unavailable (ステータスコード:503)
   システム側の処理受付が一時的に停止した状態であることを示す実行時例外。
   閉局エラーがこれに属する。システム閉局時の挙動は、各実行基盤ごとの
   運用設計に依存するものなので、各実行基盤ごとのエラーハンドラで個別に制御される。
   グローバルエラーハンドラまで到達した場合は、障害ログの出力が行われる。
 

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface nablarch.fw.Result

Result.ClientError, Result.Error, Result.MultiStatus, Result.NotFound, Result.Success

Constructor Summary

Constructors

Constructor and Description
Error() デフォルトコンストラクタ
Error(java.lang.String message) コンストラクタ
Error(java.lang.String message, java.lang.Throwable cause) コンストラクタ
Error(java.lang.Throwable cause) コンストラクタ

Method Summary

Modifier and Type	Method and Description
int	getStatusCode() ステータスコードを返す。
boolean	isSuccess() 処理が正常終了したかどうかを返す。
java.lang.String	toString() この実装では、以下の文字列を返す。

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Methods inherited from interface nablarch.fw.Result

getMessage

Constructor Detail

Error

public Error()

デフォルトコンストラクタ

Error

public Error(java.lang.String message)

コンストラクタ

Parameters:

message - エラーメッセージ

Error

public Error(java.lang.Throwable cause)

コンストラクタ

Parameters:

cause - 起因となる例外

Error

public Error(java.lang.String message,
             java.lang.Throwable cause)

コンストラクタ

Parameters:

message - エラーメッセージ

cause - 起因となる例外

Method Detail

getStatusCode

public int getStatusCode()

ステータスコードを返す。

Specified by:

getStatusCode in interface Result

Returns:

ステータスコード

toString

public java.lang.String toString()

この実装では、以下の文字列を返す。

   "[" + (ステータスコード) + (結果クラス名) + "]" + (メッセージ内容)
 

Overrides:

toString in class java.lang.Throwable

isSuccess

public boolean isSuccess()

処理が正常終了したかどうかを返す。 このクラスは異常結果を表すので、falseを返す。

Specified by:

isSuccess in interface Result

Returns:

正常終了した場合はtrue