Interface IAuthenticationResponse

All Known Implementing Classes:
AuthenticationResponse

public interface IAuthenticationResponse
Defines an object to provide information of the authentication response.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addCookie(jakarta.servlet.http.Cookie cookie)
    Implementation of HttpServletResponse.addCookie(Cookie cookie).
    void
    Redirects Saga UI to the given location specified as input.
    Implementation of HttpServletResponse.getHeader().
    void
    sendRedirect(String location)
    Implementation of HttpServletResponse.sendRedirect().
    void
    Changes Saga UI error message for the one specified as input.
    void
    setHeader(String name, String value)
    Implementation of HttpServletResponse.setHeader(String name, String value).
  • Method Details

    • browserRedirect

      void browserRedirect(String location)
      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.

      Parameters:
      location - the redirect location URL
    • setErrorMessage

      void setErrorMessage(String message)
      Changes Saga UI error message for the one specified as input.
      Parameters:
      message - the error message to be displayed on Saga UI
    • sendRedirect

      void sendRedirect(String location) throws IOException

      Implementation of HttpServletResponse.sendRedirect().

      Throws:
      IOException
      See Also:
      • HttpServletResponse.sendRedirect(String location)
    • addCookie

      void addCookie(jakarta.servlet.http.Cookie cookie)

      Implementation of HttpServletResponse.addCookie(Cookie cookie).

      See Also:
      • HttpServletResponse.addCookie(Cookie cookie)
    • setHeader

      void setHeader(String name, String value)

      Implementation of HttpServletResponse.setHeader(String name, String value).

      See Also:
      • HttpServletResponse.setHeader(String name, String value)
    • getHeader

      String getHeader(String name)

      Implementation of HttpServletResponse.getHeader().

      See Also:
      • HttpServletResponse.getHeader(String name)