クラス 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({HttpRequestMethodNotSupportedException.class,HttpMediaTypeNotSupportedException.class,HttpMediaTypeNotAcceptableException.class,MissingPathVariableException.class,MissingServletRequestParameterException.class,MissingServletRequestPartException.class,ServletRequestBindingException.class,MethodArgumentNotValidException.class,HandlerMethodValidationException.class,NoHandlerFoundException.class,NoResourceFoundException.class,AsyncRequestTimeoutException.class,ErrorResponseException.class,MaxUploadSizeExceededException.class,ConversionNotSupportedException.class,TypeMismatchException.class,HttpMessageNotReadableException.class,HttpMessageNotWritableException.class,MethodValidationException.class,AsyncRequestNotUsableException.class}) public final @Nullable ResponseEntity<ObjectSE> handleException(ExceptionSE ex, WebRequest request) throws ExceptionSE

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

  パラメーター:

  ex - 処理する例外

  request - 現在のリクエスト

  例外:

  ExceptionSE

• handleHttpRequestMethodNotSupported

  protected @Nullable ResponseEntity<ObjectSE> handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

  このメソッドは警告をログに記録し、handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest) に委譲します。

  パラメーター:

  ex - 処理する例外

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

• handleHttpMediaTypeNotSupported

  protected @Nullable ResponseEntity<ObjectSE> handleHttpMediaTypeNotSupported(HttpMediaTypeNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

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

  パラメーター:

  ex - 処理する例外

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

• handleHttpMediaTypeNotAcceptable

  protected @Nullable ResponseEntity<ObjectSE> handleHttpMediaTypeNotAcceptable(HttpMediaTypeNotAcceptableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

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

  パラメーター:

  ex - 処理する例外

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

• handleMissingPathVariable

  protected @Nullable ResponseEntity<ObjectSE> handleMissingPathVariable(MissingPathVariableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

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

  パラメーター:

  ex - 処理する例外

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

  導入:

  4.2

• handleMissingServletRequestParameter

  protected @Nullable ResponseEntity<ObjectSE> handleMissingServletRequestParameter(MissingServletRequestParameterException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

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

  パラメーター:

  ex - 処理する例外

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

• handleMissingServletRequestPart

  protected @Nullable ResponseEntity<ObjectSE> handleMissingServletRequestPart(MissingServletRequestPartException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

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

  パラメーター:

  ex - 処理する例外

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

• handleServletRequestBindingException

  protected @Nullable ResponseEntity<ObjectSE> handleServletRequestBindingException(ServletRequestBindingException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

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

  パラメーター:

  ex - 処理する例外

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

• handleMethodArgumentNotValid

  protected @Nullable ResponseEntity<ObjectSE> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

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

  パラメーター:

  ex - 処理する例外

  headers - レスポンスに書き込まれるヘッダー

  status - 選択したレスポンスステータス

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

• handleHandlerMethodValidationException

  protected @Nullable ResponseEntity<ObjectSE> handleHandlerMethodValidationException(HandlerMethodValidationException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

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

  パラメーター:

  ex - 処理する例外

  headers - レスポンスに書き込まれるヘッダー

  status - 選択したレスポンスステータス

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

  導入:

  6.1

• handleNoHandlerFoundException

  protected @Nullable ResponseEntity<ObjectSE> handleNoHandlerFoundException(NoHandlerFoundException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

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

  パラメーター:

  ex - 処理する例外

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

  導入:

  4.0

• handleNoResourceFoundException

  protected @Nullable ResponseEntity<ObjectSE> handleNoResourceFoundException(NoResourceFoundException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

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

  パラメーター:

  ex - 処理する例外

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

  導入:

  6.1

• handleAsyncRequestTimeoutException

  protected @Nullable ResponseEntity<ObjectSE> handleAsyncRequestTimeoutException(AsyncRequestTimeoutException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

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

  パラメーター:

  ex - 処理する例外

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

  導入:

  4.2.8

• handleErrorResponseException

  protected @Nullable ResponseEntity<ObjectSE> handleErrorResponseException(ErrorResponseException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

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

  パラメーター:

  ex - 処理する例外

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

  導入:

  6.0

• handleMaxUploadSizeExceededException

  protected @Nullable ResponseEntity<ObjectSE> handleMaxUploadSizeExceededException(MaxUploadSizeExceededException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

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

  パラメーター:

  ex - 処理する例外

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

  導入:

  6.1

• handleConversionNotSupported

  protected @Nullable ResponseEntity<ObjectSE> handleConversionNotSupported(ConversionNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

  デフォルトでは、このメソッドはステータスと短い詳細メッセージを含む ProblemDetail を作成し、handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest) に委譲する前に MessageSource を介して詳細のオーバーライドを検索します。

  パラメーター:

  ex - 処理する例外

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

• handleTypeMismatch

  protected @Nullable ResponseEntity<ObjectSE> handleTypeMismatch(TypeMismatchException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

  デフォルトでは、このメソッドはステータスと短い詳細メッセージを含む ProblemDetail を作成し、handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest) に委譲する前に、MessageSource を介して詳細のオーバーライドを検索します。

  パラメーター:

  ex - 処理する例外

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

• handleHttpMessageNotReadable

  protected @Nullable ResponseEntity<ObjectSE> handleHttpMessageNotReadable(HttpMessageNotReadableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

  デフォルトでは、このメソッドはステータスと短い詳細メッセージを含む ProblemDetail を作成し、handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest) に委譲する前に MessageSource を介して詳細のオーバーライドを検索します。

  パラメーター:

  ex - 処理する例外

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

• handleHttpMessageNotWritable

  protected @Nullable ResponseEntity<ObjectSE> handleHttpMessageNotWritable(HttpMessageNotWritableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

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

  デフォルトでは、このメソッドはステータスと短い詳細メッセージを含む ProblemDetail を作成し、handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest) に委譲する前に MessageSource を介して詳細のオーバーライドを検索します。

  パラメーター:

  ex - 処理する例外

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

• handleMethodValidationException

  protected @Nullable ResponseEntity<ObjectSE> handleMethodValidationException(MethodValidationException ex, HttpHeaders headers, HttpStatus status, WebRequest request)

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

  デフォルトでは、このメソッドはステータスと短い詳細メッセージを含む ProblemDetail を作成し、handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest) に委譲する前に MessageSource を介して詳細のオーバーライドを検索します。

  パラメーター:

  ex - 処理する例外

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

  導入:

  6.1

• handleAsyncRequestNotUsableException

  protected @Nullable ResponseEntity<ObjectSE> handleAsyncRequestNotUsableException(AsyncRequestNotUsableException ex, WebRequest request)

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

  デフォルトでは、レスポンスが使用できないため、null を返します。

  パラメーター:

  ex - 処理する例外

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

  導入:

  6.2

• createProblemDetail

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

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

  パラメーター:

  ex - 処理中の例外

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

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

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

  detailMessageArguments - detailMessageCode の議論

  request - 現在のリクエスト

  戻り値:

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

  導入:

  6.0

• handleExceptionInternal

  protected @Nullable ResponseEntity<ObjectSE> handleExceptionInternal(ExceptionSE ex, @Nullable ObjectSE body, HttpHeaders headers, HttpStatusCode statusCode, WebRequest request)

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

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

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

  パラメーター:

  ex - 処理する例外

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

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

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

  request - 現在のリクエスト

  戻り値:

  使用するレスポンスの ResponseEntity。レスポンスがすでにコミットされている場合は null の可能性があります

• createResponseEntity

  protected ResponseEntity<ObjectSE> createResponseEntity(@Nullable ObjectSE body, HttpHeaders headers, HttpStatusCode statusCode, WebRequest request)

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

  パラメーター:

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

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

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

  request - 現在のリクエスト

  戻り値:

  使用する ResponseEntity インスタンス

  導入:

  6.0