Package org.forgerock.caf.authentication.framework

Interface ResponseWriter

public interface ResponseWriter
Writes AuthenticationException responses for different media types. Implementations should be thread-safe.
Since:
2.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    Collection<com.google.common.net.MediaType>
    handles()
    Which media types can this handler handle.
    String
    toString()
    A short but useful description of this response writer.
    void
    write(MessageContext context, AuthenticationException exception)
    Write the details of the exception out, and set the content type of the response.

  • Method Details

    • handles

      Collection<com.google.common.net.MediaType> handles()
      Which media types can this handler handle.
      Returns:
      A list of media types.

    • write

      void write(MessageContext context, AuthenticationException exception)
      Write the details of the exception out, and set the content type of the response.
      Parameters:
      context - The MessageContext containing the response to write the details to.
      exception - The AuthenticationException to be written.

    • toString

      String toString()
      A short but useful description of this response writer. Description should include the media type this response handler handles.
      Overrides:
      toString in class Object