MockServletRequest (Apache Juneau 7.2.2)

java.lang.Object
- org.apache.juneau.rest.mock.MockServletRequest

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest, MockHttpRequest
```
public class MockServletRequest
extends Object
implements javax.servlet.http.HttpServletRequest, MockHttpRequest
```
An implementation of HttpServletRequest for mocking purposes.
See Also:
- Overview > juneau-rest-server > Serverless Unit Testing

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

Constructor Summary

Constructors
Constructor and Description

MockServletRequest()

Constructors
Constructor and Description
`MockServletRequest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MockServletRequest`	`accept(Object value)` Specifies the `Accept` header value on the request.
`MockServletRequest`	`acceptCharset(Object value)` Specifies the `Accept-Charset` header value on the request.
`MockServletRequest`	`acceptEncoding(Object value)` Specifies the `Accept-Encoding` header value on the request.
`MockServletRequest`	`acceptLanguage(Object value)` Specifies the `Accept-Language` header value on the request.
`MockServletRequest`	`attribute(String name, Object value)` Fluent setter.
`boolean`	`authenticate(javax.servlet.http.HttpServletResponse response)`
`MockServletRequest`	`authorization(Object value)` Specifies the `Authorization` header value on the request.
`MockServletRequest`	`authType(String value)` Fluent setter.
`MockServletRequest`	`body(Object value)` Fluent setter.
`MockServletRequest`	`cacheControl(Object value)` Specifies the `Cache-Control` header value on the request.
`String`	`changeSessionId()`
`MockServletRequest`	`characterEncoding(String value)` Fluent setter.
`MockServletRequest`	`clientVersion(Object value)` Specifies the `X-Client-Version` header value on the request.
`MockServletRequest`	`connection(Object value)` Specifies the `Connection` header value on the request.
`MockServletRequest`	`contentEncoding(Object value)` Specifies the `Content-Encoding` header value on the request.
`MockServletRequest`	`contentLength(Object value)` Specifies the `Content-Length` header value on the request.
`MockServletRequest`	`contentType(Object value)` Specifies the `Content-Type` header value on the request.
`MockServletRequest`	`contextPath(String value)` Fluent setter.
`MockServletRequest`	`cookies(javax.servlet.http.Cookie[] value)` Fluent setter.
`static MockServletRequest`	`create()` Creates a new servlet request.
`static MockServletRequest`	`create(String method, String path, Object... pathArgs)` Creates a new servlet request with the specified method name and request path.
`MockServletRequest`	`date(Object value)` Specifies the `Date` header value on the request.
`MockServletRequest`	`debug()` Enabled debug mode on this request.
`MockServletRequest`	`dispatcherType(javax.servlet.DispatcherType value)` Fluent setter.
`MockServletResponse`	`execute()` Executes this request and returns the response object.
`MockServletRequest`	`expect(Object value)` Specifies the `Expect` header value on the request.
`MockServletRequest`	`formData(String key, Object value)` Adds a form data entry to this request.
`MockServletRequest`	`from(Object value)` Specifies the `From` header value on the request.
`javax.servlet.AsyncContext`	`getAsyncContext()`
`Object`	`getAttribute(String name)`
`Enumeration<String>`	`getAttributeNames()`
`String`	`getAuthType()`
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`long`	`getContentLengthLong()`
`String`	`getContentType()`
`String`	`getContextPath()`
`javax.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(String name)`
`javax.servlet.DispatcherType`	`getDispatcherType()`
`String`	`getHeader(String name)`
`Enumeration<String>`	`getHeaderNames()`
`Enumeration<String>`	`getHeaders(String name)`
`javax.servlet.ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(String name)`
`String`	`getLocalAddr()`
`Locale`	`getLocale()`
`Enumeration<Locale>`	`getLocales()`
`String`	`getLocalName()`
`int`	`getLocalPort()`
`String`	`getMethod()`
`String`	`getParameter(String name)`
`Map<String,String[]>`	`getParameterMap()`
`Enumeration<String>`	`getParameterNames()`
`String[]`	`getParameterValues(String name)`
`javax.servlet.http.Part`	`getPart(String name)`
`Collection<javax.servlet.http.Part>`	`getParts()`
`String`	`getPathInfo()`
`String`	`getPathTranslated()`
`String`	`getProtocol()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRealPath(String path)`
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`String`	`getRemoteUser()`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String path)`
`String`	`getRequestedSessionId()`
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`javax.servlet.ServletContext`	`getServletContext()`
`String`	`getServletPath()`
`javax.servlet.http.HttpSession`	`getSession()`
`javax.servlet.http.HttpSession`	`getSession(boolean create)`
`Principal`	`getUserPrincipal()`
`MockServletRequest`	`header(String name, Object value)` Fluent setter.
`MockServletRequest`	`host(Object value)` Specifies the `Host` header value on the request.
`MockServletRequest`	`html()` Convenience method for setting `Accept` and `Content-Type` headers to "text/html".
`MockServletRequest`	`httpSession(javax.servlet.http.HttpSession value)` Fluent setter.
`MockServletRequest`	`ifMatch(Object value)` Specifies the `If-Match` header value on the request.
`MockServletRequest`	`ifModifiedSince(Object value)` Specifies the `If-Modified-Since` header value on the request.
`MockServletRequest`	`ifNoneMatch(Object value)` Specifies the `If-None-Match` header value on the request.
`MockServletRequest`	`ifRange(Object value)` Specifies the `If-Range` header value on the request.
`MockServletRequest`	`ifUnmodifiedSince(Object value)` Specifies the `If-Unmodified-Since` header value on the request.
`boolean`	`isAsyncStarted()`
`boolean`	`isAsyncSupported()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(String role)`
`MockServletRequest`	`json()` Convenience method for setting `Accept` and `Content-Type` headers to "application/json".
`MockServletRequest`	`localAddr(String value)` Fluent setter.
`MockServletRequest`	`locale(Locale value)` Fluent setter.
`MockServletRequest`	`localName(String value)` Fluent setter.
`MockServletRequest`	`localPort(int value)` Fluent setter.
`void`	`login(String username, String password)`
`void`	`logout()`
`MockServletRequest`	`maxForwards(Object value)` Specifies the `Max-Forwards` header value on the request.
`MockServletRequest`	`method(String value)` Fluent setter.
`MockServletRequest`	`msgpack()` Convenience method for setting `Accept` and `Content-Type` headers to "octal/msgpack".
`MockServletRequest`	`pathInfo(String value)` Fluent setter.
`MockServletRequest`	`pathTranslated(String value)` Fluent setter.
`MockServletRequest`	`plainText()` Convenience method for setting `Accept` and `Content-Type` headers to "text/plain".
`MockServletRequest`	`pragma(Object value)` Specifies the `Pragma` header value on the request.
`MockServletRequest`	`protocol(String value)` Fluent setter.
`MockServletRequest`	`proxyAuthorization(Object value)` Specifies the `Proxy-Authorization` header value on the request.
`MockServletRequest`	`query(String key, Object value)` Adds a query data entry to this request.
`MockServletRequest`	`queryString(String value)` Fluent setter.
`MockServletRequest`	`range(Object value)` Specifies the `Range` header value on the request.
`MockServletRequest`	`realPath(String value)` Fluent setter.
`MockServletRequest`	`referer(Object value)` Specifies the `Referer` header value on the request.
`MockServletRequest`	`remoteAddr(String value)` Fluent setter.
`MockServletRequest`	`remoteHost(String value)` Fluent setter.
`MockServletRequest`	`remotePort(int value)` Fluent setter.
`MockServletRequest`	`remoteUser(String value)` Fluent setter.
`void`	`removeAttribute(String name)`
`MockServletRequest`	`requestDispatcher(javax.servlet.RequestDispatcher value)` Fluent setter.
`MockServletRequest`	`requestedSessionId(String value)` Fluent setter.
`MockServletRequest`	`requestURI(String value)` Fluent setter.
`MockServletRequest`	`restContext(RestContext restContext)` Fluent setter.
`MockServletRequest`	`scheme(String value)` Fluent setter.
`MockServletRequest`	`serverName(String value)` Fluent setter.
`MockServletRequest`	`serverPort(int value)` Fluent setter.
`MockServletRequest`	`servletContext(javax.servlet.ServletContext value)` Fluent setter.
`MockServletRequest`	`servletPath(String value)` Fluent setter.
`void`	`setAttribute(String name, Object o)`
`void`	`setCharacterEncoding(String characterEncoding)`
`javax.servlet.AsyncContext`	`startAsync()`
`javax.servlet.AsyncContext`	`startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)`
`MockServletRequest`	`te(Object value)` Specifies the `TE` header value on the request.
`MockServletRequest`	`uon()` Convenience method for setting `Accept` and `Content-Type` headers to "text/uon".
`<T extends javax.servlet.http.HttpUpgradeHandler> T`	`upgrade(Class<T> handlerClass)`
`MockServletRequest`	`upgrade(Object value)` Specifies the `Upgrade` header value on the request.
`MockServletRequest`	`uri(String uri)` Fluent setter.
`MockServletRequest`	`urlEnc()` Convenience method for setting `Accept` and `Content-Type` headers to "application/x-www-form-urlencoded".
`MockServletRequest`	`userAgent(Object value)` Specifies the `User-Agent` header value on the request.
`MockServletRequest`	`userPrincipal(Principal value)` Fluent setter.
`MockServletRequest`	`warning(Object value)` Specifies the `Warning` header value on the request.
`MockServletRequest`	`xml()` Convenience method for setting `Accept` and `Content-Type` headers to "text/xml".
`MockServletRequest`	`yaml()` Convenience method for setting `Accept` and `Content-Type` headers to "text/yaml".

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MockServletRequest
```
public MockServletRequest()
```
- Method Detail
  - create
```
public static MockServletRequest create()
```
    Creates a new servlet request. Initialized with the following:
    - "Accept: text/json+simple"
    - "Content-Type: text/json"
    Returns:
    
    A new request.
  - create
```
public static MockServletRequest create(String method,
                                        String path,
                                        Object... pathArgs)
