Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
public interface HttpServletRequest
extends ServletRequest
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).
Field Summary | |
static String |
|
static String |
|
static String |
|
static String |
|
Method Summary | |
String |
|
String |
|
Cookie[] |
|
long |
|
String |
|
Enumeration |
|
Enumeration |
|
int |
|
String |
|
String |
|
String |
|
String |
|
String |
|
String |
|
StringBuffer |
|
String |
|
String |
|
HttpSession |
|
HttpSession |
|
java.security.Principal |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
Methods inherited from interface javax.servlet.ServletRequest | |
getAttribute , getAttributeNames , getCharacterEncoding , getContentLength , getContentType , getInputStream , getLocalAddr , getLocalName , getLocalPort , getLocale , getLocales , getParameter , getParameterMap , getParameterNames , getParameterValues , getProtocol , getReader , getRealPath , getRemoteAddr , getRemoteHost , getRemotePort , getRequestDispatcher , getScheme , getServerName , getServerPort , isSecure , removeAttribute , setAttribute , setCharacterEncoding |
public static final String BASIC_AUTH
String identifier for Basic authentication. Value "BASIC"
public static final String CLIENT_CERT_AUTH
String identifier for Client Certificate authentication. Value "CLIENT_CERT"
public static final String DIGEST_AUTH
String identifier for Digest authentication. Value "DIGEST"
public static final String FORM_AUTH
String identifier for Form authentication. Value "FORM"
public String getAuthType()
Returns the name of the authentication scheme used to protect the servlet. All servlet containers support basic, form and client certificate authentication, and may additionally support digest authentication. If the servlet is not authenticatednull
is returned. Same as the value of the CGI variable AUTH_TYPE.
- Returns:
- one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (suitable for == comparison) or the container-specific string indicating the authentication scheme, or
null
if the request was not authenticated.
public String getContextPath()
Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "". The container does not decode this string.
- Returns:
- a
String
specifying the portion of the request URI that indicates the context of the request
public Cookie[] getCookies()
Returns an array containing all of theCookie
objects the client sent with this request. This method returnsnull
if no cookies were sent.
- Returns:
- an array of all the
Cookies
included with this request, ornull
if the request has no cookies
public long getDateHeader(String name)
Returns the value of the specified request header as along
value that represents aDate
object. Use this method with headers that contain dates, such asIf-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 anIllegalArgumentException
.
- Parameters:
name
- aString
specifying the name of the header
- Returns:
- a
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 request
public String getHeader(String name)
Returns the value of the specified request header as aString
. If the request did not include a header of the specified name, this method returnsnull
. 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.
- Parameters:
name
- aString
specifying the header name
- Returns:
- a
String
containing the value of the requested header, ornull
if the request does not have a header of that name
public Enumeration getHeaderNames()
Returns an enumeration of all the header names this request contains. If the request has no headers, this method returns an empty enumeration. Some servlet containers do not allow servlets to access headers using this method, in which case this method returnsnull
- Returns:
- an enumeration of all the header names sent with this request; if the request has no headers, an empty enumeration; if the servlet container does not allow servlets to use this method,
null
public Enumeration getHeaders(String name)
Returns all the values of the specified request header as anEnumeration
ofString
objects. Some headers, such asAccept-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 emptyEnumeration
. The header name is case insensitive. You can use this method with any request header.
- Parameters:
name
- aString
specifying the header name
- Returns:
- an
Enumeration
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 null
public int getIntHeader(String name)
Returns the value of the specified request header as anint
. 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 aNumberFormatException
. The header name is case insensitive.
- Parameters:
name
- aString
specifying the name of a request header
- Returns:
- an integer expressing the value of the request header or -1 if the request doesn't have a header of this name
public String getMethod()
Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. Same as the value of the CGI variable REQUEST_METHOD.
- Returns:
- a
String
specifying the name of the method with which this request was made
public String getPathInfo()
Returns any extra path information associated with the URL the client sent when it made this request. The extra path information follows the servlet path but precedes the query string and will start with a "/" character. This method returnsnull
if there was no extra path information. Same as the value of the CGI variable PATH_INFO.
- Returns:
- a
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; ornull
if the URL does not have any extra path information
public String getPathTranslated()
Returns any extra path information after the servlet name but before the query string, and translates it to a real path. Same as the value of the CGI variable PATH_TRANSLATED. If the URL does not have any extra path information, this method returnsnull
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.
- Returns:
- a
String
specifying the real path, ornull
if the URL does not have any extra path information
public String getQueryString()
Returns the query string that is contained in the request URL after the path. This method returnsnull
if the URL does not have a query string. Same as the value of the CGI variable QUERY_STRING.
- Returns:
- a
String
containing the query string ornull
if the URL contains no query string. The value is not decoded by the container.
public String getRemoteUser()
Returns the login of the user making this request, if the user has been authenticated, ornull
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.
- Returns:
- a
String
specifying the login of the user making this request, ornull
if the user login is not known
public 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. The web container does not decode this String. For example:To reconstruct an URL with a scheme and host, use
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 HttpUtils.getRequestURL(HttpServletRequest)
.
- Returns:
- a
String
containing the part of the URL from the protocol name up to the query string
public StringBuffer getRequestURL()
Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and server path, but it does not include query string parameters. Because this method returns aStringBuffer
, 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.
- Returns:
- a
StringBuffer
object containing the reconstructed URL
public String getRequestedSessionId()
Returns the session ID specified by the client. This may not be the same as the ID of the current valid session for this request. If the client did not specify a session ID, this method returnsnull
.
- Returns:
- a
String
specifying the session ID, ornull
if the request did not specify a session ID
- See Also:
isRequestedSessionIdValid()
public String getServletPath()
Returns the part of this request's URL that calls the servlet. This path starts with a "/" character and includes either the servlet name or a path to the servlet, but does not include any extra path information or a query string. Same as the value of the CGI variable SCRIPT_NAME. This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.
- Returns:
- a
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.
public HttpSession getSession()
Returns the current session associated with this request, or if the request does not have a session, creates one.
- Returns:
- the
HttpSession
associated with this request
- See Also:
getSession(boolean)
public HttpSession getSession(boolean create)
Returns the currentHttpSession
associated with this request or, if there is no current session andcreate
is true, returns a new session. Ifcreate
isfalse
and the request has no validHttpSession
, this method returnsnull
. 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.
- Parameters:
create
-true
to create a new session for this request if necessary;false
to returnnull
if there's no current session
- Returns:
- the
HttpSession
associated with this request ornull
ifcreate
isfalse
and the request has no valid session
- See Also:
getSession()
public java.security.Principal getUserPrincipal()
Returns ajava.security.Principal
object containing the name of the current authenticated user. If the user has not been authenticated, the method returnsnull
.
- Returns:
- a
java.security.Principal
containing the name of the user making this request;null
if the user has not been authenticated
public boolean isRequestedSessionIdFromCookie()
Checks whether the requested session ID came in as a cookie.
- Returns:
true
if the session ID came in as a cookie; otherwise,false
- See Also:
getSession
public boolean isRequestedSessionIdFromURL()
Checks whether the requested session ID came in as part of the request URL.
- Returns:
true
if the session ID came in as part of a URL; otherwise,false
- See Also:
getSession
public boolean isRequestedSessionIdFromUrl()
Deprecated. As of Version 2.1 of the Java Servlet API, use
isRequestedSessionIdFromURL()
instead.
public boolean isRequestedSessionIdValid()
Checks whether the requested session ID is still valid.
- Returns:
true
if this request has an id for a valid session in the current session context;false
otherwise
- See Also:
getRequestedSessionId()
,getSession
,HttpSessionContext
public boolean isUserInRole(String role)
Returns a boolean indicating whether the authenticated user is included in the specified logical "role". Roles and role membership can be defined using deployment descriptors. If the user has not been authenticated, the method returnsfalse
.
- Parameters:
role
- aString
specifying the name of the role
- Returns:
- a
boolean
indicating whether the user making this request belongs to a given role;false
if the user has not been authenticated