|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
HttpServletRequest encapsulates client request data.
For example, given an application prefix of '/myapp', the api
/myapp/dir/test.jsp/data
will be split as follows:
/myapp/dir/test.jsp/data | getRequestURI() |
/myapp | getContextPath() |
/dir/test.jsp | getServletPath() |
/data | getPathInfo() |
User-Agent | String describing the browser's version |
AUTH_TYPE | getAuthType() |
CONTENT_TYPE | getContentType() |
CONTENT_LENGTH | getContentLength() |
PATH_INFO | getPathInfo() |
PATH_TRANSLATED | getPathTranslated() |
QUERY_STRING | getQueryString() |
REMOTE_ADDR | getRemoteAddr() |
REMOTE_HOST | getRemoteHost() |
REMOTE_USER | getRemoteUser() |
REQUEST_METHOD | getMethod() |
SCRIPT_NAME | getServletPath() |
SERVER_NAME | getServerName() |
SERVER_PROTOCOL | getProtocol() |
SERVER_PORT | getServerPort() |
ServletRequest.getParameter()
Method Summary | |
java.lang.String |
getAuthType()
Returns the auth type, e.g. |
java.lang.String |
getContextPath()
Returns the part of the URI corresponding to the application's prefix. |
Cookie[] |
getCookies()
Returns an array of all cookies sent by the client. |
long |
getDateHeader(java.lang.String name)
Converts a date header to milliseconds since the epoch. |
java.lang.String |
getHeader(java.lang.String name)
Returns the first value for a request header. |
java.util.Enumeration |
getHeaderNames()
Returns an enumeration of all headers sent by the client. |
java.util.Enumeration |
getHeaders(java.lang.String name)
Returns all the values for a request header. |
int |
getIntHeader(java.lang.String name)
Converts a header value to an integer. |
java.lang.String |
getMethod()
Returns the HTTP method, e.g. |
java.lang.String |
getPathInfo()
Returns the URI part after the selected servlet and null if there is no suffix. |
java.lang.String |
getPathTranslated()
Returns the physical path name for the path info. |
java.lang.String |
getQueryString()
Returns the request's query string. |
java.lang.String |
getRemoteUser()
Returns the remote user if authenticated. |
java.lang.String |
getRequestedSessionId()
Returns the session id. |
java.lang.String |
getRequestURI()
Returns the entire request URI |
java.lang.String |
getServletPath()
Returns the URI part corresponding to the selected servlet. |
HttpSession |
getSession()
Returns the current session, creating one if necessary. |
HttpSession |
getSession(boolean create)
Returns a session. |
java.security.Principal |
getUserPrincipal()
Returns the equivalent principal object for the authenticated user. |
boolean |
isRequestedSessionIdFromCookie()
Returns true if the session came from a cookie. |
boolean |
isRequestedSessionIdFromUrl()
Deprecated. |
boolean |
isRequestedSessionIdFromURL()
Returns true if the session came URL-encoding. |
boolean |
isRequestedSessionIdValid()
Returns true if the session is valid. |
boolean |
isUserInRole(java.lang.String role)
Returns true if the user is in the given role. |
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 |
public java.lang.String getMethod()
REQUEST_METHOD
public java.lang.String getRequestURI()
public java.lang.String getContextPath()
getContextPath()
is /myapp for the uri
/myapp/servlet/Hello,
public java.lang.String getServletPath()
SCRIPT_NAME
getServletPath()
is /servlet/Hello for the uri
/myapp/servlet/Hello/foo.
getServletPath()
is /dir/hello.jsp
for the uri /myapp/dir/hello.jsp/foo,public java.lang.String getPathInfo()
PATH_INFO
getPathInfo()
is /foo for
the uri /myapp/servlet/Hello/foo.
getPathInfo()
is /hello.jsp for for the uri
/myapp/dir/hello.jsp/foo.
public java.lang.String getPathTranslated()
PATH_TRANSLATED
public java.lang.String getQueryString()
ServletRequest.getParameter()
to decode the form values.
Corresponds to CGI's PATH_TRANSLATED
public java.lang.String getHeader(java.lang.String name)
HTTP_*
String userAgent = request.getHeader("User-Agent");
name
- the header namepublic java.util.Enumeration getHeaders(java.lang.String name)
name
- the header namepublic java.util.Enumeration getHeaderNames()
public int getIntHeader(java.lang.String name)
name
- the header namepublic long getDateHeader(java.lang.String name)
long mod = request.getDateHeader("If-Modified-Since");
name
- the header namepublic Cookie[] getCookies()
public HttpSession getSession(boolean create)
create
- If true, then create a new session if none exists.public HttpSession getSession()
public java.lang.String getRequestedSessionId()
public boolean isRequestedSessionIdValid()
public boolean isRequestedSessionIdFromCookie()
public boolean isRequestedSessionIdFromURL()
public java.lang.String getAuthType()
public java.lang.String getRemoteUser()
public boolean isUserInRole(java.lang.String role)
public java.security.Principal getUserPrincipal()
public boolean isRequestedSessionIdFromUrl()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |