|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Defines an interface to provide client request information .
A client can bind an object attribute into a Request
by name.
All objects stored in the request using the setAttribute method
are available to all sub requests and the main request associatiated
Objects stored in the request using the setLocalAttribute method are
only available for the current (sub) request.
Field Summary | |
static int |
GLOBAL_SCOPE
This constant defines an request wide scope for the request attribute. |
static int |
REQUEST_SCOPE
This constant defines the scope of the request attribute to be private to the current (sub) request. |
Fields inherited from interface javax.servlet.http.HttpServletRequest |
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH |
Method Summary | |
Object |
get(String name)
Returns the value of the named parameter as an Object ,
or null if no parameter of the given name exists. |
Object |
getAttribute(String name)
Returns the value of the named attribute from the GLOBAL_SCOPE
as an Object , or null if no attribute
of the given name exists. |
Enumeration |
getAttributeNames()
Returns an Enumeration containing the
names of the attributes available to this request globally. |
Map |
getAttributes()
Utility method for getting a Map view of the request attributes. |
String |
getAuthType()
Returns the name of the authentication scheme used to protect the servlet, for example, "BASIC" or "SSL," or null if the servlet was not protected |
String |
getCharacterEncoding()
Returns the name of the character encoding used in the body of this request. |
Map |
getCocoonCookieMap()
Deprecated. use getCookieMap() instead. |
Cookie[] |
getCocoonCookies()
Deprecated. use getCookies() instead. |
Session |
getCocoonSession()
Deprecated. use getSession() instead. |
Session |
getCocoonSession(boolean create)
Deprecated. use getSession(boolean) instead. |
int |
getContentLength()
Returns the length, in bytes, of the request body |
String |
getContentType()
Returns the MIME type of the body of the request |
String |
getContextPath()
Returns the portion of the request URI that indicates the context of the request. |
Map |
getCookieMap()
Returns a map of the Cookie objects the client sent
with this request, indexed by name. |
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. |
Map |
getHeaders()
Utility method for getting a Map view of the request headers. |
Enumeration |
getHeaders(String name)
Returns all the values of the specified request header as an Enumeration of String objects. |
ServletInputStream |
getInputStream()
Retrieves the body of the request as binary data using an InputStream . |
Object |
getLocalAttribute(String name)
Returns the value of the named attribute from the LOCAL_SCOPE
as an Object , or null if no attribute
of the given name exists. |
Enumeration |
getLocalAttributeNames()
Returns an Enumeration containing the
names of the attributes available to this request locally. |
Locale |
getLocale()
Returns the preferred Locale that the client will
accept content in, based on the Accept-Language header. |
Enumeration |
getLocales()
Returns an Enumeration of Locale objects
indicating, in decreasing order starting with the preferred locale, the
locales that are acceptable to the client based on the Accept-Language
header. |
String |
getMethod()
Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. |
String |
getParameter(String name)
Returns the value of a request parameter as a String , |
Enumeration |
getParameterNames()
Returns an Enumeration of String
objects containing the names of the parameters contained
in this request. |
Map |
getParameters()
Utility method for getting a Map view of the request parameters. |
String[] |
getParameterValues(String name)
Returns an array of String objects containing
all of the values the given request parameter has, or
null if the parameter does not exist. |
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 |
getProtocol()
Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1. |
String |
getQueryString()
Returns the query string that is contained in the request URL after the path. |
String |
getRemoteAddr()
Returns the Internet Protocol (IP) address of the client that sent the request. |
String |
getRemoteHost()
Returns the fully qualified name of the client that sent the request, or the IP address of the client if the name cannot be determined. |
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. |
String |
getScheme()
Returns the name of the scheme used to make this request, for example, http , https , or ftp . |
String |
getServerName()
Returns the host name of the server that received the request. |
int |
getServerPort()
Returns the port number on which this request was received. |
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 if there is no
current session and create is true, returns
a new session. |
String |
getSitemapPath()
Returns the path to the sitemap of the requested resource as interpreted by the sitemap. |
String |
getSitemapURI()
Returns the URI of the requested resource as interpreted by the sitemap. |
String |
getSitemapURIPrefix()
Returns the URI Prefix of the requested resource where the sitemap is mounted. |
Principal |
getUserPrincipal()
Returns the login of the user making this request, if the user has been authenticated, or null if the user
has not been authenticated. |
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 |
isSecure()
Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS. |
boolean |
isUserInRole(String role)
Checks whether the currently logged in user is in a specified role. |
void |
removeAttribute(String name)
Removes an attribute from this request globally. |
void |
removeLocalAttribute(String name)
Removes an attribute from this request in the GLOBAL_SCOPE . |
Object |
searchAttribute(String name)
Returns the value of the named attribute searching both scopes as an Object , or null if no attribute
of the given name exists. |
void |
setAttribute(String name,
Object o)
Stores an attribute in this request in the GLOBAL_SCOPE . |
void |
setCharacterEncoding(String enc)
Overrides the charactor encoding of parameters. |
void |
setLocalAttribute(String name,
Object o)
Stores an attribute in this request locally. |
Methods inherited from interface javax.servlet.http.HttpServletRequest |
getIntHeader, getRequestURL, isRequestedSessionIdFromUrl |
Methods inherited from interface javax.servlet.ServletRequest |
getLocalAddr, getLocalName, getLocalPort, getParameterMap, getReader, getRealPath, getRemotePort, getRequestDispatcher |
Field Detail |
public static final int GLOBAL_SCOPE
public static final int REQUEST_SCOPE
Method Detail |
public Object get(String name)
Object
,
or null
if no parameter of the given name exists.
Basically, this method is similar to getParameter(String)
,
but it returns an object instead.
This is useful when special processing has been made on these parameters,
for example for file uploads. In this case you get an object
representing the uploaded file.
If the parameters have not been processed, you either get a String
object if the parameter has one value, or a Collection of Strings
if the parameter has more than one value.
get
in interface ValueHolder
name
- a String
specifying the name of
the parameter
Object
containing the value
of the parameter, or null
if
the parameter does not existpublic Object getAttribute(String name)
GLOBAL_SCOPE
as an Object
, or null
if no attribute
of the given name exists.
getAttribute
in interface ServletRequest
name
- a String
specifying the name of
the attribute
Object
containing the value
of the attribute, or null
if
the attribute does not existpublic Object getLocalAttribute(String name)
LOCAL_SCOPE
as an Object
, or null
if no attribute
of the given name exists.
name
- a String
specifying the name of
the attribute
Object
containing the value
of the attribute, or null
if
the attribute does not existpublic Enumeration getAttributeNames()
Enumeration
containing the
names of the attributes available to this request globally.
This method returns an empty Enumeration
if the request has no attributes available to it.
getAttributeNames
in interface ServletRequest
Enumeration
of strings
containing the names
of the request's attributespublic Enumeration getLocalAttributeNames()
Enumeration
containing the
names of the attributes available to this request locally.
This method returns an empty Enumeration
if the request has no attributes available to it.
Enumeration
of strings
containing the names
of the request's attributespublic void setAttribute(String name, Object o)
GLOBAL_SCOPE
.
Attributes are reset between requests.
Attribute names should follow the same conventions as
package names. Names beginning with java.*
,
javax.*
, and com.sun.*
, are
reserved for use by Sun Microsystems.
setAttribute
in interface ServletRequest
name
- a String
specifying
the name of the attributeo
- the Object
to be storedpublic void setLocalAttribute(String name, Object o)
Attribute names should follow the same conventions as
package names. Names beginning with java.*
,
javax.*
, and com.sun.*
, are
reserved for use by Sun Microsystems.
name
- a String
specifying
the name of the attributeo
- the Object
to be storedpublic void removeAttribute(String name)
Attribute names should follow the same conventions as
package names. Names beginning with java.*
,
javax.*
, and com.sun.*
, are
reserved for use by Sun Microsystems.
removeAttribute
in interface ServletRequest
name
- a String
specifying
the name of the attribute to removepublic void removeLocalAttribute(String name)
GLOBAL_SCOPE
.
This method is not
generally needed as attributes only persist as long as the request
is being handled.
Attribute names should follow the same conventions as
package names. Names beginning with java.*
,
javax.*
, and com.sun.*
, are
reserved for use by Sun Microsystems.
name
- a String
specifying
the name of the attribute to removepublic Object searchAttribute(String name)
Object
, or null
if no attribute
of the given name exists. This method first searches in the
request scope and then, if no object is found, in the global scope.
name
- a String
specifying the name of
the attribute
Object
containing the value
of the attribute, or null
if
the attribute does not existpublic Map getAttributes()
Map
view of the request attributes.
Returns a Map
with attributes from the GLOBAL_SCOPE
.
Map
containing the request attributes.public String getAuthType()
getAuthType
in interface HttpServletRequest
public String getCharacterEncoding()
null
if the request
does not specify a character encoding
getCharacterEncoding
in interface ServletRequest
String
containing the name of
the chararacter encoding, or null
if the request does not specify a character encodingpublic void setCharacterEncoding(String enc) throws UnsupportedEncodingException
setCharacterEncoding
in interface ServletRequest
UnsupportedEncodingException
- if this is not a valid encoding.public int getContentLength()
getContentLength
in interface ServletRequest
public String getContentType()
getContentType
in interface ServletRequest
String
containing the name
of the MIME type of
the request, or -1 if the type is not knownpublic String getParameter(String name)
String
,
getParameter
in interface ServletRequest
name
- a String
specifying the
name of the parameter
String
representing the
single value of the parametergetParameterValues(String)
public Enumeration getParameterNames()
Enumeration
of String
objects containing the names of the parameters contained
in this request. If the request has
no parameters, the method returns an
empty Enumeration
.
getParameterNames
in interface ServletRequest
Enumeration
of String
objects, each String
containing
the name of a request parameter; or an
empty Enumeration
if the
request has no parameterspublic String[] getParameterValues(String name)
String
objects containing
all of the values the given request parameter has, or
null
if the parameter does not exist.
If the parameter has a single value, the array has a length of 1.
getParameterValues
in interface ServletRequest
name
- a String
containing the name of
the parameter whose value is requested
String
objects
containing the parameter's valuesgetParameter(String)
public Map getParameters()
Map
view of the request parameters.
Returns a Map
with request parameters.
Map
containing the request parameters.public String getProtocol()
SERVER_PROTOCOL
.
getProtocol
in interface ServletRequest
String
containing the protocol
name and version numberpublic String getScheme()
http
, https
, or ftp
.
Different schemes have different rules for constructing URLs,
as noted in RFC 1738.
getScheme
in interface ServletRequest
String
containing the name
of the scheme used to make this requestpublic String getServerName()
SERVER_NAME
.
getServerName
in interface ServletRequest
String
containing the name
of the server to which the request was sentpublic int getServerPort()
SERVER_PORT
.
getServerPort
in interface ServletRequest
public String getRemoteAddr()
REMOTE_ADDR
.
getRemoteAddr
in interface ServletRequest
String
containing the
IP address of the client that sent the requestpublic String getRemoteHost()
REMOTE_HOST
.
getRemoteHost
in interface ServletRequest
String
containing the fully qualified name
of the clientpublic Locale getLocale()
Locale
that the client will
accept content in, based on the Accept-Language header.
If the client request doesn't provide an Accept-Language header,
this method returns the default locale for the server.
getLocale
in interface ServletRequest
Locale
for the clientpublic Enumeration getLocales()
Enumeration
of Locale
objects
indicating, in decreasing order starting with the preferred locale, the
locales that are acceptable to the client based on the Accept-Language
header.
If the client request doesn't provide an Accept-Language header,
this method returns an Enumeration
containing one
Locale
, the default locale for the server.
getLocales
in interface ServletRequest
Enumeration
of preferred
Locale
objects for the clientpublic boolean isSecure()
isSecure
in interface ServletRequest
public Cookie[] getCookies()
Cookie
objects the client sent with this request.
This method returns null
if no cookies were sent.
getCookies
in interface HttpServletRequest
Cookie
included with this request, or null
if the request has no cookiespublic Map getCookieMap()
Cookie
objects the client sent
with this request, indexed by name. This method returns an empty
map if no cookies were sent.
Cookie
objectspublic Cookie[] getCocoonCookies()
getCookies()
instead.
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 cookiespublic Map getCocoonCookieMap()
getCookieMap()
instead.
Cookie
objects the client sent
with this request, indexed by name. This method returns an empty
map if no cookies were sent.
Cookie
objectspublic long 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
.
getDateHeader
in interface HttpServletRequest
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
reqest
IllegalArgumentException
- If the header value
can't be converted
to a datepublic String getHeader(String name)
String
. If the request did not include a header
of the specified name, this method returns null
.
The header name is case insensitive. You can use
this method with any request header.
getHeader
in interface HttpServletRequest
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 namepublic Enumeration 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.
getHeaders
in interface HttpServletRequest
name
- a String
specifying the
header name
Enumeration
containing the
values of the requested
header, or null
if the request does not
have any headers of that namepublic Enumeration getHeaderNames()
Some servlet containers do not allow do not allow
servlets to access headers using this method, in
which case this method returns null
getHeaderNames
in interface HttpServletRequest
null
public Map getHeaders()
Map
view of the request headers.
Returns a Map
with request headers.
Map
containing the request headers.public ServletInputStream getInputStream() throws IOException, UnsupportedOperationException
InputStream
.
getInputStream
in interface ServletRequest
InputStream
containing the body of the request.
IOException
- if an input or output exception occurred
UnsupportedOperationException
public String getMethod()
getMethod
in interface HttpServletRequest
String
specifying the name
of the method with which
this request was madepublic String getPathInfo()
null
if there
was no extra path information.
Same as the value of the CGI variable PATH_INFO.
getPathInfo
in interface HttpServletRequest
String
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 informationpublic String getPathTranslated()
If the URL does not have any extra path information,
this method returns null
.
getPathTranslated
in interface HttpServletRequest
String
specifying the
real path, or null
if
the URL does not have any extra path
informationpublic String getContextPath()
getContextPath
in interface HttpServletRequest
String
specifying the
portion of the request URI that indicates the context
of the requestpublic String getQueryString()
null
if the URL does not have a query string. Same as the value
of the CGI variable QUERY_STRING.
getQueryString
in interface HttpServletRequest
String
containing the query
string or null
if the URL
contains no query stringpublic 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.
getRemoteUser
in interface HttpServletRequest
String
specifying the login
of the user making this request, or null
public Principal getUserPrincipal()
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.
getUserPrincipal
in interface HttpServletRequest
String
specifying the login
of the user making this request, or null
public boolean isUserInRole(String role)
isUserInRole
in interface HttpServletRequest
true
if the user is
authenticated and in the role;
otherwise, false
getRemoteUser()
public String getRequestedSessionId()
null
.
getRequestedSessionId
in interface HttpServletRequest
String
specifying the session
ID, or null
if the request did
not specify a session IDisRequestedSessionIdValid()
public String getRequestURI()
For internal requests, this method returns the information for the original/external request!
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 http://foo.bar/a.html HEAD /xyz?a=b HTTP/1.1 /xyz
getRequestURI
in interface HttpServletRequest
String
containing
the part of the URL from the
protocol name up to the query stringpublic String getSitemapURI()
Returns the URI of the requested resource as interpreted by the sitemap. For example, if your webapp is mounted at "/webapp" and the HTTP request is for "/webapp/foo", this method returns "foo". Consequently, if the request is for "/webapp", this method returns an empty string.
Note that if the request is mapped to a pipeline that contains aggregated content, and if this method is called in the context of one of the aggregated parts (e.g. a server page), this method will return the URI of the aggregated part, not the original requested URI.
String
containing the URL as mangled by the
sitemappublic String getSitemapURIPrefix()
Returns the URI Prefix of the requested resource where the sitemap is mounted. For example, if your webapp is mounted at "/webapp" and the HTTP request is for "/webapp/foo", this method returns "webapp/".
String
containing the URI prefix as mangled by the
sitemappublic String getSitemapPath()
Returns the path to the sitemap of the requested resource as interpreted by the sitemap. For example, if your webapp is mounted at "webapp" and the HTTP request is for "webapp/foo", this method returns "webapp/". Consequently, if the request is for "foo", this method returns the empty string.
String
containing the path to the sitemappublic String getServletPath()
getServletPath
in interface HttpServletRequest
String
containing
the name or path of the servlet being
called, as specified in the request URLpublic HttpSession getSession(boolean create)
HttpSession
associated with this request or, if if there is no
current session and create
is true, returns
a new session.
If create
is false
and the request has no valid Session
,
this method returns null
.
To make sure the session is properly maintained, you must call this method before the response is committed.
getSession
in interface HttpServletRequest
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()
public HttpSession getSession()
getSession
in interface HttpServletRequest
HttpSession
associated
with this requestgetSession(boolean)
public Session getCocoonSession(boolean create)
getSession(boolean)
instead.
Session
associated with this request or, if if there is no
current session and create
is true, returns
a new session.
If create
is false
and the request has no valid Session
,
this method returns null
.
To make sure the session is properly maintained, you must call this method before the response is committed.
create
- true
to create
a new session for this request if necessary;
false
to return null
if there's no current session
Session
associated
with this request or null
if
create
is false
and the request has no valid sessiongetSession()
public Session getCocoonSession()
getSession()
instead.
Session
associated
with this requestgetSession(boolean)
public boolean isRequestedSessionIdValid()
isRequestedSessionIdValid
in interface HttpServletRequest
true
if this
request has an id for a valid session
in the current session context;
false
otherwisegetRequestedSessionId()
,
getSession()
public boolean isRequestedSessionIdFromCookie()
isRequestedSessionIdFromCookie
in interface HttpServletRequest
true
if the session ID
came in as a
cookie; otherwise, false
getSession()
public boolean isRequestedSessionIdFromURL()
isRequestedSessionIdFromURL
in interface HttpServletRequest
true
if the session ID
came in as part of a URL; otherwise,
false
getSession()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |