nablarch.fw.results

クラス ServiceError

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

nablarch.fw.Result.Error

nablarch.fw.results.ServiceError

すべての実装されたインタフェース:

Result

直系の既知のサブクラス:

InternalError, ServiceUnavailable

@Published(tag="architect")
public abstract class ServiceError
extends Result.Error

サービス側で生じた問題により処理が継続できないことを示す例外。

問題解決には、サービス側での対処が必要となるため、エラーメッセージの内容として、 呼び出し側が問題が発生したことをサービス管理者に連絡する方法と、 管理者に伝えるべき内容を含める必要がある。 また、メッセージIDを設定することにより、 運用ログへの出力に関する制御を行うことができる。

関連項目:

直列化された形式

ネストされたクラスのサマリー

インタフェースから継承されたネストされたクラス/インタフェース nablarch.fw.Result

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

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
ServiceError() デフォルトコンストラクタ
ServiceError(LogLevel logLevel, String messageId, Object... messageParams) 運用ログへの出力に関する制御情報を含む例外を生成する。
ServiceError(LogLevel logLevel, Throwable cause, String messageId, Object... messageParams) 運用ログへの出力に関する制御情報を含む例外を生成する。
ServiceError(String message) コンストラクタ
ServiceError(String message, Throwable cause) コンストラクタ
ServiceError(Throwable cause) コンストラクタ

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String	getMessage() 処理結果に関する詳細情報を返す。
String	getMessageId() メッセージIDを返す。
Object[]	getMessageParams() メッセージパラメータを返す。
int	getStatusCode() ステータスコードを返す。
void	writeLog(ExecutionContext context) この障害の内容について運用ログに出力する。

クラスから継承されたメソッド nablarch.fw.Result.Error

isSuccess, toString

コンストラクタの詳細

ServiceError

public ServiceError()

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

ServiceError

public ServiceError(String message)

コンストラクタ

パラメータ:

message - エラーメッセージ

ServiceError

public ServiceError(Throwable cause)

コンストラクタ

パラメータ:

cause - 起因となる例外

ServiceError

public ServiceError(String message,
                    Throwable cause)

コンストラクタ

パラメータ:

message - エラーメッセージ

cause - 起因となる例外

ServiceError

public ServiceError(LogLevel logLevel,
                    String messageId,
                    Object... messageParams)

運用ログへの出力に関する制御情報を含む例外を生成する。

パラメータ:

logLevel - ログ出力レベル

messageId - ログ内容のメッセージID

messageParams - ログメッセージの埋め込みパラメータ

ServiceError

public ServiceError(LogLevel logLevel,
                    Throwable cause,
                    String messageId,
                    Object... messageParams)

運用ログへの出力に関する制御情報を含む例外を生成する。

パラメータ:

logLevel - ログ出力レベル

cause - 障害の起因となる例外

messageId - ログ内容のメッセージID

messageParams - ログメッセージの埋め込みパラメータ

メソッドの詳細

getMessageId

public String getMessageId()

メッセージIDを返す。

戻り値:

メッセージID

getMessageParams

public Object[] getMessageParams()

メッセージパラメータを返す。

戻り値:

メッセージパラメータ

getMessage

public String getMessage()

処理結果に関する詳細情報を返す。

このインスタンスにメッセージIDが指定されている場合は、 そのIDに対応したメッセージ内容を返す。

定義:

getMessage インタフェース内 Result

オーバーライド:

getMessage クラス内 Throwable

戻り値:

詳細情報

writeLog

public void writeLog(ExecutionContext context)

この障害の内容について運用ログに出力する。

ログレベルがエラーレベル以上の場合に、障害内容を運用ログに出力する。 ワーニングレベル以下の場合は何もしない。

パラメータ:

context - 実行コンテキスト

getStatusCode

public int getStatusCode()

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

定義:

getStatusCode インタフェース内 Result

オーバーライド:

getStatusCode クラス内 Result.Error

戻り値:

ステータスコード