MockHttpServletRequest (Spring Framework 5.0.4.RELEASE API)

java.lang.Object
- org.springframework.mock.web.MockHttpServletRequest

All Implemented Interfaces:

HttpServletRequest, ServletRequest

Direct Known Subclasses:

MockMultipartHttpServletRequest
```
public class MockHttpServletRequest
extends java.lang.Object
implements HttpServletRequest
```
Mock implementation of the HttpServletRequest interface.
The default, preferred Locale for the server mocked by this request is Locale.ENGLISH. This value can be changed via addPreferredLocale(java.util.Locale) or setPreferredLocales(java.util.List<java.util.Locale>).
As of Spring Framework 5.0, this set of mocks is designed on a Servlet 4.0 baseline.

Since:

1.0.2

Author:

Juergen Hoeller, Rod Johnson, Rick Evans, Mark Fisher, Chris Beams, Sam Brannen, Brian Clozel

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_PROTOCOL` The default protocol: 'HTTP/1.1'.
`static java.lang.String`	`DEFAULT_REMOTE_ADDR` The default remote address: '127.0.0.1'.
`static java.lang.String`	`DEFAULT_REMOTE_HOST` The default remote host: 'localhost'.
`static java.lang.String`	`DEFAULT_SCHEME` The default scheme: 'http'.
`static java.lang.String`	`DEFAULT_SERVER_ADDR` The default server address: '127.0.0.1'.
`static java.lang.String`	`DEFAULT_SERVER_NAME` The default server name: 'localhost'.
`static int`	`DEFAULT_SERVER_PORT` The default server port: '80'.

Fields inherited from interface javax.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors
Constructor and Description
`MockHttpServletRequest()` Create a new `MockHttpServletRequest` with a default `MockServletContext`.
`MockHttpServletRequest(ServletContext servletContext)` Create a new `MockHttpServletRequest` with the supplied `ServletContext`.
`MockHttpServletRequest(ServletContext servletContext, java.lang.String method, java.lang.String requestURI)` Create a new `MockHttpServletRequest` with the supplied `ServletContext`, `method`, and `requestURI`.
`MockHttpServletRequest(java.lang.String method, java.lang.String requestURI)` Create a new `MockHttpServletRequest` with a default `MockServletContext`.

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)`
`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()`
`java.lang.Object`	`getAttribute(java.lang.String name)`
`java.util.Enumeration<java.lang.String>`	`getAttributeNames()`
`java.lang.String`	`getAuthType()`
`java.lang.String`	`getCharacterEncoding()`
`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()`
`long`	`getContentLengthLong()`
`java.lang.String`	`getContentType()`
`java.lang.String`	`getContextPath()`
`Cookie[]`	`getCookies()`
`long`	`getDateHeader(java.lang.String name)` Return the long timestamp for the date header with the given `name`.
`DispatcherType`	`getDispatcherType()`
`java.lang.String`	`getHeader(java.lang.String name)`
`java.util.Enumeration<java.lang.String>`	`getHeaderNames()`
`java.util.Enumeration<java.lang.String>`	`getHeaders(java.lang.String name)`
`ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(java.lang.String name)`
`java.lang.String`	`getLocalAddr()`
`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()`
`int`	`getLocalPort()`
`java.lang.String`	`getMethod()`
`java.lang.String`	`getParameter(java.lang.String name)`
`java.util.Map<java.lang.String,java.lang.String[]>`	`getParameterMap()`
`java.util.Enumeration<java.lang.String>`	`getParameterNames()`
`java.lang.String[]`	`getParameterValues(java.lang.String name)`
`Part`	`getPart(java.lang.String name)`
`java.util.Collection<Part>`	`getParts()`
`java.lang.String`	`getPathInfo()`
`java.lang.String`	`getPathTranslated()`
`java.lang.String`	`getProtocol()`
`java.lang.String`	`getQueryString()`
`java.io.BufferedReader`	`getReader()`
`java.lang.String`	`getRealPath(java.lang.String path)` Deprecated.
`java.lang.String`	`getRemoteAddr()`
`java.lang.String`	`getRemoteHost()`
`int`	`getRemotePort()`
`java.lang.String`	`getRemoteUser()`
`RequestDispatcher`	`getRequestDispatcher(java.lang.String path)`
`java.lang.String`	`getRequestedSessionId()`
`java.lang.String`	`getRequestURI()`
`java.lang.StringBuffer`	`getRequestURL()`
`java.lang.String`	`getScheme()`
`java.lang.String`	`getServerName()`
`int`	`getServerPort()`
`ServletContext`	`getServletContext()` Return the ServletContext that this request is associated with.
`java.lang.String`	`getServletPath()`
`HttpSession`	`getSession()`
`HttpSession`	`getSession(boolean create)`
`java.security.Principal`	`getUserPrincipal()`
`void`	`invalidate()` Invalidate this request, clearing its state.
`boolean`	`isActive()` Return whether this request is still active (that is, not completed yet).
`boolean`	`isAsyncStarted()`
`boolean`	`isAsyncSupported()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()` Deprecated.
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`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)`
`void`	`login(java.lang.String username, java.lang.String password)`
`void`	`logout()`
`void`	`removeAllParameters()` Removes all existing parameters.
`void`	`removeAttribute(java.lang.String name)`
`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)`
`void`	`setAuthType(java.lang.String authType)`
`void`	`setCharacterEncoding(java.lang.String characterEncoding)`
`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()`
`AsyncContext`	`startAsync(ServletRequest request, ServletResponse response)`
`<T extends HttpUpgradeHandler> T`	`upgrade(java.lang.Class<T> handlerClass)`

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
- Constructor Detail
  - MockHttpServletRequest
