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
@Published(tag="architect") public abstract class ServiceError extends Result.Error
サービス側で生じた問題により処理が継続できないことを示す例外。

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

See Also:

  • Constructor Details

    • ServiceError

      public ServiceError()
      デフォルトコンストラクタ

    • ServiceError

      public ServiceError(String message)
      コンストラクタ
      Parameters:
      message - エラーメッセージ

    • ServiceError

      public ServiceError(Throwable cause)
      コンストラクタ
      Parameters:
      cause - 起因となる例外

    • ServiceError

      public ServiceError(String message, Throwable cause)
      コンストラクタ
      Parameters:
      message - エラーメッセージ
      cause - 起因となる例外

    • ServiceError

      public ServiceError(LogLevel logLevel, String messageId, Object... messageParams)
      運用ログへの出力に関する制御情報を含む例外を生成する。
      Parameters:
      logLevel - ログ出力レベル
      messageId - ログ内容のメッセージID
      messageParams - ログメッセージの埋め込みパラメータ

    • ServiceError

      public ServiceError(LogLevel logLevel, Throwable cause, String messageId, Object... messageParams)
      運用ログへの出力に関する制御情報を含む例外を生成する。
      Parameters:
      logLevel - ログ出力レベル
      cause - 障害の起因となる例外
      messageId - ログ内容のメッセージID
      messageParams - ログメッセージの埋め込みパラメータ

  • Method Details

    • getMessageId

      public String getMessageId()
      メッセージIDを返す。
      Returns:
      メッセージID

    • getMessageParams

      public Object[] getMessageParams()
      メッセージパラメータを返す。
      Returns:
      メッセージパラメータ

    • getMessage

      public String getMessage()
      処理結果に関する詳細情報を返す。

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

      Specified by:
      getMessage in interface Result
      Overrides:
      getMessage in class Throwable
      Returns:
      詳細情報

    • writeLog

      public void writeLog(ExecutionContext context)
      この障害の内容について運用ログに出力する。

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

      Parameters:
      context - 実行コンテキスト

    • getStatusCode

      public int getStatusCode()
      ステータスコードを返す。
      Specified by:
      getStatusCode in interface Result
      Overrides:
      getStatusCode in class Result.Error
      Returns:
      ステータスコード