```
    Creates a new servlet request with the specified method name and request path. Initialized with the following:
    - "Accept: text/json+simple"
    - "Content-Type: text/json"
    Parameters:
    
    method - The HTTP method name.
    
    path - The request path.
    
    pathArgs - Optional path arguments.
    
    Returns:
    
    A new request.
  - json
```
public MockServletRequest json()
```
    Convenience method for setting Accept and Content-Type headers to "application/json".
    
    Returns:
    
    This object (for method chaining).
  - xml
```
public MockServletRequest xml()
```
    Convenience method for setting Accept and Content-Type headers to "text/xml".
    
    Returns:
    
    This object (for method chaining).
  - html
```
public MockServletRequest html()
```
    Convenience method for setting Accept and Content-Type headers to "text/html".
    
    Returns:
    
    This object (for method chaining).
  - plainText
```
public MockServletRequest plainText()
```
    Convenience method for setting Accept and Content-Type headers to "text/plain".
    
    Returns:
    
    This object (for method chaining).
  - msgpack
```
public MockServletRequest msgpack()
```
    Convenience method for setting Accept and Content-Type headers to "octal/msgpack".
    
    Returns:
    
    This object (for method chaining).
  - uon
```
public MockServletRequest uon()
```
    Convenience method for setting Accept and Content-Type headers to "text/uon".
    
    Returns:
    
    This object (for method chaining).
  - urlEnc
```
public MockServletRequest urlEnc()
```
    Convenience method for setting Accept and Content-Type headers to "application/x-www-form-urlencoded".
    
    Returns:
    
    This object (for method chaining).
  - yaml
```
public MockServletRequest yaml()
```
    Convenience method for setting Accept and Content-Type headers to "text/yaml".
    
    Returns:
    
    This object (for method chaining).
  - uri
```
public MockServletRequest uri(String uri)
```
    Fluent setter.
    
    Specified by:
    
    uri in interface MockHttpRequest
    
    Parameters:
    
    uri - The URI of the request.
    
    Returns:
    
    This object (for method chaining).
  - restContext
```
public MockServletRequest restContext(RestContext restContext)
```
    Fluent setter.
    
    Parameters:
    
    restContext - The rest context.
    
    Returns:
    
    This object (for method chaining).
  - execute
```
public MockServletResponse execute()
                            throws Exception