```
public MockHttpServletRequest()
```
    Create a new MockHttpServletRequest with a default MockServletContext.
    
    See Also:
    
    MockHttpServletRequest(ServletContext, String, String)
  - MockHttpServletRequest
```
public MockHttpServletRequest(@Nullable
                              java.lang.String method,
                              @Nullable
                              java.lang.String requestURI)
```
    Create a new MockHttpServletRequest with a default MockServletContext.
    
    Parameters:
    
    method - the request method (may be null)
    
    requestURI - the request URI (may be null)
    
    See Also:
    
    setMethod(java.lang.String), setRequestURI(java.lang.String), MockHttpServletRequest(ServletContext, String, String)
  - MockHttpServletRequest
```
public MockHttpServletRequest(@Nullable
                              ServletContext servletContext)
```
    Create a new MockHttpServletRequest with the supplied ServletContext.
    
    Parameters:
    
    servletContext - the ServletContext that the request runs in (may be null to use a default MockServletContext)
    
    See Also:
    
    MockHttpServletRequest(ServletContext, String, String)
  - MockHttpServletRequest
```
public MockHttpServletRequest(@Nullable
                              ServletContext servletContext,
                              @Nullable
                              java.lang.String method,
                              @Nullable
                              java.lang.String requestURI)
```
    Create a new MockHttpServletRequest with the supplied ServletContext, method, and requestURI.
    The preferred locale will be set to Locale.ENGLISH.
    
    Parameters:
    
    servletContext - the ServletContext that the request runs in (may be null to use a default MockServletContext)
    
    method - the request method (may be null)
    
    requestURI - the request URI (may be null)
    
    See Also:
    
    setMethod(java.lang.String), setRequestURI(java.lang.String), setPreferredLocales(java.util.List<java.util.Locale>), MockServletContext
- 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
  - 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)
```
    Specified by:
    
    getAttribute in interface ServletRequest
  - getAttributeNames
```
public java.util.Enumeration<java.lang.String> getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface ServletRequest
  - getCharacterEncoding
