The servlet container creates an HttpServletRequest
object and passes it as an argument to the servlet's service
methods (doGet, doPost, etc).
| Field Summary | |
|---|---|
| static String |
String identifier for Basic authentication. |
| static String |
String identifier for Client Certificate authentication. |
| static String |
String identifier for Digest authentication. |
| static String |
String identifier for Form authentication. |
| Method Summary | |
|---|---|
| String |
Returns the name of the authentication scheme used to protect the servlet. |
| String |
Returns the portion of the request URI that indicates the context of the request. |
| Cookie[] |
Returns an array containing all of the Cookie
objects the client sent with this request.
|
| long |
Returns the value of the specified request header as a long value that represents a
Date object.
|
| String |
Returns the value of the specified request header as a String.
|
| Enumeration |
Returns an enumeration of all the header names this request contains. |
| Enumeration |
Returns all the values of the specified request header as an Enumeration of String objects.
|
| int |
Returns the value of the specified request header as an int.
|
| String |
Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. |
| String |
Returns any extra path information associated with the URL the client sent when it made this request. |
| String |
Returns any extra path information after the servlet name but before the query string, and translates it to a real path. |
| String |
Returns the query string that is contained in the request URL after the path. |
| String |
Returns the login of the user making this request, if the user has been authenticated, or null if the user
has not been authenticated.
|
| String |
Returns the session ID specified by the client. |
| String |
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 |
Reconstructs the URL the client used to make the request. |
| String |
Returns the part of this request's URL that calls the servlet. |
| HttpSession |
Returns the current HttpSession
associated with this request or, if there is no
current session and create is true, returns
a new session.
|
| HttpSession |
Returns the current session associated with this request, or if the request does not have a session, creates one. |
| Principal |
Returns a java.security.Principal object containing
the name of the current authenticated user.
|
| boolean |
Checks whether the requested session ID came in as a cookie. |
| boolean |
Checks whether the requested session ID came in as part of the request URL. |
| boolean |
No description provided. |
| boolean |
Checks whether the requested session ID is still valid. |
| boolean |
Returns a boolean indicating whether the authenticated user is included in the specified logical "role". |
null is returned.
Same as the value of the CGI variable AUTH_TYPE.
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 getContextPath() method. The context path returned by getContextPath() should be considered as the prime or preferred context path of the application.
Cookie
objects the client sent with this request.
This method returns null if no cookies were sent. Beware of undefined behavior when using HttpServletResponse.addCookie(...) and this method in a round-trip cycle.
In my testing, I was creating and setting cookies with path of “/”, but the getPath() of each of the cookies in the following getCookies() calls were returning null. (Behavior seen via Tomcat on OS X, using both Firefox 2.x and Safari.)
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.
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. Some servlet containers do not allow
servlets to access headers using this method, in
which case this method returns null
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.
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.
This method returns null if there
was no extra path information.
Same as the value of the CGI variable PATH_INFO.
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.
null
if the URL does not have a query string. Same as the value
of the CGI variable QUERY_STRING. 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. null. | 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 getRequestURL(HttpServletRequest) .
If this request has been forwarded using forward(ServletRequest, 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.
Examples
Request: http://subdomain.mydomain.com/MyServlet
Request: https://subdomain.mydomain.com/MyServlet
Request: http://mydomain.com/myWebApp/MyServlet
This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.
Examples
Request: POST /myWebApp/myServlet HTTP/1.1
Result: /myServlet
Request: GET http://my.server.com/myWebApp/myServlet HTTP/1.0
Result: /myServlet
Request GET /myServlet?a=b HTTP/1.1
Result: /myServlet
Request GET /aDirectory/aDirectory/myServlet HTTP/1.1
Result: /aDirectory/aDirectory/myServlet
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.
java.security.Principal object containing
the name of the current authenticated user. If the user has not been
authenticated, the method returns null.
public
boolean
isRequestedSessionIdFromCookie
(
)
public
boolean
isRequestedSessionIdFromURL
(
)
public
boolean
isRequestedSessionIdValid
(
)
If the client did not specify any session ID, this method returns
false.
false.