Interface WebApplicationExceptionWrapper<T extends jakarta.ws.rs.WebApplicationException>

All Known Implementing Classes:
ResteasyBadRequestException, ResteasyClientErrorException, ResteasyForbiddenException, ResteasyInternalServerErrorException, ResteasyNotAcceptableException, ResteasyNotAllowedException, ResteasyNotAuthorizedException, ResteasyNotFoundException, ResteasyNotSupportedException, ResteasyRedirectionException, ResteasyServerErrorException, ResteasyServiceUnavailableException, ResteasyWebApplicationException
public interface WebApplicationExceptionWrapper<T extends jakarta.ws.rs.WebApplicationException>
An interface which allows a WebApplicationException to be unwrapped.
Author:
James R. Perkins

  • Method Summary

    Modifier and Type
    Method
    Description
    static jakarta.ws.rs.core.Response
    sanitize(jakarta.ws.rs.core.Response response)
    Sanitizes the response by creating a new response with only the status code, allowed methods, entity and the media type.
    T
    unwrap()
    Returns the original, unwrapped, exception.
    static jakarta.ws.rs.WebApplicationException
    unwrap(jakarta.ws.rs.WebApplicationException e)
    Unwraps the exception if the passed in expression is a WebApplicationExceptionWrapper.
    static jakarta.ws.rs.WebApplicationException
    wrap(jakarta.ws.rs.WebApplicationException e)
    If the resteasy.original.webapplicationexception.behavior is set to true or the request is determined to not be a server side request, then the WebApplicationException passed in will be returned.

  • Method Details

    • wrap

      static jakarta.ws.rs.WebApplicationException wrap(jakarta.ws.rs.WebApplicationException e)
      If the resteasy.original.webapplicationexception.behavior is set to true or the request is determined to not be a server side request, then the WebApplicationException passed in will be returned. If the property is not set to true and this is a server side request then the exception is wrapped and the response is sanitized.
      Parameters:
      e - the exception to possibly wrapped
      Returns:
      the wrapped exception or the original exception if the exception has already been wrapped the the wrapping feature is turned off

    • unwrap

      static jakarta.ws.rs.WebApplicationException unwrap(jakarta.ws.rs.WebApplicationException e)
      Unwraps the exception if the passed in expression is a WebApplicationExceptionWrapper. Otherwise the exception passed in is returned.
      Parameters:
      e - the exception to unwrap
      Returns:
      the unwrapped exception or the exception parameter itself if it was not a WebApplicationExceptionWrapper

    • sanitize

      static jakarta.ws.rs.core.Response sanitize(jakarta.ws.rs.core.Response response)
      Sanitizes the response by creating a new response with only the status code, allowed methods, entity and the media type. All other information is removed.
      Parameters:
      response - the response to sanitize.
      Returns:
      the new response

    • unwrap

      T unwrap()
      Returns the original, unwrapped, exception.
      Returns:
      the original exception