```
    Executes this request and returns the response object.
    
    Specified by:
    
    execute in interface MockHttpRequest
    
    Returns:
    
    The response object.
    
    Throws:
    
    Exception
  - method
```
public MockServletRequest method(String value)
```
    Fluent setter.
    
    Specified by:
    
    method in interface MockHttpRequest
    
    Parameters:
    
    value - The method name for this request.
    
    Returns:
    
    This object (for method chaining).
  - characterEncoding
```
public MockServletRequest characterEncoding(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The character encoding.
    
    Returns:
    
    This object (for method chaining).
  - protocol
```
public MockServletRequest protocol(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The protocol.
    
    Returns:
    
    This object (for method chaining).
  - scheme
```
public MockServletRequest scheme(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The scheme.
    
    Returns:
    
    This object (for method chaining).
  - serverName
```
public MockServletRequest serverName(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The server name.
    
    Returns:
    
    This object (for method chaining).
  - serverPort
```
public MockServletRequest serverPort(int value)
```
    Fluent setter.
    
    Parameters:
    
    value - The server port.
    
    Returns:
    
    This object (for method chaining).
  - remoteAddr
```
public MockServletRequest remoteAddr(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The remote address.
    
    Returns:
    
    This object (for method chaining).
  - remoteHost
```
public MockServletRequest remoteHost(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The remote port.
    
    Returns:
    
    This object (for method chaining).
  - locale
```
public MockServletRequest locale(Locale value)
```
    Fluent setter.
    
    Parameters:
    
    value - The locale.
    
    Returns:
    
    This object (for method chaining).
  - realPath
```
public MockServletRequest realPath(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The real path.
    
    Returns:
    
    This object (for method chaining).
  - remotePort
```
public MockServletRequest remotePort(int value)
```
    Fluent setter.
    
    Parameters:
    
    value - The remote port.
    
    Returns:
    
    This object (for method chaining).
  - localName
```
public MockServletRequest localName(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The local name.
    
    Returns:
    
    This object (for method chaining).
  - localAddr
```
public MockServletRequest localAddr(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The local address.
    
    Returns:
    
    This object (for method chaining).
  - localPort
```
public MockServletRequest localPort(int value)
```
    Fluent setter.
    
    Parameters:
    
    value - The local port.
    
    Returns:
    
    This object (for method chaining).
  - requestDispatcher
```
public MockServletRequest requestDispatcher(javax.servlet.RequestDispatcher value)
```
    Fluent setter.
    
    Parameters:
    
    value - The request dispatcher.
    
    Returns:
    
    This object (for method chaining).
  - servletContext
```
public MockServletRequest servletContext(javax.servlet.ServletContext value)
```
    Fluent setter.
    
    Parameters:
    
    value - The servlet context.
    
    Returns:
    
    This object (for method chaining).
  - dispatcherType
```
public MockServletRequest dispatcherType(javax.servlet.DispatcherType value)
```
    Fluent setter.
    
    Parameters:
    
    value - The dispatcher type.
    
    Returns:
    
    This object (for method chaining).
  - authType
```
public MockServletRequest authType(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The auth type.
    
    Returns:
    
    This object (for method chaining).
  - cookies
```
public MockServletRequest cookies(javax.servlet.http.Cookie[] value)
```
    Fluent setter.
    
    Parameters:
    
    value - The cookies.
    
    Returns:
    
    This object (for method chaining).
  - pathInfo
```
public MockServletRequest pathInfo(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The path info.
    
    Returns:
    
    This object (for method chaining).
  - pathTranslated
```
public MockServletRequest pathTranslated(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The path translated.
    
    Returns:
    
    This object (for method chaining).
  - contextPath
```
public MockServletRequest contextPath(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The context path.
    
    Returns:
    
    This object (for method chaining).
  - queryString
```
public MockServletRequest queryString(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The query string.
    
    Returns:
    
    This object (for method chaining).
  - remoteUser
```
public MockServletRequest remoteUser(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The remote user.
    
    Returns:
    
    This object (for method chaining).
  - userPrincipal
```
public MockServletRequest userPrincipal(Principal value)
```
    Fluent setter.
    
    Parameters:
    
    value - The user principal.
    
    Returns:
    
    This object (for method chaining).
  - requestedSessionId
```
public MockServletRequest requestedSessionId(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The requested session ID.
    
    Returns:
    
    This object (for method chaining).
  - requestURI
```
public MockServletRequest requestURI(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The request URI.
    
    Returns:
    
    This object (for method chaining).
  - servletPath
```
public MockServletRequest servletPath(String value)
```
    Fluent setter.
    
    Parameters:
    
    value - The servlet path.
    
    Returns:
    
    This object (for method chaining).
  - httpSession
```
public MockServletRequest httpSession(javax.servlet.http.HttpSession value)
```
    Fluent setter.
    
    Parameters:
    
    value - The HTTP session.
    
    Returns:
    
    This object (for method chaining).
  - getAttribute
```
public Object getAttribute(String name)
```
    Specified by:
    
    getAttribute in interface javax.servlet.ServletRequest
  - getAttributeNames
```
public Enumeration<String> getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface javax.servlet.ServletRequest
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface javax.servlet.ServletRequest
  - setCharacterEncoding
```
public void setCharacterEncoding(String characterEncoding)
                          throws UnsupportedEncodingException
```
    Specified by:
    
    setCharacterEncoding in interface javax.servlet.ServletRequest
    
    Throws:
    
    UnsupportedEncodingException
  - getContentLength
```
public int getContentLength()
```
    Specified by:
    
    getContentLength in interface javax.servlet.ServletRequest
  - getContentLengthLong
```
public long getContentLengthLong()
```
    Specified by:
    
    getContentLengthLong in interface javax.servlet.ServletRequest
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface javax.servlet.ServletRequest
  - getInputStream
```
public javax.servlet.ServletInputStream getInputStream()
                                                throws IOException
```
    Specified by:
    
    getInputStream in interface javax.servlet.ServletRequest
    
    Throws:
    
    IOException
  - getParameter
```
public String getParameter(String name)
```
    Specified by:
    
    getParameter in interface javax.servlet.ServletRequest
  - getParameterNames
```
public Enumeration<String> getParameterNames()
```
    Specified by:
    
    getParameterNames in interface javax.servlet.ServletRequest
  - getParameterValues
```
public String[] getParameterValues(String name)
```
    Specified by:
    
    getParameterValues in interface javax.servlet.ServletRequest
  - getParameterMap
```
public Map<String,String[]> getParameterMap()
```
    Specified by:
    
    getParameterMap in interface javax.servlet.ServletRequest
  - getProtocol
```
public String getProtocol()
```
    Specified by:
    
    getProtocol in interface javax.servlet.ServletRequest
  - getScheme
```
public String getScheme()
```
    Specified by:
    
    getScheme in interface javax.servlet.ServletRequest
  - getServerName
```
public String getServerName()
```
    Specified by:
    
    getServerName in interface javax.servlet.ServletRequest
  - getServerPort
```
public int getServerPort()
```
    Specified by:
    
    getServerPort in interface javax.servlet.ServletRequest
  - getReader
```
public BufferedReader getReader()
                         throws IOException
```
    Specified by:
    
    getReader in interface javax.servlet.ServletRequest
    
    Throws:
    
    IOException
  - getRemoteAddr
```
public String getRemoteAddr()
```
    Specified by:
    
    getRemoteAddr in interface javax.servlet.ServletRequest
  - getRemoteHost
```
public String getRemoteHost()
```
    Specified by:
    
    getRemoteHost in interface javax.servlet.ServletRequest
  - setAttribute
```
public void setAttribute(String name,
                         Object o)
```
    Specified by:
    
    setAttribute in interface javax.servlet.ServletRequest
  - removeAttribute
```
public void removeAttribute(String name)
```
    Specified by:
    
    removeAttribute in interface javax.servlet.ServletRequest
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface javax.servlet.ServletRequest
  - getLocales
```
public Enumeration<Locale> getLocales()
```
    Specified by:
    
    getLocales in interface javax.servlet.ServletRequest
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure in interface javax.servlet.ServletRequest
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(String path)
```
    Specified by:
    
    getRequestDispatcher in interface javax.servlet.ServletRequest
  - getRealPath
```
public String getRealPath(String path)
```
    Specified by:
    
    getRealPath in interface javax.servlet.ServletRequest
  - getRemotePort
```
public int getRemotePort()
```
    Specified by:
    
    getRemotePort in interface javax.servlet.ServletRequest
  - getLocalName
```
public String getLocalName()
```
    Specified by:
    
    getLocalName in interface javax.servlet.ServletRequest
  - getLocalAddr
```
public String getLocalAddr()
```
    Specified by:
    
    getLocalAddr in interface javax.servlet.ServletRequest
  - getLocalPort
```
public int getLocalPort()
```
    Specified by:
    
    getLocalPort in interface javax.servlet.ServletRequest
  - getServletContext
```
public javax.servlet.ServletContext getServletContext()
```
    Specified by:
    
    getServletContext in interface javax.servlet.ServletRequest
  - startAsync
```
public javax.servlet.AsyncContext startAsync()
                                      throws IllegalStateException
```
    Specified by:
    
    startAsync in interface javax.servlet.ServletRequest
    
    Throws:
    
    IllegalStateException
  - startAsync
```
public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest servletRequest,
                                             javax.servlet.ServletResponse servletResponse)
                                      throws IllegalStateException
```
    Specified by:
    
    startAsync in interface javax.servlet.ServletRequest
    
    Throws:
    
    IllegalStateException
  - isAsyncStarted
```
public boolean isAsyncStarted()
```
    Specified by:
    
    isAsyncStarted in interface javax.servlet.ServletRequest
  - isAsyncSupported
```
public boolean isAsyncSupported()
```
    Specified by:
    
    isAsyncSupported in interface javax.servlet.ServletRequest
  - getAsyncContext
```
public javax.servlet.AsyncContext getAsyncContext()
```
    Specified by:
    
    getAsyncContext in interface javax.servlet.ServletRequest
  - getDispatcherType
```
public javax.servlet.DispatcherType getDispatcherType()
```
    Specified by:
    
    getDispatcherType in interface javax.servlet.ServletRequest
  - getAuthType
```
public String getAuthType()
```
    Specified by:
    
    getAuthType in interface javax.servlet.http.HttpServletRequest
  - getCookies
```
public javax.servlet.http.Cookie[] getCookies()
```
    Specified by:
    
    getCookies in interface javax.servlet.http.HttpServletRequest
  - getDateHeader
```
public long getDateHeader(String name)
```
    Specified by:
    
    getDateHeader in interface javax.servlet.http.HttpServletRequest
  - getHeader
```
public String getHeader(String name)
```
    Specified by:
    
    getHeader in interface javax.servlet.http.HttpServletRequest
  - getHeaders
```
public Enumeration<String> getHeaders(String name)
```
    Specified by:
    
    getHeaders in interface javax.servlet.http.HttpServletRequest
  - getHeaderNames
```
public Enumeration<String> getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface javax.servlet.http.HttpServletRequest
  - getIntHeader
```
public int getIntHeader(String name)
```
    Specified by:
    
    getIntHeader in interface javax.servlet.http.HttpServletRequest
  - getMethod
```
public String getMethod()
```
    Specified by:
    
    getMethod in interface javax.servlet.http.HttpServletRequest
  - getPathInfo
```
public String getPathInfo()
```
    Specified by:
    
    getPathInfo in interface javax.servlet.http.HttpServletRequest
  - getPathTranslated
```
public String getPathTranslated()
```
    Specified by:
    
    getPathTranslated in interface javax.servlet.http.HttpServletRequest
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath in interface javax.servlet.http.HttpServletRequest
  - getQueryString
```
public String getQueryString()
```
    Specified by:
    
    getQueryString in interface javax.servlet.http.HttpServletRequest
  - getRemoteUser
```
public String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in interface javax.servlet.http.HttpServletRequest
  - isUserInRole
```
public boolean isUserInRole(String role)
```
    Specified by:
    
    isUserInRole in interface javax.servlet.http.HttpServletRequest
  - getUserPrincipal
```
public Principal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal in interface javax.servlet.http.HttpServletRequest
  - getRequestedSessionId
```
public String getRequestedSessionId()
```
    Specified by:
    
    getRequestedSessionId in interface javax.servlet.http.HttpServletRequest
  - getRequestURI
```
public String getRequestURI()
```
    Specified by:
    
    getRequestURI in interface javax.servlet.http.HttpServletRequest
  - getRequestURL
```
public StringBuffer getRequestURL()
```
    Specified by:
    
    getRequestURL in interface javax.servlet.http.HttpServletRequest
  - getServletPath
```
public String getServletPath()
```
    Specified by:
    
    getServletPath in interface javax.servlet.http.HttpServletRequest
  - getSession
```
public javax.servlet.http.HttpSession getSession(boolean create)
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
  - getSession
```
public javax.servlet.http.HttpSession getSession()
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
  - changeSessionId
```
public String changeSessionId()
```
    Specified by:
    
    changeSessionId in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
    Specified by:
    
    isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromCookie
```
public boolean isRequestedSessionIdFromCookie()
```
    Specified by:
    
    isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromURL
```
public boolean isRequestedSessionIdFromURL()
```
    Specified by:
    
    isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromUrl
```
public boolean isRequestedSessionIdFromUrl()
```
    Specified by:
    
    isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest
  - authenticate
```
public boolean authenticate(javax.servlet.http.HttpServletResponse response)
                     throws IOException,
                            javax.servlet.ServletException
```
    Specified by:
    
    authenticate in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    javax.servlet.ServletException
  - login
```
public void login(String username,
                  String password)
           throws javax.servlet.ServletException
```
    Specified by:
    
    login in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    javax.servlet.ServletException
  - logout
```
public void logout()
            throws javax.servlet.ServletException
```
    Specified by:
    
    logout in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    javax.servlet.ServletException
  - getParts
```
public Collection<javax.servlet.http.Part> getParts()
                                             throws IOException,
                                                    javax.servlet.ServletException
```
    Specified by:
    
    getParts in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    javax.servlet.ServletException
  - getPart
```
public javax.servlet.http.Part getPart(String name)
                                throws IOException,
                                       javax.servlet.ServletException
```
    Specified by:
    
    getPart in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    javax.servlet.ServletException
  - upgrade
```
public <T extends javax.servlet.http.HttpUpgradeHandler> T upgrade(Class<T> handlerClass)
                                                            throws IOException,
                                                                   javax.servlet.ServletException
```
    Specified by:
    
    upgrade in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    javax.servlet.ServletException
  - header
```
public MockServletRequest header(String name,
                                 Object value)
```
    Fluent setter.
    
    Specified by:
    
    header in interface MockHttpRequest
    
    Parameters:
    
    name - Header name.
    
    value - Header value.
    The value is converted to a simple string using Object.toString().
    
    Returns:
    
    This object (for method chaining).
  - attribute
```
public MockServletRequest attribute(String name,
                                    Object value)
```
    Fluent setter.
    
    Parameters:
    
    name - Request attribute name.
    
    value - Request attribute value.
    
    Returns:
    
    This object (for method chaining).
  - body
```
public MockServletRequest body(Object value)
```
    Fluent setter.
    Specified by:
    
    body in interface MockHttpRequest
    
    Parameters:
    value - The body of the request.
    Can be any of the following data types:
    
    byte[]
    Reader
    InputStream
    CharSequence
    Returns:
    
    This object (for method chaining).
  - formData
```
public MockServletRequest formData(String key,
                                   Object value)
```
    Adds a form data entry to this request.
    
    Parameters:
    
    key - The form data key.
    
    value - The form data value.
    The value is converted to a simple string using Object.toString().
    
    Returns:
    
    This object (for method chaining).
  - query
```
public MockServletRequest query(String key,
                                Object value)
```
    Adds a query data entry to this request.
    
    Parameters:
    
    key - The query key.
    
    value - The query value.
    The value is converted to a simple string using Object.toString().
    
    Returns:
    
    This object (for method chaining).
  - accept
```
public MockServletRequest accept(Object value)
```
    Specifies the Accept header value on the request.
    
    Parameters:
    
    value - The new value.
    
    Returns:
    
    This object (for method chaining).
  - acceptCharset
```
public MockServletRequest acceptCharset(Object value)
```
    Specifies the Accept-Charset header value on the request.
    
    Parameters:
    
    value - The new value.
    
    Returns:
    
    This object (for method chaining).
  - acceptEncoding
```
public MockServletRequest acceptEncoding(Object value)
```
    Specifies the Accept-Encoding header value on the request.
    
    Parameters:
    
    value - The new value.
    
    Returns:
    
    This object (for method chaining).
  - acceptLanguage
```
public MockServletRequest acceptLanguage(Object value)
```
    Specifies the Accept-Language header value on the request.
    
    Parameters:
    
    value - The new value.
    
    Returns:
    
    This object (for method chaining).
  - authorization
```
public MockServletRequest authorization(Object value)
```
    Specifies the Authorization header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - cacheControl
```
public MockServletRequest cacheControl(Object value)
```
    Specifies the Cache-Control header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - clientVersion
```
public MockServletRequest clientVersion(Object value)
```
    Specifies the X-Client-Version header value on the request.
    
    Parameters:
    
    value - The new value.
    
    Returns:
    
    This object (for method chaining).
  - connection
```
public MockServletRequest connection(Object value)
```
    Specifies the Connection header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - contentEncoding
```
public MockServletRequest contentEncoding(Object value)
```
    Specifies the Content-Encoding header value on the request.
    
    Parameters:
    
    value - The new value.
    
    Returns:
    
    This object (for method chaining).
  - contentLength
```
public MockServletRequest contentLength(Object value)
```
    Specifies the Content-Length header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - contentType
```
public MockServletRequest contentType(Object value)
```
    Specifies the Content-Type header value on the request.
    
    Parameters:
    
    value - The new value.
    
    Returns:
    
    This object (for method chaining).
  - date
```
public MockServletRequest date(Object value)
```
    Specifies the Date header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - expect
```
public MockServletRequest expect(Object value)
```
    Specifies the Expect header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - from
```
public MockServletRequest from(Object value)
```
    Specifies the From header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - host
```
public MockServletRequest host(Object value)
```
    Specifies the Host header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - ifMatch
```
public MockServletRequest ifMatch(Object value)
```
    Specifies the If-Match header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - ifModifiedSince
```
public MockServletRequest ifModifiedSince(Object value)
```
    Specifies the If-Modified-Since header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - ifNoneMatch
```
public MockServletRequest ifNoneMatch(Object value)
```
    Specifies the If-None-Match header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - ifRange
```
public MockServletRequest ifRange(Object value)
```
    Specifies the If-Range header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - ifUnmodifiedSince
```
public MockServletRequest ifUnmodifiedSince(Object value)
```
    Specifies the If-Unmodified-Since header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - maxForwards
```
public MockServletRequest maxForwards(Object value)
```
    Specifies the Max-Forwards header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - pragma
```
public MockServletRequest pragma(Object value)
```
    Specifies the Pragma header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - proxyAuthorization
```
public MockServletRequest proxyAuthorization(Object value)
```
    Specifies the Proxy-Authorization header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - range
```
public MockServletRequest range(Object value)
```
    Specifies the Range header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - referer
```
public MockServletRequest referer(Object value)
```
    Specifies the Referer header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - te
```
public MockServletRequest te(Object value)
```
    Specifies the TE header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - upgrade
```
public MockServletRequest upgrade(Object value)
```
    Specifies the Upgrade header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - userAgent
```
public MockServletRequest userAgent(Object value)
```
    Specifies the User-Agent header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - warning
```
public MockServletRequest warning(Object value)
```
    Specifies the Warning header value on the request.
    
    Parameters:
    
    value - The new value for the header.
    
    Returns:
    
    This object (for method chaining).
  - debug
```
public MockServletRequest debug()
```
    Enabled debug mode on this request.
    Causes information about the request execution to be sent to STDERR.
    
    Returns:
    
    This object (for method chaining).

Class MockServletRequest

See Also:

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MockServletRequest

Method Detail

create

create

json

xml

html

plainText

msgpack

uon

urlEnc

yaml

uri

restContext

execute

method

characterEncoding

protocol

scheme

serverName

serverPort

remoteAddr

remoteHost

locale

realPath

remotePort

localName

localAddr

localPort

requestDispatcher

servletContext

dispatcherType

authType

cookies

pathInfo

pathTranslated

contextPath

queryString

remoteUser

userPrincipal

requestedSessionId

requestURI

servletPath

httpSession

getAttribute

getAttributeNames

getCharacterEncoding

setCharacterEncoding

getContentLength

getContentLengthLong

getContentType

getInputStream

getParameter

getParameterNames

getParameterValues

getParameterMap

getProtocol

getScheme

getServerName

getServerPort

getReader

getRemoteAddr

getRemoteHost

setAttribute

removeAttribute

getLocale

getLocales

isSecure

getRequestDispatcher

getRealPath

getRemotePort

getLocalName