```
@Nullable
public java.lang.String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface ServletRequest
  - setCharacterEncoding
```
public void setCharacterEncoding(@Nullable
                                 java.lang.String characterEncoding)
```
    Specified by:
    
    setCharacterEncoding in interface ServletRequest
  - setContent
```
public void setContent(@Nullable
                       byte[] content)
```
    Set the content of the request body as a byte array.
    If the supplied byte array represents text such as XML or JSON, the character encoding should typically be set as well.
    
    See Also:
    
    setCharacterEncoding(String), getContentAsByteArray(), getContentAsString()
  - 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()
```
    Specified by:
    
    getContentLength in interface ServletRequest
  - getContentLengthLong
```
public long getContentLengthLong()
```
    Specified by:
    
    getContentLengthLong in interface ServletRequest
  - setContentType
```
public void setContentType(@Nullable
                           java.lang.String contentType)
```
  - getContentType
```
@Nullable
public java.lang.String getContentType()
```
    Specified by:
    
    getContentType in interface ServletRequest
  - getInputStream
```
public ServletInputStream getInputStream()
```
    Specified by:
    
    getInputStream in interface ServletRequest
  - 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)
```
    Specified by:
    
    getParameter in interface ServletRequest
  - getParameterNames
```
public java.util.Enumeration<java.lang.String> getParameterNames()
```
    Specified by:
    
    getParameterNames in interface ServletRequest
  - getParameterValues
```
public java.lang.String[] getParameterValues(java.lang.String name)
```
    Specified by:
    
    getParameterValues in interface ServletRequest
  - getParameterMap
```
public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
```
    Specified by:
    
    getParameterMap in interface ServletRequest
  - setProtocol
```
public void setProtocol(java.lang.String protocol)
```
  - getProtocol
```
public java.lang.String getProtocol()
```
    Specified by:
    
    getProtocol in interface ServletRequest
  - setScheme
```
public void setScheme(java.lang.String scheme)
```
  - getScheme
```
public java.lang.String getScheme()
```
    Specified by:
    
    getScheme in interface ServletRequest
  - setServerName
```
public void setServerName(java.lang.String serverName)
```
  - getServerName
```
public java.lang.String getServerName()
```
    Specified by:
    
    getServerName in interface ServletRequest
  - setServerPort
```
public void setServerPort(int serverPort)
```
  - getServerPort
```
public int getServerPort()
```
    Specified by:
    
    getServerPort in interface ServletRequest
  - getReader
```
public java.io.BufferedReader getReader()
                                 throws java.io.UnsupportedEncodingException
```
    Specified by:
    
    getReader in interface ServletRequest
    
    Throws:
    
    java.io.UnsupportedEncodingException
  - setRemoteAddr
```
public void setRemoteAddr(java.lang.String remoteAddr)
```
  - getRemoteAddr
```
public java.lang.String getRemoteAddr()
```
    Specified by:
    
    getRemoteAddr in interface ServletRequest
  - setRemoteHost
```
public void setRemoteHost(java.lang.String remoteHost)
```
  - getRemoteHost
```
public java.lang.String getRemoteHost()
```
    Specified by:
    
    getRemoteHost in interface ServletRequest
  - setAttribute
```
public void setAttribute(java.lang.String name,
                         @Nullable
                         java.lang.Object value)
