Class MockHttpServletRequest
- java.lang.Object
- org.springframework.mock.web.MockHttpServletRequest
- All Implemented Interfaces:
HttpServletRequest
,ServletRequest
- Direct Known Subclasses:
MockMultipartHttpServletRequest
public class MockHttpServletRequest extends Object implements HttpServletRequest
Mock implementation of theHttpServletRequest
interface.The default, preferred
Locale
for the server mocked by this request isLocale.ENGLISH
. This value can be changed viaaddPreferredLocale(java.util.Locale)
orsetPreferredLocales(java.util.List<java.util.Locale>)
.As of Spring Framework 5.0, this set of mocks is designed on a Servlet 4.0 baseline.
- Since:
- 1.0.2
- Author:
- Juergen Hoeller, Rod Johnson, Rick Evans, Mark Fisher, Chris Beams, Sam Brannen, Brian Clozel
Field Summary
Fields Modifier and Type Field 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'.Fields inherited from interface javax.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
Constructor Summary
Constructors Constructor Description MockHttpServletRequest()
Create a newMockHttpServletRequest
with a defaultMockServletContext
.MockHttpServletRequest(String method, String requestURI)
Create a newMockHttpServletRequest
with a defaultMockServletContext
.MockHttpServletRequest(ServletContext servletContext)
Create a newMockHttpServletRequest
with the suppliedServletContext
.MockHttpServletRequest(ServletContext servletContext, String method, String requestURI)
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addHeader(String name, Object value)
Add an HTTP 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<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 theServletContext
to authenticate the user making this request.String
changeSessionId()
The implementation of this (Servlet 3.1+) method callsMockHttpSession.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 ofServletRequest.startAsync()
orServletRequest.startAsync(ServletRequest,ServletResponse)
on this request.Object
getAttribute(String name)
Returns the value of the named attribute as anObject
, ornull
if no attribute of the given name exists.Enumeration<String>
getAttributeNames()
Returns anEnumeration
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 aString
, 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, ornull
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 theCookie
objects the client sent with this request.long
getDateHeader(String name)
Return the long timestamp for the date header with the givenname
.DispatcherType
getDispatcherType()
Gets the dispatcher type of this request.String
getHeader(String name)
Returns the value of the specified request header as aString
.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 anEnumeration
ofString
objects.ServletInputStream
getInputStream()
Retrieves the body of the request as binary data using aServletInputStream
.int
getIntHeader(String name)
Returns the value of the specified request header as anint
.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 aString
, ornull
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 anEnumeration
ofString
objects containing the names of the parameters contained in this request.String[]
getParameterValues(String name)
Returns an array ofString
objects containing all of the values the given request parameter has, ornull
if the parameter does not exist.Part
getPart(String name)
Gets thePart
with the given name.Collection<Part>
getParts()
Gets all thePart
components of this request, provided that it is of typemultipart/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 aBufferedReader
.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, ornull
if the user has not been authenticated.RequestDispatcher
getRequestDispatcher(String path)
Returns aRequestDispatcher
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
, orftp
.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 currentHttpSession
associated with this request or, if there is no current session andcreate
is true, returns a new session.Principal
getUserPrincipal()
Returns ajava.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 theServletContext
.void
logout()
Establishnull
as the value returned whengetUserPrincipal
,getRemoteUser
, andgetAuthType
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 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<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 booleansecure
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 itsAsyncContext
with the original (unwrapped) ServletRequest and ServletResponse objects.AsyncContext
startAsync(ServletRequest request, ServletResponse response)
Puts this request into asynchronous mode, and initializes itsAsyncContext
with the given request and response objects.<T extends HttpUpgradeHandler>
Tupgrade(Class<T> handlerClass)
Creates an instance ofHttpUpgradeHandler
for a given class and uses it for the http protocol upgrade processing.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface javax.servlet.http.HttpServletRequest
getHttpServletMapping, getTrailerFields, isTrailerFieldsReady, newPushBuilder
Field Detail
DEFAULT_PROTOCOL
public static final String DEFAULT_PROTOCOL
The default protocol: 'HTTP/1.1'.- Since:
- 4.3.7
- See Also:
- Constant Field Values
DEFAULT_SCHEME
public static final String DEFAULT_SCHEME
The default scheme: 'http'.- Since:
- 4.3.7
- See Also:
- Constant Field Values
DEFAULT_SERVER_ADDR
public static final String DEFAULT_SERVER_ADDR
The default server address: '127.0.0.1'.- See Also:
- Constant Field Values
DEFAULT_SERVER_NAME
public static final String DEFAULT_SERVER_NAME
The default server name: 'localhost'.- See Also:
- Constant Field Values
DEFAULT_SERVER_PORT
public static final int DEFAULT_SERVER_PORT
The default server port: '80'.- See Also:
- Constant Field Values
DEFAULT_REMOTE_ADDR
public static final String DEFAULT_REMOTE_ADDR
The default remote address: '127.0.0.1'.- See Also:
- Constant Field Values
DEFAULT_REMOTE_HOST
public static final String DEFAULT_REMOTE_HOST
The default remote host: 'localhost'.- See Also:
- Constant Field Values
Constructor Detail
MockHttpServletRequest
public MockHttpServletRequest()
Create a newMockHttpServletRequest
with a defaultMockServletContext
.
MockHttpServletRequest
public MockHttpServletRequest(@Nullable String method, @Nullable String requestURI)
Create a newMockHttpServletRequest
with a defaultMockServletContext
.- Parameters:
method
- the request method (may benull
)requestURI
- the request URI (may benull
)- See Also:
setMethod(java.lang.String)
,setRequestURI(java.lang.String)
,MockHttpServletRequest(ServletContext, String, String)
MockHttpServletRequest
public MockHttpServletRequest(@Nullable ServletContext servletContext)
Create a newMockHttpServletRequest
with the suppliedServletContext
.- Parameters:
servletContext
- the ServletContext that the request runs in (may benull
to use a defaultMockServletContext
)- See Also:
MockHttpServletRequest(ServletContext, String, String)
MockHttpServletRequest
public MockHttpServletRequest(@Nullable ServletContext servletContext, @Nullable String method, @Nullable String requestURI)
Create a newMockHttpServletRequest
with the suppliedServletContext
,method
, andrequestURI
.The preferred locale will be set to
Locale.ENGLISH
.- Parameters:
servletContext
- the ServletContext that the request runs in (may benull
to use a defaultMockServletContext
)method
- the request method (may benull
)requestURI
- the request URI (may benull
)- See Also:
setMethod(java.lang.String)
,setRequestURI(java.lang.String)
,setPreferredLocales(java.util.List<java.util.Locale>)
,MockServletContext
Method Detail
getServletContext
public ServletContext getServletContext()
Return the ServletContext that this request is associated with. (Not available in the standard HttpServletRequest interface for some reason.)- Specified by:
getServletContext
in interfaceServletRequest
- Returns:
- the servlet context to which this ServletRequest was last dispatched
isActive
public boolean isActive()
Return whether this request is still active (that is, not completed yet).
close
public void close()
Mark this request as completed, keeping its state.
invalidate
public void invalidate()
Invalidate this request, clearing its state.
checkActive
protected void checkActive() throws IllegalStateException
Check whether this request is still active (that is, not completed yet), throwing an IllegalStateException if not active anymore.- Throws:
IllegalStateException
getAttribute
public Object getAttribute(String name)
Description copied from interface:javax.servlet.ServletRequest
Returns the value of the named attribute as anObject
, ornull
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 usingServletRequest.setAttribute(java.lang.String, java.lang.Object)
. This allows information to be embedded into a request before aRequestDispatcher
call.Attribute names should follow the same conventions as package names. This specification reserves names matching
java.*
,javax.*
, andsun.*
.- Specified by:
getAttribute
in interfaceServletRequest
- Parameters:
name
- aString
specifying the name of the attribute- Returns:
- an
Object
containing the value of the attribute, ornull
if the attribute does not exist
getAttributeNames
public Enumeration<String> getAttributeNames()
Description copied from interface:javax.servlet.ServletRequest
Returns anEnumeration
containing the names of the attributes available to this request. This method returns an emptyEnumeration
if the request has no attributes available to it.- Specified by:
getAttributeNames
in interfaceServletRequest
- Returns:
- an
Enumeration
of strings containing the names of the request's attributes
getCharacterEncoding
@Nullable public String getCharacterEncoding()
Description copied from interface:javax.servlet.ServletRequest
Returns the name of the character encoding used in the body of this request. This method returnsnull
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 (usingServletContext.setRequestCharacterEncoding(java.lang.String)
, deployment descriptor), and per container (for all web applications deployed in that container, using vendor specific configuration).- Specified by:
getCharacterEncoding
in interfaceServletRequest
- Returns:
- a
String
containing the name of the character encoding, ornull
if the request does not specify a character encoding
setCharacterEncoding
public void setCharacterEncoding(@Nullable String characterEncoding)
Description copied from interface:javax.servlet.ServletRequest
Overrides the name of the character encoding used in the body of this request. This method must be called prior to reading request parameters or reading input using getReader(). Otherwise, it has no effect.- Specified by:
setCharacterEncoding
in interfaceServletRequest
- Parameters:
characterEncoding
-String
containing the name of the character encoding.
setContent
public void setContent(@Nullable byte[] content)
Set the content of the request body as a byte array.If the supplied byte array represents text such as XML or JSON, the
character encoding
should typically be set as well.
getContentAsByteArray
@Nullable public byte[] getContentAsByteArray()
Get the content of the request body as a byte array.- Returns:
- the content as a byte array (potentially
null
) - Since:
- 5.0
- See Also:
setContent(byte[])
,getContentAsString()
getContentAsString
@Nullable public String getContentAsString() throws IllegalStateException, UnsupportedEncodingException
Get the content of the request body as aString
, using the configured character encoding.- Returns:
- the content as a
String
, potentiallynull
- Throws:
IllegalStateException
- if the character encoding has not been setUnsupportedEncodingException
- if the character encoding is not supported- Since:
- 5.0
- See Also:
setContent(byte[])
,setCharacterEncoding(String)
,getContentAsByteArray()
getContentLength
public int getContentLength()
Description copied from interface:javax.servlet.ServletRequest
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. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.- Specified by:
getContentLength
in interfaceServletRequest
- Returns:
- an integer containing the length of the request body or -1 if the length is not known or is greater than Integer.MAX_VALUE.
getContentLengthLong
public long getContentLengthLong()
Description copied from interface:javax.servlet.ServletRequest
Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.- Specified by:
getContentLengthLong
in interfaceServletRequest
- Returns:
- a long containing the length of the request body or -1L if the length is not known
setContentType
public void setContentType(@Nullable String contentType)
getContentType
@Nullable public String getContentType()
Description copied from interface:javax.servlet.ServletRequest
Returns the MIME type of the body of the request, ornull
if the type is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE.- Specified by:
getContentType
in interfaceServletRequest
- Returns:
- a
String
containing the name of the MIME type of the request, or null if the type is not known
getInputStream
public ServletInputStream getInputStream()
Description copied from interface:javax.servlet.ServletRequest
Retrieves the body of the request as binary data using aServletInputStream
. Either this method orServletRequest.getReader()
may be called to read the body, not both.- Specified by:
getInputStream
in interfaceServletRequest
- Returns:
- a
ServletInputStream
object containing the body of the request
setParameter
public void setParameter(String name, String value)
Set a single value for the specified HTTP parameter.If there are already one or more values registered for the given parameter name, they will be replaced.
setParameter
public void setParameter(String name, String... values)
Set an array of values for the specified HTTP parameter.If there are already one or more values registered for the given parameter name, they will be replaced.
setParameters
public void setParameters(Map<String,?> params)
Set all provided parameters replacing any existing values for the provided parameter names. To add without replacing existing values, useaddParameters(java.util.Map)
.
addParameter
public void addParameter(String name, @Nullable String value)
Add a single value for the specified HTTP parameter.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.
addParameter
public void addParameter(String name, String... values)
Add an array of values for the specified HTTP parameter.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.
addParameters
public void addParameters(Map<String,?> params)
Add all provided parameters without replacing any existing values. To replace existing values, usesetParameters(java.util.Map)
.
removeParameter
public void removeParameter(String name)
Remove already registered values for the specified HTTP parameter, if any.
removeAllParameters
public void removeAllParameters()
Remove all existing parameters.
getParameter
@Nullable public String getParameter(String name)
Description copied from interface:javax.servlet.ServletRequest
Returns the value of a request parameter as aString
, ornull
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()
orServletRequest.getReader()
can interfere with the execution of this method.- Specified by:
getParameter
in interfaceServletRequest
- Parameters:
name
- aString
specifying the name of the parameter- Returns:
- a
String
representing the single value of the parameter - See Also:
ServletRequest.getParameterValues(java.lang.String)
getParameterNames
public Enumeration<String> getParameterNames()
Description copied from interface:javax.servlet.ServletRequest
Returns anEnumeration
ofString
objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an emptyEnumeration
.- Specified by:
getParameterNames
in interfaceServletRequest
- Returns:
- an
Enumeration
ofString
objects, eachString
containing the name of a request parameter; or an emptyEnumeration
if the request has no parameters
getParameterValues
public String[] getParameterValues(String name)
Description copied from interface:javax.servlet.ServletRequest
Returns an array ofString
objects containing all of the values the given request parameter has, ornull
if the parameter does not exist.If the parameter has a single value, the array has a length of 1.
- Specified by:
getParameterValues
in interfaceServletRequest
- Parameters:
name
- aString
containing the name of the parameter whose value is requested- Returns:
- an array of
String
objects containing the parameter's values - See Also:
ServletRequest.getParameter(java.lang.String)
getParameterMap
public Map<String,String[]> getParameterMap()
Description copied from interface:javax.servlet.ServletRequest
Returns a java.util.Map of the parameters of this request.Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.
- Specified by:
getParameterMap
in interfaceServletRequest
- Returns:
- an immutable java.util.Map containing parameter names as keys and parameter values as map values. The keys in the parameter map are of type String. The values in the parameter map are of type String array.
setProtocol
public void setProtocol(String protocol)
getProtocol
public String getProtocol()
Description copied from interface:javax.servlet.ServletRequest
Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1. For HTTP servlets, the value returned is the same as the value of the CGI variableSERVER_PROTOCOL
.- Specified by:
getProtocol
in interfaceServletRequest
- Returns:
- a
String
containing the protocol name and version number
getScheme
public String getScheme()
Description copied from interface:javax.servlet.ServletRequest
Returns the name of the scheme used to make this request, for example,http
,https
, orftp
. Different schemes have different rules for constructing URLs, as noted in RFC 1738.- Specified by:
getScheme
in interfaceServletRequest
- Returns:
- a
String
containing the name of the scheme used to make this request
setServerName
public void setServerName(String serverName)
getServerName
public String getServerName()
Description copied from interface:javax.servlet.ServletRequest
Returns the host name of the server to which the request was sent. It is the value of the part before ":" in theHost
header value, if any, or the resolved server name, or the server IP address.- Specified by:
getServerName
in interfaceServletRequest
- Returns:
- a
String
containing the name of the server
setServerPort
public void setServerPort(int serverPort)
getServerPort
public int getServerPort()
Description copied from interface:javax.servlet.ServletRequest
Returns the port number to which the request was sent. It is the value of the part after ":" in theHost
header value, if any, or the server port where the client connection was accepted on.- Specified by:
getServerPort
in interfaceServletRequest
- Returns:
- an integer specifying the port number
getReader
public BufferedReader getReader() throws UnsupportedEncodingException
Description copied from interface:javax.servlet.ServletRequest
Retrieves the body of the request as character data using aBufferedReader
. The reader translates the character data according to the character encoding used on the body. Either this method orServletRequest.getInputStream()
may be called to read the body, not both.- Specified by:
getReader
in interfaceServletRequest
- Returns:
- a
BufferedReader
containing the body of the request - Throws:
UnsupportedEncodingException
- if the character set encoding used is not supported and the text cannot be decoded- See Also:
ServletRequest.getInputStream()
setRemoteAddr
public void setRemoteAddr(String remoteAddr)
getRemoteAddr
public String getRemoteAddr()
Description copied from interface:javax.servlet.ServletRequest
Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. For HTTP servlets, same as the value of the CGI variableREMOTE_ADDR
.- Specified by:
getRemoteAddr
in interfaceServletRequest
- Returns:
- a
String
containing the IP address of the client that sent the request
setRemoteHost
public void setRemoteHost(String remoteHost)
getRemoteHost
public String getRemoteHost()
Description copied from interface:javax.servlet.ServletRequest
Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variableREMOTE_HOST
.- Specified by:
getRemoteHost
in interfaceServletRequest
- Returns:
- a
String
containing the fully qualified name of the client
setAttribute
public void setAttribute(String name, @Nullable Object value)
Description copied from interface:javax.servlet.ServletRequest
Stores an attribute in this request. Attributes are reset between requests. This method is most often used in conjunction withRequestDispatcher
.Attribute names should follow the same conventions as package names. Names beginning with
java.*
,javax.*
, andcom.sun.*
, are reserved for use by Sun Microsystems.
If the object passed in is null, the effect is the same as callingServletRequest.removeAttribute(java.lang.String)
.
It is warned that when the request is dispatched from the servlet resides in a different web application byRequestDispatcher
, the object set by this method may not be correctly retrieved in the caller servlet.- Specified by:
setAttribute
in interfaceServletRequest
- Parameters:
name
- aString
specifying the name of the attributevalue
- theObject
to be stored
removeAttribute
public void removeAttribute(String name)
Description copied from interface:javax.servlet.ServletRequest
Removes an attribute from this request. This method is not generally needed as attributes only persist as long as the request is being handled.Attribute names should follow the same conventions as package names. Names beginning with
java.*
,javax.*
, andcom.sun.*
, are reserved for use by Sun Microsystems.- Specified by:
removeAttribute
in interfaceServletRequest
- Parameters:
name
- aString
specifying the name of the attribute to remove
clearAttributes
public void clearAttributes()
Clear all of this request's attributes.
addPreferredLocale
public void addPreferredLocale(Locale locale)
Add a new preferred locale, before any existing locales.
setPreferredLocales
public void setPreferredLocales(List<Locale> locales)
Set the list of preferred locales, in descending order, effectively replacing any existing locales.- Since:
- 3.2
- See Also:
addPreferredLocale(java.util.Locale)
getLocale
public Locale getLocale()
Return the first preferred locale configured in this mock request.If no locales have been explicitly configured, the default, preferred
Locale
for the server mocked by this request isLocale.ENGLISH
.In contrast to the Servlet specification, this mock implementation does not take into consideration any locales specified via the
Accept-Language
header.- Specified by:
getLocale
in interfaceServletRequest
- Returns:
- the preferred
Locale
for the client - See Also:
ServletRequest.getLocale()
,addPreferredLocale(Locale)
,setPreferredLocales(List)
getLocales
public Enumeration<Locale> getLocales()
Return an enumeration of the preferred locales configured in this mock request.If no locales have been explicitly configured, the default, preferred
Locale
for the server mocked by this request isLocale.ENGLISH
.In contrast to the Servlet specification, this mock implementation does not take into consideration any locales specified via the
Accept-Language
header.- Specified by:
getLocales
in interfaceServletRequest
- Returns:
- an
Enumeration
of preferredLocale
objects for the client - See Also:
ServletRequest.getLocales()
,addPreferredLocale(Locale)
,setPreferredLocales(List)
setSecure
public void setSecure(boolean secure)
Set the booleansecure
flag indicating whether the mock request was made using a secure channel, such as HTTPS.- See Also:
isSecure()
,getScheme()
,setScheme(String)
isSecure
public boolean isSecure()
- Specified by:
isSecure
in interfaceServletRequest
- Returns:
- a boolean indicating if the request was made using a secure channel
- See Also:
ServletRequest.isSecure()
getRequestDispatcher
public RequestDispatcher getRequestDispatcher(String path)
Description copied from interface:javax.servlet.ServletRequest
Returns aRequestDispatcher
object that acts as a wrapper for the resource located at the given path. ARequestDispatcher
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 aRequestDispatcher
.The difference between this method and
ServletContext.getRequestDispatcher(java.lang.String)
is that this method can take a relative path.- Specified by:
getRequestDispatcher
in interfaceServletRequest
- Parameters:
path
- aString
specifying the pathname to the resource. If it is relative, it must be relative against the current servlet.- Returns:
- a
RequestDispatcher
object that acts as a wrapper for the resource at the specified path, ornull
if the servlet container cannot return aRequestDispatcher
- See Also:
RequestDispatcher
,ServletContext.getRequestDispatcher(java.lang.String)
getRealPath
@Deprecated public String getRealPath(String path)
Deprecated.- Specified by:
getRealPath
in interfaceServletRequest
- Parameters:
path
- the path for which the real path is to be returned.- Returns:
- the real path, or null if the translation cannot be performed.
setRemotePort
public void setRemotePort(int remotePort)
getRemotePort
public int getRemotePort()
Description copied from interface:javax.servlet.ServletRequest
Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.- Specified by:
getRemotePort
in interfaceServletRequest
- Returns:
- an integer specifying the port number
setLocalName
public void setLocalName(String localName)
getLocalName
public String getLocalName()
Description copied from interface:javax.servlet.ServletRequest
Returns the host name of the Internet Protocol (IP) interface on which the request was received.- Specified by:
getLocalName
in interfaceServletRequest
- Returns:
- a
String
containing the host name of the IP on which the request was received.
setLocalAddr
public void setLocalAddr(String localAddr)
getLocalAddr
public String getLocalAddr()
Description copied from interface:javax.servlet.ServletRequest
Returns the Internet Protocol (IP) address of the interface on which the request was received.- Specified by:
getLocalAddr
in interfaceServletRequest
- Returns:
- a
String
containing the IP address on which the request was received.
setLocalPort
public void setLocalPort(int localPort)
getLocalPort
public int getLocalPort()
Description copied from interface:javax.servlet.ServletRequest
Returns the Internet Protocol (IP) port number of the interface on which the request was received.- Specified by:
getLocalPort
in interfaceServletRequest
- Returns:
- an integer specifying the port number
startAsync
public AsyncContext startAsync()
Description copied from interface:javax.servlet.ServletRequest
Puts this request into asynchronous mode, and initializes itsAsyncContext
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 returnedAsyncContext
, or the asynchronous operation has timed out.Calling
AsyncContext.hasOriginalRequestAndResponse()
on the returned AsyncContext will returntrue
. 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 itsonStartAsync
method.Subsequent invocations of this method, or its overloaded variant, will return the same AsyncContext instance, reinitialized as appropriate.
- Specified by:
startAsync
in interfaceServletRequest
- Returns:
- the (re)initialized AsyncContext
- See Also:
AsyncContext.dispatch()
startAsync
public AsyncContext startAsync(ServletRequest request, @Nullable ServletResponse response)
Description copied from interface:javax.servlet.ServletRequest
Puts this request into asynchronous mode, and initializes itsAsyncContext
with the given request and response objects.The ServletRequest and ServletResponse arguments must be the same instances, or instances of
ServletRequestWrapper
andServletResponseWrapper
that wrap them, that were passed to theservice
method of the Servlet or thedoFilter
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 returnedAsyncContext
, or the asynchronous operation has timed out.Calling
AsyncContext.hasOriginalRequestAndResponse()
on the returned AsyncContext will returnfalse
, 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 givenservletRequest
, which is used to initialize the AsyncContext and will be returned by a call toAsyncContext.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 itsonStartAsync
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.
- Specified by:
startAsync
in interfaceServletRequest
- Parameters:
request
- the ServletRequest used to initialize the AsyncContextresponse
- the ServletResponse used to initialize the AsyncContext- Returns:
- the (re)initialized AsyncContext
setAsyncStarted
public void setAsyncStarted(boolean asyncStarted)
isAsyncStarted
public boolean isAsyncStarted()
Description copied from interface:javax.servlet.ServletRequest
Checks if this request has been put into asynchronous mode.A ServletRequest is put into asynchronous mode by calling
ServletRequest.startAsync()
orServletRequest.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 toAsyncContext.complete()
.- Specified by:
isAsyncStarted
in interfaceServletRequest
- Returns:
- true if this request has been put into asynchronous mode, false otherwise
setAsyncSupported
public void setAsyncSupported(boolean asyncSupported)
isAsyncSupported
public boolean isAsyncSupported()
Description copied from interface:javax.servlet.ServletRequest
Checks if this request supports asynchronous operation.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.
- Specified by:
isAsyncSupported
in interfaceServletRequest
- Returns:
- true if this request supports asynchronous operation, false otherwise
setAsyncContext
public void setAsyncContext(@Nullable MockAsyncContext asyncContext)
getAsyncContext
@Nullable public AsyncContext getAsyncContext()
Description copied from interface:javax.servlet.ServletRequest
Gets the AsyncContext that was created or reinitialized by the most recent invocation ofServletRequest.startAsync()
orServletRequest.startAsync(ServletRequest,ServletResponse)
on this request.- Specified by:
getAsyncContext
in interfaceServletRequest
- Returns:
- the AsyncContext that was created or reinitialized by the most recent invocation of
ServletRequest.startAsync()
orServletRequest.startAsync(ServletRequest,ServletResponse)
on this request
setDispatcherType
public void setDispatcherType(DispatcherType dispatcherType)
getDispatcherType
public DispatcherType getDispatcherType()
Description copied from interface:javax.servlet.ServletRequest
Gets the dispatcher type of this request.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 viaRequestDispatcher.forward(ServletRequest, ServletResponse)
orRequestDispatcher.include(ServletRequest, ServletResponse)
is given asDispatcherType.FORWARD
orDispatcherType.INCLUDE
, respectively, while the dispatcher type of an asynchronous request dispatched via one of theAsyncContext.dispatch()
methods is given asDispatcherType.ASYNC
. Finally, the dispatcher type of a request dispatched to an error page by the container's error handling mechanism is given asDispatcherType.ERROR
.- Specified by:
getDispatcherType
in interfaceServletRequest
- Returns:
- the dispatcher type of this request
- See Also:
DispatcherType
setAuthType
public void setAuthType(@Nullable String authType)
getAuthType
@Nullable public String getAuthType()
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns the name of the authentication scheme used to protect the servlet. All servlet containers support basic, form and client certificate authentication, and may additionally support digest authentication. If the servlet is not authenticatednull
is returned.Same as the value of the CGI variable AUTH_TYPE.
- Specified by:
getAuthType
in interfaceHttpServletRequest
- Returns:
- one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (suitable for == comparison) or the container-specific string indicating the authentication scheme, or
null
if the request was not authenticated.
setCookies
public void setCookies(@Nullable Cookie... cookies)
getCookies
@Nullable public Cookie[] getCookies()
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns an array containing all of theCookie
objects the client sent with this request. This method returnsnull
if no cookies were sent.- Specified by:
getCookies
in interfaceHttpServletRequest
- Returns:
- an array of all the
Cookies
included with this request, ornull
if the request has no cookies
addHeader
public void addHeader(String name, Object value)
Add an HTTP header entry for the given name.While this method can take any
Object
as a parameter, it is recommended to use the following types:- String or any Object to be converted using
toString()
; seegetHeader(java.lang.String)
. - String, Number, or Date for date headers; see
getDateHeader(java.lang.String)
. - String or Number for integer headers; see
getIntHeader(java.lang.String)
. String[]
orCollection<String>
for multiple values; seegetHeaders(java.lang.String)
.
- String or any Object to be converted using
removeHeader
public void removeHeader(String name)
Remove already registered entries for the specified HTTP header, if any.- Since:
- 4.3.20
getDateHeader
public long getDateHeader(String name)
Return the long timestamp for the date header with the givenname
.If the internal value representation is a String, this method will try to parse it as a date using the supported date formats:
- "EEE, dd MMM yyyy HH:mm:ss zzz"
- "EEE, dd-MMM-yy HH:mm:ss zzz"
- "EEE MMM dd HH:mm:ss yyyy"
- Specified by:
getDateHeader
in interfaceHttpServletRequest
- Parameters:
name
- the header name- Returns:
- a
long
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 - See Also:
- Section 7.1.1.1 of RFC 7231
getHeader
@Nullable public String getHeader(String name)
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns the value of the specified request header as aString
. If the request did not include a header of the specified name, this method returnsnull
. 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.- Specified by:
getHeader
in interfaceHttpServletRequest
- Parameters:
name
- aString
specifying the header name- Returns:
- a
String
containing the value of the requested header, ornull
if the request does not have a header of that name
getHeaders
public Enumeration<String> getHeaders(String name)
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns all the values of the specified request header as anEnumeration
ofString
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.- Specified by:
getHeaders
in interfaceHttpServletRequest
- Parameters:
name
- aString
specifying the header name- Returns:
- an
Enumeration
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 null
getHeaderNames
public Enumeration<String> getHeaderNames()
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns an enumeration of all the header names this request contains. If the request has no headers, this method returns an empty enumeration.Some servlet containers do not allow servlets to access headers using this method, in which case this method returns
null
- Specified by:
getHeaderNames
in interfaceHttpServletRequest
- Returns:
- an enumeration of all the header names sent with this request; if the request has no headers, an empty enumeration; if the servlet container does not allow servlets to use this method,
null
getIntHeader
public int getIntHeader(String name)
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns the value of the specified request header as anint
. 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 aNumberFormatException
.The header name is case insensitive.
- Specified by:
getIntHeader
in interfaceHttpServletRequest
- Parameters:
name
- aString
specifying the name of a request header- Returns:
- an integer expressing the value of the request header or -1 if the request doesn't have a header of this name
getMethod
@Nullable public String getMethod()
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. Same as the value of the CGI variable REQUEST_METHOD.- Specified by:
getMethod
in interfaceHttpServletRequest
- Returns:
- a
String
specifying the name of the method with which this request was made
setPathInfo
public void setPathInfo(@Nullable String pathInfo)
getPathInfo
@Nullable public String getPathInfo()
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns any extra path information associated with the URL the client sent when it made this request. The extra path information follows the servlet path but precedes the query string and will start with a "/" character.This method returns
null
if there was no extra path information.Same as the value of the CGI variable PATH_INFO.
- Specified by:
getPathInfo
in interfaceHttpServletRequest
- Returns:
- a
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; ornull
if the URL does not have any extra path information
getPathTranslated
@Nullable public String getPathTranslated()
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns any extra path information after the servlet name but before the query string, and translates it to a real path. Same as the value of the CGI variable PATH_TRANSLATED.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.- Specified by:
getPathTranslated
in interfaceHttpServletRequest
- Returns:
- a
String
specifying the real path, ornull
if the URL does not have any extra path information
setContextPath
public void setContextPath(String contextPath)
getContextPath
public String getContextPath()
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "". The container does not decode this string.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 byServletContext.getContextPath()
should be considered as the prime or preferred context path of the application.- Specified by:
getContextPath
in interfaceHttpServletRequest
- Returns:
- a
String
specifying the portion of the request URI that indicates the context of the request - See Also:
ServletContext.getContextPath()
setQueryString
public void setQueryString(@Nullable String queryString)
getQueryString
@Nullable public String getQueryString()
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns the query string that is contained in the request URL after the path. This method returnsnull
if the URL does not have a query string. Same as the value of the CGI variable QUERY_STRING.- Specified by:
getQueryString
in interfaceHttpServletRequest
- Returns:
- a
String
containing the query string ornull
if the URL contains no query string. The value is not decoded by the container.
setRemoteUser
public void setRemoteUser(@Nullable String remoteUser)
getRemoteUser
@Nullable public String getRemoteUser()
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns the login of the user making this request, if the user has been authenticated, ornull
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.- Specified by:
getRemoteUser
in interfaceHttpServletRequest
- Returns:
- a
String
specifying the login of the user making this request, ornull
if the user login is not known
addUserRole
public void addUserRole(String role)
isUserInRole
public boolean isUserInRole(String role)
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns a boolean indicating whether the authenticated user is included in the specified logical "role". Roles and role membership can be defined using deployment descriptors. If the user has not been authenticated, the method returnsfalse
.The role name "*" should never be used as an argument in calling
isUserInRole
. Any call toisUserInRole
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 whenHttpServletRequest.getRemoteUser()
andHttpServletRequest.getUserPrincipal()
would both return a non-null value. Otherwise, the container must check the user for membership in the application role.- Specified by:
isUserInRole
in interfaceHttpServletRequest
- Parameters:
role
- aString
specifying the name of the role- Returns:
- a
boolean
indicating whether the user making this request belongs to a given role;false
if the user has not been authenticated
setUserPrincipal
public void setUserPrincipal(@Nullable Principal userPrincipal)
getUserPrincipal
@Nullable public Principal getUserPrincipal()
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns ajava.security.Principal
object containing the name of the current authenticated user. If the user has not been authenticated, the method returnsnull
.- Specified by:
getUserPrincipal
in interfaceHttpServletRequest
- Returns:
- a
java.security.Principal
containing the name of the user making this request;null
if the user has not been authenticated
setRequestedSessionId
public void setRequestedSessionId(@Nullable String requestedSessionId)
getRequestedSessionId
@Nullable public String getRequestedSessionId()
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns the session ID specified by the client. This may not be the same as the ID of the current valid session for this request. If the client did not specify a session ID, this method returnsnull
.- Specified by:
getRequestedSessionId
in interfaceHttpServletRequest
- Returns:
- a
String
specifying the session ID, ornull
if the request did not specify a session ID - See Also:
HttpServletRequest.isRequestedSessionIdValid()
setRequestURI
public void setRequestURI(@Nullable String requestURI)
getRequestURI
@Nullable public String getRequestURI()
Description copied from interface:javax.servlet.http.HttpServletRequest
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. The web container does not decode this String. For example: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)
.- Specified by:
getRequestURI
in interfaceHttpServletRequest
- Returns:
- a
String
containing the part of the URL from the protocol name up to the query string - See Also:
HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)
getRequestURL
public StringBuffer getRequestURL()
Description copied from interface:javax.servlet.http.HttpServletRequest
Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and server path, but it does not include query string parameters.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.
- Specified by:
getRequestURL
in interfaceHttpServletRequest
- Returns:
- a
StringBuffer
object containing the reconstructed URL
setServletPath
public void setServletPath(String servletPath)
getServletPath
public String getServletPath()
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns the part of this request's URL that calls the servlet. This path starts with a "/" character and includes either the servlet name or a path to the servlet, but does not include any extra path information or a query string. Same as the value of the CGI variable SCRIPT_NAME.This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.
- Specified by:
getServletPath
in interfaceHttpServletRequest
- Returns:
- a
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.
setSession
public void setSession(HttpSession session)
getSession
@Nullable public HttpSession getSession(boolean create)
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns the currentHttpSession
associated with this request or, if there is no current session andcreate
is true, returns a new session.If
create
isfalse
and the request has no validHttpSession
, this method returnsnull
.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.
- Specified by:
getSession
in interfaceHttpServletRequest
- Parameters:
create
-true
to create a new session for this request if necessary;false
to returnnull
if there's no current session- Returns:
- the
HttpSession
associated with this request ornull
ifcreate
isfalse
and the request has no valid session - See Also:
HttpServletRequest.getSession()
getSession
@Nullable public HttpSession getSession()
Description copied from interface:javax.servlet.http.HttpServletRequest
Returns the current session associated with this request, or if the request does not have a session, creates one.- Specified by:
getSession
in interfaceHttpServletRequest
- Returns:
- the
HttpSession
associated with this request - See Also:
HttpServletRequest.getSession(boolean)
changeSessionId
public String changeSessionId()
The implementation of this (Servlet 3.1+) method callsMockHttpSession.changeSessionId()
if the session is a mock session. Otherwise it simply returns the current session id.- Specified by:
changeSessionId
in interfaceHttpServletRequest
- Returns:
- the new session id
- Since:
- 4.0.3
setRequestedSessionIdValid
public void setRequestedSessionIdValid(boolean requestedSessionIdValid)
isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()
Description copied from interface:javax.servlet.http.HttpServletRequest
Checks whether the requested session ID is still valid.If the client did not specify any session ID, this method returns
false
.- Specified by:
isRequestedSessionIdValid
in interfaceHttpServletRequest
- Returns:
true
if this request has an id for a valid session in the current session context;false
otherwise- See Also:
HttpServletRequest.getRequestedSessionId()
,HttpServletRequest.getSession(boolean)
,HttpSessionContext
setRequestedSessionIdFromCookie
public void setRequestedSessionIdFromCookie(boolean requestedSessionIdFromCookie)
isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()
Description copied from interface:javax.servlet.http.HttpServletRequest
Checks whether the requested session ID was conveyed to the server as an HTTP cookie.
- Specified by:
isRequestedSessionIdFromCookie
in interfaceHttpServletRequest
- Returns:
true
if the session ID was conveyed to the server an an HTTP cookie; otherwise,false
- See Also:
HttpServletRequest.getSession(boolean)
setRequestedSessionIdFromURL
public void setRequestedSessionIdFromURL(boolean requestedSessionIdFromURL)
isRequestedSessionIdFromURL
public boolean isRequestedSessionIdFromURL()
Description copied from interface:javax.servlet.http.HttpServletRequest
Checks whether the requested session ID was conveyed to the server as part of the request URL.
- Specified by:
isRequestedSessionIdFromURL
in interfaceHttpServletRequest
- Returns:
true
if the session ID was conveyed to the server as part of a URL; otherwise,false
- See Also:
HttpServletRequest.getSession(boolean)
isRequestedSessionIdFromUrl
@Deprecated public boolean isRequestedSessionIdFromUrl()
Deprecated.- Specified by:
isRequestedSessionIdFromUrl
in interfaceHttpServletRequest
- Returns:
true
if the session ID was conveyed to the server as part of a URL; otherwise,false
authenticate
public boolean authenticate(HttpServletResponse response) throws IOException, ServletException
Description copied from interface:javax.servlet.http.HttpServletRequest
Use the container login mechanism configured for theServletContext
to authenticate the user making this request.This method may modify and commit the argument
HttpServletResponse
.- Specified by:
authenticate
in interfaceHttpServletRequest
- Parameters:
response
- TheHttpServletResponse
associated with thisHttpServletRequest
- Returns:
true
when non-null values were or have been established as the values returned bygetUserPrincipal
,getRemoteUser
, andgetAuthType
. Returnfalse
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.- Throws:
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)
login
public void login(String username, String password) throws ServletException
Description copied from interface:javax.servlet.http.HttpServletRequest
Validate the provided username and password in the password validation realm used by the web container login mechanism configured for theServletContext
.This method returns without throwing a
ServletException
when the login mechanism configured for theServletContext
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 ofgetUserPrincipal
,getRemoteUser
, andgetAuthType
return null), and when validation of the provided credentials is successful. Otherwise, this method throws aServletException
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
, andgetAuthType
.- Specified by:
login
in interfaceHttpServletRequest
- Parameters:
username
- TheString
value corresponding to the login identifier of the user.password
- The passwordString
corresponding to the identified user.- Throws:
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.
logout
public void logout() throws ServletException
Description copied from interface:javax.servlet.http.HttpServletRequest
Establishnull
as the value returned whengetUserPrincipal
,getRemoteUser
, andgetAuthType
is called on the request.- Specified by:
logout
in interfaceHttpServletRequest
- Throws:
ServletException
- if logout fails
getPart
@Nullable public Part getPart(String name) throws IOException, ServletException
Description copied from interface:javax.servlet.http.HttpServletRequest
Gets thePart
with the given name.- Specified by:
getPart
in interfaceHttpServletRequest
- Parameters:
name
- the name of the requestedPart
- Returns:
- The
Part
with the given name, ornull
if this request is of typemultipart/form-data
, but does not contain the requestedPart
- Throws:
IOException
- if an I/O error occurred during the retrieval of the requestedPart
ServletException
- if this request is not of typemultipart/form-data
- See Also:
MultipartConfig.maxFileSize()
,MultipartConfig.maxRequestSize()
getParts
public Collection<Part> getParts() throws IOException, ServletException
Description copied from interface:javax.servlet.http.HttpServletRequest
Gets all thePart
components of this request, provided that it is of typemultipart/form-data
.If this request is of type
multipart/form-data
, but does not contain anyPart
components, the returnedCollection
will be empty.Any changes to the returned
Collection
must not affect thisHttpServletRequest
.- Specified by:
getParts
in interfaceHttpServletRequest
- Returns:
- a (possibly empty)
Collection
of thePart
components of this request - Throws:
IOException
- if an I/O error occurred during the retrieval of thePart
components of this requestServletException
- if this request is not of typemultipart/form-data
- See Also:
MultipartConfig.maxFileSize()
,MultipartConfig.maxRequestSize()
upgrade
public <T extends HttpUpgradeHandler> T upgrade(Class<T> handlerClass) throws IOException, ServletException
Description copied from interface:javax.servlet.http.HttpServletRequest
Creates an instance ofHttpUpgradeHandler
for a given class and uses it for the http protocol upgrade processing.- Specified by:
upgrade
in interfaceHttpServletRequest
- Type Parameters:
T
- TheClass
, which extendsHttpUpgradeHandler
, of thehandlerClass
.- Parameters:
handlerClass
- TheHttpUpgradeHandler
class used for the upgrade.- Returns:
- an instance of the
HttpUpgradeHandler
- Throws:
IOException
- if an I/O error occurred during the upgradeServletException
- if the givenhandlerClass
fails to be instantiated- See Also:
HttpUpgradeHandler
,WebConnection