|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.springframework.mock.web.MockHttpServletRequest
public class MockHttpServletRequest
Mock implementation of the HttpServletRequest
interface. Supports the Servlet 2.5 API level.
Used for testing the web framework; also useful for testing application controllers.
| Field Summary | |
|---|---|
static String |
DEFAULT_PROTOCOL
The default protocol: 'http'. |
static String |
DEFAULT_REMOTE_ADDR
The default remote address: '127.0.0.1'. |
static String |
DEFAULT_REMOTE_HOST
The default remote host: 'localhost'. |
static String |
DEFAULT_SERVER_ADDR
The default server address: '127.0.0.1'. |
static 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 | |
|---|---|
MockHttpServletRequest()
Create a new MockHttpServletRequest with a default MockServletContext. |
|
MockHttpServletRequest(ServletContext servletContext)
Create a new MockHttpServletRequest. |
|
MockHttpServletRequest(ServletContext servletContext,
String method,
String requestURI)
Create a new MockHttpServletRequest. |
|
MockHttpServletRequest(String method,
String requestURI)
Create a new MockHttpServletRequest with a default MockServletContext. |
|
| Method Summary | |
|---|---|
void |
addHeader(String name,
Object value)
Add a header entry for the given name. |
void |
addParameter(String name,
String value)
Add a single value for the specified HTTP parameter. |
void |
addParameter(String name,
String[] values)
Add an array of values for the specified HTTP parameter. |
void |
addParameters(Map params)
Adds all provided parameters |
void |
addPreferredLocale(Locale locale)
Add a new preferred locale, before any existing locales. |
void |
addUserRole(String role)
|
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. |
Object |
getAttribute(String name)
|
Enumeration<String> |
getAttributeNames()
|
String |
getAuthType()
|
String |
getCharacterEncoding()
|
int |
getContentLength()
|
String |
getContentType()
|
String |
getContextPath()
|
Cookie[] |
getCookies()
|
long |
getDateHeader(String name)
|
String |
getHeader(String name)
|
Enumeration<String> |
getHeaderNames()
|
Enumeration<String> |
getHeaders(String name)
|
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)
|
String |
getPathInfo()
|
String |
getPathTranslated()
|
String |
getProtocol()
|
String |
getQueryString()
|
BufferedReader |
getReader()
|
String |
getRealPath(String path)
|
String |
getRemoteAddr()
|
String |
getRemoteHost()
|
int |
getRemotePort()
|
String |
getRemoteUser()
|
RequestDispatcher |
getRequestDispatcher(String path)
|
String |
getRequestedSessionId()
|
String |
getRequestURI()
|
StringBuffer |
getRequestURL()
|
String |
getScheme()
|
String |
getServerName()
|
int |
getServerPort()
|
ServletContext |
getServletContext()
Return the ServletContext that this request is associated with. |
String |
getServletPath()
|
HttpSession |
getSession()
|
HttpSession |
getSession(boolean create)
|
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 |
isRequestedSessionIdFromCookie()
|
boolean |
isRequestedSessionIdFromUrl()
|
boolean |
isRequestedSessionIdFromURL()
|
boolean |
isRequestedSessionIdValid()
|
boolean |
isSecure()
|
boolean |
isUserInRole(String role)
|
void |
removeAllParameters()
Removes all existing parameters. |
void |
removeAttribute(String name)
|
void |
removeParameter(String name)
Remove already registered values for the specified HTTP parameter, if any. |
void |
setAttribute(String name,
Object value)
|
void |
setAuthType(String authType)
|
void |
setCharacterEncoding(String characterEncoding)
|
void |
setContent(byte[] content)
|
void |
setContentType(String contentType)
|
void |
setContextPath(String contextPath)
|
void |
setCookies(Cookie... cookies)
|
void |
setLocalAddr(String localAddr)
|
void |
setLocalName(String localName)
|
void |
setLocalPort(int localPort)
|
void |
setMethod(String method)
|
void |
setParameter(String name,
String value)
Set a single value for the specified HTTP parameter. |
void |
setParameter(String name,
String[] values)
Set an array of values for the specified HTTP parameter. |
void |
setParameters(Map params)
Sets all provided parameters |
void |
setPathInfo(String pathInfo)
|
void |
setProtocol(String protocol)
|
void |
setQueryString(String queryString)
|
void |
setRemoteAddr(String remoteAddr)
|
void |
setRemoteHost(String remoteHost)
|
void |
setRemotePort(int remotePort)
|
void |
setRemoteUser(String remoteUser)
|
void |
setRequestedSessionId(String requestedSessionId)
|
void |
setRequestedSessionIdFromCookie(boolean requestedSessionIdFromCookie)
|
void |
setRequestedSessionIdFromURL(boolean requestedSessionIdFromURL)
|
void |
setRequestedSessionIdValid(boolean requestedSessionIdValid)
|
void |
setRequestURI(String requestURI)
|
void |
setScheme(String scheme)
|
void |
setSecure(boolean secure)
|
void |
setServerName(String serverName)
|
void |
setServerPort(int serverPort)
|
void |
setServletPath(String servletPath)
|
void |
setSession(HttpSession session)
|
void |
setUserPrincipal(Principal userPrincipal)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String DEFAULT_PROTOCOL
public static final String DEFAULT_SERVER_ADDR
public static final String DEFAULT_SERVER_NAME
public static final int DEFAULT_SERVER_PORT
public static final String DEFAULT_REMOTE_ADDR
public static final String DEFAULT_REMOTE_HOST
| Constructor Detail |
|---|
public MockHttpServletRequest()
MockServletContext.
MockServletContext
public MockHttpServletRequest(String method,
String requestURI)
MockServletContext.
method - the request method (may be null)requestURI - the request URI (may be null)setMethod(java.lang.String),
setRequestURI(java.lang.String),
MockServletContextpublic MockHttpServletRequest(ServletContext servletContext)
servletContext - the ServletContext that the request runs in
(may be null to use a default MockServletContext)MockServletContext
public MockHttpServletRequest(ServletContext servletContext,
String method,
String requestURI)
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),
MockServletContext| Method Detail |
|---|
public ServletContext getServletContext()
public boolean isActive()
public void close()
public void invalidate()
protected void checkActive()
throws IllegalStateException
IllegalStateExceptionpublic Object getAttribute(String name)
getAttribute in interface ServletRequestpublic Enumeration<String> getAttributeNames()
getAttributeNames in interface ServletRequestpublic String getCharacterEncoding()
getCharacterEncoding in interface ServletRequestpublic void setCharacterEncoding(String characterEncoding)
setCharacterEncoding in interface ServletRequestpublic void setContent(byte[] content)
public int getContentLength()
getContentLength in interface ServletRequestpublic void setContentType(String contentType)
public String getContentType()
getContentType in interface ServletRequestpublic ServletInputStream getInputStream()
getInputStream in interface ServletRequest
public void setParameter(String name,
String value)
If there are already one or more values registered for the given parameter name, they will be replaced.
public void setParameter(String name,
String[] values)
If there are already one or more values registered for the given parameter name, they will be replaced.
public void setParameters(Map params)
addParameters(java.util.Map).
public void addParameter(String name,
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(String name,
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(Map params)
setParameters(java.util.Map).
public void removeParameter(String name)
public void removeAllParameters()
public String getParameter(String name)
getParameter in interface ServletRequestpublic Enumeration<String> getParameterNames()
getParameterNames in interface ServletRequestpublic String[] getParameterValues(String name)
getParameterValues in interface ServletRequestpublic Map<String,String[]> getParameterMap()
getParameterMap in interface ServletRequestpublic void setProtocol(String protocol)
public String getProtocol()
getProtocol in interface ServletRequestpublic void setScheme(String scheme)
public String getScheme()
getScheme in interface ServletRequestpublic void setServerName(String serverName)
public String getServerName()
getServerName in interface ServletRequestpublic void setServerPort(int serverPort)
public int getServerPort()
getServerPort in interface ServletRequest
public BufferedReader getReader()
throws UnsupportedEncodingException
getReader in interface ServletRequestUnsupportedEncodingExceptionpublic void setRemoteAddr(String remoteAddr)
public String getRemoteAddr()
getRemoteAddr in interface ServletRequestpublic void setRemoteHost(String remoteHost)
public String getRemoteHost()
getRemoteHost in interface ServletRequest
public void setAttribute(String name,
Object value)
setAttribute in interface ServletRequestpublic void removeAttribute(String name)
removeAttribute in interface ServletRequestpublic void clearAttributes()
public void addPreferredLocale(Locale locale)
public Locale getLocale()
getLocale in interface ServletRequestpublic Enumeration<Locale> getLocales()
getLocales in interface ServletRequestpublic void setSecure(boolean secure)
public boolean isSecure()
isSecure in interface ServletRequestpublic RequestDispatcher getRequestDispatcher(String path)
getRequestDispatcher in interface ServletRequestpublic String getRealPath(String path)
getRealPath in interface ServletRequestpublic void setRemotePort(int remotePort)
public int getRemotePort()
getRemotePort in interface ServletRequestpublic void setLocalName(String localName)
public String getLocalName()
getLocalName in interface ServletRequestpublic void setLocalAddr(String localAddr)
public String getLocalAddr()
getLocalAddr in interface ServletRequestpublic void setLocalPort(int localPort)
public int getLocalPort()
getLocalPort in interface ServletRequestpublic void setAuthType(String authType)
public String getAuthType()
getAuthType in interface HttpServletRequestpublic void setCookies(Cookie... cookies)
public Cookie[] getCookies()
getCookies in interface HttpServletRequest
public void addHeader(String name,
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.
getHeaderNames(),
getHeader(java.lang.String),
getHeaders(java.lang.String),
getDateHeader(java.lang.String),
getIntHeader(java.lang.String)public long getDateHeader(String name)
getDateHeader in interface HttpServletRequestpublic String getHeader(String name)
getHeader in interface HttpServletRequestpublic Enumeration<String> getHeaders(String name)
getHeaders in interface HttpServletRequestpublic Enumeration<String> getHeaderNames()
getHeaderNames in interface HttpServletRequestpublic int getIntHeader(String name)
getIntHeader in interface HttpServletRequestpublic void setMethod(String method)
public String getMethod()
getMethod in interface HttpServletRequestpublic void setPathInfo(String pathInfo)
public String getPathInfo()
getPathInfo in interface HttpServletRequestpublic String getPathTranslated()
getPathTranslated in interface HttpServletRequestpublic void setContextPath(String contextPath)
public String getContextPath()
getContextPath in interface HttpServletRequestpublic void setQueryString(String queryString)
public String getQueryString()
getQueryString in interface HttpServletRequestpublic void setRemoteUser(String remoteUser)
public String getRemoteUser()
getRemoteUser in interface HttpServletRequestpublic void addUserRole(String role)
public boolean isUserInRole(String role)
isUserInRole in interface HttpServletRequestpublic void setUserPrincipal(Principal userPrincipal)
public Principal getUserPrincipal()
getUserPrincipal in interface HttpServletRequestpublic void setRequestedSessionId(String requestedSessionId)
public String getRequestedSessionId()
getRequestedSessionId in interface HttpServletRequestpublic void setRequestURI(String requestURI)
public String getRequestURI()
getRequestURI in interface HttpServletRequestpublic StringBuffer getRequestURL()
getRequestURL in interface HttpServletRequestpublic void setServletPath(String servletPath)
public String getServletPath()
getServletPath in interface HttpServletRequestpublic void setSession(HttpSession session)
public HttpSession getSession(boolean create)
getSession in interface HttpServletRequestpublic HttpSession getSession()
getSession in interface HttpServletRequestpublic void setRequestedSessionIdValid(boolean requestedSessionIdValid)
public boolean isRequestedSessionIdValid()
isRequestedSessionIdValid in interface HttpServletRequestpublic void setRequestedSessionIdFromCookie(boolean requestedSessionIdFromCookie)
public boolean isRequestedSessionIdFromCookie()
isRequestedSessionIdFromCookie in interface HttpServletRequestpublic void setRequestedSessionIdFromURL(boolean requestedSessionIdFromURL)
public boolean isRequestedSessionIdFromURL()
isRequestedSessionIdFromURL in interface HttpServletRequestpublic boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromUrl in interface HttpServletRequest
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||