```
    Specified by:
    
    setAttribute in interface ServletRequest
  - removeAttribute
```
public void removeAttribute(java.lang.String name)
```
    Specified by:
    
    removeAttribute in interface ServletRequest
  - clearAttributes
```
public void clearAttributes()
```
    Clear all of this request's attributes.
  - addPreferredLocale
```
public void addPreferredLocale(java.util.Locale locale)
```
    Add a new preferred locale, before any existing locales.
    
    See Also:
    
    setPreferredLocales(java.util.List<java.util.Locale>)
  - 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
    
    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
    
    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)
  - isSecure
```
public boolean isSecure()
```
    Return true if the secure flag has been set to true or if the scheme is https.
    
    Specified by:
    
    isSecure in interface ServletRequest
    
    See Also:
    
    ServletRequest.isSecure()
  - getRequestDispatcher
```
public RequestDispatcher getRequestDispatcher(java.lang.String path)
```
    Specified by:
    
    getRequestDispatcher in interface ServletRequest
  - getRealPath
```
@Deprecated
public java.lang.String getRealPath(java.lang.String path)
```
    Deprecated.
    
    Specified by:
    
    getRealPath in interface ServletRequest
  - setRemotePort
```
public void setRemotePort(int remotePort)
```
  - getRemotePort
```
public int getRemotePort()
```
    Specified by:
    
    getRemotePort in interface ServletRequest
  - setLocalName
```
public void setLocalName(java.lang.String localName)
```
  - getLocalName
```
public java.lang.String getLocalName()
```
    Specified by:
    
    getLocalName in interface ServletRequest
  - setLocalAddr
```
public void setLocalAddr(java.lang.String localAddr)
```
  - getLocalAddr
```
public java.lang.String getLocalAddr()
```
    Specified by:
    
    getLocalAddr in interface ServletRequest
  - setLocalPort
```
public void setLocalPort(int localPort)
```
  - getLocalPort
```
public int getLocalPort()
```
    Specified by:
    
    getLocalPort in interface ServletRequest
  - startAsync
```
public AsyncContext startAsync()
```
    Specified by:
    
    startAsync in interface ServletRequest
  - startAsync
```
public AsyncContext startAsync(ServletRequest request,
                               @Nullable
                               ServletResponse response)
```
    Specified by:
    
    startAsync in interface ServletRequest
  - setAsyncStarted
```
public void setAsyncStarted(boolean asyncStarted)
```
  - isAsyncStarted
```
public boolean isAsyncStarted()
```
    Specified by:
    
    isAsyncStarted in interface ServletRequest
  - setAsyncSupported
```
public void setAsyncSupported(boolean asyncSupported)
```
  - isAsyncSupported
```
public boolean isAsyncSupported()
```
    Specified by:
    
    isAsyncSupported in interface ServletRequest
  - setAsyncContext
```
public void setAsyncContext(@Nullable
                            MockAsyncContext asyncContext)
```
  - getAsyncContext
```
@Nullable
public AsyncContext getAsyncContext()
```
    Specified by:
    
    getAsyncContext in interface ServletRequest
  - setDispatcherType
```
public void setDispatcherType(DispatcherType dispatcherType)
```
  - getDispatcherType
```
public DispatcherType getDispatcherType()
```
    Specified by:
    
    getDispatcherType in interface ServletRequest
  - setAuthType
```
public void setAuthType(@Nullable
                        java.lang.String authType)
```
  - getAuthType
```
@Nullable
public java.lang.String getAuthType()
```
    Specified by:
    
    getAuthType in interface HttpServletRequest
  - setCookies
```
public void setCookies(@Nullable
                       Cookie... cookies)
```
  - getCookies
```
@Nullable
public Cookie[] getCookies()
```
    Specified by:
    
    getCookies in interface HttpServletRequest
  - addHeader
```
public void addHeader(java.lang.String name,
                      java.lang.Object value)
```
    Add a header entry for the given name.
    While this method can take any Object as a parameter, it is recommended to use the following types:
    - String or any Object to be converted using toString(); see getHeader(java.lang.String).
    - String, Number, or Date for date headers; see getDateHeader(java.lang.String).
    - String or Number for integer headers; see getIntHeader(java.lang.String).
    - String[] or Collection<String> for multiple values; see getHeaders(java.lang.String).
    See Also:
    
    getHeaderNames(), getHeaders(java.lang.String), getHeader(java.lang.String), getDateHeader(java.lang.String)
  - 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
    
    See Also:
    
    Section 7.1.1.1 of RFC 7231
  - getHeader
```
@Nullable
public java.lang.String getHeader(java.lang.String name)
```
    Specified by:
    
    getHeader in interface HttpServletRequest
  - getHeaders
```
public java.util.Enumeration<java.lang.String> getHeaders(java.lang.String name)
```
    Specified by:
    
    getHeaders in interface HttpServletRequest
  - getHeaderNames
```
public java.util.Enumeration<java.lang.String> getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface HttpServletRequest
  - getIntHeader
