public final class HttpServletRequestImpl extends Object implements HttpServletRequest
Modifier and Type | Field and Description |
---|---|
static AttachmentKey<Boolean> |
SECURE_REQUEST
Deprecated.
|
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
Constructor and Description |
---|
HttpServletRequestImpl(HttpServerExchange exchange,
ServletContextImpl servletContext) |
Modifier and Type | Method and Description |
---|---|
boolean |
authenticate(HttpServletResponse response)
Use the container login mechanism configured for the
ServletContext to authenticate the user making
this request. |
String |
changeSessionId()
Change the session id of the current session associated with this request and return the new session id.
|
void |
clearAttributes() |
void |
closeAndDrainRequest() |
void |
freeResources()
Frees any resources (namely buffers) that may be associated with this request.
|
AsyncContextImpl |
getAsyncContext()
Gets the AsyncContext that was created or reinitialized by the most recent invocation of
ServletRequest.startAsync() or
ServletRequest.startAsync(ServletRequest,ServletResponse) on this request. |
AsyncContextImpl |
getAsyncContextInternal() |
Object |
getAttribute(String name)
Returns the value of the named attribute as an
Object , or null if no attribute of the
given name exists. |
Enumeration<String> |
getAttributeNames()
Returns an
Enumeration containing the names of the attributes available to this request. |
String |
getAuthType()
Returns the name of the authentication scheme used to protect the servlet.
|
String |
getCharacterEncoding()
Returns the name of the character encoding used in the body of this request.
|
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 or is greater than Integer.MAX_VALUE.
|
long |
getContentLengthLong()
Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is
not known.
|
String |
getContentType()
Returns the MIME type of the body of the request, or
null if the type is not known. |
String |
getContextPath()
Returns the portion of the request URI that indicates the context of the request.
|
Cookie[] |
getCookies()
Returns an array containing all of the
Cookie objects the client sent with this request. |
long |
getDateHeader(String name)
Returns the value of the specified request header as a
long value that represents a
Date object. |
DispatcherType |
getDispatcherType()
Gets the dispatcher type of this request.
|
HttpServerExchange |
getExchange() |
String |
getHeader(HttpString name) |
String |
getHeader(String name)
Returns the value of the specified request header as a
String . |
Enumeration<String> |
getHeaderNames()
Returns an enumeration of all the header names this request contains.
|
Enumeration<String> |
getHeaders(String name)
Returns all the values of the specified request header as an
Enumeration of String
objects. |
HttpServletMapping |
getHttpServletMapping()
|
ServletInputStream |
getInputStream()
Retrieves the body of the request as binary data using a
ServletInputStream . |
int |
getIntHeader(String name)
Returns the value of the specified request header as an
int . |
String |
getLocalAddr()
Returns the Internet Protocol (IP) address of the interface on which the request was received.
|
Locale |
getLocale()
Returns the preferred
Locale that the client will accept content in, based on the Accept-Language
header. |
Enumeration<Locale> |
getLocales()
Returns an
Enumeration of Locale objects indicating, in decreasing order starting with
the preferred locale, the locales that are acceptable to the client based on the Accept-Language header. |
String |
getLocalName()
String java.net.InetAddress.getHostName()
Gets the host name for this IP address.
|
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 |
getOriginalContextPath() |
String |
getOriginalPathInfo() |
String |
getOriginalQueryString() |
String |
getOriginalRequestURI() |
String |
getOriginalServletPath() |
String |
getParameter(String name)
Returns the value of a request parameter as a
String , or null if the parameter does not
exist. |
Map<String,String[]> |
getParameterMap()
Returns a java.util.Map of the parameters of this request.
|
Enumeration<String> |
getParameterNames()
Returns an
Enumeration of String objects containing the names of the parameters
contained in this request. |
String[] |
getParameterValues(String name)
Returns an array of
String objects containing all of the values the given request parameter has, or
null if the parameter does not exist. |
Part |
getPart(String name)
Gets the
Part with the given name. |
Collection<Part> |
getParts()
Gets all the
Part components of this request, provided that it is of type
multipart/form-data . |
String |
getPathInfo()
Returns any extra path information associated with the URL the client sent when it made this request.
|
String |
getPathTranslated()
Returns any extra path information after the servlet name but before the query string, and translates it to a
real path.
|
String |
getProtocol()
Returns the name and version of the protocol the request uses in the form
protocol/majorVersion.minorVersion, for example, HTTP/1.1.
|
Map<String,Deque<String>> |
getQueryParameters() |
String |
getQueryString()
Returns the query string that is contained in the request URL after the path.
|
BufferedReader |
getReader()
Retrieves the body of the request as character data using a
BufferedReader . |
String |
getRealPath(String path) |
String |
getRemoteAddr()
Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
|
String |
getRemoteHost()
Returns the fully qualified name of the client or the last proxy that sent the request.
|
int |
getRemotePort()
Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
|
String |
getRemoteUser()
Returns the login of the user making this request, if the user has been authenticated, or
null if
the user has not been authenticated. |
RequestDispatcher |
getRequestDispatcher(String path)
Returns a
RequestDispatcher object that acts as a wrapper for the resource located at the given path. |
String |
getRequestedSessionId()
Returns the session ID specified by the client.
|
String |
getRequestURI()
Returns the part of this request's URL from the protocol name up to the query string in the first line of the
HTTP request.
|
StringBuffer |
getRequestURL()
Reconstructs the URL the client used to make the request.
|
String |
getScheme()
Returns the name of the scheme used to make this request, for example,
http , https , or
ftp . |
String |
getServerName()
Returns the host name of the server to which the request was sent.
|
int |
getServerPort()
Returns the port number to which the request was sent.
|
ServletContextImpl |
getServletContext()
Gets the servlet context to which this ServletRequest was last dispatched.
|
String |
getServletPath()
Returns the part of this request's URL that calls the servlet.
|
HttpSession |
getSession()
Returns the current session associated with this request, or if the request does not have a session, creates one.
|
HttpSession |
getSession(boolean create)
Returns the current
HttpSession associated with this request or, if there is no current session and
create is true, returns a new session. |
Map<String,String> |
getTrailerFields()
Get the request trailer fields.
|
Principal |
getUserPrincipal()
Returns a
java.security.Principal object containing the name of the current authenticated user. |
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()
Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
|
boolean |
isTrailerFieldsReady()
Return a boolean indicating whether trailer fields are ready to read using
HttpServletRequest.getTrailerFields() . |
boolean |
isUserInRole(String role)
Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
|
void |
login(String username,
String password)
Validate the provided username and password in the password validation realm used by the web container login
mechanism configured for the
ServletContext . |
void |
logout()
Establish
null as the value returned when getUserPrincipal , getRemoteUser ,
and getAuthType is called on the request. |
PushBuilder |
newPushBuilder()
Instantiates a new instance of
PushBuilder for issuing server push responses from the current request. |
void |
removeAttribute(String name)
Removes an attribute from this request.
|
void |
setAttribute(String name,
Object object)
Stores an attribute in this request.
|
void |
setCharacterEncoding(String env)
Overrides the name of the character encoding used in the body of this request.
|
void |
setQueryParameters(Map<String,Deque<String>> queryParameters) |
void |
setServletContext(ServletContextImpl servletContext) |
AsyncContext |
startAsync()
Puts this request into asynchronous mode, and initializes its
AsyncContext with the original (unwrapped)
ServletRequest and ServletResponse objects. |
AsyncContext |
startAsync(ServletRequest servletRequest,
ServletResponse servletResponse)
Puts this request into asynchronous mode, and initializes its
AsyncContext with the given request and
response objects. |
String |
toString() |
<T extends HttpUpgradeHandler> |
upgrade(Class<T> handlerClass)
Creates an instance of
HttpUpgradeHandler for a given class and uses it for the http protocol
upgrade processing. |
@Deprecated public static final AttachmentKey<Boolean> SECURE_REQUEST
public HttpServletRequestImpl(HttpServerExchange exchange, ServletContextImpl servletContext)
public HttpServerExchange getExchange()
public String getAuthType()
HttpServletRequest
null
is returned.
Same as the value of the CGI variable AUTH_TYPE.
getAuthType
in interface HttpServletRequest
null
if the request was not authenticated.public Cookie[] getCookies()
HttpServletRequest
Cookie
objects the client sent with this request. This method
returns null
if no cookies were sent.getCookies
in interface HttpServletRequest
Cookies
included with this request, or null
if the request
has no cookiespublic long getDateHeader(String name)
HttpServletRequest
long
value that represents a
Date
object. Use this method with headers that contain dates, such as
If-Modified-Since
.
The date is returned as the number of milliseconds since January 1, 1970 GMT. The header name is case insensitive.
If the request did not have a header of the specified name, this method returns -1. If the header can't be
converted to a date, the method throws an IllegalArgumentException
.
getDateHeader
in interface HttpServletRequest
name
- a String
specifying the name of the headerlong
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 requestpublic String getHeader(String name)
HttpServletRequest
String
. If the request did not include a
header of the specified name, this method returns null
. If there are multiple headers with the same
name, this method returns the first head in the request. The header name is case insensitive. You can use this
method with any request header.getHeader
in interface HttpServletRequest
name
- a String
specifying the header nameString
containing the value of the requested header, or null
if the request
does not have a header of that namepublic String getHeader(HttpString name)
public Enumeration<String> getHeaders(String name)
HttpServletRequest
Enumeration
of String
objects.
Some headers, such as Accept-Language
can be sent by clients as several headers each with a
different value rather than sending the header as a comma separated list.
If the request did not include any headers of the specified name, this method returns an empty
Enumeration
. The header name is case insensitive. You can use this method with any request header.
getHeaders
in interface HttpServletRequest
name
- a String
specifying the header nameEnumeration
containing the values of the requested header. If the request does not have
any headers of that name return an empty enumeration. If the container does not allow access to header
information, return nullpublic Enumeration<String> getHeaderNames()
HttpServletRequest
Some servlet containers do not allow servlets to access headers using this method, in which case this method
returns null
getHeaderNames
in interface HttpServletRequest
null
public HttpServletMapping getHttpServletMapping()
HttpServletRequest
Return the HttpServletMapping
by which the HttpServlet
for this HttpServletRequest
was
invoked. The mappings for any applicable Filter
s are not indicated in the result. If the
currently active Servlet
invocation was obtained by a call to
ServletRequest.getRequestDispatcher(java.lang.String)
followed by a call to RequestDispatcher.forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
, the returned
HttpServletMapping
is the one corresponding to the path used to obtain the RequestDispatcher
. If the
currently active Servlet
invocation was obtained by a call to ServletRequest.getRequestDispatcher(java.lang.String)
followed by a call to RequestDispatcher.include(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
, the returned HttpServletMapping
is the one corresponding to the path that caused the first Servlet
in the invocation
sequence to be invoked. If the currently active Servlet
invocation was obtained by a call to
AsyncContext.dispatch()
, the returned HttpServletMapping
is the one corresponding to the path that caused the first Servlet
in the invocation
sequence to be invoked. See RequestDispatcher.FORWARD_MAPPING
,
RequestDispatcher.INCLUDE_MAPPING
and AsyncContext.ASYNC_MAPPING
for
additional request attributes related to HttpServletMapping
. If the currently active Servlet
invocation was obtained by a call to ServletContext.getNamedDispatcher(java.lang.String)
, the returned
HttpServletMapping
is the one corresponding to the path for the mapping last applied to this request.
The returned object is immutable. Servlet 4.0 compliant implementations must override this method.
getHttpServletMapping
in interface HttpServletRequest
HttpServletMapping
describing the manner in which the current request was invoked.public int getIntHeader(String name)
HttpServletRequest
int
. If the request does not have a header
of the specified name, this method returns -1. If the header cannot be converted to an integer, this method
throws a NumberFormatException
.
The header name is case insensitive.
getIntHeader
in interface HttpServletRequest
name
- a String
specifying the name of a request headerpublic String getMethod()
HttpServletRequest
getMethod
in interface HttpServletRequest
String
specifying the name of the method with which this request was madepublic String getPathInfo()
HttpServletRequest
This method returns null
if there was no extra path information.
Same as the value of the CGI variable PATH_INFO.
getPathInfo
in interface HttpServletRequest
String
, decoded by the web container, specifying extra path information that comes after
the servlet path but before the query string in the request URL; or null
if the URL does not
have any extra path informationpublic String getPathTranslated()
HttpServletRequest
If the URL does not have any extra path information, this method returns null
or the servlet
container cannot translate the virtual path to a real path for any reason (such as when the web application is
executed from an archive).
The web container does not decode this string.
getPathTranslated
in interface HttpServletRequest
String
specifying the real path, or null
if the URL does not have any extra
path informationpublic String getContextPath()
HttpServletRequest
It is possible that a servlet container may match a context by more than one context path. In such cases this
method will return the actual context path used by the request and it may differ from the path returned by the
ServletContext.getContextPath()
method. The context path returned by
ServletContext.getContextPath()
should be considered as the prime or preferred context path
of the application.
getContextPath
in interface HttpServletRequest
String
specifying the portion of the request URI that indicates the context of the requestServletContext.getContextPath()
public String getQueryString()
HttpServletRequest
null
if the URL does not have a query string. Same as the value of the CGI variable QUERY_STRING.getQueryString
in interface HttpServletRequest
String
containing the query string or null
if the URL contains no query
string. The value is not decoded by the container.public String getRemoteUser()
HttpServletRequest
null
if
the user has not been authenticated. Whether the user name is sent with each subsequent request depends on the
browser and type of authentication. Same as the value of the CGI variable REMOTE_USER.getRemoteUser
in interface HttpServletRequest
String
specifying the login of the user making this request, or null
if the
user login is not knownpublic boolean isUserInRole(String role)
HttpServletRequest
false
.
The role name "*" should never be used as an argument in calling isUserInRole
. Any call to
isUserInRole
with "*" must return false. If the role-name of the security-role to be tested is "**",
and the application has NOT declared an application security-role with role-name "**", isUserInRole
must only return true if the user has been authenticated; that is, only when HttpServletRequest.getRemoteUser()
and
HttpServletRequest.getUserPrincipal()
would both return a non-null value. Otherwise, the container must check the user for
membership in the application role.
isUserInRole
in interface HttpServletRequest
role
- a String
specifying the name of the roleboolean
indicating whether the user making this request belongs to a given role;
false
if the user has not been authenticatedpublic Principal getUserPrincipal()
HttpServletRequest
java.security.Principal
object containing the name of the current authenticated user. If
the user has not been authenticated, the method returns null
.getUserPrincipal
in interface HttpServletRequest
java.security.Principal
containing the name of the user making this request;
null
if the user has not been authenticatedpublic String getRequestedSessionId()
HttpServletRequest
null
.getRequestedSessionId
in interface HttpServletRequest
String
specifying the session ID, or null
if the request did not specify a
session IDHttpServletRequest.isRequestedSessionIdValid()
public String changeSessionId()
HttpServletRequest
changeSessionId
in interface HttpServletRequest
public String getRequestURI()
HttpServletRequest
First line of HTTP request | Returned Value | |
---|---|---|
POST /some/path.html HTTP/1.1 | /some/path.html | |
GET http://foo.bar/a.html HTTP/1.0 | /a.html | |
HEAD /xyz?a=b HTTP/1.1 | /xyz |
To reconstruct an URL with a scheme and host, use HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)
.
getRequestURI
in interface HttpServletRequest
String
containing the part of the URL from the protocol name up to the query stringHttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)
public StringBuffer getRequestURL()
HttpServletRequest
If this request has been forwarded using RequestDispatcher.forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
, the server path in the
reconstructed URL must reflect the path used to obtain the RequestDispatcher, and not the server path specified
by the client.
Because this method returns a StringBuffer
, not a string, you can modify the URL easily, for
example, to append query parameters.
This method is useful for creating redirect messages and for reporting errors.
getRequestURL
in interface HttpServletRequest
StringBuffer
object containing the reconstructed URLpublic String getServletPath()
HttpServletRequest
This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.
getServletPath
in interface HttpServletRequest
String
containing the name or path of the servlet being called, as specified in the
request URL, decoded, or an empty string if the servlet used to process the request is matched using the
"/*" pattern.public HttpSession getSession(boolean create)
HttpServletRequest
HttpSession
associated with this request or, if there is no current session and
create
is true, returns a new session.
If create
is false
and the request has no valid HttpSession
, this method
returns null
.
To make sure the session is properly maintained, you must call this method before the response is committed. If the container is using cookies to maintain session integrity and is asked to create a new session when the response is committed, an IllegalStateException is thrown.
getSession
in interface HttpServletRequest
create
- true
to create a new session for this request if necessary; false
to
return null
if there's no current sessionHttpSession
associated with this request or null
if create
is
false
and the request has no valid sessionHttpServletRequest.getSession()
public HttpSession getSession()
HttpServletRequest
getSession
in interface HttpServletRequest
HttpSession
associated with this requestHttpServletRequest.getSession(boolean)
public boolean isRequestedSessionIdValid()
HttpServletRequest
If the client did not specify any session ID, this method returns false
.
isRequestedSessionIdValid
in interface HttpServletRequest
true
if this request has an id for a valid session in the current session context;
false
otherwiseHttpServletRequest.getRequestedSessionId()
,
HttpServletRequest.getSession(boolean)
,
HttpSessionContext
public boolean isRequestedSessionIdFromCookie()
HttpServletRequest
Checks whether the requested session ID was conveyed to the server as an HTTP cookie.
isRequestedSessionIdFromCookie
in interface HttpServletRequest
true
if the session ID was conveyed to the server an an HTTP cookie; otherwise,
false
HttpServletRequest.getSession(boolean)
public boolean isRequestedSessionIdFromURL()
HttpServletRequest
Checks whether the requested session ID was conveyed to the server as part of the request URL.
isRequestedSessionIdFromURL
in interface HttpServletRequest
true
if the session ID was conveyed to the server as part of a URL; otherwise,
false
HttpServletRequest.getSession(boolean)
public boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromUrl
in interface HttpServletRequest
true
if the session ID was conveyed to the server as part of a URL; otherwise,
false
public boolean authenticate(HttpServletResponse response) throws IOException, ServletException
HttpServletRequest
ServletContext
to authenticate the user making
this request.
This method may modify and commit the argument HttpServletResponse
.
authenticate
in interface HttpServletRequest
response
- The HttpServletResponse
associated with this HttpServletRequest
true
when non-null values were or have been established as the values returned by
getUserPrincipal
, getRemoteUser
, and getAuthType
. Return
false
if authentication is incomplete and the underlying login mechanism has committed, in
the response, the message (e.g., challenge) and HTTP status code to be returned to the user.IOException
- if an input or output error occurred while reading from this request or writing to
the given responseServletException
- if the authentication failed and the caller is responsible for handling the error
(i.e., the underlying login mechanism did NOT establish the message and HTTP status
code to be returned to the user)public void login(String username, String password) throws ServletException
HttpServletRequest
ServletContext
.
This method returns without throwing a ServletException
when the login mechanism configured for the
ServletContext
supports username password validation, and when, at the time of the call to login,
the identity of the caller of the request had not been established (i.e, all of getUserPrincipal
,
getRemoteUser
, and getAuthType
return null), and when validation of the provided
credentials is successful. Otherwise, this method throws a ServletException
as described below.
When this method returns without throwing an exception, it must have established non-null values as the values
returned by getUserPrincipal
, getRemoteUser
, and getAuthType
.
login
in interface HttpServletRequest
username
- The String
value corresponding to the login identifier of the user.password
- The password String
corresponding to the identified user.ServletException
- if the configured login mechanism does not support username password authentication,
or if a non-null caller identity had already been established (prior to the call to
login), or if validation of the provided username and password fails.public void logout() throws ServletException
HttpServletRequest
null
as the value returned when getUserPrincipal
, getRemoteUser
,
and getAuthType
is called on the request.logout
in interface HttpServletRequest
ServletException
- if logout failspublic Collection<Part> getParts() throws IOException, ServletException
HttpServletRequest
Part
components of this request, provided that it is of type
multipart/form-data
.
If this request is of type multipart/form-data
, but does not contain any Part
components, the returned Collection
will be empty.
Any changes to the returned Collection
must not affect this HttpServletRequest
.
getParts
in interface HttpServletRequest
Collection
of the Part
components of this requestIOException
- if an I/O error occurred during the retrieval of the Part
components of
this requestServletException
- if this request is not of type multipart/form-data
MultipartConfig.maxFileSize()
,
MultipartConfig.maxRequestSize()
public Part getPart(String name) throws IOException, ServletException
HttpServletRequest
Part
with the given name.getPart
in interface HttpServletRequest
name
- the name of the requested Part
Part
with the given name, or null
if this request is of type
multipart/form-data
, but does not contain the requested Part
IOException
- if an I/O error occurred during the retrieval of the requested Part
ServletException
- if this request is not of type multipart/form-data
MultipartConfig.maxFileSize()
,
MultipartConfig.maxRequestSize()
public <T extends HttpUpgradeHandler> T upgrade(Class<T> handlerClass) throws IOException
HttpServletRequest
HttpUpgradeHandler
for a given class and uses it for the http protocol
upgrade processing.upgrade
in interface HttpServletRequest
T
- The Class
, which extends HttpUpgradeHandler
, of the handlerClass
.handlerClass
- The HttpUpgradeHandler
class used for the upgrade.HttpUpgradeHandler
IOException
- if an I/O error occurred during the upgradeHttpUpgradeHandler
,
WebConnection
public Object getAttribute(String name)
ServletRequest
Object
, or null
if no attribute of the
given name exists.
Attributes can be set two ways. The servlet container may set attributes to make available custom information
about a request. For example, for requests made using HTTPS, the attribute
javax.servlet.request.X509Certificate
can be used to retrieve information on the certificate of the
client. Attributes can also be set programmatically using ServletRequest.setAttribute(java.lang.String, java.lang.Object)
. This allows
information to be embedded into a request before a RequestDispatcher
call.
Attribute names should follow the same conventions as package names. This specification reserves names matching
java.*
, javax.*
, and sun.*
.
getAttribute
in interface ServletRequest
name
- a String
specifying the name of the attributeObject
containing the value of the attribute, or null
if the attribute does
not existpublic Enumeration<String> getAttributeNames()
ServletRequest
Enumeration
containing the names of the attributes available to this request. This method
returns an empty Enumeration
if the request has no attributes available to it.getAttributeNames
in interface ServletRequest
Enumeration
of strings containing the names of the request's attributespublic String getCharacterEncoding()
ServletRequest
null
if no request encoding character encoding has been specified. The following methods for
specifying the request character encoding are consulted, in decreasing order of priority: per request, per web
app (using ServletContext.setRequestCharacterEncoding(java.lang.String)
, deployment descriptor), and per container (for all
web applications deployed in that container, using vendor specific configuration).getCharacterEncoding
in interface ServletRequest
String
containing the name of the character encoding, or null
if the request
does not specify a character encodingpublic void setCharacterEncoding(String env) throws UnsupportedEncodingException
ServletRequest
setCharacterEncoding
in interface ServletRequest
env
- String
containing the name of the character encoding.UnsupportedEncodingException
- if this ServletRequest is still in a state where a character encoding may be
set, but the specified encoding is invalidpublic int getContentLength()
ServletRequest
getContentLength
in interface ServletRequest
public long getContentLengthLong()
ServletRequest
getContentLengthLong
in interface ServletRequest
public String getContentType()
ServletRequest
null
if the type is not known. For HTTP
servlets, same as the value of the CGI variable CONTENT_TYPE.getContentType
in interface ServletRequest
String
containing the name of the MIME type of the request, or null if the type is not
knownpublic ServletInputStream getInputStream() throws IOException
ServletRequest
ServletInputStream
. Either this method or
ServletRequest.getReader()
may be called to read the body, not both.getInputStream
in interface ServletRequest
ServletInputStream
object containing the body of the requestIOException
- if an input or output exception occurredpublic void closeAndDrainRequest() throws IOException
IOException
public void freeResources() throws IOException
IOException
public String getParameter(String name)
ServletRequest
String
, or null
if the parameter does not
exist. Request parameters are extra information sent with the request. For HTTP servlets, parameters are
contained in the query string or posted form data.
You should only use this method when you are sure the parameter has only one value. If the parameter might have
more than one value, use ServletRequest.getParameterValues(java.lang.String)
.
If you use this method with a multivalued parameter, the value returned is equal to the first value in the array
returned by getParameterValues
.
If the parameter data was sent in the request body, such as occurs with an HTTP POST request, then reading the
body directly via ServletRequest.getInputStream()
or ServletRequest.getReader()
can interfere with the execution of this method.
getParameter
in interface ServletRequest
name
- a String
specifying the name of the parameterString
representing the single value of the parameterServletRequest.getParameterValues(java.lang.String)
public Enumeration<String> getParameterNames()
ServletRequest
Enumeration
of String
objects containing the names of the parameters
contained in this request. If the request has no parameters, the method returns an empty
Enumeration
.getParameterNames
in interface ServletRequest
Enumeration
of String
objects, each String
containing the name
of a request parameter; or an empty Enumeration
if the request has no parameterspublic String[] getParameterValues(String name)
ServletRequest
String
objects containing all of the values the given request parameter has, or
null
if the parameter does not exist.
If the parameter has a single value, the array has a length of 1.
getParameterValues
in interface ServletRequest
name
- a String
containing the name of the parameter whose value is requestedString
objects containing the parameter's valuesServletRequest.getParameter(java.lang.String)
public Map<String,String[]> getParameterMap()
ServletRequest
Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.
getParameterMap
in interface ServletRequest
public String getProtocol()
ServletRequest
SERVER_PROTOCOL
.getProtocol
in interface ServletRequest
String
containing the protocol name and version numberpublic String getScheme()
ServletRequest
http
, https
, or
ftp
. Different schemes have different rules for constructing URLs, as noted in RFC 1738.getScheme
in interface ServletRequest
String
containing the name of the scheme used to make this requestpublic String getServerName()
ServletRequest
Host
header value, if any, or the resolved server name, or the server IP address.getServerName
in interface ServletRequest
String
containing the name of the serverpublic int getServerPort()
ServletRequest
Host
header value, if any, or the server port where the client connection was accepted on.getServerPort
in interface ServletRequest
public BufferedReader getReader() throws IOException
ServletRequest
BufferedReader
. The reader translates
the character data according to the character encoding used on the body. Either this method or
ServletRequest.getInputStream()
may be called to read the body, not both.getReader
in interface ServletRequest
BufferedReader
containing the body of the requestUnsupportedEncodingException
- if the character set encoding used is not supported and the text cannot
be decodedIOException
- if an input or output exception occurredServletRequest.getInputStream()
public String getRemoteAddr()
ServletRequest
REMOTE_ADDR
.getRemoteAddr
in interface ServletRequest
String
containing the IP address of the client that sent the requestpublic String getRemoteHost()
ServletRequest
REMOTE_HOST
.getRemoteHost
in interface ServletRequest
String
containing the fully qualified name of the clientpublic void setAttribute(String name, Object object)
ServletRequest
RequestDispatcher
.
Attribute names should follow the same conventions as package names.
If the object passed in is null, the effect is the same as calling ServletRequest.removeAttribute(java.lang.String)
.
It is warned that when the request is dispatched from the servlet resides in a different web application by
RequestDispatcher
, the object set by this method may not be correctly retrieved in the caller
servlet.
setAttribute
in interface ServletRequest
name
- a String
specifying the name of the attributeobject
- the Object
to be storedpublic void removeAttribute(String name)
ServletRequest
Attribute names should follow the same conventions as package names. Names beginning with java.*
,
javax.*
, and com.sun.*
, are reserved for use by Sun Microsystems.
removeAttribute
in interface ServletRequest
name
- a String
specifying the name of the attribute to removepublic Locale getLocale()
ServletRequest
Locale
that the client will accept content in, based on the Accept-Language
header. If the client request doesn't provide an Accept-Language header, this method returns the default locale
for the server.getLocale
in interface ServletRequest
Locale
for the clientpublic Enumeration<Locale> getLocales()
ServletRequest
Enumeration
of Locale
objects indicating, in decreasing order starting with
the preferred locale, the locales that are acceptable to the client based on the Accept-Language header. If the
client request doesn't provide an Accept-Language header, this method returns an Enumeration
containing one Locale
, the default locale for the server.getLocales
in interface ServletRequest
Enumeration
of preferred Locale
objects for the clientpublic boolean isSecure()
ServletRequest
isSecure
in interface ServletRequest
public RequestDispatcher getRequestDispatcher(String path)
ServletRequest
RequestDispatcher
object that acts as a wrapper for the resource located at the given path. A
RequestDispatcher
object can be used to forward a request to the resource or to include the resource
in a response. The resource can be dynamic or static.
The pathname specified may be relative, although it cannot extend outside the current servlet context. If the
path begins with a "/" it is interpreted as relative to the current context root. This method returns
null
if the servlet container cannot return a RequestDispatcher
.
Using a RequestDispatcher, requests may be dispatched to any part of the web application bypassing both implicit (no direct access to WEB-INF or META-INF) and explicit (defined by the web application) security constraints. Unsanitized user provided data must not be used to construct the path passed to the RequestDispatcher as it is very likely to create a security vulnerability in the application.
The difference between this method and ServletContext.getRequestDispatcher(java.lang.String)
is that this method can take a
relative path.
getRequestDispatcher
in interface ServletRequest
path
- a String
specifying the pathname to the resource. If it is relative, it must be relative
against the current servlet.RequestDispatcher
object that acts as a wrapper for the resource at the specified path, or
null
if the servlet container cannot return a RequestDispatcher
RequestDispatcher
,
ServletContext.getRequestDispatcher(java.lang.String)
public String getRealPath(String path)
getRealPath
in interface ServletRequest
path
- the path for which the real path is to be returned.public int getRemotePort()
ServletRequest
getRemotePort
in interface ServletRequest
public String getLocalName()
getLocalName
in interface ServletRequest
String
containing the host name of the IP on which the request was received.InetAddres#getHostName
public String getLocalAddr()
ServletRequest
getLocalAddr
in interface ServletRequest
String
containing the IP address on which the request was received.public int getLocalPort()
ServletRequest
getLocalPort
in interface ServletRequest
public ServletContextImpl getServletContext()
ServletRequest
getServletContext
in interface ServletRequest
public AsyncContext startAsync() throws IllegalStateException
ServletRequest
AsyncContext
with the original (unwrapped)
ServletRequest and ServletResponse objects.
Calling this method will cause committal of the associated response to be delayed until
AsyncContext.complete()
is called on the returned AsyncContext
, or the asynchronous operation has
timed out.
Calling AsyncContext.hasOriginalRequestAndResponse()
on the returned AsyncContext will return
true
. Any filters invoked in the outbound direction after this request was put into
asynchronous mode may use this as an indication that any request and/or response wrappers that they added during
their inbound invocation need not stay around for the duration of the asynchronous operation, and
therefore any of their associated resources may be released.
This method clears the list of AsyncListener
instances (if any) that were registered with the
AsyncContext returned by the previous call to one of the startAsync methods, after calling each AsyncListener at
its onStartAsync
method.
Subsequent invocations of this method, or its overloaded variant, will return the same AsyncContext instance, reinitialized as appropriate.
startAsync
in interface ServletRequest
IllegalStateException
- if this request is within the scope of a filter or servlet that does not support
asynchronous operations (that is, ServletRequest.isAsyncSupported()
returns false), or if
this method is called again without any asynchronous dispatch (resulting from one
of the AsyncContext.dispatch()
methods), is called outside the scope of any
such dispatch, or is called again within the scope of the same dispatch, or if the
response has already been closedAsyncContext.dispatch()
public AsyncContext startAsync(ServletRequest servletRequest, ServletResponse servletResponse) throws IllegalStateException
ServletRequest
AsyncContext
with the given request and
response objects.
The ServletRequest and ServletResponse arguments must be the same instances, or instances of
ServletRequestWrapper
and ServletResponseWrapper
that wrap them, that were passed to the
service
method of the Servlet or the doFilter
method of the
Filter, respectively, in whose scope this method is being called.
Calling this method will cause committal of the associated response to be delayed until
AsyncContext.complete()
is called on the returned AsyncContext
, or the asynchronous operation has
timed out.
Calling AsyncContext.hasOriginalRequestAndResponse()
on the returned AsyncContext will return
false
, unless the passed in ServletRequest and ServletResponse arguments are the original ones or do
not carry any application-provided wrappers. Any filters invoked in the outbound direction after this
request was put into asynchronous mode may use this as an indication that some of the request and/or response
wrappers that they added during their inbound invocation may need to stay in place for the duration of the
asynchronous operation, and their associated resources may not be released. A ServletRequestWrapper applied
during the inbound invocation of a filter may be released by the outbound invocation of the filter
only if the given servletRequest
, which is used to initialize the AsyncContext and will be returned
by a call to AsyncContext.getRequest()
, does not contain said ServletRequestWrapper. The same holds true
for ServletResponseWrapper instances.
This method clears the list of AsyncListener
instances (if any) that were registered with the
AsyncContext returned by the previous call to one of the startAsync methods, after calling each AsyncListener at
its onStartAsync
method.
Subsequent invocations of this method, or its zero-argument variant, will return the same AsyncContext instance, reinitialized as appropriate. If a call to this method is followed by a call to its zero-argument variant, the specified (and possibly wrapped) request and response objects will remain locked in on the returned AsyncContext.
startAsync
in interface ServletRequest
servletRequest
- the ServletRequest used to initialize the AsyncContextservletResponse
- the ServletResponse used to initialize the AsyncContextIllegalStateException
- if this request is within the scope of a filter or servlet that does not support
asynchronous operations (that is, ServletRequest.isAsyncSupported()
returns false), or if
this method is called again without any asynchronous dispatch (resulting from one
of the AsyncContext.dispatch()
methods), is called outside the scope of any
such dispatch, or is called again within the scope of the same dispatch, or if the
response has already been closedpublic boolean isAsyncStarted()
ServletRequest
A ServletRequest is put into asynchronous mode by calling ServletRequest.startAsync()
or
ServletRequest.startAsync(ServletRequest,ServletResponse)
on it.
This method returns false if this request was put into asynchronous mode, but has since been dispatched
using one of the AsyncContext.dispatch()
methods or released from asynchronous mode via a call to
AsyncContext.complete()
.
isAsyncStarted
in interface ServletRequest
public boolean isAsyncSupported()
ServletRequest
Asynchronous operation is disabled for this request if this request is within the scope of a filter or servlet that has not been annotated or flagged in the deployment descriptor as being able to support asynchronous handling.
isAsyncSupported
in interface ServletRequest
public AsyncContextImpl getAsyncContext()
ServletRequest
ServletRequest.startAsync()
or
ServletRequest.startAsync(ServletRequest,ServletResponse)
on this request.getAsyncContext
in interface ServletRequest
ServletRequest.startAsync()
or ServletRequest.startAsync(ServletRequest,ServletResponse)
on this requestpublic AsyncContextImpl getAsyncContextInternal()
public DispatcherType getDispatcherType()
ServletRequest
The dispatcher type of a request is used by the container to select the filters that need to be applied to the request: Only filters with matching dispatcher type and url patterns will be applied.
Allowing a filter that has been configured for multiple dispatcher types to query a request for its dispatcher type allows the filter to process the request differently depending on its dispatcher type.
The initial dispatcher type of a request is defined as DispatcherType.REQUEST
. The dispatcher type
of a request dispatched via RequestDispatcher.forward(ServletRequest, ServletResponse)
or
RequestDispatcher.include(ServletRequest, ServletResponse)
is given as
DispatcherType.FORWARD
or DispatcherType.INCLUDE
, respectively, while the dispatcher
type of an asynchronous request dispatched via one of the AsyncContext.dispatch()
methods is given as
DispatcherType.ASYNC
. Finally, the dispatcher type of a request dispatched to an error page by the
container's error handling mechanism is given as DispatcherType.ERROR
.
getDispatcherType
in interface ServletRequest
DispatcherType
public void setServletContext(ServletContextImpl servletContext)
public String getOriginalRequestURI()
public String getOriginalServletPath()
public String getOriginalPathInfo()
public String getOriginalContextPath()
public String getOriginalQueryString()
public void clearAttributes()
public PushBuilder newPushBuilder()
HttpServletRequest
PushBuilder
for issuing server push responses from the current request.
This method returns null if the current connection does not support server push, or server push has been disabled
by the client via a SETTINGS_ENABLE_PUSH
settings frame value of 0
(zero).newPushBuilder
in interface HttpServletRequest
PushBuilder
for issuing server push responses from the current request, or null if push is not
supportedpublic Map<String,String> getTrailerFields()
HttpServletRequest
The returned map is not backed by the HttpServletRequest
object, so changes in the returned map are not
reflected in the HttpServletRequest
object, and vice-versa.
HttpServletRequest.isTrailerFieldsReady()
should be called first to determine if it is safe to call this method without
causing an exception.
getTrailerFields
in interface HttpServletRequest
HttpServletRequest.isTrailerFieldsReady()
is returning true, the
empty map is returned.public boolean isTrailerFieldsReady()
HttpServletRequest
HttpServletRequest.getTrailerFields()
.
This methods returns true immediately if it is known that there is no trailer in the request, for instance, the
underlying protocol (such as HTTP 1.0) does not supports the trailer fields, or the request is not in chunked
encoding in HTTP 1.1. And the method also returns true if both of the following conditions are satisfied:
ServletRequest.getReader()
or ServletRequest.getInputStream()
.
isTrailerFieldsReady
in interface HttpServletRequest
Copyright © 2021 JBoss by Red Hat. All rights reserved.