public class MockHttpServletRequest
extends java.lang.Object
implements javax.servlet.http.HttpServletRequest
Mock HttpServletRequest object for low-level unit tests of Struts controller components. Coarser grained tests should be implemented in terms of the Cactus framework, instead of the mock object classes.
WARNING - Only the minimal set of methods needed to
create unit tests is provided, plus additional methods to configure this
object as necessary. Methods for unsupported operations will throw
UnsupportedOperationException
.
WARNING - Because unit tests operate in a single threaded environment, no synchronization is performed.
Modifier and Type | Field and Description |
---|---|
protected java.util.HashMap |
attributes
The set of request attributes.
|
protected java.lang.String |
contentType
The Content Type for this request.
|
protected java.lang.String |
contextPath
The context path for this request.
|
protected java.util.Locale |
locale
The preferred locale for this request.
|
protected java.lang.String |
method
The HTTP request method.
|
protected java.util.HashMap |
parameters
The set of arrays of parameter values, keyed by parameter name.
|
protected java.lang.String |
pathInfo
The extra path information for this request.
|
protected java.security.Principal |
principal
The authenticated user for this request.
|
protected java.lang.String |
queryString
The query string for this request.
|
protected java.lang.String |
servletPath
The servlet path for this request.
|
protected javax.servlet.http.HttpSession |
session
The HttpSession with which we are associated.
|
Constructor and Description |
---|
MockHttpServletRequest() |
MockHttpServletRequest(javax.servlet.http.HttpSession session) |
MockHttpServletRequest(java.lang.String contextPath,
java.lang.String servletPath,
java.lang.String pathInfo,
java.lang.String queryString) |
MockHttpServletRequest(java.lang.String contextPath,
java.lang.String servletPath,
java.lang.String pathInfo,
java.lang.String queryString,
javax.servlet.http.HttpSession session) |
Modifier and Type | Method and Description |
---|---|
void |
addParameter(java.lang.String name,
java.lang.String value) |
boolean |
authenticate(javax.servlet.http.HttpServletResponse response) |
java.lang.String |
changeSessionId() |
javax.servlet.AsyncContext |
getAsyncContext() |
java.lang.Object |
getAttribute(java.lang.String name) |
java.util.Enumeration |
getAttributeNames() |
java.lang.String |
getAuthType() |
java.lang.String |
getCharacterEncoding() |
int |
getContentLength() |
long |
getContentLengthLong() |
java.lang.String |
getContentType() |
java.lang.String |
getContextPath() |
javax.servlet.http.Cookie[] |
getCookies() |
long |
getDateHeader(java.lang.String name) |
javax.servlet.DispatcherType |
getDispatcherType() |
java.lang.String |
getHeader(java.lang.String name) |
java.util.Enumeration |
getHeaderNames() |
java.util.Enumeration |
getHeaders(java.lang.String name) |
javax.servlet.ServletInputStream |
getInputStream() |
int |
getIntHeader(java.lang.String name) |
java.lang.String |
getLocalAddr() |
java.util.Locale |
getLocale() |
java.util.Enumeration |
getLocales() |
java.lang.String |
getLocalName() |
int |
getLocalPort() |
java.lang.String |
getMethod() |
java.lang.String |
getParameter(java.lang.String name) |
java.util.Map |
getParameterMap() |
java.util.Enumeration |
getParameterNames() |
java.lang.String[] |
getParameterValues(java.lang.String name) |
javax.servlet.http.Part |
getPart(java.lang.String name) |
java.util.Collection<javax.servlet.http.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() |
java.lang.String |
getRemoteName() |
int |
getRemotePort() |
java.lang.String |
getRemoteUser() |
javax.servlet.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() |
javax.servlet.ServletContext |
getServletContext() |
java.lang.String |
getServletPath() |
javax.servlet.http.HttpSession |
getSession() |
javax.servlet.http.HttpSession |
getSession(boolean create) |
java.security.Principal |
getUserPrincipal() |
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 |
removeAttribute(java.lang.String name) |
void |
setAttribute(java.lang.String name,
java.lang.Object value) |
void |
setCharacterEncoding(java.lang.String name) |
void |
setContentType(java.lang.String contentType) |
void |
setHttpSession(javax.servlet.http.HttpSession session) |
void |
setLocale(java.util.Locale locale) |
void |
setMethod(java.lang.String method) |
void |
setPathElements(java.lang.String contextPath,
java.lang.String servletPath,
java.lang.String pathInfo,
java.lang.String queryString) |
void |
setUserPrincipal(java.security.Principal principal) |
javax.servlet.AsyncContext |
startAsync() |
javax.servlet.AsyncContext |
startAsync(javax.servlet.ServletRequest servletRequest,
javax.servlet.ServletResponse servletResponse) |
<T extends javax.servlet.http.HttpUpgradeHandler> |
upgrade(java.lang.Class<T> arg0) |
protected java.util.HashMap attributes
The set of request attributes.
protected java.lang.String contextPath
The context path for this request.
protected java.util.Locale locale
The preferred locale for this request.
protected java.util.HashMap parameters
The set of arrays of parameter values, keyed by parameter name.
protected java.lang.String pathInfo
The extra path information for this request. v *
protected java.security.Principal principal
The authenticated user for this request.
protected java.lang.String queryString
The query string for this request.
protected java.lang.String servletPath
The servlet path for this request.
protected javax.servlet.http.HttpSession session
The HttpSession with which we are associated.
protected java.lang.String method
The HTTP request method.
protected java.lang.String contentType
The Content Type for this request.
public MockHttpServletRequest()
public MockHttpServletRequest(javax.servlet.http.HttpSession session)
public MockHttpServletRequest(java.lang.String contextPath, java.lang.String servletPath, java.lang.String pathInfo, java.lang.String queryString)
public MockHttpServletRequest(java.lang.String contextPath, java.lang.String servletPath, java.lang.String pathInfo, java.lang.String queryString, javax.servlet.http.HttpSession session)
public void addParameter(java.lang.String name, java.lang.String value)
public void setHttpSession(javax.servlet.http.HttpSession session)
public void setLocale(java.util.Locale locale)
public void setMethod(java.lang.String method)
public void setContentType(java.lang.String contentType)
public void setPathElements(java.lang.String contextPath, java.lang.String servletPath, java.lang.String pathInfo, java.lang.String queryString)
public void setUserPrincipal(java.security.Principal principal)
public java.lang.String getAuthType()
getAuthType
in interface javax.servlet.http.HttpServletRequest
public java.lang.String getContextPath()
getContextPath
in interface javax.servlet.http.HttpServletRequest
public javax.servlet.http.Cookie[] getCookies()
getCookies
in interface javax.servlet.http.HttpServletRequest
public long getDateHeader(java.lang.String name)
getDateHeader
in interface javax.servlet.http.HttpServletRequest
public java.lang.String getHeader(java.lang.String name)
getHeader
in interface javax.servlet.http.HttpServletRequest
public java.util.Enumeration getHeaderNames()
getHeaderNames
in interface javax.servlet.http.HttpServletRequest
public java.util.Enumeration getHeaders(java.lang.String name)
getHeaders
in interface javax.servlet.http.HttpServletRequest
public int getIntHeader(java.lang.String name)
getIntHeader
in interface javax.servlet.http.HttpServletRequest
public java.lang.String getMethod()
getMethod
in interface javax.servlet.http.HttpServletRequest
public java.lang.String getPathInfo()
getPathInfo
in interface javax.servlet.http.HttpServletRequest
public java.lang.String getPathTranslated()
getPathTranslated
in interface javax.servlet.http.HttpServletRequest
public java.lang.String getQueryString()
getQueryString
in interface javax.servlet.http.HttpServletRequest
public java.lang.String getRemoteUser()
getRemoteUser
in interface javax.servlet.http.HttpServletRequest
public java.lang.String getRequestedSessionId()
getRequestedSessionId
in interface javax.servlet.http.HttpServletRequest
public java.lang.String getRequestURI()
getRequestURI
in interface javax.servlet.http.HttpServletRequest
public java.lang.StringBuffer getRequestURL()
getRequestURL
in interface javax.servlet.http.HttpServletRequest
public java.lang.String getServletPath()
getServletPath
in interface javax.servlet.http.HttpServletRequest
public javax.servlet.http.HttpSession getSession()
getSession
in interface javax.servlet.http.HttpServletRequest
public javax.servlet.http.HttpSession getSession(boolean create)
getSession
in interface javax.servlet.http.HttpServletRequest
public java.security.Principal getUserPrincipal()
getUserPrincipal
in interface javax.servlet.http.HttpServletRequest
public boolean isRequestedSessionIdFromCookie()
isRequestedSessionIdFromCookie
in interface javax.servlet.http.HttpServletRequest
public boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromUrl
in interface javax.servlet.http.HttpServletRequest
public boolean isRequestedSessionIdFromURL()
isRequestedSessionIdFromURL
in interface javax.servlet.http.HttpServletRequest
public boolean isRequestedSessionIdValid()
isRequestedSessionIdValid
in interface javax.servlet.http.HttpServletRequest
public boolean isUserInRole(java.lang.String role)
isUserInRole
in interface javax.servlet.http.HttpServletRequest
public java.lang.Object getAttribute(java.lang.String name)
getAttribute
in interface javax.servlet.ServletRequest
public java.util.Enumeration getAttributeNames()
getAttributeNames
in interface javax.servlet.ServletRequest
public java.lang.String getCharacterEncoding()
getCharacterEncoding
in interface javax.servlet.ServletRequest
public int getContentLength()
getContentLength
in interface javax.servlet.ServletRequest
public java.lang.String getContentType()
getContentType
in interface javax.servlet.ServletRequest
public javax.servlet.ServletInputStream getInputStream()
getInputStream
in interface javax.servlet.ServletRequest
public java.util.Locale getLocale()
getLocale
in interface javax.servlet.ServletRequest
public java.util.Enumeration getLocales()
getLocales
in interface javax.servlet.ServletRequest
public java.lang.String getParameter(java.lang.String name)
getParameter
in interface javax.servlet.ServletRequest
public java.util.Map getParameterMap()
getParameterMap
in interface javax.servlet.ServletRequest
public java.util.Enumeration getParameterNames()
getParameterNames
in interface javax.servlet.ServletRequest
public java.lang.String[] getParameterValues(java.lang.String name)
getParameterValues
in interface javax.servlet.ServletRequest
public java.lang.String getProtocol()
getProtocol
in interface javax.servlet.ServletRequest
public java.io.BufferedReader getReader()
getReader
in interface javax.servlet.ServletRequest
public java.lang.String getRealPath(java.lang.String path)
getRealPath
in interface javax.servlet.ServletRequest
public java.lang.String getRemoteAddr()
getRemoteAddr
in interface javax.servlet.ServletRequest
public java.lang.String getRemoteHost()
getRemoteHost
in interface javax.servlet.ServletRequest
public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
getRequestDispatcher
in interface javax.servlet.ServletRequest
public java.lang.String getScheme()
getScheme
in interface javax.servlet.ServletRequest
public java.lang.String getServerName()
getServerName
in interface javax.servlet.ServletRequest
public int getServerPort()
getServerPort
in interface javax.servlet.ServletRequest
public boolean isSecure()
isSecure
in interface javax.servlet.ServletRequest
public void removeAttribute(java.lang.String name)
removeAttribute
in interface javax.servlet.ServletRequest
public void setAttribute(java.lang.String name, java.lang.Object value)
setAttribute
in interface javax.servlet.ServletRequest
public void setCharacterEncoding(java.lang.String name)
setCharacterEncoding
in interface javax.servlet.ServletRequest
public int getLocalPort()
getLocalPort
in interface javax.servlet.ServletRequest
public java.lang.String getLocalAddr()
getLocalAddr
in interface javax.servlet.ServletRequest
public java.lang.String getLocalName()
getLocalName
in interface javax.servlet.ServletRequest
public int getRemotePort()
getRemotePort
in interface javax.servlet.ServletRequest
public java.lang.String getRemoteName()
public javax.servlet.http.Part getPart(java.lang.String name) throws java.io.IOException, java.lang.IllegalStateException, javax.servlet.ServletException
getPart
in interface javax.servlet.http.HttpServletRequest
java.io.IOException
java.lang.IllegalStateException
javax.servlet.ServletException
public java.util.Collection<javax.servlet.http.Part> getParts() throws java.io.IOException, java.lang.IllegalStateException, javax.servlet.ServletException
getParts
in interface javax.servlet.http.HttpServletRequest
java.io.IOException
java.lang.IllegalStateException
javax.servlet.ServletException
public void logout() throws javax.servlet.ServletException
logout
in interface javax.servlet.http.HttpServletRequest
javax.servlet.ServletException
public void login(java.lang.String username, java.lang.String password) throws javax.servlet.ServletException
login
in interface javax.servlet.http.HttpServletRequest
javax.servlet.ServletException
public boolean authenticate(javax.servlet.http.HttpServletResponse response) throws java.io.IOException, javax.servlet.ServletException
authenticate
in interface javax.servlet.http.HttpServletRequest
java.io.IOException
javax.servlet.ServletException
public javax.servlet.DispatcherType getDispatcherType()
getDispatcherType
in interface javax.servlet.ServletRequest
public javax.servlet.AsyncContext getAsyncContext()
getAsyncContext
in interface javax.servlet.ServletRequest
public boolean isAsyncSupported()
isAsyncSupported
in interface javax.servlet.ServletRequest
public boolean isAsyncStarted()
isAsyncStarted
in interface javax.servlet.ServletRequest
public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)
startAsync
in interface javax.servlet.ServletRequest
public javax.servlet.AsyncContext startAsync()
startAsync
in interface javax.servlet.ServletRequest
public javax.servlet.ServletContext getServletContext()
getServletContext
in interface javax.servlet.ServletRequest
public <T extends javax.servlet.http.HttpUpgradeHandler> T upgrade(java.lang.Class<T> arg0) throws java.io.IOException, javax.servlet.ServletException
upgrade
in interface javax.servlet.http.HttpServletRequest
java.io.IOException
javax.servlet.ServletException
public java.lang.String changeSessionId()
changeSessionId
in interface javax.servlet.http.HttpServletRequest
public long getContentLengthLong()
getContentLengthLong
in interface javax.servlet.ServletRequest
Copyright © 2000–2022 Apache Software Foundation. All rights reserved.