```
public int getIntHeader(java.lang.String name)
```
    Specified by:
    
    getIntHeader in interface HttpServletRequest
  - setMethod
```
public void setMethod(@Nullable
                      java.lang.String method)
```
  - getMethod
```
@Nullable
public java.lang.String getMethod()
```
    Specified by:
    
    getMethod in interface HttpServletRequest
  - setPathInfo
```
public void setPathInfo(@Nullable
                        java.lang.String pathInfo)
```
  - getPathInfo
```
@Nullable
public java.lang.String getPathInfo()
```
    Specified by:
    
    getPathInfo in interface HttpServletRequest
  - getPathTranslated
```
@Nullable
public java.lang.String getPathTranslated()
```
    Specified by:
    
    getPathTranslated in interface HttpServletRequest
  - setContextPath
```
public void setContextPath(java.lang.String contextPath)
```
  - getContextPath
```
public java.lang.String getContextPath()
```
    Specified by:
    
    getContextPath in interface HttpServletRequest
  - setQueryString
```
public void setQueryString(@Nullable
                           java.lang.String queryString)
```
  - getQueryString
```
@Nullable
public java.lang.String getQueryString()
```
    Specified by:
    
    getQueryString in interface HttpServletRequest
  - setRemoteUser
```
public void setRemoteUser(@Nullable
                          java.lang.String remoteUser)
```
  - getRemoteUser
```
@Nullable
public java.lang.String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in interface HttpServletRequest
  - addUserRole
```
public void addUserRole(java.lang.String role)
```
  - isUserInRole
```
public boolean isUserInRole(java.lang.String role)
```
    Specified by:
    
    isUserInRole in interface HttpServletRequest
  - setUserPrincipal
```
public void setUserPrincipal(@Nullable
                             java.security.Principal userPrincipal)
```
  - getUserPrincipal
```
@Nullable
public java.security.Principal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal in interface HttpServletRequest
  - setRequestedSessionId
```
public void setRequestedSessionId(@Nullable
                                  java.lang.String requestedSessionId)
```
  - getRequestedSessionId
```
@Nullable
public java.lang.String getRequestedSessionId()
```
    Specified by:
    
    getRequestedSessionId in interface HttpServletRequest
  - setRequestURI
```
public void setRequestURI(@Nullable
                          java.lang.String requestURI)
```
  - getRequestURI
```
@Nullable
public java.lang.String getRequestURI()
```
    Specified by:
    
    getRequestURI in interface HttpServletRequest
  - getRequestURL
```
public java.lang.StringBuffer getRequestURL()
```
    Specified by:
    
    getRequestURL in interface HttpServletRequest
  - setServletPath
```
public void setServletPath(java.lang.String servletPath)
```
  - getServletPath
```
public java.lang.String getServletPath()
```
    Specified by:
    
    getServletPath in interface HttpServletRequest
  - setSession
```
public void setSession(HttpSession session)
```
  - getSession
```
@Nullable
public HttpSession getSession(boolean create)
```
    Specified by:
    
    getSession in interface HttpServletRequest
  - getSession
```
@Nullable
public HttpSession getSession()
```
    Specified by:
    
    getSession in interface HttpServletRequest
  - 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
    
    Since:
    
    4.0.3
  - setRequestedSessionIdValid
```
public void setRequestedSessionIdValid(boolean requestedSessionIdValid)
```
  - isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
    Specified by:
    
    isRequestedSessionIdValid in interface HttpServletRequest
  - setRequestedSessionIdFromCookie
