public class MockHttpServletRequest
extends java.lang.Object
javax.servlet.http.HttpServletRequest
interface.
As of Spring 4.0, this set of mocks is designed on a Servlet 3.0 baseline.
Modifier and Type | Field and Description |
---|---|
private boolean |
active |
private MockAsyncContext |
asyncContext |
private boolean |
asyncStarted |
private boolean |
asyncSupported |
private java.util.Map<java.lang.String,java.lang.Object> |
attributes |
private java.lang.String |
authType |
private java.lang.String |
characterEncoding |
private static java.lang.String |
CHARSET_PREFIX |
private byte[] |
content |
private static java.lang.String |
CONTENT_TYPE_HEADER |
private java.lang.String |
contentType |
private java.lang.String |
contextPath |
private Cookie[] |
cookies |
static java.lang.String |
DEFAULT_PROTOCOL
The default protocol: 'http'.
|
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_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'.
|
private DispatcherType |
dispatcherType |
private java.util.Map<java.lang.String,HeaderValueHolder> |
headers |
private java.lang.String |
localAddr |
private java.util.List<java.util.Locale> |
locales
List of locales in descending order
|
private java.lang.String |
localName |
private int |
localPort |
private java.lang.String |
method |
private java.util.Map<java.lang.String,java.lang.String[]> |
parameters |
private java.util.Map<java.lang.String,Part> |
parts |
private java.lang.String |
pathInfo |
private java.lang.String |
protocol |
private java.lang.String |
queryString |
private java.lang.String |
remoteAddr |
private java.lang.String |
remoteHost |
private int |
remotePort |
private java.lang.String |
remoteUser |
private java.lang.String |
requestedSessionId |
private boolean |
requestedSessionIdFromCookie |
private boolean |
requestedSessionIdFromURL |
private boolean |
requestedSessionIdValid |
private java.lang.String |
requestURI |
private java.lang.String |
scheme |
private boolean |
secure |
private java.lang.String |
serverName |
private int |
serverPort |
private ServletContext |
servletContext |
private java.lang.String |
servletPath |
private HttpSession |
session |
private java.security.Principal |
userPrincipal |
private java.util.Set<java.lang.String> |
userRoles |
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 . |
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 value)
Add a single value for the specified HTTP parameter.
|
void |
addParameter(java.lang.String name,
java.lang.String[] values)
Add an array of values for the specified HTTP parameter.
|
void |
addParameters(java.util.Map 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) |
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.
|
private void |
doAddHeaderValue(java.lang.String name,
java.lang.Object value,
boolean replace) |
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() |
int |
getContentLength() |
java.lang.String |
getContentType() |
java.lang.String |
getContextPath() |
Cookie[] |
getCookies() |
long |
getDateHeader(java.lang.String 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() |
java.util.Enumeration<java.util.Locale> |
getLocales() |
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) |
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() |
boolean |
isRequestedSessionIdFromURL() |
boolean |
isRequestedSessionIdValid() |
boolean |
isSecure() |
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) |
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 value)
Set a single value for the specified HTTP parameter.
|
void |
setParameter(java.lang.String name,
java.lang.String[] values)
Set an array of values for the specified HTTP parameter.
|
void |
setParameters(java.util.Map params)
Sets 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) |
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) |
private void |
updateContentTypeHeader() |
public static final java.lang.String DEFAULT_PROTOCOL
public static final java.lang.String DEFAULT_SERVER_ADDR
public static final java.lang.String DEFAULT_SERVER_NAME
public static final int DEFAULT_SERVER_PORT
public static final java.lang.String DEFAULT_REMOTE_ADDR
public static final java.lang.String DEFAULT_REMOTE_HOST
private static final java.lang.String CONTENT_TYPE_HEADER
private static final java.lang.String CHARSET_PREFIX
private boolean active
private final java.util.Map<java.lang.String,java.lang.Object> attributes
private java.lang.String characterEncoding
private byte[] content
private java.lang.String contentType
private final java.util.Map<java.lang.String,java.lang.String[]> parameters
private java.lang.String protocol
private java.lang.String scheme
private java.lang.String serverName
private int serverPort
private java.lang.String remoteAddr
private java.lang.String remoteHost
private final java.util.List<java.util.Locale> locales
private boolean secure
private final ServletContext servletContext
private int remotePort
private java.lang.String localName
private java.lang.String localAddr
private int localPort
private boolean asyncStarted
private boolean asyncSupported
private MockAsyncContext asyncContext
private DispatcherType dispatcherType
private java.lang.String authType
private Cookie[] cookies
private final java.util.Map<java.lang.String,HeaderValueHolder> headers
private java.lang.String method
private java.lang.String pathInfo
private java.lang.String contextPath
private java.lang.String queryString
private java.lang.String remoteUser
private final java.util.Set<java.lang.String> userRoles
private java.security.Principal userPrincipal
private java.lang.String requestedSessionId
private java.lang.String requestURI
private java.lang.String servletPath
private HttpSession session
private boolean requestedSessionIdValid
private boolean requestedSessionIdFromCookie
private boolean requestedSessionIdFromURL
private final java.util.Map<java.lang.String,Part> parts
public MockHttpServletRequest()
MockHttpServletRequest
with a default
MockServletContext
.public MockHttpServletRequest(java.lang.String method, java.lang.String requestURI)
MockHttpServletRequest
with a default
MockServletContext
.method
- the request method (may be null
)requestURI
- the request URI (may be null
)setMethod(java.lang.String)
,
setRequestURI(java.lang.String)
,
MockHttpServletRequest(ServletContext, String, String)
public MockHttpServletRequest(ServletContext servletContext)
MockHttpServletRequest
with the supplied ServletContext
.servletContext
- the ServletContext that the request runs in
(may be null
to use a default MockServletContext
)MockHttpServletRequest(ServletContext, String, String)
public MockHttpServletRequest(ServletContext servletContext, java.lang.String method, java.lang.String requestURI)
MockHttpServletRequest
with the supplied ServletContext
,
method
, and requestURI
.
The preferred locale will be set to Locale.ENGLISH
.
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
)setMethod(java.lang.String)
,
setRequestURI(java.lang.String)
,
setPreferredLocales(java.util.List<java.util.Locale>)
,
MockServletContext
public ServletContext getServletContext()
public boolean isActive()
public void close()
public void invalidate()
protected void checkActive() throws java.lang.IllegalStateException
java.lang.IllegalStateException
public java.lang.Object getAttribute(java.lang.String name)
public java.util.Enumeration<java.lang.String> getAttributeNames()
public java.lang.String getCharacterEncoding()
public void setCharacterEncoding(java.lang.String characterEncoding)
private void updateContentTypeHeader()
public void setContent(byte[] content)
public int getContentLength()
public void setContentType(java.lang.String contentType)
public java.lang.String getContentType()
public ServletInputStream getInputStream()
public void setParameter(java.lang.String name, java.lang.String value)
If there are already one or more values registered for the given parameter name, they will be replaced.
public void setParameter(java.lang.String name, java.lang.String[] values)
If there are already one or more values registered for the given parameter name, they will be replaced.
public void setParameters(java.util.Map params)
addParameters(java.util.Map)
.public void addParameter(java.lang.String name, java.lang.String value)
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.
public void addParameter(java.lang.String name, java.lang.String[] values)
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.
public void addParameters(java.util.Map params)
setParameters(java.util.Map)
.public void removeParameter(java.lang.String name)
public void removeAllParameters()
public java.lang.String getParameter(java.lang.String name)
public java.util.Enumeration<java.lang.String> getParameterNames()
public java.lang.String[] getParameterValues(java.lang.String name)
public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
public void setProtocol(java.lang.String protocol)
public java.lang.String getProtocol()
public void setScheme(java.lang.String scheme)
public java.lang.String getScheme()
public void setServerName(java.lang.String serverName)
public java.lang.String getServerName()
public void setServerPort(int serverPort)
public int getServerPort()
public java.io.BufferedReader getReader() throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException
public void setRemoteAddr(java.lang.String remoteAddr)
public java.lang.String getRemoteAddr()
public void setRemoteHost(java.lang.String remoteHost)
public java.lang.String getRemoteHost()
public void setAttribute(java.lang.String name, java.lang.Object value)
public void removeAttribute(java.lang.String name)
public void clearAttributes()
public void addPreferredLocale(java.util.Locale locale)
public void setPreferredLocales(java.util.List<java.util.Locale> locales)
addPreferredLocale(java.util.Locale)
public java.util.Locale getLocale()
public java.util.Enumeration<java.util.Locale> getLocales()
public void setSecure(boolean secure)
public boolean isSecure()
public RequestDispatcher getRequestDispatcher(java.lang.String path)
public java.lang.String getRealPath(java.lang.String path)
public void setRemotePort(int remotePort)
public int getRemotePort()
public void setLocalName(java.lang.String localName)
public java.lang.String getLocalName()
public void setLocalAddr(java.lang.String localAddr)
public java.lang.String getLocalAddr()
public void setLocalPort(int localPort)
public int getLocalPort()
public AsyncContext startAsync()
public AsyncContext startAsync(ServletRequest request, ServletResponse response)
public void setAsyncStarted(boolean asyncStarted)
public boolean isAsyncStarted()
public void setAsyncSupported(boolean asyncSupported)
public boolean isAsyncSupported()
public void setAsyncContext(MockAsyncContext asyncContext)
public AsyncContext getAsyncContext()
public void setDispatcherType(DispatcherType dispatcherType)
public DispatcherType getDispatcherType()
public void setAuthType(java.lang.String authType)
public java.lang.String getAuthType()
public void setCookies(Cookie... cookies)
public Cookie[] getCookies()
public void addHeader(java.lang.String name, java.lang.Object value)
If there was no entry for that header name before, the value will be used as-is. In case of an existing entry, a String array will be created, adding the given value (more specifically, its toString representation) as further element.
Multiple values can only be stored as list of Strings, following the
Servlet spec (see getHeaders
accessor). As alternative to
repeated addHeader
calls for individual elements, you can
use a single call with an entire array or Collection of values as
parameter.
private void doAddHeaderValue(java.lang.String name, java.lang.Object value, boolean replace)
public long getDateHeader(java.lang.String name)
public java.lang.String getHeader(java.lang.String name)
public java.util.Enumeration<java.lang.String> getHeaders(java.lang.String name)
public java.util.Enumeration<java.lang.String> getHeaderNames()
public int getIntHeader(java.lang.String name)
public void setMethod(java.lang.String method)
public java.lang.String getMethod()
public void setPathInfo(java.lang.String pathInfo)
public java.lang.String getPathInfo()
public java.lang.String getPathTranslated()
public void setContextPath(java.lang.String contextPath)
public java.lang.String getContextPath()
public void setQueryString(java.lang.String queryString)
public java.lang.String getQueryString()
public void setRemoteUser(java.lang.String remoteUser)
public java.lang.String getRemoteUser()
public void addUserRole(java.lang.String role)
public boolean isUserInRole(java.lang.String role)
public void setUserPrincipal(java.security.Principal userPrincipal)
public java.security.Principal getUserPrincipal()
public void setRequestedSessionId(java.lang.String requestedSessionId)
public java.lang.String getRequestedSessionId()
public void setRequestURI(java.lang.String requestURI)
public java.lang.String getRequestURI()
public java.lang.StringBuffer getRequestURL()
public void setServletPath(java.lang.String servletPath)
public java.lang.String getServletPath()
public void setSession(HttpSession session)
public HttpSession getSession(boolean create)
public HttpSession getSession()
public void setRequestedSessionIdValid(boolean requestedSessionIdValid)
public boolean isRequestedSessionIdValid()
public void setRequestedSessionIdFromCookie(boolean requestedSessionIdFromCookie)
public boolean isRequestedSessionIdFromCookie()
public void setRequestedSessionIdFromURL(boolean requestedSessionIdFromURL)
public boolean isRequestedSessionIdFromURL()
public boolean isRequestedSessionIdFromUrl()
public boolean authenticate(HttpServletResponse response) throws java.io.IOException, ServletException
java.io.IOException
ServletException
public void login(java.lang.String username, java.lang.String password) throws ServletException
ServletException
public void logout() throws ServletException
ServletException
public void addPart(Part part)
public Part getPart(java.lang.String name) throws java.io.IOException, java.lang.IllegalStateException, ServletException
java.io.IOException
java.lang.IllegalStateException
ServletException
public java.util.Collection<Part> getParts() throws java.io.IOException, java.lang.IllegalStateException, ServletException
java.io.IOException
java.lang.IllegalStateException
ServletException