Package com.persequor.extension.authentication

Class AuthenticationRequest

java.lang.Object
jakarta.servlet.ServletRequestWrapper
jakarta.servlet.http.HttpServletRequestWrapper
com.persequor.extension.authentication.AuthenticationRequest
All Implemented Interfaces:
IAuthenticationRequest, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.ServletRequest
public class AuthenticationRequest extends jakarta.servlet.http.HttpServletRequestWrapper implements IAuthenticationRequest

  • Field Summary

    Fields inherited from interface jakarta.servlet.http.HttpServletRequest

    BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

  • Constructor Summary

    Constructors
    Constructor
    Description
    AuthenticationRequest(jakarta.servlet.http.HttpServletRequest request)
    Constructs a request object wrapping the given request.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsParameter(String name)
    Returns a boolean indicating whether this request has a parameter with the specified name
    Optional<SagaLogin>
    getLoginCredentials()
    Returns the credentials entered into the standard Saga login form.
    void
    setLoginCredentials(SagaLogin sagaLogin)
     

    Methods inherited from class jakarta.servlet.http.HttpServletRequestWrapper

    authenticate, changeSessionId, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getHttpServletMapping, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getTrailerFields, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isTrailerFieldsReady, isUserInRole, login, logout, newPushBuilder, upgrade

    Methods inherited from class jakarta.servlet.ServletRequestWrapper

    getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getProtocolRequestId, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getRequestId, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setCharacterEncoding, setRequest, startAsync, startAsync

    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.IAuthenticationRequest

    getCookies, getHeader, getParameter

    Methods inherited from interface jakarta.servlet.ServletRequest

    getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getProtocolRequestId, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getRequestId, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

  • Constructor Details

    • AuthenticationRequest

      public AuthenticationRequest(jakarta.servlet.http.HttpServletRequest request)
      Constructs a request object wrapping the given request.
      Parameters:
      request - the HttpServletRequest to be wrapped.
      Throws:
      IllegalArgumentException - if the request is null

  • Method Details

    • getLoginCredentials

      public Optional<SagaLogin> getLoginCredentials()
      Description copied from interface: IAuthenticationRequest

      Returns the credentials entered into the standard Saga login form.

      This object contains the username and password used to login.

      If no login was performed, an Optional.empty() is returned instead

      Specified by:
      getLoginCredentials in interface IAuthenticationRequest
      Returns:
      the SagaLogin credentials object

    • containsParameter

      public boolean containsParameter(String name)
      Description copied from interface: IAuthenticationRequest
      Returns a boolean indicating whether this request has a parameter with the specified name
      Specified by:
      containsParameter in interface IAuthenticationRequest
      Returns:
      a boolean indicating if the request has the parameter name

    • setLoginCredentials

      public void setLoginCredentials(SagaLogin sagaLogin)