```
public void setRequestedSessionIdFromCookie(boolean requestedSessionIdFromCookie)
```
  - isRequestedSessionIdFromCookie
```
public boolean isRequestedSessionIdFromCookie()
```
    Specified by:
    
    isRequestedSessionIdFromCookie in interface HttpServletRequest
  - setRequestedSessionIdFromURL
```
public void setRequestedSessionIdFromURL(boolean requestedSessionIdFromURL)
```
  - isRequestedSessionIdFromURL
```
public boolean isRequestedSessionIdFromURL()
```
    Specified by:
    
    isRequestedSessionIdFromURL in interface HttpServletRequest
  - isRequestedSessionIdFromUrl
```
@Deprecated
public boolean isRequestedSessionIdFromUrl()
```
    Deprecated.
    
    Specified by:
    
    isRequestedSessionIdFromUrl in interface HttpServletRequest
  - authenticate
```
public boolean authenticate(HttpServletResponse response)
                     throws java.io.IOException,
                            ServletException
```
    Specified by:
    
    authenticate in interface HttpServletRequest
    
    Throws:
    
    java.io.IOException
    
    ServletException
  - login
```
public void login(java.lang.String username,
                  java.lang.String password)
           throws ServletException
```
    Specified by:
    
    login in interface HttpServletRequest
    
    Throws:
    
    ServletException
  - logout
```
public void logout()
            throws ServletException
```
    Specified by:
    
    logout in interface HttpServletRequest
    
    Throws:
    
    ServletException
  - addPart
```
public void addPart(Part part)
```
  - getPart
```
@Nullable
public Part getPart(java.lang.String name)
                       throws java.io.IOException,
                              ServletException
```
    Specified by:
    
    getPart in interface HttpServletRequest
    
    Throws:
    
    java.io.IOException
    
    ServletException
  - getParts
```
public java.util.Collection<Part> getParts()
                                    throws java.io.IOException,
                                           ServletException
```
    Specified by:
    
    getParts in interface HttpServletRequest
    
    Throws:
    
    java.io.IOException
    
    ServletException
  - upgrade
```
public <T extends HttpUpgradeHandler> T upgrade(java.lang.Class<T> handlerClass)
                                         throws java.io.IOException,
                                                ServletException
```
    Specified by:
    
    upgrade in interface HttpServletRequest
    
    Throws:
    
    java.io.IOException
    
    ServletException

Class MockHttpServletRequest

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PROTOCOL

DEFAULT_SCHEME

DEFAULT_SERVER_ADDR

DEFAULT_SERVER_NAME

DEFAULT_SERVER_PORT

DEFAULT_REMOTE_ADDR

DEFAULT_REMOTE_HOST

Constructor Detail

MockHttpServletRequest

MockHttpServletRequest

MockHttpServletRequest

MockHttpServletRequest

Method Detail

getServletContext

isActive

close

invalidate

checkActive

getAttribute

getAttributeNames

getCharacterEncoding

setCharacterEncoding

setContent

getContentAsByteArray

getContentAsString

getContentLength

getContentLengthLong

setContentType

getContentType

getInputStream

setParameter

setParameter

setParameters

addParameter

addParameter

addParameters

removeParameter

removeAllParameters

getParameter

getParameterNames

getParameterValues

getParameterMap

setProtocol

getProtocol

setScheme

getScheme

setServerName

getServerName

setServerPort

getServerPort

getReader

setRemoteAddr

getRemoteAddr

setRemoteHost

getRemoteHost

setAttribute

removeAttribute

clearAttributes

addPreferredLocale

setPreferredLocales

getLocale

getLocales

setSecure

isSecure

getRequestDispatcher

getRealPath

setRemotePort

getRemotePort

setLocalName

getLocalName

setLocalAddr

getLocalAddr

setLocalPort