| javax.servlet.http.HttpServletRequest
All known Subclasses: org.apache.catalina.core.DummyRequest, org.apache.catalina.connector.RequestFacade, org.apache.catalina.connector.Request, javax.servlet.http.HttpServletRequestWrapper,
| HttpServletRequest | | public interface HttpServletRequest extends ServletRequest(Code) | | Extends the
javax.servlet.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).
author:
Various
version:
$Version$ |
| Field Summary | |
| final public static String | BASIC_AUTH
String identifier for Basic authentication. | | final public static String | CLIENT_CERT_AUTH
String identifier for Client Certificate authentication. | | final public static String | DIGEST_AUTH
String identifier for Digest authentication. | | final public static String | FORM_AUTH
String identifier for Form authentication. |
| Method Summary | |
| public String | getAuthType()
Returns the name of the authentication scheme used to protect
the servlet. | | public String | getContextPath()
Returns the portion of the request URI that indicates the context
of the request. | | public Cookie[] | getCookies()
Returns an array containing all of the Cookie
objects the client sent with this request. | | public long | getDateHeader(String name)
Returns the value of the specified request header
as a long value that represents a
Date object. | | public String | getHeader(String name)
Returns the value of the specified request header
as a String. | | public Enumeration | getHeaderNames()
Returns an enumeration of all the header names
this request contains. | | public Enumeration | getHeaders(String name)
Returns all the values of the specified request header
as an 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. | | public int | getIntHeader(String name)
Returns the value of the specified request header
as an int. | | public String | getMethod()
Returns the name of the HTTP method with which this
request was made, for example, GET, POST, or PUT. | | public String | getPathInfo()
Returns any extra path information associated with
the URL the client sent when it made this request. | | public String | getPathTranslated()
Returns any extra path information after the servlet name
but before the query string, and translates it to a real
path. | | public String | getQueryString()
Returns the query string that is contained in the request
URL after the path. | | public 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.
Whether the user name is sent with each subsequent request
depends on the browser and type of authentication. | | 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. | | public StringBuffer | getRequestURL()
Reconstructs the URL the client used to make the request. | | public String | getRequestedSessionId()
Returns the session ID specified by the client. | | public String | getServletPath()
Returns the part of this request's URL that calls
the servlet. | | public HttpSession | getSession(boolean create)
Returns the current 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. | | public HttpSession | getSession()
Returns the current session associated with this request,
or if the request does not have a session, creates one. | | public java.security.Principal | getUserPrincipal()
Returns a java.security.Principal object containing
the name of the current authenticated user. | | public boolean | isRequestedSessionIdFromCookie()
Checks whether the requested session ID came in as a cookie. | | public boolean | isRequestedSessionIdFromURL()
Checks whether the requested session ID came in as part of the
request URL. | | public boolean | isRequestedSessionIdFromUrl()
| | public boolean | isRequestedSessionIdValid()
Checks whether the requested session ID is still valid. | | public boolean | isUserInRole(String role)
Returns a boolean indicating whether the authenticated user is included
in the specified logical "role". |
| BASIC_AUTH | | final public static String BASIC_AUTH(Code) | | String identifier for Basic authentication. Value "BASIC"
|
| CLIENT_CERT_AUTH | | final public static String CLIENT_CERT_AUTH(Code) | | String identifier for Client Certificate authentication. Value "CLIENT_CERT"
|
| DIGEST_AUTH | | final public static String DIGEST_AUTH(Code) | | String identifier for Digest authentication. Value "DIGEST"
|
| FORM_AUTH | | final public static String FORM_AUTH(Code) | | String identifier for Form authentication. Value "FORM"
|
| getAuthType | | public String getAuthType()(Code) | | 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 authenticated null is returned.
Same as the value of the CGI variable AUTH_TYPE.
one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH(suitable for == comparison) orthe container-specific string indicatingthe authentication scheme, ornull if the request was not authenticated. |
| getContextPath | | public String getContextPath()(Code) | | 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.
a String specifying theportion of the request URI that indicates the contextof the request |
| getCookies | | public Cookie[] getCookies()(Code) | | Returns an array containing all of the Cookie
objects the client sent with this request.
This method returns null if no cookies were sent.
an array of all the Cookiesincluded with this request, or nullif the request has no cookies |
| getDateHeader | | public long getDateHeader(String name)(Code) | | Returns the value of the specified request header
as a 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.
Parameters:
name - a String specifying thename of the header a long valuerepresenting the date specifiedin the header expressed asthe number of millisecondssince January 1, 1970 GMT,or -1 if the named headerwas not included with therequest
exception:
IllegalArgumentException - If the header valuecan't be convertedto a date |
| getHeader | | public String getHeader(String name)(Code) | | Returns the value of the specified request header
as a 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.
Parameters:
name - a String specifying theheader name a String containing thevalue of the requestedheader, or nullif the request does nothave a header of that name |
| getHeaderNames | | public Enumeration getHeaderNames()(Code) | | 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 returns null
an enumeration of all theheader names sent with thisrequest; if the request hasno headers, an empty enumeration;if the servlet container does notallow servlets to use this method,null |
| getHeaders | | public Enumeration getHeaders(String name)(Code) | | Returns all the values of the specified request header
as an 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.
Parameters:
name - a String specifying theheader name an Enumeration containingthe values of the requested header. Ifthe request does not have any headers ofthat name return an emptyenumeration. If the container does not allow access toheader information, return null |
| getIntHeader | | public int getIntHeader(String name)(Code) | | Returns the value of the specified request header
as an 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.
Parameters:
name - a String specifying the nameof a request header an integer expressing the value of the request header or -1if the request doesn't have aheader of this name
exception:
NumberFormatException - If the header valuecan't be convertedto an int |
| getMethod | | public String getMethod()(Code) | | 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.
a String specifying the nameof the method with whichthis request was made |
| getPathInfo | | public String getPathInfo()(Code) | | 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 returns null if there
was no extra path information.
Same as the value of the CGI variable PATH_INFO.
a String, decoded by theweb container, specifying extra path information that comesafter the servlet path but beforethe query string in the request URL;or null if the URL does not haveany extra path information |
| getPathTranslated | | public String getPathTranslated()(Code) | | 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 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.
a String specifying thereal path, or null ifthe URL does not have any extra pathinformation |
| getQueryString | | public String getQueryString()(Code) | | Returns the query string that is contained in the request
URL after the path. This method returns null
if the URL does not have a query string. Same as the value
of the CGI variable QUERY_STRING.
a String containing the querystring or null if the URL contains no query string. The value is notdecoded by the container. |
| getRemoteUser | | public String getRemoteUser()(Code) | | Returns the login of the user making this request, if the
user has been authenticated, or 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.
a String specifying the loginof the user making this request, or nullif the user login is not known |
| getRequestURI | | public String getRequestURI()(Code) | | 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:
| 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 .
a String containingthe part of the URL from the protocol name up to the query string
See Also: HttpUtils.getRequestURL |
| getRequestURL | | public StringBuffer getRequestURL()(Code) | | 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 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.
a StringBuffer object containingthe reconstructed URL |
| getRequestedSessionId | | public String getRequestedSessionId()(Code) | | 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 returns
null.
a String specifying the sessionID, or null if the request didnot specify a session ID
See Also: HttpServletRequest.isRequestedSessionIdValid |
| getServletPath | | public String getServletPath()(Code) | | 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.
a String containingthe name or path of the servlet beingcalled, as specified in the request URL,decoded, or an empty string if the servletused to process the request is matchedusing the "/*" pattern. |
| getSession | | public HttpSession getSession(boolean create)(Code) | | Returns the current 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.
Parameters:
create - true to createa new session for this request if necessary; false to return nullif there's no current session the HttpSession associated with this request or null ifcreate is falseand the request has no valid session
See Also: HttpServletRequest.getSession() |
| getUserPrincipal | | public java.security.Principal getUserPrincipal()(Code) | | Returns a java.security.Principal object containing
the name of the current authenticated user. If the user has not been
authenticated, the method returns null.
a java.security.Principal containingthe name of the user making this request;null if the user has not been authenticated |
| isRequestedSessionIdFromCookie | | public boolean isRequestedSessionIdFromCookie()(Code) | | Checks whether the requested session ID came in as a cookie.
true if the session IDcame in as acookie; otherwise, false
See Also: HttpServletRequest.getSession |
| isRequestedSessionIdFromURL | | public boolean isRequestedSessionIdFromURL()(Code) | | Checks whether the requested session ID came in as part of the
request URL.
true if the session IDcame in as part of a URL; otherwise,false
See Also: HttpServletRequest.getSession |
| isUserInRole | | public boolean isUserInRole(String role)(Code) | | 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 returns false.
Parameters:
role - a String specifying the nameof the role a boolean indicating whetherthe user making this request belongs to a given role;false if the user has not been authenticated |
|
|