パッケージ org.springframework.web

クラス ErrorResponseException

java.lang.ObjectSE
java.lang.ThrowableSE
java.lang.ExceptionSE
java.lang.RuntimeExceptionSE
org.springframework.core.NestedRuntimeException
org.springframework.web.ErrorResponseException
実装されたすべてのインターフェース:
SerializableSE, ErrorResponse
既知の直属サブクラス
ResponseStatusException
public class ErrorResponseException extends NestedRuntimeException implements ErrorResponse
ErrorResponse を実装して、HTTP ステータス、レスポンスヘッダー、RFC 9457 ProblemDetail としてフォーマットされた本文を公開する RuntimeExceptionSE。

例外はそのまま使用することも、type または detail フィールドにデータを入力する、または他の非標準プロパティを潜在的に追加する、より具体的な例外として拡張することもできます。

導入:
6.0
作成者:
Rossen Stoyanchev
関連事項:

  • コンストラクターの詳細

  • メソッドの詳細

    • getStatusCode

      public HttpStatusCode getStatusCode()
      インターフェースからコピーされた説明: ErrorResponse
      レスポンスに使用する HTTP ステータスコードを返します。
      次で指定:
      インターフェース ErrorResponse の getStatusCode 

    • getHeaders

      public HttpHeaders getHeaders()
      インターフェースからコピーされた説明: ErrorResponse
      レスポンスに使用するヘッダーを返します。
      次で指定:
      インターフェース ErrorResponse の getHeaders 

    • setType

      public void setType(URISE type)
      レスポンスボディの type フィールドを設定します。
      パラメーター:
      type - 問題の種類

    • setTitle

      public void setTitle(@Nullable StringSE title)
      レスポンスボディの title フィールドを設定します。
      パラメーター:
      title - 問題のタイトル

    • setDetail

      public void setDetail(@Nullable StringSE detail)
      レスポンスボディの detail フィールドを設定します。
      パラメーター:
      detail - 問題の詳細

    • setInstance

      public void setInstance(@Nullable URISE instance)
      レスポンスボディの instance フィールドを設定します。
      パラメーター:
      instance - 問題のインスタンス

    • getBody

      public final ProblemDetail getBody()
      レスポンスのボディを返します。本文の内容をカスタマイズするには、次を使用します。

      デフォルトでは、ProblemDetail のステータスフィールドは、コンストラクターに提供されたステータスから初期化されます。コンストラクターは、ステータスがよく知られている場合、ステータス理由句からタイトルフィールドを初期化することもあります。インスタンスフィールドが設定されていない場合、ProblemDetail が @ExceptionHandler メソッドから返されたときに、リクエストパスから初期化されます。

      次で指定:
      インターフェース ErrorResponse の getBody 

    • getDetailMessageCode

      public StringSE getDetailMessageCode()
      インターフェースからコピーされた説明: ErrorResponse
      MessageSource を介して、この例外の問題「詳細」を解決するために使用するコードを返します。

      デフォルトでは、これは ErrorResponse.getDefaultDetailMessageCode(Class, String) によって初期化されます。

      次で指定:
      インターフェース ErrorResponse の getDetailMessageCode 

    • getDetailMessageArguments

      @Nullable public ObjectSE[] getDetailMessageArguments()
      インターフェースからコピーされた説明: ErrorResponse
      MessageSource を介してこの例外の問題「詳細」を解決するために message code と一緒に使用する引数を返します。引数は、メッセージ値のプレースホルダーに展開されます (例: 「無効なコンテンツ型 {0}」)。
      次で指定:
      インターフェース ErrorResponse の getDetailMessageArguments 

    • getMessage

      public StringSE getMessage()
      オーバーライド:
      クラス ThrowableSE の getMessage