Package org.forgerock.http.protocol

Class Responses

java.lang.Object
org.forgerock.http.protocol.Responses
public final class Responses extends Object
Provide out-of-the-box, pre-configured Response objects.

  • Method Details

    • newInternalServerError

      public static Response newInternalServerError()
      Generates an empty Internal Server Error response (500).
      Returns:
      an empty Internal Server Error response (500).

    • newInternalServerError

      public static Response newInternalServerError(Exception exception)
      Generates an Internal Server Error response (500) containing the cause of the error response.
      Parameters:
      exception - wrapped exception
      Returns:
      an empty Internal Server Error response 500 with the cause set.

    • newNotFound

      public static Response newNotFound()
      Generates an empty Not Found response (404).
      Returns:
      an empty Not Found response (404).

    • newForbidden

      public static Response newForbidden()
      Generates an empty Forbidden response (403).
      Returns:
      an empty Forbidden response (403).

    • noopExceptionFunction

      public static <V, E extends Exception> Function<NeverThrowsException,V,E> noopExceptionFunction()
      Utility method returning an empty function, whose goal is to ease the transformation of a Promise type. Its main usage will be as the second argument in Promise.then(Function, Function). The implementation of this function is just to return null : as its name suggests it, an Exception of type NeverThrowsException will never be thrown.
      Type Parameters:
      V - The expected type of that function
      E - The new Exception that can be thrown by this function.
      Returns:
      a function that will return null and not throw any Exception.

    • noopExceptionAsyncFunction

      public static <V, E extends Exception> AsyncFunction<NeverThrowsException,V,E> noopExceptionAsyncFunction()
      Utility method returning an empty async function, whose goal is to ease the transformation of a Promise type.

      Its main usage will be as the exception handling function in Promise.thenAsync(AsyncFunction, AsyncFunction).

      The implementation of this function is throwing an IllegalStateException: as its name suggests, an Exception of type NeverThrowsException can never be thrown anyway.

      Type Parameters:
      V - The expected type of that async function
      E - The new Exception type that can be thrown by this function.
      Returns:
      an async function that will complete with an IllegalStateException if invoked (should never happen).

    • onExceptionInternalServerError

      public static <E extends Exception> Function<E,Response,NeverThrowsException> onExceptionInternalServerError()
      Utility function that returns a Response whose status is Status.INTERNAL_SERVER_ERROR and the exception attached to the response as the cause.
      Type Parameters:
      E - The type of the incoming exception
      Returns:
      Response whose status is Status.INTERNAL_SERVER_ERROR and the exception attached to the response as the cause.

    • internalServerError

      public static <E extends Exception> AsyncFunction<E,Response,NeverThrowsException> internalServerError()
      Utility method returning an async function that creates a Response with status Status.INTERNAL_SERVER_ERROR and the exception set as the cause.
      Type Parameters:
      E - The type of the incoming Exception
      Returns:
      an async function that creates a Response with status Status.INTERNAL_SERVER_ERROR and the exception set as the cause.