org.springframework.mock.web

Class MockHttpServletRequest

  • java.lang.Object
    • org.springframework.mock.web.MockHttpServletRequest
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method and Description
      void addHeader(java.lang.String name, java.lang.Object value)
      Add a header entry for the given name.
      void addParameter(java.lang.String name, java.lang.String... values)
      Add an array of values for the specified HTTP parameter.
      void addParameter(java.lang.String name, java.lang.String value)
      Add a single value for the specified HTTP parameter.
      void addParameters(java.util.Map<java.lang.String,?> params)
      Adds all provided parameters without replacing any existing values.
      void addPart(Part part) 
      void addPreferredLocale(java.util.Locale locale)
      Add a new preferred locale, before any existing locales.
      void addUserRole(java.lang.String role) 
      boolean authenticate(HttpServletResponse response)
      Use the container login mechanism configured for the ServletContext to authenticate the user making this request.
      java.lang.String changeSessionId()
      The implementation of this (Servlet 3.1+) method calls MockHttpSession.changeSessionId() if the session is a mock session.
      protected void checkActive()
      Check whether this request is still active (that is, not completed yet), throwing an IllegalStateException if not active anymore.
      void clearAttributes()
      Clear all of this request's attributes.
      void close()
      Mark this request as completed, keeping its state.
      AsyncContext getAsyncContext()
      Gets the AsyncContext that was created or reinitialized by the most recent invocation of ServletRequest.startAsync() or ServletRequest.startAsync(ServletRequest,ServletResponse) on this request.
      java.lang.Object getAttribute(java.lang.String name)
      Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
      java.util.Enumeration<java.lang.String> getAttributeNames()
      Returns an Enumeration containing the names of the attributes available to this request.
      java.lang.String getAuthType()
      Returns the name of the authentication scheme used to protect the servlet.
      java.lang.String getCharacterEncoding()
      Returns the name of the character encoding used in the body of this request.
      byte[] getContentAsByteArray()
      Get the content of the request body as a byte array.
      java.lang.String getContentAsString()
      Get the content of the request body as a String, using the configured character encoding.
      int getContentLength()
      Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known ir is greater than Integer.MAX_VALUE.
      long getContentLengthLong()
      Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.
      java.lang.String getContentType()
      Returns the MIME type of the body of the request, or null if the type is not known.
      java.lang.String getContextPath()
      Returns the portion of the request URI that indicates the context of the request.
      Cookie[] getCookies()
      Returns an array containing all of the Cookie objects the client sent with this request.
      long getDateHeader(java.lang.String name)
      Return the long timestamp for the date header with the given name.
      DispatcherType getDispatcherType()
      Gets the dispatcher type of this request.
      java.lang.String getHeader(java.lang.String name)
      Returns the value of the specified request header as a String.
      java.util.Enumeration<java.lang.String> getHeaderNames()
      Returns an enumeration of all the header names this request contains.
      java.util.Enumeration<java.lang.String> getHeaders(java.lang.String name)
      Returns all the values of the specified request header as an Enumeration of String objects.
      ServletInputStream getInputStream()
      Retrieves the body of the request as binary data using a ServletInputStream.
      int getIntHeader(java.lang.String name)
      Returns the value of the specified request header as an int.
      java.lang.String getLocalAddr()
      Returns the Internet Protocol (IP) address of the interface on which the request was received.
      java.util.Locale getLocale()
      Return the first preferred locale configured in this mock request.
      java.util.Enumeration<java.util.Locale> getLocales()
      Return an enumeration of the preferred locales configured in this mock request.
      java.lang.String getLocalName()
      Returns the host name of the Internet Protocol (IP) interface on which the request was received.
      int getLocalPort()
      Returns the Internet Protocol (IP) port number of the interface on which the request was received.
      java.lang.String getMethod()
      Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
      java.lang.String getParameter(java.lang.String name)
      Returns the value of a request parameter as a String, or null if the parameter does not exist.
      java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
      Returns a java.util.Map of the parameters of this request.
      java.util.Enumeration<java.lang.String> getParameterNames()
      Returns an Enumeration of String objects containing the names of the parameters contained in this request.
      java.lang.String[] getParameterValues(java.lang.String name)
      Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.
      Part getPart(java.lang.String name)
      Gets the Part with the given name.
      java.util.Collection<Part> getParts()
      Gets all the Part components of this request, provided that it is of type multipart/form-data.
      java.lang.String getPathInfo()
      Returns any extra path information associated with the URL the client sent when it made this request.
      java.lang.String getPathTranslated()
      Returns any extra path information after the servlet name but before the query string, and translates it to a real path.
      java.lang.String getProtocol()
      Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.
      java.lang.String getQueryString()
      Returns the query string that is contained in the request URL after the path.
      java.io.BufferedReader getReader()
      Retrieves the body of the request as character data using a BufferedReader.
      java.lang.String getRealPath(java.lang.String path)
      Deprecated. 
      java.lang.String getRemoteAddr()
      Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
      java.lang.String getRemoteHost()
      Returns the fully qualified name of the client or the last proxy that sent the request.
      int getRemotePort()
      Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
      java.lang.String getRemoteUser()
      Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.
      RequestDispatcher getRequestDispatcher(java.lang.String path)
      Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path.
      java.lang.String getRequestedSessionId()
      Returns the session ID specified by the client.
      java.lang.String getRequestURI()
      Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
      java.lang.StringBuffer getRequestURL()
      Reconstructs the URL the client used to make the request.
      java.lang.String getScheme()
      Returns the name of the scheme used to make this request, for example, http, https, or ftp.
      java.lang.String getServerName()
      Returns the host name of the server to which the request was sent.
      int getServerPort()
      Returns the port number to which the request was sent.
      ServletContext getServletContext()
      Return the ServletContext that this request is associated with.
      java.lang.String getServletPath()
      Returns the part of this request's URL that calls the servlet.
      HttpSession getSession()
      Returns the current session associated with this request, or if the request does not have a session, creates one.
      HttpSession getSession(boolean create)
      Returns the current HttpSession associated with this request or, if there is no current session and create is true, returns a new session.
      java.security.Principal getUserPrincipal()
      Returns a java.security.Principal object containing the name of the current authenticated user.
      void invalidate()
      Invalidate this request, clearing its state.
      boolean isActive()
      Return whether this request is still active (that is, not completed yet).
      boolean isAsyncStarted()
      Checks if this request has been put into asynchronous mode.
      boolean isAsyncSupported()
      Checks if this request supports asynchronous operation.
      boolean isRequestedSessionIdFromCookie()
      Checks whether the requested session ID was conveyed to the server as an HTTP cookie.
      boolean isRequestedSessionIdFromUrl()
      Deprecated. 
      boolean isRequestedSessionIdFromURL()
      Checks whether the requested session ID was conveyed to the server as part of the request URL.
      boolean isRequestedSessionIdValid()
      Checks whether the requested session ID is still valid.
      boolean isSecure()
      Return true if the secure flag has been set to true or if the scheme is https.
      boolean isUserInRole(java.lang.String role)
      Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
      void login(java.lang.String username, java.lang.String password)
      Validate the provided username and password in the password validation realm used by the web container login mechanism configured for the ServletContext.
      void logout()
      Establish null as the value returned when getUserPrincipal, getRemoteUser, and getAuthType is called on the request.
      void removeAllParameters()
      Removes all existing parameters.
      void removeAttribute(java.lang.String name)
      Removes an attribute from this request.
      void removeParameter(java.lang.String name)
      Remove already registered values for the specified HTTP parameter, if any.
      void setAsyncContext(MockAsyncContext asyncContext) 
      void setAsyncStarted(boolean asyncStarted) 
      void setAsyncSupported(boolean asyncSupported) 
      void setAttribute(java.lang.String name, java.lang.Object value)
      Stores an attribute in this request.
      void setAuthType(java.lang.String authType) 
      void setCharacterEncoding(java.lang.String characterEncoding)
      Overrides the name of the character encoding used in the body of this request.
      void setContent(byte[] content)
      Set the content of the request body as a byte array.
      void setContentType(java.lang.String contentType) 
      void setContextPath(java.lang.String contextPath) 
      void setCookies(Cookie... cookies) 
      void setDispatcherType(DispatcherType dispatcherType) 
      void setLocalAddr(java.lang.String localAddr) 
      void setLocalName(java.lang.String localName) 
      void setLocalPort(int localPort) 
      void setMethod(java.lang.String method) 
      void setParameter(java.lang.String name, java.lang.String... values)
      Set an array of values for the specified HTTP parameter.
      void setParameter(java.lang.String name, java.lang.String value)
      Set a single value for the specified HTTP parameter.
      void setParameters(java.util.Map<java.lang.String,?> params)
      Set all provided parameters replacing any existing values for the provided parameter names.
      void setPathInfo(java.lang.String pathInfo) 
      void setPreferredLocales(java.util.List<java.util.Locale> locales)
      Set the list of preferred locales, in descending order, effectively replacing any existing locales.
      void setProtocol(java.lang.String protocol) 
      void setQueryString(java.lang.String queryString) 
      void setRemoteAddr(java.lang.String remoteAddr) 
      void setRemoteHost(java.lang.String remoteHost) 
      void setRemotePort(int remotePort) 
      void setRemoteUser(java.lang.String remoteUser) 
      void setRequestedSessionId(java.lang.String requestedSessionId) 
      void setRequestedSessionIdFromCookie(boolean requestedSessionIdFromCookie) 
      void setRequestedSessionIdFromURL(boolean requestedSessionIdFromURL) 
      void setRequestedSessionIdValid(boolean requestedSessionIdValid) 
      void setRequestURI(java.lang.String requestURI) 
      void setScheme(java.lang.String scheme) 
      void setSecure(boolean secure)
      Set the boolean secure flag indicating whether the mock request was made using a secure channel, such as HTTPS.
      void setServerName(java.lang.String serverName) 
      void setServerPort(int serverPort) 
      void setServletPath(java.lang.String servletPath) 
      void setSession(HttpSession session) 
      void setUserPrincipal(java.security.Principal userPrincipal) 
      AsyncContext startAsync()
      Puts this request into asynchronous mode, and initializes its AsyncContext with the original (unwrapped) ServletRequest and ServletResponse objects.
      AsyncContext startAsync(ServletRequest request, ServletResponse response)
      Puts this request into asynchronous mode, and initializes its AsyncContext with the given request and response objects.
      <T extends HttpUpgradeHandler>
      T
      upgrade(java.lang.Class<T> handlerClass)
      Creates an instance of HttpUpgradeHandler for a given class and uses it for the http protocol upgrade processing.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • DEFAULT_PROTOCOL

        public static final java.lang.String DEFAULT_PROTOCOL
        The default protocol: 'HTTP/1.1'.
        Since:
        4.3.7
        See Also:
        Constant Field Values
      • DEFAULT_SCHEME

        public static final java.lang.String DEFAULT_SCHEME
        The default scheme: 'http'.
        Since:
        4.3.7
        See Also:
        Constant Field Values
      • DEFAULT_SERVER_ADDR

        public static final java.lang.String DEFAULT_SERVER_ADDR
        The default server address: '127.0.0.1'.
        See Also:
        Constant Field Values
      • DEFAULT_SERVER_NAME

        public static final java.lang.String DEFAULT_SERVER_NAME
        The default server name: 'localhost'.
        See Also:
        Constant Field Values
      • DEFAULT_SERVER_PORT

        public static final int DEFAULT_SERVER_PORT
        The default server port: '80'.
        See Also:
        Constant Field Values
      • DEFAULT_REMOTE_ADDR

        public static final java.lang.String DEFAULT_REMOTE_ADDR
        The default remote address: '127.0.0.1'.
        See Also:
        Constant Field Values
      • DEFAULT_REMOTE_HOST

        public static final java.lang.String DEFAULT_REMOTE_HOST
        The default remote host: 'localhost'.
        See Also:
        Constant Field Values
    • Method Detail

      • getServletContext

        public ServletContext getServletContext()
        Return the ServletContext that this request is associated with. (Not available in the standard HttpServletRequest interface for some reason.)
        Specified by:
        getServletContext in interface ServletRequest
        Returns:
        the servlet context to which this ServletRequest was last dispatched
      • isActive

        public boolean isActive()
        Return whether this request is still active (that is, not completed yet).
      • close

        public void close()
        Mark this request as completed, keeping its state.
      • invalidate

        public void invalidate()
        Invalidate this request, clearing its state.
      • checkActive

        protected void checkActive()
                            throws java.lang.IllegalStateException
        Check whether this request is still active (that is, not completed yet), throwing an IllegalStateException if not active anymore.
        Throws:
        java.lang.IllegalStateException
      • getAttribute

        public java.lang.Object getAttribute(java.lang.String name)
        Description copied from interface: javax.servlet.ServletRequest
        Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.

        Attributes can be set two ways. The servlet container may set attributes to make available custom information about a request. For example, for requests made using HTTPS, the attribute javax.servlet.request.X509Certificate can be used to retrieve information on the certificate of the client. Attributes can also be set programatically using ServletRequest.setAttribute(java.lang.String, java.lang.Object). This allows information to be embedded into a request before a RequestDispatcher call.

        Attribute names should follow the same conventions as package names. This specification reserves names matching java.*, javax.*, and sun.*.

        Specified by:
        getAttribute in interface ServletRequest
        Parameters:
        name - a String specifying the name of the attribute
        Returns:
        an Object containing the value of the attribute, or null if the attribute does not exist
      • getAttributeNames

        public java.util.Enumeration<java.lang.String> getAttributeNames()
        Description copied from interface: javax.servlet.ServletRequest
        Returns an Enumeration containing the names of the attributes available to this request. This method returns an empty Enumeration if the request has no attributes available to it.
        Specified by:
        getAttributeNames in interface ServletRequest
        Returns:
        an Enumeration of strings containing the names of the request's attributes
      • getCharacterEncoding

        @Nullable
        public java.lang.String getCharacterEncoding()
        Description copied from interface: javax.servlet.ServletRequest
        Returns the name of the character encoding used in the body of this request. This method returns null if no request encoding character encoding has been specified. The following methods for specifying the request character encoding are consulted, in decreasing order of priority: per request, per web app (using ServletContext.setRequestCharacterEncoding(java.lang.String), deployment descriptor), and per container (for all web applications deployed in that container, using vendor specific configuration).
        Specified by:
        getCharacterEncoding in interface ServletRequest
        Returns:
        a String containing the name of the character encoding, or null if the request does not specify a character encoding
      • setCharacterEncoding

        public void setCharacterEncoding(@Nullable
                                         java.lang.String characterEncoding)
        Description copied from interface: javax.servlet.ServletRequest
        Overrides the name of the character encoding used in the body of this request. This method must be called prior to reading request parameters or reading input using getReader(). Otherwise, it has no effect.
        Specified by:
        setCharacterEncoding in interface ServletRequest
        Parameters:
        characterEncoding - String containing the name of the character encoding.
      • getContentAsByteArray

        @Nullable
        public byte[] getContentAsByteArray()
        Get the content of the request body as a byte array.
        Returns:
        the content as a byte array (potentially null)
        Since:
        5.0
        See Also:
        setContent(byte[]), getContentAsString()
      • getContentAsString

        @Nullable
        public java.lang.String getContentAsString()
                                                      throws java.lang.IllegalStateException,
                                                             java.io.UnsupportedEncodingException
        Get the content of the request body as a String, using the configured character encoding.
        Returns:
        the content as a String, potentially null
        Throws:
        java.lang.IllegalStateException - if the character encoding has not been set
        java.io.UnsupportedEncodingException - if the character encoding is not supported
        Since:
        5.0
        See Also:
        setContent(byte[]), setCharacterEncoding(String), getContentAsByteArray()
      • getContentLength

        public int getContentLength()
        Description copied from interface: javax.servlet.ServletRequest
        Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known ir is greater than Integer.MAX_VALUE. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.
        Specified by:
        getContentLength in interface ServletRequest
        Returns:
        an integer containing the length of the request body or -1 if the length is not known or is greater than Integer.MAX_VALUE.
      • getContentLengthLong

        public long getContentLengthLong()
        Description copied from interface: javax.servlet.ServletRequest
        Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.
        Specified by:
        getContentLengthLong in interface ServletRequest
        Returns:
        a long containing the length of the request body or -1L if the length is not known
      • setContentType

        public void setContentType(@Nullable
                                   java.lang.String contentType)
      • getContentType

        @Nullable
        public java.lang.String getContentType()
        Description copied from interface: javax.servlet.ServletRequest
        Returns the MIME type of the body of the request, or null if the type is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE.
        Specified by:
        getContentType in interface ServletRequest
        Returns:
        a String containing the name of the MIME type of the request, or null if the type is not known
      • setParameter

        public void setParameter(java.lang.String name,
                                 java.lang.String value)
        Set a single value for the specified HTTP parameter.

        If there are already one or more values registered for the given parameter name, they will be replaced.

      • setParameter

        public void setParameter(java.lang.String name,
                                 java.lang.String... values)
        Set an array of values for the specified HTTP parameter.

        If there are already one or more values registered for the given parameter name, they will be replaced.

      • setParameters

        public void setParameters(java.util.Map<java.lang.String,?> params)
        Set all provided parameters replacing any existing values for the provided parameter names. To add without replacing existing values, use addParameters(java.util.Map).
      • addParameter

        public void addParameter(java.lang.String name,
                                 @Nullable
                                 java.lang.String value)
        Add a single value for the specified HTTP parameter.

        If there are already one or more values registered for the given parameter name, the given value will be added to the end of the list.

      • addParameter

        public void addParameter(java.lang.String name,
                                 java.lang.String... values)
        Add an array of values for the specified HTTP parameter.

        If there are already one or more values registered for the given parameter name, the given values will be added to the end of the list.

      • addParameters

        public void addParameters(java.util.Map<java.lang.String,?> params)
        Adds all provided parameters without replacing any existing values. To replace existing values, use setParameters(java.util.Map).
      • removeParameter

        public void removeParameter(java.lang.String name)
        Remove already registered values for the specified HTTP parameter, if any.
      • removeAllParameters

        public void removeAllParameters()
        Removes all existing parameters.
      • getParameter

        @Nullable
        public java.lang.String getParameter(java.lang.String name)
        Description copied from interface: javax.servlet.ServletRequest
        Returns the value of a request parameter as a String, or null if the parameter does not exist. Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.

        You should only use this method when you are sure the parameter has only one value. If the parameter might have more than one value, use ServletRequest.getParameterValues(java.lang.String).

        If you use this method with a multivalued parameter, the value returned is equal to the first value in the array returned by getParameterValues.

        If the parameter data was sent in the request body, such as occurs with an HTTP POST request, then reading the body directly via ServletRequest.getInputStream() or ServletRequest.getReader() can interfere with the execution of this method.

        Specified by:
        getParameter in interface ServletRequest
        Parameters:
        name - a String specifying the name of the parameter
        Returns:
        a String representing the single value of the parameter
        See Also:
        ServletRequest.getParameterValues(java.lang.String)
      • getParameterNames

        public java.util.Enumeration<java.lang.String> getParameterNames()
        Description copied from interface: javax.servlet.ServletRequest
        Returns an Enumeration of String objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an empty Enumeration.
        Specified by:
        getParameterNames in interface ServletRequest
        Returns:
        an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters
      • getParameterValues

        public java.lang.String[] getParameterValues(java.lang.String name)
        Description copied from interface: javax.servlet.ServletRequest
        Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.

        If the parameter has a single value, the array has a length of 1.

        Specified by:
        getParameterValues in interface ServletRequest
        Parameters:
        name - a String containing the name of the parameter whose value is requested
        Returns:
        an array of String objects containing the parameter's values
        See Also:
        ServletRequest.getParameter(java.lang.String)
      • getParameterMap

        public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
        Description copied from interface: javax.servlet.ServletRequest
        Returns a java.util.Map of the parameters of this request.

        Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.

        Specified by:
        getParameterMap in interface ServletRequest
        Returns:
        an immutable java.util.Map containing parameter names as keys and parameter values as map values. The keys in the parameter map are of type String. The values in the parameter map are of type String array.
      • setProtocol

        public void setProtocol(java.lang.String protocol)
      • getProtocol

        public java.lang.String getProtocol()
        Description copied from interface: javax.servlet.ServletRequest
        Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1. For HTTP servlets, the value returned is the same as the value of the CGI variable SERVER_PROTOCOL.
        Specified by:
        getProtocol in interface ServletRequest
        Returns:
        a String containing the protocol name and version number
      • setScheme

        public void setScheme(java.lang.String scheme)
      • getScheme

        public java.lang.String getScheme()
        Description copied from interface: javax.servlet.ServletRequest
        Returns the name of the scheme used to make this request, for example, http, https, or ftp. Different schemes have different rules for constructing URLs, as noted in RFC 1738.
        Specified by:
        getScheme in interface ServletRequest
        Returns:
        a String containing the name of the scheme used to make this request
      • setServerName

        public void setServerName(java.lang.String serverName)
      • getServerName

        public java.lang.String getServerName()
        Description copied from interface: javax.servlet.ServletRequest
        Returns the host name of the server to which the request was sent. It is the value of the part before ":" in the Host header value, if any, or the resolved server name, or the server IP address.
        Specified by:
        getServerName in interface ServletRequest
        Returns:
        a String containing the name of the server
      • setServerPort

        public void setServerPort(int serverPort)
      • getServerPort

        public int getServerPort()
        Description copied from interface: javax.servlet.ServletRequest
        Returns the port number to which the request was sent. It is the value of the part after ":" in the Host header value, if any, or the server port where the client connection was accepted on.
        Specified by:
        getServerPort in interface ServletRequest
        Returns:
        an integer specifying the port number
      • getReader

        public java.io.BufferedReader getReader()
                                         throws java.io.UnsupportedEncodingException
        Description copied from interface: javax.servlet.ServletRequest
        Retrieves the body of the request as character data using a BufferedReader. The reader translates the character data according to the character encoding used on the body. Either this method or ServletRequest.getInputStream() may be called to read the body, not both.
        Specified by:
        getReader in interface ServletRequest
        Returns:
        a BufferedReader containing the body of the request
        Throws:
        java.io.UnsupportedEncodingException - if the character set encoding used is not supported and the text cannot be decoded
        See Also:
        ServletRequest.getInputStream()
      • setRemoteAddr

        public void setRemoteAddr(java.lang.String remoteAddr)
      • getRemoteAddr

        public java.lang.String getRemoteAddr()
        Description copied from interface: javax.servlet.ServletRequest
        Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. For HTTP servlets, same as the value of the CGI variable REMOTE_ADDR.
        Specified by:
        getRemoteAddr in interface ServletRequest
        Returns:
        a String containing the IP address of the client that sent the request
      • setRemoteHost

        public void setRemoteHost(java.lang.String remoteHost)
      • getRemoteHost

        public java.lang.String getRemoteHost()
        Description copied from interface: javax.servlet.ServletRequest
        Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variable REMOTE_HOST.
        Specified by:
        getRemoteHost in interface ServletRequest
        Returns:
        a String containing the fully qualified name of the client
      • setAttribute

        public void setAttribute(java.lang.String name,
                                 @Nullable
                                 java.lang.Object value)
        Description copied from interface: javax.servlet.ServletRequest
        Stores an attribute in this request. Attributes are reset between requests. This method is most often used in conjunction with RequestDispatcher.

        Attribute names should follow the same conventions as package names. Names beginning with java.*, javax.*, and com.sun.*, are reserved for use by Sun Microsystems.
        If the object passed in is null, the effect is the same as calling ServletRequest.removeAttribute(java.lang.String).
        It is warned that when the request is dispatched from the servlet resides in a different web application by RequestDispatcher, the object set by this method may not be correctly retrieved in the caller servlet.

        Specified by:
        setAttribute in interface ServletRequest
        Parameters:
        name - a String specifying the name of the attribute
        value - the Object to be stored
      • removeAttribute

        public void removeAttribute(java.lang.String name)
        Description copied from interface: javax.servlet.ServletRequest
        Removes an attribute from this request. This method is not generally needed as attributes only persist as long as the request is being handled.

        Attribute names should follow the same conventions as package names. Names beginning with java.*, javax.*, and com.sun.*, are reserved for use by Sun Microsystems.

        Specified by:
        removeAttribute in interface ServletRequest
        Parameters:
        name - a String specifying the name of the attribute to remove
      • clearAttributes

        public void clearAttributes()
        Clear all of this request's attributes.
      • setPreferredLocales

        public void setPreferredLocales(java.util.List<java.util.Locale> locales)
        Set the list of preferred locales, in descending order, effectively replacing any existing locales.
        Since:
        3.2
        See Also:
        addPreferredLocale(java.util.Locale)
      • getLocale

        public java.util.Locale getLocale()
        Return the first preferred locale configured in this mock request.

        If no locales have been explicitly configured, the default, preferred Locale for the server mocked by this request is Locale.ENGLISH.

        In contrast to the Servlet specification, this mock implementation does not take into consideration any locales specified via the Accept-Language header.

        Specified by:
        getLocale in interface ServletRequest
        Returns:
        the preferred Locale for the client
        See Also:
        ServletRequest.getLocale(), addPreferredLocale(Locale), setPreferredLocales(List)
      • getLocales

        public java.util.Enumeration<java.util.Locale> getLocales()
        Return an enumeration of the preferred locales configured in this mock request.

        If no locales have been explicitly configured, the default, preferred Locale for the server mocked by this request is Locale.ENGLISH.

        In contrast to the Servlet specification, this mock implementation does not take into consideration any locales specified via the Accept-Language header.

        Specified by:
        getLocales in interface ServletRequest
        Returns:
        an Enumeration of preferred Locale objects for the client
        See Also:
        ServletRequest.getLocales(), addPreferredLocale(Locale), setPreferredLocales(List)
      • setSecure

        public void setSecure(boolean secure)
        Set the boolean secure flag indicating whether the mock request was made using a secure channel, such as HTTPS.
        See Also:
        isSecure(), getScheme(), setScheme(String)
      • getRequestDispatcher

        public RequestDispatcher getRequestDispatcher(java.lang.String path)
        Description copied from interface: javax.servlet.ServletRequest
        Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path. A RequestDispatcher object can be used to forward a request to the resource or to include the resource in a response. The resource can be dynamic or static.

        The pathname specified may be relative, although it cannot extend outside the current servlet context. If the path begins with a "/" it is interpreted as relative to the current context root. This method returns null if the servlet container cannot return a RequestDispatcher.

        The difference between this method and ServletContext.getRequestDispatcher(java.lang.String) is that this method can take a relative path.

        Specified by:
        getRequestDispatcher in interface ServletRequest
        Parameters:
        path - a String specifying the pathname to the resource. If it is relative, it must be relative against the current servlet.
        Returns:
        a RequestDispatcher object that acts as a wrapper for the resource at the specified path, or null if the servlet container cannot return a RequestDispatcher
        See Also:
        RequestDispatcher, ServletContext.getRequestDispatcher(java.lang.String)
      • getRealPath

        @Deprecated
        public java.lang.String getRealPath(java.lang.String path)
        Deprecated. 
        Specified by:
        getRealPath in interface ServletRequest
        Parameters:
        path - the path for which the real path is to be returned.
        Returns:
        the real path, or null if the translation cannot be performed.
      • setRemotePort

        public void setRemotePort(int remotePort)
      • getRemotePort

        public int getRemotePort()
        Description copied from interface: javax.servlet.ServletRequest
        Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
        Specified by:
        getRemotePort in interface ServletRequest
        Returns:
        an integer specifying the port number
      • setLocalName

        public void setLocalName(java.lang.String localName)
      • getLocalName

        public java.lang.String getLocalName()
        Description copied from interface: javax.servlet.ServletRequest
        Returns the host name of the Internet Protocol (IP) interface on which the request was received.
        Specified by:
        getLocalName in interface ServletRequest
        Returns:
        a String containing the host name of the IP on which the request was received.
      • setLocalAddr

        public void setLocalAddr(java.lang.String localAddr)
      • getLocalAddr

        public java.lang.String getLocalAddr()
        Description copied from interface: javax.servlet.ServletRequest
        Returns the Internet Protocol (IP) address of the interface on which the request was received.
        Specified by:
        getLocalAddr in interface ServletRequest
        Returns:
        a String containing the IP address on which the request was received.
      • setLocalPort

        public void setLocalPort(int localPort)
      • getLocalPort

        public int getLocalPort()
        Description copied from interface: javax.servlet.ServletRequest
        Returns the Internet Protocol (IP) port number of the interface on which the request was received.
        Specified by:
        getLocalPort in interface ServletRequest
        Returns:
        an integer specifying the port number
      • startAsync

        public AsyncContext startAsync()
        Description copied from interface: javax.servlet.ServletRequest
        Puts this request into asynchronous mode, and initializes its AsyncContext with the original (unwrapped) ServletRequest and ServletResponse objects.

        Calling this method will cause committal of the associated response to be delayed until AsyncContext.complete() is called on the returned AsyncContext, or the asynchronous operation has timed out.

        Calling AsyncContext.hasOriginalRequestAndResponse() on the returned AsyncContext will return true. Any filters invoked in the outbound direction after this request was put into asynchronous mode may use this as an indication that any request and/or response wrappers that they added during their inbound invocation need not stay around for the duration of the asynchronous operation, and therefore any of their associated resources may be released.

        This method clears the list of AsyncListener instances (if any) that were registered with the AsyncContext returned by the previous call to one of the startAsync methods, after calling each AsyncListener at its onStartAsync method.

        Subsequent invocations of this method, or its overloaded variant, will return the same AsyncContext instance, reinitialized as appropriate.

        Specified by:
        startAsync in interface ServletRequest
        Returns:
        the (re)initialized AsyncContext
        See Also:
        AsyncContext.dispatch()
      • startAsync

        public AsyncContext startAsync(ServletRequest request,
                                       @Nullable
                                       ServletResponse response)
        Description copied from interface: javax.servlet.ServletRequest
        Puts this request into asynchronous mode, and initializes its AsyncContext with the given request and response objects.

        The ServletRequest and ServletResponse arguments must be the same instances, or instances of ServletRequestWrapper and ServletResponseWrapper that wrap them, that were passed to the service method of the Servlet or the doFilter method of the Filter, respectively, in whose scope this method is being called.

        Calling this method will cause committal of the associated response to be delayed until AsyncContext.complete() is called on the returned AsyncContext, or the asynchronous operation has timed out.

        Calling AsyncContext.hasOriginalRequestAndResponse() on the returned AsyncContext will return false, unless the passed in ServletRequest and ServletResponse arguments are the original ones or do not carry any application-provided wrappers. Any filters invoked in the outbound direction after this request was put into asynchronous mode may use this as an indication that some of the request and/or response wrappers that they added during their inbound invocation may need to stay in place for the duration of the asynchronous operation, and their associated resources may not be released. A ServletRequestWrapper applied during the inbound invocation of a filter may be released by the outbound invocation of the filter only if the given servletRequest, which is used to initialize the AsyncContext and will be returned by a call to AsyncContext.getRequest(), does not contain said ServletRequestWrapper. The same holds true for ServletResponseWrapper instances.

        This method clears the list of AsyncListener instances (if any) that were registered with the AsyncContext returned by the previous call to one of the startAsync methods, after calling each AsyncListener at its onStartAsync method.

        Subsequent invocations of this method, or its zero-argument variant, will return the same AsyncContext instance, reinitialized as appropriate. If a call to this method is followed by a call to its zero-argument variant, the specified (and possibly wrapped) request and response objects will remain locked in on the returned AsyncContext.

        Specified by:
        startAsync in interface ServletRequest
        Parameters:
        request - the ServletRequest used to initialize the AsyncContext
        response - the ServletResponse used to initialize the AsyncContext
        Returns:
        the (re)initialized AsyncContext
      • setAsyncStarted

        public void setAsyncStarted(boolean asyncStarted)
      • setAsyncSupported

        public void setAsyncSupported(boolean asyncSupported)
      • isAsyncSupported

        public boolean isAsyncSupported()
        Description copied from interface: javax.servlet.ServletRequest
        Checks if this request supports asynchronous operation.

        Asynchronous operation is disabled for this request if this request is within the scope of a filter or servlet that has not been annotated or flagged in the deployment descriptor as being able to support asynchronous handling.

        Specified by:
        isAsyncSupported in interface ServletRequest
        Returns:
        true if this request supports asynchronous operation, false otherwise
      • setDispatcherType

        public void setDispatcherType(DispatcherType dispatcherType)
      • getDispatcherType

        public DispatcherType getDispatcherType()
        Description copied from interface: javax.servlet.ServletRequest
        Gets the dispatcher type of this request.

        The dispatcher type of a request is used by the container to select the filters that need to be applied to the request: Only filters with matching dispatcher type and url patterns will be applied.

        Allowing a filter that has been configured for multiple dispatcher types to query a request for its dispatcher type allows the filter to process the request differently depending on its dispatcher type.

        The initial dispatcher type of a request is defined as DispatcherType.REQUEST. The dispatcher type of a request dispatched via RequestDispatcher.forward(ServletRequest, ServletResponse) or RequestDispatcher.include(ServletRequest, ServletResponse) is given as DispatcherType.FORWARD or DispatcherType.INCLUDE, respectively, while the dispatcher type of an asynchronous request dispatched via one of the AsyncContext.dispatch() methods is given as DispatcherType.ASYNC. Finally, the dispatcher type of a request dispatched to an error page by the container's error handling mechanism is given as DispatcherType.ERROR.

        Specified by:
        getDispatcherType in interface ServletRequest
        Returns:
        the dispatcher type of this request
        See Also:
        DispatcherType
      • setAuthType

        public void setAuthType(@Nullable
                                java.lang.String authType)
      • getAuthType

        @Nullable
        public java.lang.String getAuthType()
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Returns the name of the authentication scheme used to protect the servlet. All servlet containers support basic, form and client certificate authentication, and may additionally support digest authentication. If the servlet is not authenticated null is returned.

        Same as the value of the CGI variable AUTH_TYPE.

        Specified by:
        getAuthType in interface HttpServletRequest
        Returns:
        one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (suitable for == comparison) or the container-specific string indicating the authentication scheme, or null if the request was not authenticated.
      • getCookies

        @Nullable
        public Cookie[] getCookies()
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Returns an array containing all of the Cookie objects the client sent with this request. This method returns null if no cookies were sent.
        Specified by:
        getCookies in interface HttpServletRequest
        Returns:
        an array of all the Cookies included with this request, or null if the request has no cookies
      • getDateHeader

        public long getDateHeader(java.lang.String name)
        Return the long timestamp for the date header with the given name.

        If the internal value representation is a String, this method will try to parse it as a date using the supported date formats:

        • "EEE, dd MMM yyyy HH:mm:ss zzz"
        • "EEE, dd-MMM-yy HH:mm:ss zzz"
        • "EEE MMM dd HH:mm:ss yyyy"
        Specified by:
        getDateHeader in interface HttpServletRequest
        Parameters:
        name - the header name
        Returns:
        a long value representing the date specified in the header expressed as the number of milliseconds since January 1, 1970 GMT, or -1 if the named header was not included with the request
        See Also:
        Section 7.1.1.1 of RFC 7231
      • getHeader

        @Nullable
        public java.lang.String getHeader(java.lang.String name)
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Returns the value of the specified request header as a String. If the request did not include a header of the specified name, this method returns null. If there are multiple headers with the same name, this method returns the first head in the request. The header name is case insensitive. You can use this method with any request header.
        Specified by:
        getHeader in interface HttpServletRequest
        Parameters:
        name - a String specifying the header name
        Returns:
        a String containing the value of the requested header, or null if the request does not have a header of that name
      • getHeaders

        public java.util.Enumeration<java.lang.String> getHeaders(java.lang.String name)
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Returns all the values of the specified request header as an Enumeration of String objects.

        Some headers, such as Accept-Language can be sent by clients as several headers each with a different value rather than sending the header as a comma separated list.

        If the request did not include any headers of the specified name, this method returns an empty Enumeration. The header name is case insensitive. You can use this method with any request header.

        Specified by:
        getHeaders in interface HttpServletRequest
        Parameters:
        name - a String specifying the header name
        Returns:
        an Enumeration containing the values of the requested header. If the request does not have any headers of that name return an empty enumeration. If the container does not allow access to header information, return null
      • getHeaderNames

        public java.util.Enumeration<java.lang.String> getHeaderNames()
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Returns an enumeration of all the header names this request contains. If the request has no headers, this method returns an empty enumeration.

        Some servlet containers do not allow servlets to access headers using this method, in which case this method returns null

        Specified by:
        getHeaderNames in interface HttpServletRequest
        Returns:
        an enumeration of all the header names sent with this request; if the request has no headers, an empty enumeration; if the servlet container does not allow servlets to use this method, null
      • getIntHeader

        public int getIntHeader(java.lang.String name)
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Returns the value of the specified request header as an int. If the request does not have a header of the specified name, this method returns -1. If the header cannot be converted to an integer, this method throws a NumberFormatException.

        The header name is case insensitive.

        Specified by:
        getIntHeader in interface HttpServletRequest
        Parameters:
        name - a String specifying the name of a request header
        Returns:
        an integer expressing the value of the request header or -1 if the request doesn't have a header of this name
      • setMethod

        public void setMethod(@Nullable
                              java.lang.String method)
      • getMethod

        @Nullable
        public java.lang.String getMethod()
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. Same as the value of the CGI variable REQUEST_METHOD.
        Specified by:
        getMethod in interface HttpServletRequest
        Returns:
        a String specifying the name of the method with which this request was made
      • setPathInfo

        public void setPathInfo(@Nullable
                                java.lang.String pathInfo)
      • getPathInfo

        @Nullable
        public java.lang.String getPathInfo()
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Returns any extra path information associated with the URL the client sent when it made this request. The extra path information follows the servlet path but precedes the query string and will start with a "/" character.

        This method returns null if there was no extra path information.

        Same as the value of the CGI variable PATH_INFO.

        Specified by:
        getPathInfo in interface HttpServletRequest
        Returns:
        a String, decoded by the web container, specifying extra path information that comes after the servlet path but before the query string in the request URL; or null if the URL does not have any extra path information
      • getPathTranslated

        @Nullable
        public java.lang.String getPathTranslated()
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Returns any extra path information after the servlet name but before the query string, and translates it to a real path. Same as the value of the CGI variable PATH_TRANSLATED.

        If the URL does not have any extra path information, this method returns null or the servlet container cannot translate the virtual path to a real path for any reason (such as when the web application is executed from an archive). The web container does not decode this string.

        Specified by:
        getPathTranslated in interface HttpServletRequest
        Returns:
        a String specifying the real path, or null if the URL does not have any extra path information
      • setContextPath

        public void setContextPath(java.lang.String contextPath)
      • getContextPath

        public java.lang.String getContextPath()
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "". The container does not decode this string.

        It is possible that a servlet container may match a context by more than one context path. In such cases this method will return the actual context path used by the request and it may differ from the path returned by the ServletContext.getContextPath() method. The context path returned by ServletContext.getContextPath() should be considered as the prime or preferred context path of the application.

        Specified by:
        getContextPath in interface HttpServletRequest
        Returns:
        a String specifying the portion of the request URI that indicates the context of the request
        See Also:
        ServletContext.getContextPath()
      • setQueryString

        public void setQueryString(@Nullable
                                   java.lang.String queryString)
      • getQueryString

        @Nullable
        public java.lang.String getQueryString()
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Returns the query string that is contained in the request URL after the path. This method returns null if the URL does not have a query string. Same as the value of the CGI variable QUERY_STRING.
        Specified by:
        getQueryString in interface HttpServletRequest
        Returns:
        a String containing the query string or null if the URL contains no query string. The value is not decoded by the container.
      • setRemoteUser

        public void setRemoteUser(@Nullable
                                  java.lang.String remoteUser)
      • getRemoteUser

        @Nullable
        public java.lang.String getRemoteUser()
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated. Whether the user name is sent with each subsequent request depends on the browser and type of authentication. Same as the value of the CGI variable REMOTE_USER.
        Specified by:
        getRemoteUser in interface HttpServletRequest
        Returns:
        a String specifying the login of the user making this request, or null if the user login is not known
      • addUserRole

        public void addUserRole(java.lang.String role)
      • isUserInRole

        public boolean isUserInRole(java.lang.String role)
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Returns a boolean indicating whether the authenticated user is included in the specified logical "role". Roles and role membership can be defined using deployment descriptors. If the user has not been authenticated, the method returns false.

        The role name "*" should never be used as an argument in calling isUserInRole. Any call to isUserInRole with "*" must return false. If the role-name of the security-role to be tested is "**", and the application has NOT declared an application security-role with role-name "**", isUserInRole must only return true if the user has been authenticated; that is, only when HttpServletRequest.getRemoteUser() and HttpServletRequest.getUserPrincipal() would both return a non-null value. Otherwise, the container must check the user for membership in the application role.

        Specified by:
        isUserInRole in interface HttpServletRequest
        Parameters:
        role - a String specifying the name of the role
        Returns:
        a boolean indicating whether the user making this request belongs to a given role; false if the user has not been authenticated
      • setUserPrincipal

        public void setUserPrincipal(@Nullable
                                     java.security.Principal userPrincipal)
      • getUserPrincipal

        @Nullable
        public java.security.Principal getUserPrincipal()
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Returns a java.security.Principal object containing the name of the current authenticated user. If the user has not been authenticated, the method returns null.
        Specified by:
        getUserPrincipal in interface HttpServletRequest
        Returns:
        a java.security.Principal containing the name of the user making this request; null if the user has not been authenticated
      • setRequestedSessionId

        public void setRequestedSessionId(@Nullable
                                          java.lang.String requestedSessionId)
      • setRequestURI

        public void setRequestURI(@Nullable
                                  java.lang.String requestURI)
      • getRequestURL

        public java.lang.StringBuffer getRequestURL()
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and server path, but it does not include query string parameters.

        If this request has been forwarded using RequestDispatcher.forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse), the server path in the reconstructed URL must reflect the path used to obtain the RequestDispatcher, and not the server path specified by the client.

        Because this method returns a StringBuffer, not a string, you can modify the URL easily, for example, to append query parameters.

        This method is useful for creating redirect messages and for reporting errors.

        Specified by:
        getRequestURL in interface HttpServletRequest
        Returns:
        a StringBuffer object containing the reconstructed URL
      • setServletPath

        public void setServletPath(java.lang.String servletPath)
      • getServletPath

        public java.lang.String getServletPath()
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Returns the part of this request's URL that calls the servlet. This path starts with a "/" character and includes either the servlet name or a path to the servlet, but does not include any extra path information or a query string. Same as the value of the CGI variable SCRIPT_NAME.

        This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.

        Specified by:
        getServletPath in interface HttpServletRequest
        Returns:
        a String containing the name or path of the servlet being called, as specified in the request URL, decoded, or an empty string if the servlet used to process the request is matched using the "/*" pattern.
      • setSession

        public void setSession(HttpSession session)
      • getSession

        @Nullable
        public HttpSession getSession(boolean create)
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Returns the current HttpSession associated with this request or, if there is no current session and create is true, returns a new session.

        If create is false and the request has no valid HttpSession, this method returns null.

        To make sure the session is properly maintained, you must call this method before the response is committed. If the container is using cookies to maintain session integrity and is asked to create a new session when the response is committed, an IllegalStateException is thrown.

        Specified by:
        getSession in interface HttpServletRequest
        Parameters:
        create - true to create a new session for this request if necessary; false to return null if there's no current session
        Returns:
        the HttpSession associated with this request or null if create is false and the request has no valid session
        See Also:
        HttpServletRequest.getSession()
      • changeSessionId

        public java.lang.String changeSessionId()
        The implementation of this (Servlet 3.1+) method calls MockHttpSession.changeSessionId() if the session is a mock session. Otherwise it simply returns the current session id.
        Specified by:
        changeSessionId in interface HttpServletRequest
        Returns:
        the new session id
        Since:
        4.0.3
      • setRequestedSessionIdValid

        public void setRequestedSessionIdValid(boolean requestedSessionIdValid)
      • setRequestedSessionIdFromCookie

        public void setRequestedSessionIdFromCookie(boolean requestedSessionIdFromCookie)
      • setRequestedSessionIdFromURL

        public void setRequestedSessionIdFromURL(boolean requestedSessionIdFromURL)
      • isRequestedSessionIdFromUrl

        @Deprecated
        public boolean isRequestedSessionIdFromUrl()
        Deprecated. 
        Specified by:
        isRequestedSessionIdFromUrl in interface HttpServletRequest
        Returns:
        true if the session ID was conveyed to the server as part of a URL; otherwise, false
      • authenticate

        public boolean authenticate(HttpServletResponse response)
                             throws java.io.IOException,
                                    ServletException
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Use the container login mechanism configured for the ServletContext to authenticate the user making this request.

        This method may modify and commit the argument HttpServletResponse.

        Specified by:
        authenticate in interface HttpServletRequest
        Parameters:
        response - The HttpServletResponse associated with this HttpServletRequest
        Returns:
        true when non-null values were or have been established as the values returned by getUserPrincipal, getRemoteUser, and getAuthType. Return false if authentication is incomplete and the underlying login mechanism has committed, in the response, the message (e.g., challenge) and HTTP status code to be returned to the user.
        Throws:
        java.io.IOException - if an input or output error occurred while reading from this request or writing to the given response
        ServletException - if the authentication failed and the caller is responsible for handling the error (i.e., the underlying login mechanism did NOT establish the message and HTTP status code to be returned to the user)
      • login

        public void login(java.lang.String username,
                          java.lang.String password)
                   throws ServletException
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Validate the provided username and password in the password validation realm used by the web container login mechanism configured for the ServletContext.

        This method returns without throwing a ServletException when the login mechanism configured for the ServletContext supports username password validation, and when, at the time of the call to login, the identity of the caller of the request had not been established (i.e, all of getUserPrincipal, getRemoteUser, and getAuthType return null), and when validation of the provided credentials is successful. Otherwise, this method throws a ServletException as described below.

        When this method returns without throwing an exception, it must have established non-null values as the values returned by getUserPrincipal, getRemoteUser, and getAuthType.

        Specified by:
        login in interface HttpServletRequest
        Parameters:
        username - The String value corresponding to the login identifier of the user.
        password - The password String corresponding to the identified user.
        Throws:
        ServletException - if the configured login mechanism does not support username password authentication, or if a non-null caller identity had already been established (prior to the call to login), or if validation of the provided username and password fails.
      • addPart

        public void addPart(Part part)
      • getParts

        public java.util.Collection<Part> getParts()
                                            throws java.io.IOException,
                                                   ServletException
        Description copied from interface: javax.servlet.http.HttpServletRequest
        Gets all the Part components of this request, provided that it is of type multipart/form-data.

        If this request is of type multipart/form-data, but does not contain any Part components, the returned Collection will be empty.

        Any changes to the returned Collection must not affect this HttpServletRequest.

        Specified by:
        getParts in interface HttpServletRequest
        Returns:
        a (possibly empty) Collection of the Part components of this request
        Throws:
        java.io.IOException - if an I/O error occurred during the retrieval of the Part components of this request
        ServletException - if this request is not of type multipart/form-data
        See Also:
        MultipartConfig.maxFileSize(), MultipartConfig.maxRequestSize()