クラス ResponseEntityExceptionHandler

メソッドの詳細

• setMessageSource

  public void setMessageSource(MessageSource messageSource)

  インターフェースからコピーされた説明: MessageSourceAware

  このオブジェクトが実行される MessageSource を設定します。

  通常の Bean プロパティの設定後、InitializingBean の afterPropertiesSet などの init コールバックやカスタム init メソッドの前に呼び出されます。ApplicationContextAware の setApplicationContext の前に呼び出されます。

  次で指定:

  インターフェース MessageSourceAware の setMessageSource 

  パラメーター:

  messageSource - このオブジェクトが使用するメッセージソース

• getMessageSource

  protected @Nullable MessageSource getMessageSource()

  この例外ハンドラーが使用する MessageSource を取得します。

  導入:

  6.0.3

• handleException

  @ExceptionHandler({MethodNotAllowedException.class,NotAcceptableStatusException.class,UnsupportedMediaTypeStatusException.class,MissingRequestValueException.class,UnsatisfiedRequestParameterException.class,WebExchangeBindException.class,HandlerMethodValidationException.class,ServerWebInputException.class,ServerErrorException.class,ResponseStatusException.class,ErrorResponseException.class,MethodValidationException.class}) public final Mono<ResponseEntity<ObjectSE>> handleException(ExceptionSE ex, ServerWebExchange exchange)

  リクエストの Spring または WebFlux 処理内で発生したすべての例外を処理します。

  パラメーター:

  ex - 処理する例外

  exchange - 現在のリクエストレスポンス

• handleMethodNotAllowedException

  protected Mono<ResponseEntity<ObjectSE>> handleMethodNotAllowedException(MethodNotAllowedException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)

  MethodNotAllowedException の処理をカスタマイズします。

  このメソッドは handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, ServerWebExchange) に委譲します。

  パラメーター:

  ex - 処理する例外

  headers - レスポンスに使用するヘッダー

  status - レスポンスに使用するステータスコード

  exchange - 現在のリクエストとレスポンス

  戻り値:

  レスポンス用の ResponseEntity を含む Mono 

• handleNotAcceptableStatusException

  protected Mono<ResponseEntity<ObjectSE>> handleNotAcceptableStatusException(NotAcceptableStatusException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)

  NotAcceptableStatusException の処理をカスタマイズします。

  このメソッドは handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, ServerWebExchange) に委譲します。

  パラメーター:

  ex - 処理する例外

  headers - レスポンスに使用するヘッダー

  status - レスポンスに使用するステータスコード

  exchange - 現在のリクエストとレスポンス

  戻り値:

  レスポンス用の ResponseEntity を含む Mono 

• handleUnsupportedMediaTypeStatusException

  protected Mono<ResponseEntity<ObjectSE>> handleUnsupportedMediaTypeStatusException(UnsupportedMediaTypeStatusException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)

  UnsupportedMediaTypeStatusException の処理をカスタマイズします。

  このメソッドは handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, ServerWebExchange) に委譲します。

  パラメーター:

  ex - 処理する例外

  headers - レスポンスに使用するヘッダー

  status - レスポンスに使用するステータスコード

  exchange - 現在のリクエストとレスポンス

  戻り値:

  レスポンス用の ResponseEntity を含む Mono 

• handleMissingRequestValueException

  protected Mono<ResponseEntity<ObjectSE>> handleMissingRequestValueException(MissingRequestValueException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)

  MissingRequestValueException の処理をカスタマイズします。

  このメソッドは handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, ServerWebExchange) に委譲します。

  パラメーター:

  ex - 処理する例外

  headers - レスポンスに使用するヘッダー

  status - レスポンスに使用するステータスコード

  exchange - 現在のリクエストとレスポンス

  戻り値:

  レスポンス用の ResponseEntity を含む Mono 

• handleUnsatisfiedRequestParameterException

  protected Mono<ResponseEntity<ObjectSE>> handleUnsatisfiedRequestParameterException(UnsatisfiedRequestParameterException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)

  UnsatisfiedRequestParameterException の処理をカスタマイズします。

  このメソッドは handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, ServerWebExchange) に委譲します。

  パラメーター:

  ex - 処理する例外

  headers - レスポンスに使用するヘッダー

  status - レスポンスに使用するステータスコード

  exchange - 現在のリクエストとレスポンス

  戻り値:

  レスポンス用の ResponseEntity を含む Mono 

• handleWebExchangeBindException

  protected Mono<ResponseEntity<ObjectSE>> handleWebExchangeBindException(WebExchangeBindException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)

  WebExchangeBindException の処理をカスタマイズします。

  このメソッドは handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, ServerWebExchange) に委譲します。

  パラメーター:

  ex - 処理する例外

  headers - レスポンスに使用するヘッダー

  status - レスポンスに使用するステータスコード

  exchange - 現在のリクエストとレスポンス

  戻り値:

  レスポンス用の ResponseEntity を含む Mono 

• handleHandlerMethodValidationException

  protected Mono<ResponseEntity<ObjectSE>> handleHandlerMethodValidationException(HandlerMethodValidationException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)

  HandlerMethodValidationException の処理をカスタマイズします。

  このメソッドは handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, ServerWebExchange) に委譲します。

  パラメーター:

  ex - 処理する例外

  headers - レスポンスに使用するヘッダー

  status - レスポンスに使用するステータスコード

  exchange - 現在のリクエストとレスポンス

  戻り値:

  レスポンス用の ResponseEntity を含む Mono 

  導入:

  6.1

