|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface HttpServletRequest
Extends the ServletRequest
interface
to provide request information for HTTP servlets.
The servlet container creates an HttpServletRequest
object and passes it as an argument to the servlet's service
methods (doGet
, doPost
, etc).
Method Summary | |
---|---|
String |
getAuthType()
Returns the name of the authentication scheme used to protect the servlet, for example, "BASIC" or "SSL". |
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. |
String |
getHeader(String name)
Returns the value of the specified request header as a String . |
Enumeration |
getHeaderNames()
Returns an enumeration of all the header names this request contains. |
int |
getIntHeader(String name)
Returns the value of the specified request header as an int . |
String |
getMethod()
Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. |
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 |
getQueryString()
Returns the query string that is contained in the request URL after the path. |
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. |
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. |
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 if there is no
current session and create is true, returns
a new session. |
boolean |
isRequestedSessionIdFromCookie()
Checks whether the requested session ID came in as a cookie. |
boolean |
isRequestedSessionIdFromUrl()
Deprecated. As of Version 2.1 of the Java Servlet API, use isRequestedSessionIdFromURL()
instead. |
boolean |
isRequestedSessionIdFromURL()
Checks whether the requested session ID came in as part of the request URL. |
boolean |
isRequestedSessionIdValid()
Checks whether the requested session ID is still valid. |
Methods inherited from interface javax.servlet.ServletRequest |
---|
getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getParameter, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getScheme, getServerName, getServerPort, setAttribute |
Method Detail |
---|
String getAuthType()
null
is returned.
Same as the value of the CGI variable AUTH_TYPE.
String
specifying the name of
the authentication scheme, or
null
if the request was not
authenticatedCookie[] getCookies()
Cookie
objects the client sent with this request.
This method returns null
if no cookies were sent.
Cookies
included with this request, or null
if the request has no cookieslong getDateHeader(String name)
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 header
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
reqest
IllegalArgumentException
- If the header value
can't be converted
to a dateString getHeader(String name)
String
. If the request did not include a header
of the specified name, this method returns null
.
The header name is case insensitive. You can use
this method with any request header.
name
- a String
specifying the
header name
String
containing the
value of the requested
header, or null
if the request does not
have a header of that nameEnumeration getHeaderNames()
Some servlet containers do not allow do not allow
servlets to access headers using this method, in
which case this method returns null
null
int getIntHeader(String name)
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.
name
- a String
specifying the name
of a request header
NumberFormatException
- If the header value
can't be converted
to an int
String getMethod()
String
specifying the name
of the method with which
this request was madeString getPathInfo()
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 informationString getPathTranslated()
If the URL does not have any extra path information,
this method returns null
.
The web container does not decode this string.
String
specifying the
real path, or null
if
the URL does not have any extra path
informationString getQueryString()
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.String getRemoteUser()
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
String getRequestedSessionId()
null
.
String
specifying the session
ID, or null
if the request did
not specify a session IDisRequestedSessionIdValid()
String getRequestURI()
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)
String getServletPath()
String
containing
the name or path of the servlet being
called, as specified in the request URL,
decoded.HttpSession getSession(boolean create)
HttpSession
associated with this request or, if 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 session
HttpSession
associated
with this request or null
if
create
is false
and the request has no valid sessiongetSession()
HttpSession getSession()
HttpSession
associated
with this requestgetSession(boolean)
boolean isRequestedSessionIdValid()
true
if this
request has an id for a valid session
in the current session context;
false
otherwisegetRequestedSessionId()
,
getSession(boolean)
,
HttpSessionContext
boolean isRequestedSessionIdFromCookie()
true
if the session ID
came in as a
cookie; otherwise, false
getSession(boolean)
boolean isRequestedSessionIdFromURL()
true
if the session ID
came in as part of a URL; otherwise,
false
getSession(boolean)
boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromURL()
instead.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |