2.5
javax.servlet.ServletRequestThe servlet container creates an HttpServletRequest
object and passes it as an argument to the servlet's service
methods (doGet, doPost, etc).
null is returned.
Same as the value of the CGI variable AUTH_TYPE.
null if the request was
not authenticated.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.
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
requestjava.lang.IllegalArgumentException If the header value
can't be converted
to a dateString. 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.
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 nameEnumeration 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.
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 nullSome servlet containers do not allow
servlets to access headers using this method, in
which case this method returns null
nullint. 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.
name a String specifying the name
of a request headerjava.lang.NumberFormatException If the header value
can't be converted
to an intThis method returns null if there
was no extra path information.
Same as the value of the CGI variable PATH_INFO.
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 informationIf 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.
String specifying the
real path, or null if
the URL does not have any extra path
informationIt 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
javax.servlet.ServletContext.getContextPath()javax.servlet.ServletContext.getContextPath()
String specifying the
portion of the request URI that indicates the context
of the requestjavax.servlet.ServletContext.getContextPath()null
if the URL does not have a query string. Same as the value
of the CGI variable QUERY_STRING.
String containing the query
string or null if the URL
contains no query string. The value is not
decoded by the container.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.
String specifying the login
of the user making this request, or null
if the user login is not knownfalse.
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
authenticatednull.
String specifying the session
ID, or null if the request did
not specify a session IDisRequestedSessionIdValid()| 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)
String containing
the part of the URL from the
protocol name up to the query stringHttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)If this request has been forwarded using
javax.servlet.RequestDispatcher.forward(javax.servlet.ServletRequest,javax.servlet.ServletResponse)
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.
StringBuffer object containing
the reconstructed URLThis method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.
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.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.
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 sessiongetSession()HttpSession associated
with this requestgetSession(boolean)If the client did not specify any session ID, this method returns
false.
true if this
request has an id for a valid session
in the current session context;
false otherwisegetRequestedSessionId()getSession()HttpSessionContexttrue if the session ID
came in as a
cookie; otherwise, falsegetSession()true if the session ID
came in as part of a URL; otherwise,
falsegetSession()