• handleServerWebInputException

  protected Mono<ResponseEntity<ObjectSE>> handleServerWebInputException(ServerWebInputException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)

  ServerWebInputException の処理をカスタマイズします。

  このメソッドは handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, ServerWebExchange) に委譲します。

  パラメーター:

  ex - 処理する例外

  headers - レスポンスに使用するヘッダー

  status - レスポンスに使用するステータスコード

  exchange - 現在のリクエストとレスポンス

  戻り値:

  レスポンス用の ResponseEntity を含む Mono 

• handleResponseStatusException

  protected Mono<ResponseEntity<ObjectSE>> handleResponseStatusException(ResponseStatusException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)

  ResponseStatusException の処理をカスタマイズします。

  このメソッドは handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, ServerWebExchange) に委譲します。

  パラメーター:

  ex - 処理する例外

  headers - レスポンスに使用するヘッダー

  status - レスポンスに使用するステータスコード

  exchange - 現在のリクエストとレスポンス

  戻り値:

  レスポンス用の ResponseEntity を含む Mono 

• handleServerErrorException

  protected Mono<ResponseEntity<ObjectSE>> handleServerErrorException(ServerErrorException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)

  ServerErrorException の処理をカスタマイズします。

  このメソッドは handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, ServerWebExchange) に委譲します。

  パラメーター:

  ex - 処理する例外

  headers - レスポンスに使用するヘッダー

  status - レスポンスに使用するステータスコード

  exchange - 現在のリクエストとレスポンス

  戻り値:

  レスポンス用の ResponseEntity を含む Mono 

• handleErrorResponseException

  protected Mono<ResponseEntity<ObjectSE>> handleErrorResponseException(ErrorResponseException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)

  ErrorResponseException の処理をカスタマイズします。

  このメソッドは handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, ServerWebExchange) に委譲します。

  パラメーター:

  ex - 処理する例外

  headers - レスポンスに使用するヘッダー

  status - レスポンスに使用するステータスコード

  exchange - 現在のリクエストとレスポンス

  戻り値:

  レスポンス用の ResponseEntity を含む Mono 

• handleMethodValidationException

  protected Mono<ResponseEntity<ObjectSE>> handleMethodValidationException(MethodValidationException ex, HttpStatus status, ServerWebExchange exchange)

  MethodValidationException の処理をカスタマイズします。

  このメソッドは handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, ServerWebExchange) に委譲します。

  パラメーター:

  ex - 処理する例外

  status - レスポンスに使用するステータスコード

  exchange - 現在のリクエストとレスポンス

  戻り値:

  レスポンス用の ResponseEntity を含む Mono 

  導入:

  6.1

• createProblemDetail

  protected ProblemDetail createProblemDetail(ExceptionSE ex, HttpStatusCode status, StringSE defaultDetail, @Nullable StringSE detailMessageCode, ObjectSE @Nullable [] detailMessageArguments, ServerWebExchange exchange)

  ErrorResponse を実装していない例外に対して ProblemDetail を作成し、「詳細」フィールドの MessageSource ルックアップも実行する便利なメソッド。

  パラメーター:

  ex - 処理中の例外

  status - 例外に関連付けるステータス

  defaultDetail - 「詳細」フィールドのデフォルト値

  detailMessageCode - MessageSource を通じて「詳細」フィールドを検索するために使用するコード。null の場合、使用するデフォルトのメッセージコードを決定するために ErrorResponse.getDefaultDetailMessageCode(Class, String) が使用されます。

  detailMessageArguments - detailMessageCode の議論

  戻り値:

  作成された ProblemDetail インスタンス

• handleExceptionInternal

  protected Mono<ResponseEntity<ObjectSE>> handleExceptionInternal(ExceptionSE ex, @Nullable ObjectSE body, @Nullable HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)

  共通の処理と ResponseEntity の作成のために、このクラスの他のすべてが委譲する内部ハンドラーメソッド。

  デフォルトの実装では、次のことが行われます。

  • レスポンスがすでにコミットされている場合は null を返す
  • レスポンスステータスが 500 (INTERNAL_SERVER_ERROR) の場合は、"jakarta.servlet.error.exception" リクエスト属性を設定します。
  • body が null の場合、ErrorResponse 例外から body を抽出します。

  パラメーター:

  ex - 処理する例外

  body - レスポンスに使用するボディ

  headers - レスポンスに使用するヘッダー

  status - レスポンスに使用するステータスコード

  exchange - 現在のリクエストとレスポンス

  戻り値:

  レスポンス用の ResponseEntity を含む Mono 

• createResponseEntity

  protected Mono<ResponseEntity<ObjectSE>> createResponseEntity(@Nullable ObjectSE body, @Nullable HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)

  指定された本文、ヘッダー、statusCode から使用する ResponseEntity を作成します。サブクラスはこのメソッドをオーバーライドして、本文、ヘッダー、statusCode をインスペクションし、必要に応じて変更して、たとえば、ProblemDetail のインスタンスを ProblemDetail の拡張として再作成することができます。

  パラメーター:

  body - レスポンスに使用するボディ

  headers - レスポンスに使用するヘッダー

  status - レスポンスに使用するステータスコード

  exchange - 現在のリクエストとレスポンス

  戻り値:

  作成された ResponseEntity を持つ Mono 

  導入:

  6.0