类 MockHttpServletRequest
- java.lang.Object
- org.springframework.mock.web.MockHttpServletRequest
- 所有已实现的接口:
HttpServletRequest
,ServletRequest
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.
- 从以下版本开始:
- 1.0.2
- 作者:
- Juergen Hoeller, Rod Johnson, Rick Evans, Mark Fisher, Chris Beams, Sam Brannen, Brian Clozel
字段概要
字段 修饰符和类型 字段 说明 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'.从接口继承的字段 javax.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
构造器概要
构造器 构造器 说明 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)
方法概要
所有方法 实例方法 具体方法 已过时的方法 修饰符和类型 方法 说明 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)
已过时。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()
已过时。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.从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
从接口继承的方法 javax.servlet.http.HttpServletRequest
getHttpServletMapping, getTrailerFields, isTrailerFieldsReady, newPushBuilder
字段详细资料
DEFAULT_PROTOCOL
public static final String DEFAULT_PROTOCOL
The default protocol: 'HTTP/1.1'.- 从以下版本开始:
- 4.3.7
- 另请参阅:
- 常量字段值
DEFAULT_SCHEME
public static final String DEFAULT_SCHEME
The default scheme: 'http'.- 从以下版本开始:
- 4.3.7
- 另请参阅:
- 常量字段值
DEFAULT_SERVER_ADDR
public static final String DEFAULT_SERVER_ADDR
The default server address: '127.0.0.1'.- 另请参阅:
- 常量字段值
DEFAULT_SERVER_NAME
public static final String DEFAULT_SERVER_NAME
The default server name: 'localhost'.- 另请参阅:
- 常量字段值
DEFAULT_SERVER_PORT
public static final int DEFAULT_SERVER_PORT
The default server port: '80'.- 另请参阅:
- 常量字段值
DEFAULT_REMOTE_ADDR
public static final String DEFAULT_REMOTE_ADDR
The default remote address: '127.0.0.1'.- 另请参阅:
- 常量字段值
DEFAULT_REMOTE_HOST
public static final String DEFAULT_REMOTE_HOST
The default remote host: 'localhost'.- 另请参阅:
- 常量字段值
构造器详细资料
MockHttpServletRequest
public MockHttpServletRequest()
Create a newMockHttpServletRequest
with a defaultMockServletContext
.
MockHttpServletRequest
public MockHttpServletRequest(@Nullable String method, @Nullable String requestURI)
Create a newMockHttpServletRequest
with a defaultMockServletContext
.- 参数:
method
- the request method (may benull
)requestURI
- the request URI (may benull
)- 另请参阅:
setMethod(java.lang.String)
,setRequestURI(java.lang.String)
,MockHttpServletRequest(ServletContext, String, String)
MockHttpServletRequest
public MockHttpServletRequest(@Nullable ServletContext servletContext)
Create a newMockHttpServletRequest
with the suppliedServletContext
.- 参数:
servletContext
- the ServletContext that the request runs in (may benull
to use a defaultMockServletContext
)- 另请参阅:
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
.- 参数:
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
)- 另请参阅:
setMethod(java.lang.String)
,setRequestURI(java.lang.String)
,setPreferredLocales(java.util.List<java.util.Locale>)
,MockServletContext
方法详细资料
getServletContext
public ServletContext getServletContext()
Return the ServletContext that this request is associated with. (Not available in the standard HttpServletRequest interface for some reason.)- 指定者:
getServletContext
在接口中ServletRequest
- 返回:
- 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.
getAttribute
public Object getAttribute(String name)
从接口复制的说明: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.*
.- 指定者:
getAttribute
在接口中ServletRequest
- 参数:
name
- aString
specifying the name of the attribute- 返回:
- an
Object
containing the value of the attribute, ornull
if the attribute does not exist
getAttributeNames
public Enumeration<String> getAttributeNames()
从接口复制的说明: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.- 指定者:
getAttributeNames
在接口中ServletRequest
- 返回:
- an
Enumeration
of strings containing the names of the request's attributes
getCharacterEncoding
@Nullable public String getCharacterEncoding()
从接口复制的说明: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).- 指定者:
getCharacterEncoding
在接口中ServletRequest
- 返回:
- 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)
从接口复制的说明: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.- 指定者:
setCharacterEncoding
在接口中ServletRequest
- 参数:
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.- 返回:
- the content as a byte array (potentially
null
) - 从以下版本开始:
- 5.0
- 另请参阅:
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.- 返回:
- the content as a
String
, potentiallynull
- 抛出:
IllegalStateException
- if the character encoding has not been setUnsupportedEncodingException
- if the character encoding is not supported- 从以下版本开始:
- 5.0
- 另请参阅:
setContent(byte[])
,setCharacterEncoding(String)
,getContentAsByteArray()
getContentLength
public int getContentLength()
从接口复制的说明: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.- 指定者:
getContentLength
在接口中ServletRequest
- 返回:
- 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()
从接口复制的说明: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.- 指定者:
getContentLengthLong
在接口中ServletRequest
- 返回:
- 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()
从接口复制的说明: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.- 指定者:
getContentType
在接口中ServletRequest
- 返回:
- a
String
containing the name of the MIME type of the request, or null if the type is not known
getInputStream
public ServletInputStream getInputStream()
从接口复制的说明: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.- 指定者:
getInputStream
在接口中ServletRequest
- 返回:
- 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)
从接口复制的说明: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.- 指定者:
getParameter
在接口中ServletRequest
- 参数:
name
- aString
specifying the name of the parameter- 返回:
- a
String
representing the single value of the parameter - 另请参阅:
ServletRequest.getParameterValues(java.lang.String)
getParameterNames
public Enumeration<String> getParameterNames()
从接口复制的说明: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
.- 指定者:
getParameterNames
在接口中ServletRequest
- 返回:
- 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)
从接口复制的说明: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.
- 指定者:
getParameterValues
在接口中ServletRequest
- 参数:
name
- aString
containing the name of the parameter whose value is requested- 返回:
- an array of
String
objects containing the parameter's values - 另请参阅:
ServletRequest.getParameter(java.lang.String)
getParameterMap
public Map<String,String[]> getParameterMap()
从接口复制的说明: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.
- 指定者:
getParameterMap
在接口中ServletRequest
- 返回:
- 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()
从接口复制的说明: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
.- 指定者:
getProtocol
在接口中ServletRequest
- 返回:
- a
String
containing the protocol name and version number
getScheme
public String getScheme()
从接口复制的说明: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.- 指定者:
getScheme
在接口中ServletRequest
- 返回:
- a
String
containing the name of the scheme used to make this request
setServerName
public void setServerName(String serverName)
getServerName
public String getServerName()
从接口复制的说明: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.- 指定者:
getServerName
在接口中ServletRequest
- 返回:
- a
String
containing the name of the server
setServerPort
public void setServerPort(int serverPort)
getServerPort
public int getServerPort()
从接口复制的说明: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.- 指定者:
getServerPort
在接口中ServletRequest
- 返回:
- an integer specifying the port number
getReader
public BufferedReader getReader() throws UnsupportedEncodingException
从接口复制的说明: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.- 指定者:
getReader
在接口中ServletRequest
- 返回:
- a
BufferedReader
containing the body of the request - 抛出:
UnsupportedEncodingException
- if the character set encoding used is not supported and the text cannot be decoded- 另请参阅:
ServletRequest.getInputStream()
setRemoteAddr
public void setRemoteAddr(String remoteAddr)
getRemoteAddr
public String getRemoteAddr()
从接口复制的说明: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
.- 指定者:
getRemoteAddr
在接口中ServletRequest
- 返回:
- a
String
containing the IP address of the client that sent the request
setRemoteHost
public void setRemoteHost(String remoteHost)
getRemoteHost
public String getRemoteHost()
从接口复制的说明: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
.- 指定者:
getRemoteHost
在接口中ServletRequest
- 返回:
- a
String
containing the fully qualified name of the client
setAttribute
public void setAttribute(String name, @Nullable Object value)
从接口复制的说明: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.- 指定者:
setAttribute
在接口中ServletRequest
- 参数:
name
- aString
specifying the name of the attributevalue
- theObject
to be stored
removeAttribute
public void removeAttribute(String name)
从接口复制的说明: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.- 指定者:
removeAttribute
在接口中ServletRequest
- 参数:
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.- 从以下版本开始:
- 3.2
- 另请参阅:
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.- 指定者:
getLocale
在接口中ServletRequest
- 返回:
- the preferred
Locale
for the client - 另请参阅:
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.- 指定者:
getLocales
在接口中ServletRequest
- 返回:
- an
Enumeration
of preferredLocale
objects for the client - 另请参阅:
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.
isSecure
public boolean isSecure()
- 指定者:
isSecure
在接口中ServletRequest
- 返回:
- a boolean indicating if the request was made using a secure channel
- 另请参阅:
ServletRequest.isSecure()
getRequestDispatcher
public RequestDispatcher getRequestDispatcher(String path)
从接口复制的说明: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.- 指定者:
getRequestDispatcher
在接口中ServletRequest
- 参数:
path
- aString
specifying the pathname to the resource. If it is relative, it must be relative against the current servlet.- 返回:
- a
RequestDispatcher
object that acts as a wrapper for the resource at the specified path, ornull
if the servlet container cannot return aRequestDispatcher
- 另请参阅:
RequestDispatcher
,ServletContext.getRequestDispatcher(java.lang.String)
getRealPath
@Deprecated public String getRealPath(String path)
已过时。- 指定者:
getRealPath
在接口中ServletRequest
- 参数:
path
- the path for which the real path is to be returned.- 返回:
- the real path, or null if the translation cannot be performed.
setRemotePort
public void setRemotePort(int remotePort)
getRemotePort
public int getRemotePort()
从接口复制的说明:javax.servlet.ServletRequest
Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.- 指定者:
getRemotePort
在接口中ServletRequest
- 返回:
- an integer specifying the port number
setLocalName
public void setLocalName(String localName)
getLocalName
public String getLocalName()
从接口复制的说明:javax.servlet.ServletRequest
Returns the host name of the Internet Protocol (IP) interface on which the request was received.- 指定者:
getLocalName
在接口中ServletRequest
- 返回:
- 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()
从接口复制的说明:javax.servlet.ServletRequest
Returns the Internet Protocol (IP) address of the interface on which the request was received.- 指定者:
getLocalAddr
在接口中ServletRequest
- 返回:
- a
String
containing the IP address on which the request was received.
setLocalPort
public void setLocalPort(int localPort)
getLocalPort
public int getLocalPort()
从接口复制的说明:javax.servlet.ServletRequest
Returns the Internet Protocol (IP) port number of the interface on which the request was received.- 指定者:
getLocalPort
在接口中ServletRequest
- 返回:
- an integer specifying the port number
startAsync
public AsyncContext startAsync()
从接口复制的说明: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.
- 指定者:
startAsync
在接口中ServletRequest
- 返回:
- the (re)initialized AsyncContext
- 另请参阅:
AsyncContext.dispatch()
startAsync
public AsyncContext startAsync(ServletRequest request, @Nullable ServletResponse response)
从接口复制的说明: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.
- 指定者:
startAsync
在接口中ServletRequest
- 参数:
request
- the ServletRequest used to initialize the AsyncContextresponse
- the ServletResponse used to initialize the AsyncContext- 返回:
- the (re)initialized AsyncContext
setAsyncStarted
public void setAsyncStarted(boolean asyncStarted)
isAsyncStarted
public boolean isAsyncStarted()
从接口复制的说明: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()
.- 指定者:
isAsyncStarted
在接口中ServletRequest
- 返回:
- true if this request has been put into asynchronous mode, false otherwise
setAsyncSupported
public void setAsyncSupported(boolean asyncSupported)
isAsyncSupported
public boolean isAsyncSupported()
从接口复制的说明: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.
- 指定者:
isAsyncSupported
在接口中ServletRequest
- 返回:
- true if this request supports asynchronous operation, false otherwise
setAsyncContext
public void setAsyncContext(@Nullable MockAsyncContext asyncContext)
getAsyncContext
@Nullable public AsyncContext getAsyncContext()
从接口复制的说明: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.- 指定者:
getAsyncContext
在接口中ServletRequest
- 返回:
- 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()
从接口复制的说明: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
.- 指定者:
getDispatcherType
在接口中ServletRequest
- 返回:
- the dispatcher type of this request
- 另请参阅:
DispatcherType
setAuthType
public void setAuthType(@Nullable String authType)
getAuthType
@Nullable public String getAuthType()
从接口复制的说明: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.
- 指定者:
getAuthType
在接口中HttpServletRequest
- 返回:
- 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()
从接口复制的说明: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.- 指定者:
getCookies
在接口中HttpServletRequest
- 返回:
- 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.- 从以下版本开始:
- 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"
- 指定者:
getDateHeader
在接口中HttpServletRequest
- 参数:
name
- the header name- 返回:
- 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 - 另请参阅:
- Section 7.1.1.1 of RFC 7231
getHeader
@Nullable public String getHeader(String name)
从接口复制的说明: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.- 指定者:
getHeader
在接口中HttpServletRequest
- 参数:
name
- aString
specifying the header name- 返回:
- 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)
从接口复制的说明: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.- 指定者:
getHeaders
在接口中HttpServletRequest
- 参数:
name
- aString
specifying the header name- 返回:
- 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()
从接口复制的说明: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
- 指定者:
getHeaderNames
在接口中HttpServletRequest
- 返回:
- 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)
从接口复制的说明: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.
- 指定者:
getIntHeader
在接口中HttpServletRequest
- 参数:
name
- aString
specifying the name of a request header- 返回:
- 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()
从接口复制的说明: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.- 指定者:
getMethod
在接口中HttpServletRequest
- 返回:
- 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()
从接口复制的说明: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.
- 指定者:
getPathInfo
在接口中HttpServletRequest
- 返回:
- 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()
从接口复制的说明: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.- 指定者:
getPathTranslated
在接口中HttpServletRequest
- 返回:
- 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()
从接口复制的说明: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.- 指定者:
getContextPath
在接口中HttpServletRequest
- 返回:
- a
String
specifying the portion of the request URI that indicates the context of the request - 另请参阅:
ServletContext.getContextPath()
setQueryString
public void setQueryString(@Nullable String queryString)
getQueryString
@Nullable public String getQueryString()
从接口复制的说明: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.- 指定者:
getQueryString
在接口中HttpServletRequest
- 返回:
- 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()
从接口复制的说明: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.- 指定者:
getRemoteUser
在接口中HttpServletRequest
- 返回:
- 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)
从接口复制的说明: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.- 指定者:
isUserInRole
在接口中HttpServletRequest
- 参数:
role
- aString
specifying the name of the role- 返回:
- 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()
从接口复制的说明: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
.- 指定者:
getUserPrincipal
在接口中HttpServletRequest
- 返回:
- 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()
从接口复制的说明: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
.- 指定者:
getRequestedSessionId
在接口中HttpServletRequest
- 返回:
- a
String
specifying the session ID, ornull
if the request did not specify a session ID - 另请参阅:
HttpServletRequest.isRequestedSessionIdValid()
setRequestURI
public void setRequestURI(@Nullable String requestURI)
getRequestURI
@Nullable public String getRequestURI()
从接口复制的说明: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)
.- 指定者:
getRequestURI
在接口中HttpServletRequest
- 返回:
- a
String
containing the part of the URL from the protocol name up to the query string - 另请参阅:
HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)
getRequestURL
public StringBuffer getRequestURL()
从接口复制的说明: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.
- 指定者:
getRequestURL
在接口中HttpServletRequest
- 返回:
- a
StringBuffer
object containing the reconstructed URL
setServletPath
public void setServletPath(String servletPath)
getServletPath
public String getServletPath()
从接口复制的说明: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.
- 指定者:
getServletPath
在接口中HttpServletRequest
- 返回:
- 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)
从接口复制的说明: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.
- 指定者:
getSession
在接口中HttpServletRequest
- 参数:
create
-true
to create a new session for this request if necessary;false
to returnnull
if there's no current session- 返回:
- the
HttpSession
associated with this request ornull
ifcreate
isfalse
and the request has no valid session - 另请参阅:
HttpServletRequest.getSession()
getSession
@Nullable public HttpSession getSession()
从接口复制的说明:javax.servlet.http.HttpServletRequest
Returns the current session associated with this request, or if the request does not have a session, creates one.- 指定者:
getSession
在接口中HttpServletRequest
- 返回:
- the
HttpSession
associated with this request - 另请参阅:
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.- 指定者:
changeSessionId
在接口中HttpServletRequest
- 返回:
- the new session id
- 从以下版本开始:
- 4.0.3
setRequestedSessionIdValid
public void setRequestedSessionIdValid(boolean requestedSessionIdValid)
isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()
从接口复制的说明: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
.- 指定者:
isRequestedSessionIdValid
在接口中HttpServletRequest
- 返回:
true
if this request has an id for a valid session in the current session context;false
otherwise- 另请参阅:
HttpServletRequest.getRequestedSessionId()
,HttpServletRequest.getSession(boolean)
,HttpSessionContext
setRequestedSessionIdFromCookie
public void setRequestedSessionIdFromCookie(boolean requestedSessionIdFromCookie)
isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()
从接口复制的说明:javax.servlet.http.HttpServletRequest
Checks whether the requested session ID was conveyed to the server as an HTTP cookie.
- 指定者:
isRequestedSessionIdFromCookie
在接口中HttpServletRequest
- 返回:
true
if the session ID was conveyed to the server an an HTTP cookie; otherwise,false
- 另请参阅:
HttpServletRequest.getSession(boolean)
setRequestedSessionIdFromURL
public void setRequestedSessionIdFromURL(boolean requestedSessionIdFromURL)
isRequestedSessionIdFromURL
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
在接口中HttpServletRequest
- 返回:
true
if the session ID was conveyed to the server as part of a URL; otherwise,false
- 另请参阅:
HttpServletRequest.getSession(boolean)
isRequestedSessionIdFromUrl
@Deprecated public boolean isRequestedSessionIdFromUrl()
已过时。- 指定者:
isRequestedSessionIdFromUrl
在接口中HttpServletRequest
- 返回:
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
从接口复制的说明: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
.- 指定者:
authenticate
在接口中HttpServletRequest
- 参数:
response
- TheHttpServletResponse
associated with thisHttpServletRequest
- 返回:
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.- 抛出:
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
从接口复制的说明: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
.- 指定者:
login
在接口中HttpServletRequest
- 参数:
username
- TheString
value corresponding to the login identifier of the user.password
- The passwordString
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.
logout
public void logout() throws ServletException
从接口复制的说明:javax.servlet.http.HttpServletRequest
Establishnull
as the value returned whengetUserPrincipal
,getRemoteUser
, andgetAuthType
is called on the request.- 指定者:
logout
在接口中HttpServletRequest
- 抛出:
ServletException
- if logout fails
getPart
@Nullable public Part getPart(String name) throws IOException, ServletException
从接口复制的说明:javax.servlet.http.HttpServletRequest
Gets thePart
with the given name.- 指定者:
getPart
在接口中HttpServletRequest
- 参数:
name
- the name of the requestedPart
- 返回:
- The
Part
with the given name, ornull
if this request is of typemultipart/form-data
, but does not contain the requestedPart
- 抛出:
IOException
- if an I/O error occurred during the retrieval of the requestedPart
ServletException
- if this request is not of typemultipart/form-data
- 另请参阅:
MultipartConfig.maxFileSize()
,MultipartConfig.maxRequestSize()
getParts
public Collection<Part> getParts() throws IOException, ServletException
从接口复制的说明: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
.- 指定者:
getParts
在接口中HttpServletRequest
- 返回:
- a (possibly empty)
Collection
of thePart
components of this request - 抛出:
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
- 另请参阅:
MultipartConfig.maxFileSize()
,MultipartConfig.maxRequestSize()
upgrade
public <T extends HttpUpgradeHandler> T upgrade(Class<T> handlerClass) throws IOException, ServletException
从接口复制的说明:javax.servlet.http.HttpServletRequest
Creates an instance ofHttpUpgradeHandler
for a given class and uses it for the http protocol upgrade processing.- 指定者:
upgrade
在接口中HttpServletRequest
- 类型参数:
T
- TheClass
, which extendsHttpUpgradeHandler
, of thehandlerClass
.- 参数:
handlerClass
- TheHttpUpgradeHandler
class used for the upgrade.- 返回:
- an instance of the
HttpUpgradeHandler
- 抛出:
IOException
- if an I/O error occurred during the upgradeServletException
- if the givenhandlerClass
fails to be instantiated- 另请参阅:
HttpUpgradeHandler
,WebConnection