|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@TransactionType(value=NOT_SUPPORTED) 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).
This Java Card interface is a subset of the Java Servlet API 2.4 HttpServletRequest interface. Some methods have been pruned in an effort to reduce the size of this interface and its implementations and/or eliminate dependencies on unsupported features.
Field Summary | |
---|---|
static String |
BASIC_AUTH
String identifier for Basic authentication. |
static String |
DIGEST_AUTH
String identifier for Digest authentication. |
static String |
FORM_AUTH
String identifier for Form authentication. |
Method Summary | |
---|---|
String |
getAuthType()
Returns the name of the authentication scheme used to protect the servlet. |
String |
getContextPath()
Returns the portion of the request URI that indicates the context of the request. |
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. |
Enumeration |
getHeaders(String name)
Returns all the values of the specified request header as an Enumeration of String objects. |
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. |
StringBuffer |
getRequestURL()
Reconstructs the URL the client used to make the 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 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()
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. |
boolean |
isUserInRole(String role)
Returns a boolean indicating whether the authenticated user is included in the specified logical "role". |
Methods inherited from interface javax.servlet.ServletRequest |
---|
getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterNames, getParameterValues, getProtocol, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding |
Field Detail |
---|
static final String BASIC_AUTH
static final String FORM_AUTH
static final String DIGEST_AUTH
Method Detail |
---|
String getAuthType()
null
is returned.
Same as the value of the CGI variable AUTH_TYPE.
null
if the request was not authenticated.Cookie[] 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
request
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
. 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.
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 getHeaders(String name)
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.
name
- a String
specifying the header name
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 nullEnumeration getHeaderNames()
Some servlet containers 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()
This method returns 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
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.
String
specifying the real path, or
null
if the URL does not have any extra path
informationString getContextPath()
String
specifying the portion of the request URI
that indicates the context of the requestString 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
if the user login is not
knownboolean isUserInRole(String role)
false
.
role
- a String
specifying the name of the role
boolean
indicating whether the user making this
request belongs to a given role; false
if the user
has not been authenticatedString 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 |
String
containing the part of the URL from the
protocol name up to the query stringStringBuffer getRequestURL()
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.
StringBuffer
object containing the reconstructed
URLString getServletPath()
This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.
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.HttpSession getSession(boolean create)
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.
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)
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)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |