|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface HttpServletRequest
Contains all the client's request information. Implementation note: all the headername matching in this class should be caseinsensitive.
Method Summary | |
---|---|
java.lang.String |
getAuthType()
Gets the authorization scheme of this request. |
java.lang.String |
getContextPath()
XXX |
Cookie[] |
getCookies()
Gets all the Cookies present in the request. |
long |
getDateHeader(java.lang.String name)
Converts a given header parameter name to a date in the form of the number of milliseconds since 1 january 1970 midnight GMT. |
java.lang.String |
getHeader(java.lang.String name)
Gets a named header. |
java.util.Enumeration |
getHeaderNames()
Gets an Enumeration with all the headernames. |
java.util.Enumeration |
getHeaders(java.lang.String name)
XXX |
int |
getIntHeader(java.lang.String name)
Gets a named header and returns it in the shape of an int. |
java.lang.String |
getMethod()
Gets the method the client used. |
java.lang.String |
getPathInfo()
Extra path info. |
java.lang.String |
getPathTranslated()
The filesystem path to the path info. |
java.lang.String |
getQueryString()
Gets the request's query string. |
java.lang.String |
getRemoteUser()
Gets the username of the person sending the request. |
java.lang.String |
getRequestedSessionId()
Gets the session Id of this request that the client wanted. |
java.lang.String |
getRequestURI()
Gets the requested URI. |
java.lang.String |
getServletPath()
Gets the part of the URI up to and including the servlet name. |
HttpSession |
getSession()
Gets the HttpSession connected with the client sending the request. |
HttpSession |
getSession(boolean create)
Gets the HttpSession connected with the client sending the request. |
java.security.Principal |
getUserPrincipal()
XXX |
boolean |
isRequestedSessionIdFromCookie()
Returns whether the session id in the request was provided through a Cookie. |
boolean |
isRequestedSessionIdFromUrl()
Deprecated. Use isRequestedSessionIdFromURL |
boolean |
isRequestedSessionIdFromURL()
Returns whether the session id in the request was encoded in the request URI. |
boolean |
isRequestedSessionIdValid()
Checks whether the session connected with the id in the request is a valid one. |
boolean |
isUserInRole(java.lang.String role)
XXX |
Methods inherited from interface javax.servlet.ServletRequest |
---|
getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocale, getLocales, getParameter, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute |
Method Detail |
---|
java.lang.String getAuthType()
AUTH_TYPE
.
See also section 11 of the HTTP/1.1 specification (RFC 2068).
Cookie[] getCookies()
long getDateHeader(java.lang.String name)
name
- the name of the header field (case insensitive)
java.lang.IllegalArgumentException
- if the value is not a datejava.lang.String getHeader(java.lang.String name)
name
- the name of the header field (case insensitive)
java.util.Enumeration getHeaders(java.lang.String name)
java.util.Enumeration getHeaderNames()
int getIntHeader(java.lang.String name) throws java.lang.NumberFormatException
name
- the name of the header field (case insensitive)
java.lang.NumberFormatException
- if the headervalue can't be converted
to an int.java.lang.String getMethod()
REQUEST_METHOD
.
Possible return values are "GET", "HEAD", "POST", "PUT", "DELETE",
"OPTIONS", "TRACE".
java.lang.String getContextPath()
java.lang.String getPathInfo()
PATH_INFO
and identifies the source or sub-resource to be returned by the Servlet.
The function of this method could best be explained using an example.
Client requests: www.foo_bar.com/servlets/myServlet/more/path?id=paul
(where myServlet is a servlet)
In this case this method would return "/more/path".
[MJW] Note that the Servlet 2.1 Spec says that the path info must be URL
decoded although this was not required before 2.1 and I am not sure if
that is the behaviour of the CGI request metadata PATH_INFO
.
java.lang.String getPathTranslated()
PATH_TRANSLATED
.
[MJW] Can this be different from calling
ServletContext.getRealPath()
on the urldecoded result of
getPathInfo()
?
java.lang.String getQueryString()
QUERY_STRING
.
java.lang.String getRemoteUser()
REMOTE_USER
.
boolean isUserInRole(java.lang.String role)
java.security.Principal getUserPrincipal()
java.lang.String getRequestedSessionId()
java.lang.String getRequestURI()
Note that the Servlet 2.1 Spec says that the URI must be decoded before being returned, but this was not required before the Servlet 2.1 API and normally all URIs are encoded.
java.lang.String getServletPath()
SCRIPT_NAME
.
HttpSession getSession()
getSession(true)
.
HttpSession getSession(boolean create)
create
is true then a new HttpSession will be
created. If create
is false then null
is returned. To maintain a session this
method must be called before the connection is flushed or closed.
boolean isRequestedSessionIdValid()
getSession
.
boolean isRequestedSessionIdFromCookie()
boolean isRequestedSessionIdFromURL()
boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromURL
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |