Package com.persequor.extension.authentication

Class AuthenticationResponse

java.lang.Object
jakarta.servlet.ServletResponseWrapper
jakarta.servlet.http.HttpServletResponseWrapper
com.persequor.extension.authentication.AuthenticationResponse
All Implemented Interfaces:
IAuthenticationResponse, jakarta.servlet.http.HttpServletResponse, jakarta.servlet.ServletResponse
public class AuthenticationResponse extends jakarta.servlet.http.HttpServletResponseWrapper implements IAuthenticationResponse

  • Field Summary

    Fields inherited from interface jakarta.servlet.http.HttpServletResponse

    SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

  • Constructor Summary

    Constructors
    Constructor
    Description
    AuthenticationResponse(jakarta.servlet.http.HttpServletResponse response)
    Constructs a response adaptor wrapping the given response.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    browserRedirect(String location)
    Redirects Saga UI to the given location specified as input.
    void
    setErrorMessage(String message)
    Changes Saga UI error message for the one specified as input.

    Methods inherited from class jakarta.servlet.http.HttpServletResponseWrapper

    addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectURL, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, getTrailerFields, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setTrailerFields

    Methods inherited from class jakarta.servlet.ServletResponseWrapper

    flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale, setResponse

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.persequor.extension.authentication.IAuthenticationResponse

    addCookie, getHeader, sendRedirect, setHeader

    Methods inherited from interface jakarta.servlet.ServletResponse

    flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale

  • Constructor Details

    • AuthenticationResponse

      public AuthenticationResponse(jakarta.servlet.http.HttpServletResponse response)
      Constructs a response adaptor wrapping the given response.
      Parameters:
      response - the HttpServletResponse to be wrapped.
      Throws:
      IllegalArgumentException - if the response is null

  • Method Details

    • browserRedirect

      public void browserRedirect(String location)
      Description copied from interface: IAuthenticationResponse
      Redirects Saga UI to the given location specified as input.

      The response status code is not going to be set by this method.

      This method can accept relative URLs.

      Specified by:
      browserRedirect in interface IAuthenticationResponse
      Parameters:
      location - the redirect location URL

    • setErrorMessage

      public void setErrorMessage(String message)
      Description copied from interface: IAuthenticationResponse
      Changes Saga UI error message for the one specified as input.
      Specified by:
      setErrorMessage in interface IAuthenticationResponse
      Parameters:
      message - the error message to be displayed on Saga UI