public class MockHttpServletRequest extends Object implements HttpServletRequest
HttpServletRequest
interface.
The default, preferred Locale
for the server mocked by this request
is Locale.ENGLISH
. This value can be changed via addPreferredLocale(java.util.Locale)
or setPreferredLocales(java.util.List<java.util.Locale>)
.
As of Spring Framework 5.0, this set of mocks is designed on a Servlet 4.0 baseline.
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_PROTOCOL
The default protocol: 'HTTP/1.1'.
|
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_SCHEME
The default scheme: 'http'.
|
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'.
|
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
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,
String method,
String requestURI)
|
MockHttpServletRequest(String method,
String requestURI)
Create a new
MockHttpServletRequest with a default
MockServletContext . |
Modifier and Type | Method and Description |
---|---|
void |
addHeader(String name,
Object value)
Add an HTTP header entry for the given name.
|
void |
addParameter(String name,
String... values)
Add an array of values for the specified HTTP parameter.
|
void |
addParameter(String name,
String value)
Add a single value for the specified HTTP parameter.
|
void |
addParameters(Map<String,?> params)
Add all provided parameters without replacing any
existing values.
|
void |
addPart(Part part) |
void |
addPreferredLocale(Locale locale)
Add a new preferred locale, before any existing locales.
|
void |
addUserRole(String role) |
boolean |
authenticate(HttpServletResponse response)
Use the container login mechanism configured for the
ServletContext to authenticate the user making
this request. |
String |
changeSessionId()
The implementation of this (Servlet 3.1+) method calls
MockHttpSession.changeSessionId() if the session is a mock session. |
protected void |
checkActive()
Check whether this request is still active (that is, not completed yet),
throwing an IllegalStateException if not active anymore.
|
void |
clearAttributes()
Clear all of this request's attributes.
|
void |
close()
Mark this request as completed, keeping its state.
|
AsyncContext |
getAsyncContext()
Gets the AsyncContext that was created or reinitialized by the
most recent invocation of
ServletRequest.startAsync() or
ServletRequest.startAsync(ServletRequest,ServletResponse) on this request. |
Object |
getAttribute(String name)
Returns the value of the named attribute as an
Object ,
or null if no attribute of the given name exists. |
Enumeration<String> |
getAttributeNames()
Returns an
Enumeration containing the
names of the attributes available to this request. |
String |
getAuthType()
Returns the name of the authentication scheme used to protect
the servlet.
|
String |
getCharacterEncoding()
Returns the name of the character encoding used in the body of this
request.
|
byte[] |
getContentAsByteArray()
Get the content of the request body as a byte array.
|
String |
getContentAsString()
Get the content of the request body as a
String , using the configured
character encoding. |
int |
getContentLength()
Returns the length, in bytes, of the request body and made available by
the input stream, or -1 if the length is not known ir is greater than
Integer.MAX_VALUE.
|
long |
getContentLengthLong()
Returns the length, in bytes, of the request body and made available by
the input stream, or -1 if the length is not known.
|
String |
getContentType()
Returns the MIME type of the body of the request, or
null if the type is not known. |
String |
getContextPath()
Returns the portion of the request URI that indicates the context
of the request.
|
Cookie[] |
getCookies()
Returns an array containing all of the
Cookie
objects the client sent with this request. |
long |
getDateHeader(String name)
Return the long timestamp for the date header with the given
name . |
DispatcherType |
getDispatcherType()
Gets the dispatcher type of this request.
|
String |
getHeader(String name)
Returns the value of the specified request header
as a
String . |
Enumeration<String> |
getHeaderNames()
Returns an enumeration of all the header names
this request contains.
|
Enumeration<String> |
getHeaders(String name)
Returns all the values of the specified request header
as an
Enumeration of String objects. |
ServletInputStream |
getInputStream()
Retrieves the body of the request as binary data using
a
ServletInputStream . |
int |
getIntHeader(String name)
Returns the value of the specified request header
as an
int . |
String |
getLocalAddr()
Returns the Internet Protocol (IP) address of the interface on
which the request was received.
|
Locale |
getLocale()
Return the first preferred locale configured
in this mock request.
|
Enumeration<Locale> |
getLocales()
Return an enumeration of the preferred
locales configured in this mock request.
|
String |
getLocalName()
Returns the host name of the Internet Protocol (IP) interface on
which the request was received.
|
int |
getLocalPort()
Returns the Internet Protocol (IP) port number of the interface
on which the request was received.
|
String |
getMethod()
Returns the name of the HTTP method with which this
request was made, for example, GET, POST, or PUT.
|
String |
getParameter(String name)
Returns the value of a request parameter as a
String ,
or null if the parameter does not exist. |
Map<String,String[]> |
getParameterMap()
Returns a java.util.Map of the parameters of this request.
|
Enumeration<String> |
getParameterNames()
Returns an
Enumeration of String
objects containing the names of the parameters contained
in this request. |
String[] |
getParameterValues(String name)
Returns an array of
String objects containing
all of the values the given request parameter has, or
null if the parameter does not exist. |
Part |
getPart(String name)
Gets the
Part with the given name. |
Collection<Part> |
getParts()
Gets all the
Part components of this request, provided
that it is of type multipart/form-data . |
String |
getPathInfo()
Returns any extra path information associated with
the URL the client sent when it made this request.
|
String |
getPathTranslated()
Returns any extra path information after the servlet name
but before the query string, and translates it to a real
path.
|
String |
getProtocol()
Returns the name and version of the protocol the request uses
in the form protocol/majorVersion.minorVersion, for
example, HTTP/1.1.
|
String |
getQueryString()
Returns the query string that is contained in the request
URL after the path.
|
BufferedReader |
getReader()
Retrieves the body of the request as character data using
a
BufferedReader . |
String |
getRealPath(String path)
Deprecated.
|
String |
getRemoteAddr()
Returns the Internet Protocol (IP) address of the client
or last proxy that sent the request.
|
String |
getRemoteHost()
Returns the fully qualified name of the client
or the last proxy that sent the request.
|
int |
getRemotePort()
Returns the Internet Protocol (IP) source port of the client
or last proxy that sent the request.
|
String |
getRemoteUser()
Returns the login of the user making this request, if the
user has been authenticated, or
null if the user
has not been authenticated. |
RequestDispatcher |
getRequestDispatcher(String path)
Returns a
RequestDispatcher object that acts as a wrapper for
the resource located at the given path. |
String |
getRequestedSessionId()
Returns the session ID specified by the client.
|
String |
getRequestURI()
Returns the part of this request's URL from the protocol
name up to the query string in the first line of the HTTP request.
|
StringBuffer |
getRequestURL()
Reconstructs the URL the client used to make the request.
|
String |
getScheme()
Returns the name of the scheme used to make this request,
for example,
http , https , or ftp . |
String |
getServerName()
Returns the host name of the server to which the request was sent.
|
int |
getServerPort()
Returns the port number to which the request was sent.
|
ServletContext |
getServletContext()
Return the ServletContext that this request is associated with.
|
String |
getServletPath()
Returns the part of this request's URL that calls
the servlet.
|
HttpSession |
getSession()
Returns the current session associated with this request,
or if the request does not have a session, creates one.
|
HttpSession |
getSession(boolean create)
Returns the current
HttpSession
associated with this request or, if there is no
current session and create is true, returns
a new session. |
Principal |
getUserPrincipal()
Returns a
java.security.Principal object containing
the name of the current authenticated user. |
void |
invalidate()
Invalidate this request, clearing its state.
|
boolean |
isActive()
Return whether this request is still active (that is, not completed yet).
|
boolean |
isAsyncStarted()
Checks if this request has been put into asynchronous mode.
|
boolean |
isAsyncSupported()
Checks if this request supports asynchronous operation.
|
boolean |
isRequestedSessionIdFromCookie()
Checks whether the requested session ID was conveyed to the
server as an HTTP cookie.
|
boolean |
isRequestedSessionIdFromUrl()
Deprecated.
|
boolean |
isRequestedSessionIdFromURL()
Checks whether the requested session ID was conveyed to the
server as part of the request URL.
|
boolean |
isRequestedSessionIdValid()
Checks whether the requested session ID is still valid.
|
boolean |
isSecure()
|
boolean |
isUserInRole(String role)
Returns a boolean indicating whether the authenticated user is included
in the specified logical "role".
|
void |
login(String username,
String password)
Validate the provided username and password in the password validation
realm used by the web container login mechanism configured for the
ServletContext . |
void |
logout()
Establish
null as the value returned when
getUserPrincipal , getRemoteUser ,
and getAuthType is called on the request. |
void |
removeAllParameters()
Remove all existing parameters.
|
void |
removeAttribute(String name)
Removes an attribute from this request.
|
void |
removeHeader(String name)
Remove already registered entries for the specified HTTP header, if any.
|
void |
removeParameter(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(String name,
Object value)
Stores an attribute in this request.
|
void |
setAuthType(String authType) |
void |
setCharacterEncoding(String characterEncoding)
Overrides the name of the character encoding used in the body of this
request.
|
void |
setContent(byte[] content)
Set the content of the request body as a byte array.
|
void |
setContentType(String contentType) |
void |
setContextPath(String contextPath) |
void |
setCookies(Cookie... cookies) |
void |
setDispatcherType(DispatcherType dispatcherType) |
void |
setLocalAddr(String localAddr) |
void |
setLocalName(String localName) |
void |
setLocalPort(int localPort) |
void |
setMethod(String method) |
void |
setParameter(String name,
String... values)
Set an array of values for the specified HTTP parameter.
|
void |
setParameter(String name,
String value)
Set a single value for the specified HTTP parameter.
|
void |
setParameters(Map<String,?> params)
Set all provided parameters replacing any existing
values for the provided parameter names.
|
void |
setPathInfo(String pathInfo) |
void |
setPreferredLocales(List<Locale> locales)
Set the list of preferred locales, in descending order, effectively replacing
any existing locales.
|
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)
Set the boolean
secure flag indicating whether the mock request
was made using a secure channel, such as HTTPS. |
void |
setServerName(String serverName) |
void |
setServerPort(int serverPort) |
void |
setServletPath(String servletPath) |
void |
setSession(HttpSession session) |
void |
setUserPrincipal(Principal userPrincipal) |
AsyncContext |
startAsync()
Puts this request into asynchronous mode, and initializes its
AsyncContext with the original (unwrapped) ServletRequest
and ServletResponse objects. |
AsyncContext |
startAsync(ServletRequest request,
ServletResponse response)
Puts this request into asynchronous mode, and initializes its
AsyncContext with the given request and response objects. |
<T extends HttpUpgradeHandler> |
upgrade(Class<T> handlerClass)
Creates an instance of
HttpUpgradeHandler for a given
class and uses it for the http protocol upgrade processing. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getHttpServletMapping, getTrailerFields, isTrailerFieldsReady, newPushBuilder
public static final String DEFAULT_PROTOCOL
public static final String DEFAULT_SCHEME
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
public MockHttpServletRequest()
MockHttpServletRequest
with a default
MockServletContext
.public MockHttpServletRequest(@Nullable String method, @Nullable 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(@Nullable 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(@Nullable ServletContext servletContext, @Nullable String method, @Nullable 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()
getServletContext
in interface ServletRequest
public boolean isActive()
public void close()
public void invalidate()
protected void checkActive() throws IllegalStateException
IllegalStateException
public Object getAttribute(String name)
javax.servlet.ServletRequest
Object
,
or null
if no attribute of the given name exists.
Attributes can be set two ways. The servlet container may set
attributes to make available custom information about a request.
For example, for requests made using HTTPS, the attribute
javax.servlet.request.X509Certificate
can be used to
retrieve information on the certificate of the client. Attributes
can also be set programatically using
ServletRequest.setAttribute(java.lang.String, java.lang.Object)
. This allows information to be
embedded into a request before a RequestDispatcher
call.
Attribute names should follow the same conventions as package
names. This specification reserves names matching java.*
,
javax.*
, and sun.*
.
getAttribute
in interface ServletRequest
name
- a String
specifying the name of the attributeObject
containing the value of the attribute,
or null
if the attribute does not existpublic Enumeration<String> getAttributeNames()
javax.servlet.ServletRequest
Enumeration
containing the
names of the attributes available to this request.
This method returns an empty Enumeration
if the request has no attributes available to it.getAttributeNames
in interface ServletRequest
Enumeration
of strings containing the names
of the request's attributes@Nullable public String getCharacterEncoding()
javax.servlet.ServletRequest
null
if no request encoding
character encoding has been specified. The following methods for
specifying the request character encoding are consulted, in decreasing
order of priority: per request, per web app (using
ServletContext.setRequestCharacterEncoding(java.lang.String)
, deployment
descriptor), and per container (for all web applications deployed in
that container, using vendor specific configuration).getCharacterEncoding
in interface ServletRequest
String
containing the name of the character
encoding, or null
if the request does not specify a
character encodingpublic void setCharacterEncoding(@Nullable String characterEncoding)
javax.servlet.ServletRequest
setCharacterEncoding
in interface ServletRequest
characterEncoding
- String
containing the name of
the character encoding.public void setContent(@Nullable byte[] content)
If the supplied byte array represents text such as XML or JSON, the
character encoding
should typically be
set as well.
@Nullable public byte[] getContentAsByteArray()
null
)setContent(byte[])
,
getContentAsString()
@Nullable public String getContentAsString() throws IllegalStateException, UnsupportedEncodingException
String
, using the configured
character encoding.String
, potentially null
IllegalStateException
- if the character encoding has not been setUnsupportedEncodingException
- if the character encoding is not supportedsetContent(byte[])
,
setCharacterEncoding(String)
,
getContentAsByteArray()
public int getContentLength()
javax.servlet.ServletRequest
getContentLength
in interface ServletRequest
public long getContentLengthLong()
javax.servlet.ServletRequest
getContentLengthLong
in interface ServletRequest
@Nullable public String getContentType()
javax.servlet.ServletRequest
null
if the type is not known. For HTTP servlets,
same as the value of the CGI variable CONTENT_TYPE.getContentType
in interface ServletRequest
String
containing the name of the MIME type
of the request, or null if the type is not knownpublic ServletInputStream getInputStream()
javax.servlet.ServletRequest
ServletInputStream
. Either this method or
ServletRequest.getReader()
may be called to read the body, not both.getInputStream
in interface ServletRequest
ServletInputStream
object containing
the body of the requestpublic 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<String,?> params)
addParameters(java.util.Map)
.public void addParameter(String name, @Nullable 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<String,?> params)
setParameters(java.util.Map)
.public void removeParameter(String name)
public void removeAllParameters()
@Nullable public String getParameter(String name)
javax.servlet.ServletRequest
String
,
or null
if the parameter does not exist. Request parameters
are extra information sent with the request. For HTTP servlets,
parameters are contained in the query string or posted form data.
You should only use this method when you are sure the
parameter has only one value. If the parameter might have
more than one value, use ServletRequest.getParameterValues(java.lang.String)
.
If you use this method with a multivalued
parameter, the value returned is equal to the first value
in the array returned by getParameterValues
.
If the parameter data was sent in the request body, such as occurs
with an HTTP POST request, then reading the body directly via ServletRequest.getInputStream()
or ServletRequest.getReader()
can interfere
with the execution of this method.
getParameter
in interface ServletRequest
name
- a String
specifying the name of the parameterString
representing the single value of
the parameterServletRequest.getParameterValues(java.lang.String)
public Enumeration<String> getParameterNames()
javax.servlet.ServletRequest
Enumeration
of String
objects containing the names of the parameters contained
in this request. If the request has
no parameters, the method returns an empty Enumeration
.getParameterNames
in interface ServletRequest
Enumeration
of String
objects, each String
containing the name of
a request parameter; or an empty Enumeration
if the request has no parameterspublic String[] getParameterValues(String name)
javax.servlet.ServletRequest
String
objects containing
all of the values the given request parameter has, or
null
if the parameter does not exist.
If the parameter has a single value, the array has a length of 1.
getParameterValues
in interface ServletRequest
name
- a String
containing the name of
the parameter whose value is requestedString
objects
containing the parameter's valuesServletRequest.getParameter(java.lang.String)
public Map<String,String[]> getParameterMap()
javax.servlet.ServletRequest
Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.
getParameterMap
in interface ServletRequest
public void setProtocol(String protocol)
public String getProtocol()
javax.servlet.ServletRequest
SERVER_PROTOCOL
.getProtocol
in interface ServletRequest
String
containing the protocol
name and version numberpublic void setScheme(String scheme)
public String getScheme()
javax.servlet.ServletRequest
http
, https
, or ftp
.
Different schemes have different rules for constructing URLs,
as noted in RFC 1738.getScheme
in interface ServletRequest
String
containing the name
of the scheme used to make this requestpublic void setServerName(String serverName)
public String getServerName()
javax.servlet.ServletRequest
Host
header value, if any, or the resolved server name, or the server IP
address.getServerName
in interface ServletRequest
String
containing the name of the serverpublic void setServerPort(int serverPort)
public int getServerPort()
javax.servlet.ServletRequest
Host
header value, if any, or the server port where the client connection
was accepted on.getServerPort
in interface ServletRequest
public BufferedReader getReader() throws UnsupportedEncodingException
javax.servlet.ServletRequest
BufferedReader
. The reader translates the character
data according to the character encoding used on the body.
Either this method or ServletRequest.getInputStream()
may be called to read the
body, not both.getReader
in interface ServletRequest
BufferedReader
containing the body of the requestUnsupportedEncodingException
- if the character set encoding
used is not supported and the text cannot be decodedServletRequest.getInputStream()
public void setRemoteAddr(String remoteAddr)
public String getRemoteAddr()
javax.servlet.ServletRequest
REMOTE_ADDR
.getRemoteAddr
in interface ServletRequest
String
containing the
IP address of the client that sent the requestpublic void setRemoteHost(String remoteHost)
public String getRemoteHost()
javax.servlet.ServletRequest
REMOTE_HOST
.getRemoteHost
in interface ServletRequest
String
containing the fully
qualified name of the clientpublic void setAttribute(String name, @Nullable Object value)
javax.servlet.ServletRequest
RequestDispatcher
.
Attribute names should follow the same conventions as
package names. Names beginning with java.*
,
javax.*
, and com.sun.*
, are
reserved for use by Sun Microsystems.
If the object passed in is null, the effect is the same as
calling ServletRequest.removeAttribute(java.lang.String)
.
It is warned that when the request is dispatched from the
servlet resides in a different web application by
RequestDispatcher
, the object set by this method
may not be correctly retrieved in the caller servlet.
setAttribute
in interface ServletRequest
name
- a String
specifying
the name of the attributevalue
- the Object
to be storedpublic void removeAttribute(String name)
javax.servlet.ServletRequest
Attribute names should follow the same conventions as
package names. Names beginning with java.*
,
javax.*
, and com.sun.*
, are
reserved for use by Sun Microsystems.
removeAttribute
in interface ServletRequest
name
- a String
specifying
the name of the attribute to removepublic void clearAttributes()
public void addPreferredLocale(Locale locale)
public void setPreferredLocales(List<Locale> locales)
addPreferredLocale(java.util.Locale)
public Locale getLocale()
If no locales have been explicitly configured, the default,
preferred Locale
for the server mocked by this
request is Locale.ENGLISH
.
In contrast to the Servlet specification, this mock implementation
does not take into consideration any locales
specified via the Accept-Language
header.
getLocale
in interface ServletRequest
Locale
for the clientServletRequest.getLocale()
,
addPreferredLocale(Locale)
,
setPreferredLocales(List)
public Enumeration<Locale> getLocales()
If no locales have been explicitly configured, the default,
preferred Locale
for the server mocked by this
request is Locale.ENGLISH
.
In contrast to the Servlet specification, this mock implementation
does not take into consideration any locales
specified via the Accept-Language
header.
getLocales
in interface ServletRequest
Enumeration
of preferred
Locale
objects for the clientServletRequest.getLocales()
,
addPreferredLocale(Locale)
,
setPreferredLocales(List)
public void setSecure(boolean secure)
secure
flag indicating whether the mock request
was made using a secure channel, such as HTTPS.isSecure()
,
getScheme()
,
setScheme(String)
public boolean isSecure()
isSecure
in interface ServletRequest
ServletRequest.isSecure()
public RequestDispatcher getRequestDispatcher(String path)
javax.servlet.ServletRequest
RequestDispatcher
object that acts as a wrapper for
the resource located at the given path.
A RequestDispatcher
object can be used to forward
a request to the resource or to include the resource in a response.
The resource can be dynamic or static.
The pathname specified may be relative, although it cannot extend
outside the current servlet context. If the path begins with
a "/" it is interpreted as relative to the current context root.
This method returns null
if the servlet container
cannot return a RequestDispatcher
.
The difference between this method and ServletContext.getRequestDispatcher(java.lang.String)
is that this method can take a
relative path.
getRequestDispatcher
in interface ServletRequest
path
- a String
specifying the pathname
to the resource. If it is relative, it must be
relative against the current servlet.RequestDispatcher
object that acts as a
wrapper for the resource at the specified path,
or null
if the servlet container cannot
return a RequestDispatcher
RequestDispatcher
,
ServletContext.getRequestDispatcher(java.lang.String)
@Deprecated public String getRealPath(String path)
getRealPath
in interface ServletRequest
path
- the path for which the real path is to be returned.public void setRemotePort(int remotePort)
public int getRemotePort()
javax.servlet.ServletRequest
getRemotePort
in interface ServletRequest
public void setLocalName(String localName)
public String getLocalName()
javax.servlet.ServletRequest
getLocalName
in interface ServletRequest
String
containing the host
name of the IP on which the request was received.public void setLocalAddr(String localAddr)
public String getLocalAddr()
javax.servlet.ServletRequest
getLocalAddr
in interface ServletRequest
String
containing the
IP address on which the request was received.public void setLocalPort(int localPort)
public int getLocalPort()
javax.servlet.ServletRequest
getLocalPort
in interface ServletRequest
public AsyncContext startAsync()
javax.servlet.ServletRequest
AsyncContext
with the original (unwrapped) ServletRequest
and ServletResponse objects.
Calling this method will cause committal of the associated
response to be delayed until AsyncContext.complete()
is
called on the returned AsyncContext
, or the asynchronous
operation has timed out.
Calling AsyncContext.hasOriginalRequestAndResponse()
on
the returned AsyncContext will return true
. Any filters
invoked in the outbound direction after this request was put
into asynchronous mode may use this as an indication that any request
and/or response wrappers that they added during their inbound
invocation need not stay around for the duration of the asynchronous
operation, and therefore any of their associated resources may be
released.
This method clears the list of AsyncListener
instances
(if any) that were registered with the AsyncContext returned by the
previous call to one of the startAsync methods, after calling each
AsyncListener at its onStartAsync
method.
Subsequent invocations of this method, or its overloaded variant, will return the same AsyncContext instance, reinitialized as appropriate.
startAsync
in interface ServletRequest
AsyncContext.dispatch()
public AsyncContext startAsync(ServletRequest request, @Nullable ServletResponse response)
javax.servlet.ServletRequest
AsyncContext
with the given request and response objects.
The ServletRequest and ServletResponse arguments must be
the same instances, or instances of ServletRequestWrapper
and
ServletResponseWrapper
that wrap them, that were passed to the
service
method of the Servlet or the
doFilter
method of the Filter, respectively,
in whose scope this method is being called.
Calling this method will cause committal of the associated
response to be delayed until AsyncContext.complete()
is
called on the returned AsyncContext
, or the asynchronous
operation has timed out.
Calling AsyncContext.hasOriginalRequestAndResponse()
on
the returned AsyncContext will return false
,
unless the passed in ServletRequest and ServletResponse arguments
are the original ones or do not carry any application-provided wrappers.
Any filters invoked in the outbound direction after this
request was put into asynchronous mode may use this as an indication
that some of the request and/or response wrappers that they added
during their inbound invocation may need to stay in place for
the duration of the asynchronous operation, and their associated
resources may not be released.
A ServletRequestWrapper applied during the inbound
invocation of a filter may be released by the outbound
invocation of the filter only if the given servletRequest
,
which is used to initialize the AsyncContext and will be returned by
a call to AsyncContext.getRequest()
, does not contain said
ServletRequestWrapper. The same holds true for ServletResponseWrapper
instances.
This method clears the list of AsyncListener
instances
(if any) that were registered with the AsyncContext returned by the
previous call to one of the startAsync methods, after calling each
AsyncListener at its onStartAsync
method.
Subsequent invocations of this method, or its zero-argument variant, will return the same AsyncContext instance, reinitialized as appropriate. If a call to this method is followed by a call to its zero-argument variant, the specified (and possibly wrapped) request and response objects will remain locked in on the returned AsyncContext.
startAsync
in interface ServletRequest
request
- the ServletRequest used to initialize the
AsyncContextresponse
- the ServletResponse used to initialize the
AsyncContextpublic void setAsyncStarted(boolean asyncStarted)
public boolean isAsyncStarted()
javax.servlet.ServletRequest
A ServletRequest is put into asynchronous mode by calling
ServletRequest.startAsync()
or
ServletRequest.startAsync(ServletRequest,ServletResponse)
on it.
This method returns false if this request was
put into asynchronous mode, but has since been dispatched using
one of the AsyncContext.dispatch()
methods or released
from asynchronous mode via a call to AsyncContext.complete()
.
isAsyncStarted
in interface ServletRequest
public void setAsyncSupported(boolean asyncSupported)
public boolean isAsyncSupported()
javax.servlet.ServletRequest
Asynchronous operation is disabled for this request if this request is within the scope of a filter or servlet that has not been annotated or flagged in the deployment descriptor as being able to support asynchronous handling.
isAsyncSupported
in interface ServletRequest
public void setAsyncContext(@Nullable MockAsyncContext asyncContext)
@Nullable public AsyncContext getAsyncContext()
javax.servlet.ServletRequest
ServletRequest.startAsync()
or
ServletRequest.startAsync(ServletRequest,ServletResponse)
on this request.getAsyncContext
in interface ServletRequest
ServletRequest.startAsync()
or
ServletRequest.startAsync(ServletRequest,ServletResponse)
on
this requestpublic void setDispatcherType(DispatcherType dispatcherType)
public DispatcherType getDispatcherType()
javax.servlet.ServletRequest
The dispatcher type of a request is used by the container to select the filters that need to be applied to the request: Only filters with matching dispatcher type and url patterns will be applied.
Allowing a filter that has been configured for multiple dispatcher types to query a request for its dispatcher type allows the filter to process the request differently depending on its dispatcher type.
The initial dispatcher type of a request is defined as
DispatcherType.REQUEST
. The dispatcher type of a request
dispatched via RequestDispatcher.forward(ServletRequest,
ServletResponse)
or RequestDispatcher.include(ServletRequest,
ServletResponse)
is given as DispatcherType.FORWARD
or
DispatcherType.INCLUDE
, respectively, while the
dispatcher type of an asynchronous request dispatched via
one of the AsyncContext.dispatch()
methods is given as
DispatcherType.ASYNC
. Finally, the dispatcher type of a
request dispatched to an error page by the container's error handling
mechanism is given as DispatcherType.ERROR
.
getDispatcherType
in interface ServletRequest
DispatcherType
@Nullable public String getAuthType()
javax.servlet.http.HttpServletRequest
null
is returned.
Same as the value of the CGI variable AUTH_TYPE.
getAuthType
in interface HttpServletRequest
null
if the request was
not authenticated.@Nullable public Cookie[] getCookies()
javax.servlet.http.HttpServletRequest
Cookie
objects the client sent with this request.
This method returns null
if no cookies were sent.getCookies
in interface HttpServletRequest
Cookies
included with this request, or null
if the request has no cookiespublic void addHeader(String name, Object value)
While this method can take any Object
as a parameter,
it is recommended to use the following types:
toString()
; see getHeader(java.lang.String)
.getDateHeader(java.lang.String)
.getIntHeader(java.lang.String)
.String[]
or Collection<String>
for multiple values; see getHeaders(java.lang.String)
.public void removeHeader(String name)
public long getDateHeader(String name)
name
.
If the internal value representation is a String, this method will try to parse it as a date using the supported date formats:
getDateHeader
in interface HttpServletRequest
name
- the header namelong
value
representing the date specified
in the header expressed as
the number of milliseconds
since January 1, 1970 GMT,
or -1 if the named header
was not included with the
request@Nullable public String getHeader(String name)
javax.servlet.http.HttpServletRequest
String
. If the request did not include a header
of the specified name, this method returns null
.
If there are multiple headers with the same name, this method
returns the first head in the request.
The header name is case insensitive. You can use
this method with any request header.getHeader
in interface HttpServletRequest
name
- a String
specifying the
header nameString
containing the
value of the requested
header, or null
if the request does not
have a header of that namepublic Enumeration<String> getHeaders(String name)
javax.servlet.http.HttpServletRequest
Enumeration
of String
objects.
Some headers, such as Accept-Language
can be sent
by clients as several headers each with a different value rather than
sending the header as a comma separated list.
If the request did not include any headers
of the specified name, this method returns an empty
Enumeration
.
The header name is case insensitive. You can use
this method with any request header.
getHeaders
in interface HttpServletRequest
name
- a String
specifying the
header nameEnumeration
containing
the values of the requested header. If
the request does not have any headers of
that name return an empty
enumeration. If
the container does not allow access to
header information, return nullpublic Enumeration<String> getHeaderNames()
javax.servlet.http.HttpServletRequest
Some servlet containers do not allow
servlets to access headers using this method, in
which case this method returns null
getHeaderNames
in interface HttpServletRequest
null
public int getIntHeader(String name)
javax.servlet.http.HttpServletRequest
int
. If the request does not have a header
of the specified name, this method returns -1. If the
header cannot be converted to an integer, this method
throws a NumberFormatException
.
The header name is case insensitive.
getIntHeader
in interface HttpServletRequest
name
- a String
specifying the name
of a request header@Nullable public String getMethod()
javax.servlet.http.HttpServletRequest
getMethod
in interface HttpServletRequest
String
specifying the name
of the method with which
this request was made@Nullable public String getPathInfo()
javax.servlet.http.HttpServletRequest
This method returns null
if there
was no extra path information.
Same as the value of the CGI variable PATH_INFO.
getPathInfo
in interface HttpServletRequest
String
, decoded by the
web container, specifying
extra path information that comes
after the servlet path but before
the query string in the request URL;
or null
if the URL does not have
any extra path information@Nullable public String getPathTranslated()
javax.servlet.http.HttpServletRequest
If the URL does not have any extra path information,
this method returns null
or the servlet container
cannot translate the virtual path to a real path for any reason
(such as when the web application is executed from an archive).
The web container does not decode this string.
getPathTranslated
in interface HttpServletRequest
String
specifying the
real path, or null
if
the URL does not have any extra path
informationpublic void setContextPath(String contextPath)
public String getContextPath()
javax.servlet.http.HttpServletRequest
It is possible that a servlet container may match a context by
more than one context path. In such cases this method will return the
actual context path used by the request and it may differ from the
path returned by the
ServletContext.getContextPath()
method.
The context path returned by
ServletContext.getContextPath()
should be considered as the prime or preferred context path of the
application.
getContextPath
in interface HttpServletRequest
String
specifying the
portion of the request URI that indicates the context
of the requestServletContext.getContextPath()
@Nullable public String getQueryString()
javax.servlet.http.HttpServletRequest
null
if the URL does not have a query string. Same as the value
of the CGI variable QUERY_STRING.getQueryString
in interface HttpServletRequest
String
containing the query
string or null
if the URL
contains no query string. The value is not
decoded by the container.@Nullable public String getRemoteUser()
javax.servlet.http.HttpServletRequest
null
if the user
has not been authenticated.
Whether the user name is sent with each subsequent request
depends on the browser and type of authentication. Same as the
value of the CGI variable REMOTE_USER.getRemoteUser
in interface HttpServletRequest
String
specifying the login
of the user making this request, or null
if the user login is not knownpublic void addUserRole(String role)
public boolean isUserInRole(String role)
javax.servlet.http.HttpServletRequest
false
.
The role name "*" should never be used as an argument in calling
isUserInRole
. Any call to isUserInRole
with
"*" must return false.
If the role-name of the security-role to be tested is "**", and
the application has NOT declared an application security-role with
role-name "**", isUserInRole
must only return true if
the user has been authenticated; that is, only when
HttpServletRequest.getRemoteUser()
and HttpServletRequest.getUserPrincipal()
would both return
a non-null value. Otherwise, the container must check
the user for membership in the application role.
isUserInRole
in interface HttpServletRequest
role
- a String
specifying the name
of the roleboolean
indicating whether
the user making this request belongs to a given role;
false
if the user has not been
authenticated@Nullable public Principal getUserPrincipal()
javax.servlet.http.HttpServletRequest
java.security.Principal
object containing
the name of the current authenticated user. If the user has not been
authenticated, the method returns null
.getUserPrincipal
in interface HttpServletRequest
java.security.Principal
containing
the name of the user making this request;
null
if the user has not been
authenticated@Nullable public String getRequestedSessionId()
javax.servlet.http.HttpServletRequest
null
.getRequestedSessionId
in interface HttpServletRequest
String
specifying the session
ID, or null
if the request did
not specify a session IDHttpServletRequest.isRequestedSessionIdValid()
@Nullable public String getRequestURI()
javax.servlet.http.HttpServletRequest
First line of HTTP request | Returned Value | |
---|---|---|
POST /some/path.html HTTP/1.1 | /some/path.html | |
GET http://foo.bar/a.html HTTP/1.0 | /a.html | |
HEAD /xyz?a=b HTTP/1.1 | /xyz |
To reconstruct an URL with a scheme and host, use
HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)
.
getRequestURI
in interface HttpServletRequest
String
containing
the part of the URL from the
protocol name up to the query stringHttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)
public StringBuffer getRequestURL()
javax.servlet.http.HttpServletRequest
If this request has been forwarded using
RequestDispatcher.forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
, the server path in the
reconstructed URL must reflect the path used to obtain the
RequestDispatcher, and not the server path specified by the client.
Because this method returns a StringBuffer
,
not a string, you can modify the URL easily, for example,
to append query parameters.
This method is useful for creating redirect messages and for reporting errors.
getRequestURL
in interface HttpServletRequest
StringBuffer
object containing
the reconstructed URLpublic void setServletPath(String servletPath)
public String getServletPath()
javax.servlet.http.HttpServletRequest
This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.
getServletPath
in interface HttpServletRequest
String
containing
the name or path of the servlet being
called, as specified in the request URL,
decoded, or an empty string if the servlet
used to process the request is matched
using the "/*" pattern.public void setSession(HttpSession session)
@Nullable public HttpSession getSession(boolean create)
javax.servlet.http.HttpServletRequest
HttpSession
associated with this request or, if there is no
current session and create
is true, returns
a new session.
If create
is false
and the request has no valid HttpSession
,
this method returns null
.
To make sure the session is properly maintained, you must call this method before the response is committed. If the container is using cookies to maintain session integrity and is asked to create a new session when the response is committed, an IllegalStateException is thrown.
getSession
in interface HttpServletRequest
create
- true
to create
a new session for this request if necessary;
false
to return null
if there's no current sessionHttpSession
associated
with this request or null
if
create
is false
and the request has no valid sessionHttpServletRequest.getSession()
@Nullable public HttpSession getSession()
javax.servlet.http.HttpServletRequest
getSession
in interface HttpServletRequest
HttpSession
associated
with this requestHttpServletRequest.getSession(boolean)
public String changeSessionId()
MockHttpSession.changeSessionId()
if the session is a mock session.
Otherwise it simply returns the current session id.changeSessionId
in interface HttpServletRequest
public void setRequestedSessionIdValid(boolean requestedSessionIdValid)
public boolean isRequestedSessionIdValid()
javax.servlet.http.HttpServletRequest
If the client did not specify any session ID, this method returns
false
.
isRequestedSessionIdValid
in interface HttpServletRequest
true
if this
request has an id for a valid session
in the current session context;
false
otherwiseHttpServletRequest.getRequestedSessionId()
,
HttpServletRequest.getSession(boolean)
,
HttpSessionContext
public void setRequestedSessionIdFromCookie(boolean requestedSessionIdFromCookie)
public boolean isRequestedSessionIdFromCookie()
javax.servlet.http.HttpServletRequest
Checks whether the requested session ID was conveyed to the server as an HTTP cookie.
isRequestedSessionIdFromCookie
in interface HttpServletRequest
true
if the session ID
was conveyed to the server an an HTTP
cookie; otherwise, false
HttpServletRequest.getSession(boolean)
public void setRequestedSessionIdFromURL(boolean requestedSessionIdFromURL)
public boolean isRequestedSessionIdFromURL()
javax.servlet.http.HttpServletRequest
Checks whether the requested session ID was conveyed to the server as part of the request URL.
isRequestedSessionIdFromURL
in interface HttpServletRequest
true
if the session ID was conveyed to the
server as part of a URL; otherwise,
false
HttpServletRequest.getSession(boolean)
@Deprecated public boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromUrl
in interface HttpServletRequest
true
if the session ID was conveyed to the
server as part of a URL; otherwise,
false
public boolean authenticate(HttpServletResponse response) throws IOException, ServletException
javax.servlet.http.HttpServletRequest
ServletContext
to authenticate the user making
this request.
This method may modify and commit the argument
HttpServletResponse
.
authenticate
in interface HttpServletRequest
response
- The HttpServletResponse
associated with this HttpServletRequest
true
when non-null values were or have been
established as the values returned by getUserPrincipal
,
getRemoteUser
, and getAuthType
. Return
false
if authentication is incomplete and the underlying
login mechanism has committed, in the response, the message (e.g.,
challenge) and HTTP status code to be returned to the user.IOException
- if an input or output error occurred while
reading from this request or writing to the given responseServletException
- if the authentication failed and
the caller is responsible for handling the error (i.e., the
underlying login mechanism did NOT establish the message and
HTTP status code to be returned to the user)public void login(String username, String password) throws ServletException
javax.servlet.http.HttpServletRequest
ServletContext
.
This method returns without throwing a ServletException
when the login mechanism configured for the ServletContext
supports username password validation, and when, at the time of the
call to login, the identity of the caller of the request had
not been established (i.e, all of getUserPrincipal
,
getRemoteUser
, and getAuthType
return null),
and when validation of the provided credentials is successful.
Otherwise, this method throws a ServletException
as
described below.
When this method returns without throwing an exception, it must
have established non-null values as the values returned by
getUserPrincipal
, getRemoteUser
, and
getAuthType
.
login
in interface HttpServletRequest
username
- The String
value corresponding to
the login identifier of the user.password
- The password String
corresponding
to the identified user.ServletException
- if the configured login mechanism
does not support username
password authentication, or if a
non-null caller identity had
already been established (prior
to the call to login), or if
validation of the provided
username and password fails.public void logout() throws ServletException
javax.servlet.http.HttpServletRequest
null
as the value returned when
getUserPrincipal
, getRemoteUser
,
and getAuthType
is called on the request.logout
in interface HttpServletRequest
ServletException
- if logout failspublic void addPart(Part part)
@Nullable public Part getPart(String name) throws IOException, ServletException
javax.servlet.http.HttpServletRequest
Part
with the given name.getPart
in interface HttpServletRequest
name
- the name of the requested Part
Part
with the given name, or
null
if this request is of type
multipart/form-data
, but does not
contain the requested Part
IOException
- if an I/O error occurred during the retrieval
of the requested Part
ServletException
- if this request is not of type
multipart/form-data
MultipartConfig.maxFileSize()
,
MultipartConfig.maxRequestSize()
public Collection<Part> getParts() throws IOException, ServletException
javax.servlet.http.HttpServletRequest
Part
components of this request, provided
that it is of type multipart/form-data
.
If this request is of type multipart/form-data
, but
does not contain any Part
components, the returned
Collection
will be empty.
Any changes to the returned Collection
must not
affect this HttpServletRequest
.
getParts
in interface HttpServletRequest
Collection
of the
Part
components of this requestIOException
- if an I/O error occurred during the retrieval
of the Part
components of this requestServletException
- if this request is not of type
multipart/form-data
MultipartConfig.maxFileSize()
,
MultipartConfig.maxRequestSize()
public <T extends HttpUpgradeHandler> T upgrade(Class<T> handlerClass) throws IOException, ServletException
javax.servlet.http.HttpServletRequest
HttpUpgradeHandler
for a given
class and uses it for the http protocol upgrade processing.upgrade
in interface HttpServletRequest
T
- The Class
, which extends HttpUpgradeHandler
, of the handlerClass
.handlerClass
- The HttpUpgradeHandler
class used for the upgrade.HttpUpgradeHandler
IOException
- if an I/O error occurred during the upgradeServletException
- if the given handlerClass
fails to
be instantiatedHttpUpgradeHandler
,
WebConnection