Package nablarch.fw.results
Class ServiceError
java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
nablarch.fw.Result.Error
nablarch.fw.results.ServiceError
- All Implemented Interfaces:
Serializable
,Result
- Direct Known Subclasses:
InternalError
,ServiceUnavailable
サービス側で生じた問題により処理が継続できないことを示す例外。
問題解決には、サービス側での対処が必要となるため、エラーメッセージの内容として、
呼び出し側が問題が発生したことをサービス管理者に連絡する方法と、
管理者に伝えるべき内容を含める必要がある。
また、メッセージIDを設定することにより、
運用ログへの出力に関する制御を行うことができる。
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface nablarch.fw.Result
Result.ClientError, Result.Error, Result.MultiStatus, Result.NotFound, Result.Success
-
Constructor Summary
ConstructorDescriptionデフォルトコンストラクタServiceError
(String message) コンストラクタServiceError
(String message, Throwable cause) コンストラクタServiceError
(Throwable cause) コンストラクタServiceError
(LogLevel logLevel, String messageId, Object... messageParams) 運用ログへの出力に関する制御情報を含む例外を生成する。ServiceError
(LogLevel logLevel, Throwable cause, String messageId, Object... messageParams) 運用ログへの出力に関する制御情報を含む例外を生成する。 -
Method Summary
Modifier and TypeMethodDescription処理結果に関する詳細情報を返す。メッセージIDを返す。Object[]
メッセージパラメータを返す。int
ステータスコードを返す。void
writeLog
(ExecutionContext context) この障害の内容について運用ログに出力する。Methods inherited from class nablarch.fw.Result.Error
isSuccess, toString
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
-
Constructor Details
-
ServiceError
public ServiceError()デフォルトコンストラクタ -
ServiceError
コンストラクタ- Parameters:
message
- エラーメッセージ
-
ServiceError
コンストラクタ- Parameters:
cause
- 起因となる例外
-
ServiceError
コンストラクタ- Parameters:
message
- エラーメッセージcause
- 起因となる例外
-
ServiceError
運用ログへの出力に関する制御情報を含む例外を生成する。- Parameters:
logLevel
- ログ出力レベルmessageId
- ログ内容のメッセージIDmessageParams
- ログメッセージの埋め込みパラメータ
-
ServiceError
運用ログへの出力に関する制御情報を含む例外を生成する。- Parameters:
logLevel
- ログ出力レベルcause
- 障害の起因となる例外messageId
- ログ内容のメッセージIDmessageParams
- ログメッセージの埋め込みパラメータ
-
-
Method Details
-
getMessageId
メッセージIDを返す。- Returns:
- メッセージID
-
getMessageParams
メッセージパラメータを返す。- Returns:
- メッセージパラメータ
-
getMessage
処理結果に関する詳細情報を返す。 このインスタンスにメッセージIDが指定されている場合は、 そのIDに対応したメッセージ内容を返す。- Specified by:
getMessage
in interfaceResult
- Overrides:
getMessage
in classThrowable
- Returns:
- 詳細情報
-
writeLog
この障害の内容について運用ログに出力する。 ログレベルがエラーレベル以上の場合に、障害内容を運用ログに出力する。 ワーニングレベル以下の場合は何もしない。- Parameters:
context
- 実行コンテキスト
-
getStatusCode
public int getStatusCode()ステータスコードを返す。- Specified by:
getStatusCode
in interfaceResult
- Overrides:
getStatusCode
in classResult.Error
- Returns:
- ステータスコード
-