|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.mortbay.jetty.servlet.ServletHttpRequest
Servlet Request Wrapper. This class wraps a Jetty HTTP request as a 2.2 Servlet request.
Note that this wrapper is not synchronized and if a request is to be operated on by multiple threads, then higher level synchronizations may be required.
Field Summary | |
static java.lang.String |
__SESSIONID_COOKIE
|
static java.lang.String |
__SESSIONID_NONE
|
static java.lang.String |
__SESSIONID_NOT_CHECKED
|
static java.lang.String |
__SESSIONID_URL
|
Fields inherited from interface javax.servlet.http.HttpServletRequest |
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH |
Constructor Summary | |
ServletHttpRequest(ServletHandler servletHandler,
java.lang.String pathInContext,
HttpRequest request)
Constructor. |
Method Summary | |
java.lang.Object |
getAttribute(java.lang.String name)
Returns the value of the named attribute as an Object ,
or null if no attribute of the given name exists. |
java.util.Enumeration |
getAttributeNames()
Returns an Enumeration containing the
names of the attributes available to this request. |
java.lang.String |
getAuthType()
Returns the name of the authentication scheme used to protect the servlet. |
java.lang.String |
getCharacterEncoding()
Returns the name of the character encoding used in the body of this request. |
int |
getContentLength()
Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known. |
java.lang.String |
getContentType()
Returns the MIME type of the body of the request, or null if the type is not known. |
java.lang.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(java.lang.String name)
Returns the value of the specified request header as a long value that represents a
Date object. |
java.lang.String |
getHeader(java.lang.String name)
Returns the value of the specified request header as a String . |
java.util.Enumeration |
getHeaderNames()
Returns an enumeration of all the header names this request contains. |
java.util.Enumeration |
getHeaders(java.lang.String s)
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 a ServletInputStream . |
int |
getIntHeader(java.lang.String name)
Returns the value of the specified request header as an int . |
java.lang.String |
getLocalAddr()
Returns the Internet Protocol (IP) address of the interface on which the request was received. |
java.util.Locale |
getLocale()
Returns the preferred Locale that the client will
accept content in, based on the Accept-Language header. |
java.util.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. |
java.lang.String |
getLocalName()
Returns the host name of the Internet Protocol (IP) interface on which the request was received. |
int |
getLocalPort()
Returns the Internet Protocol (IP) port number of the interface on which the request was received. |
java.lang.String |
getMethod()
Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. |
java.lang.String |
getParameter(java.lang.String name)
Returns the value of a request parameter as a String ,
or null if the parameter does not exist. |
java.util.Map |
getParameterMap()
This method is not recommended as it forces the generation of a non-optimal data structure. |
java.util.Enumeration |
getParameterNames()
Returns an Enumeration of String
objects containing the names of the parameters contained
in this request. |
java.lang.String[] |
getParameterValues(java.lang.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. |
java.lang.String |
getPathInfo()
Returns any extra path information associated with the URL the client sent when it made this request. |
java.lang.String |
getPathTranslated()
Returns any extra path information after the servlet name but before the query string, and translates it to a real path. |
java.lang.String |
getProtocol()
Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1. |
java.lang.String |
getQueryString()
Returns the query string that is contained in the request URL after the path. |
java.io.BufferedReader |
getReader()
Retrieves the body of the request as character data using a BufferedReader . |
java.lang.String |
getRealPath(java.lang.String path)
Deprecated. As of Version 2.1 of the Java Servlet API, use ServletContext.getRealPath(java.lang.String) instead. |
java.lang.String |
getRemoteAddr()
Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. |
java.lang.String |
getRemoteHost()
Returns the fully qualified name of the client or the last proxy that sent the request. |
int |
getRemotePort()
Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request. |
java.lang.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. |
RequestDispatcher |
getRequestDispatcher(java.lang.String url)
Returns a RequestDispatcher object that acts as a wrapper for
the resource located at the given path. |
java.lang.String |
getRequestedSessionId()
Returns the session ID specified by the client. |
java.lang.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. |
java.lang.StringBuffer |
getRequestURL()
Reconstructs the URL the client used to make the request. |
java.lang.String |
getScheme()
Returns the name of the scheme used to make this request, for example, http , https , or ftp . |
java.lang.String |
getServerName()
Returns the host name of the server to which the request was sent. |
int |
getServerPort()
Returns the port number to which the request was sent. |
ServletHttpResponse |
getServletHttpResponse()
|
java.lang.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. |
java.security.Principal |
getUserPrincipal()
Returns a java.security.Principal object containing
the name of the current authenticated user. |
boolean |
isRequestedSessionIdFromCookie()
Checks whether the requested session ID came in as a cookie. |
boolean |
isRequestedSessionIdFromUrl()
Deprecated. |
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(java.lang.String role)
Returns a boolean indicating whether the authenticated user is included in the specified logical "role". |
void |
removeAttribute(java.lang.String name)
Removes an attribute from this request. |
void |
setAttribute(java.lang.String name,
java.lang.Object value)
Stores an attribute in this request. |
void |
setCharacterEncoding(java.lang.String encoding)
Overrides the name of the character encoding used in the body of this request. |
java.lang.String |
toString()
|
static ServletHttpRequest |
unwrap(ServletRequest request)
Unwrap a ServletRequest. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String __SESSIONID_NOT_CHECKED
public static final java.lang.String __SESSIONID_URL
public static final java.lang.String __SESSIONID_COOKIE
public static final java.lang.String __SESSIONID_NONE
Constructor Detail |
public ServletHttpRequest(ServletHandler servletHandler, java.lang.String pathInContext, HttpRequest request)
Method Detail |
public ServletHttpResponse getServletHttpResponse()
public java.util.Locale getLocale()
ServletRequest
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 java.util.Enumeration getLocales()
ServletRequest
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()
ServletRequest
isSecure
in interface ServletRequest
public Cookie[] getCookies()
HttpServletRequest
Cookie
objects the client sent with this request.
This method returns null
if no cookies were sent.
getCookies
in interface HttpServletRequest
Cookies
included with this request, or null
if the request has no cookiespublic long getDateHeader(java.lang.String name)
HttpServletRequest
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 reqestpublic java.util.Enumeration getHeaderNames()
HttpServletRequest
Some servlet containers do not allow servlets to access headers
using this method, in which case this method returns null
getHeaderNames
in interface HttpServletRequest
null
public java.lang.String getHeader(java.lang.String name)
HttpServletRequest
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.
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 java.util.Enumeration getHeaders(java.lang.String s)
HttpServletRequest
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
s
- 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 nullpublic int getIntHeader(java.lang.String name) throws java.lang.NumberFormatException
HttpServletRequest
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.
getIntHeader
in interface HttpServletRequest
name
- a String
specifying the name
of a request header
java.lang.NumberFormatException
- If the header value can't be
converted to an int
public java.lang.String getMethod()
HttpServletRequest
getMethod
in interface HttpServletRequest
String
specifying the name of the method with
which this request was madepublic java.lang.String getContextPath()
HttpServletRequest
getContextPath
in interface HttpServletRequest
String
specifying the portion of the request
URI that indicates the context of the requestpublic java.lang.String getPathInfo()
HttpServletRequest
This method returns null
if there was no extra path
information.
Same as the value of the CGI variable PATH_INFO.
getPathInfo
in interface HttpServletRequest
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 informationpublic java.lang.String getPathTranslated()
HttpServletRequest
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.
getPathTranslated
in interface HttpServletRequest
String
specifying the real path, or
null
if the URL does not have any extra path informationpublic java.lang.String getQueryString()
HttpServletRequest
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 string. The value is not
decoded by the container.public java.lang.String getAuthType()
HttpServletRequest
null
is returned.
Same as the value of the CGI variable AUTH_TYPE.
getAuthType
in interface HttpServletRequest
null
if the request
was not authenticated.public java.lang.String getRemoteUser()
HttpServletRequest
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
if the user login is not knownpublic boolean isUserInRole(java.lang.String role)
HttpServletRequest
false
.
isUserInRole
in interface HttpServletRequest
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 authenticatedpublic java.security.Principal getUserPrincipal()
HttpServletRequest
java.security.Principal
object containing
the name of the current authenticated user. If the user has not been
authenticated, the method returns null
.
getUserPrincipal
in interface HttpServletRequest
java.security.Principal
containing the name
of the user making this request; null
if the user has
not been authenticatedpublic java.lang.String getRequestedSessionId()
HttpServletRequest
null
.
getRequestedSessionId
in interface HttpServletRequest
String
specifying the session ID, or
null
if the request did not specify a session IDHttpServletRequest.isRequestedSessionIdValid()
public java.lang.String getRequestURI()
HttpServletRequest
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(javax.servlet.http.HttpServletRequest)
.
getRequestURI
in interface HttpServletRequest
String
containing the part of the URL
from the protocol name up to the query stringHttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)
public java.lang.StringBuffer getRequestURL()
HttpServletRequest
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.
getRequestURL
in interface HttpServletRequest
StringBuffer
object containing the reconstructed URLpublic java.lang.String getServletPath()
HttpServletRequest
This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.
getServletPath
in interface HttpServletRequest
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(boolean create)
HttpServletRequest
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.
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 sessionHttpServletRequest.getSession()
public HttpSession getSession()
HttpServletRequest
getSession
in interface HttpServletRequest
HttpSession
associated with this requestHttpServletRequest.getSession(boolean)
public boolean isRequestedSessionIdValid()
HttpServletRequest
isRequestedSessionIdValid
in interface HttpServletRequest
true
if this request has an id for a valid session
in the current session context; false
otherwiseHttpServletRequest.getRequestedSessionId()
,
HttpServletRequest.getSession(boolean)
,
HttpSessionContext
public boolean isRequestedSessionIdFromCookie()
HttpServletRequest
isRequestedSessionIdFromCookie
in interface HttpServletRequest
true
if the session ID came in as a cookie;
otherwise, false
HttpServletRequest.getSession(boolean)
public boolean isRequestedSessionIdFromURL()
HttpServletRequest
isRequestedSessionIdFromURL
in interface HttpServletRequest
true
if the session ID came in as part of a URL;
otherwise, false
HttpServletRequest.getSession(boolean)
public boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromUrl
in interface HttpServletRequest
public java.util.Enumeration getAttributeNames()
ServletRequest
Enumeration
containing the
names of the attributes available to this request.
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 java.lang.Object getAttribute(java.lang.String name)
ServletRequest
Object
,
or null
if no attribute of the given name exists.
Attributes can be set two ways. The servlet container may set
attributes to make available custom information about a request.
For example, for requests made using HTTPS, the attribute
javax.servlet.request.X509Certificate
can be used to
retrieve information on the certificate of the client. Attributes
can also be set programatically using
ServletRequest.setAttribute(java.lang.String, java.lang.Object)
. This allows information to be
embedded into a request before a RequestDispatcher
call.
Attribute names should follow the same conventions as package
names. This specification reserves names matching java.*
,
javax.*
, and sun.*
.
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 void setAttribute(java.lang.String name, java.lang.Object value)
ServletRequest
RequestDispatcher
.
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.
If the object passed in is null, the effect is the same as
calling ServletRequest.removeAttribute(java.lang.String)
.
setAttribute
in interface ServletRequest
name
- a String
specifying the name of the attributevalue
- the Object
to be storedpublic void removeAttribute(java.lang.String name)
ServletRequest
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 setCharacterEncoding(java.lang.String encoding) throws java.io.UnsupportedEncodingException
ServletRequest
setCharacterEncoding
in interface ServletRequest
encoding
- a String
containing the name of
the chararacter encoding.
java.io.UnsupportedEncodingException
- if this is not a valid encodingpublic java.lang.String getCharacterEncoding()
ServletRequest
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 int getContentLength()
ServletRequest
getContentLength
in interface ServletRequest
public java.lang.String getContentType()
ServletRequest
null
if the type is not known. For HTTP servlets,
same as the value of the CGI variable CONTENT_TYPE.
getContentType
in interface ServletRequest
String
containing the name
of the MIME type of the request, or null if the type is not knownpublic ServletInputStream getInputStream()
ServletRequest
ServletInputStream
. Either this method or
ServletRequest.getReader()
may be called to read the body, not both.
getInputStream
in interface ServletRequest
ServletInputStream
object containing
the body of the requestpublic java.util.Map getParameterMap()
getParameterMap
in interface ServletRequest
public java.lang.String getParameter(java.lang.String name)
ServletRequest
String
,
or null
if the parameter does not exist. Request parameters
are extra information sent with the request. For HTTP servlets,
parameters are contained in the query string or posted form data.
You should only use this method when you are sure the
parameter has only one value. If the parameter might have
more than one value, use ServletRequest.getParameterValues(java.lang.String)
.
If you use this method with a multivalued
parameter, the value returned is equal to the first value
in the array returned by getParameterValues
.
If the parameter data was sent in the request body, such as occurs
with an HTTP POST request, then reading the body directly via ServletRequest.getInputStream()
or ServletRequest.getReader()
can interfere
with the execution of this method.
getParameter
in interface ServletRequest
name
- a String
specifying the
name of the parameter
String
representing the
single value of the parameterServletRequest.getParameterValues(java.lang.String)
public java.util.Enumeration getParameterNames()
ServletRequest
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 java.lang.String[] getParameterValues(java.lang.String name)
ServletRequest
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 valuesServletRequest.getParameter(java.lang.String)
public java.lang.String getProtocol()
ServletRequest
SERVER_PROTOCOL
.
getProtocol
in interface ServletRequest
String
containing the protocol
name and version numberpublic java.lang.String getScheme()
ServletRequest
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 java.lang.String getServerName()
ServletRequest
Host
header, if any, or the resolved server name, or the server IP address.
getServerName
in interface ServletRequest
String
containing the name
of the serverpublic int getServerPort()
ServletRequest
Host
header, if any, or the server port where the client connection
was accepted on.
getServerPort
in interface ServletRequest
public int getRemotePort()
ServletRequest
getRemotePort
in interface ServletRequest
public java.lang.String getLocalName()
ServletRequest
getLocalName
in interface ServletRequest
String
containing the host
name of the IP on which the request was received.public java.lang.String getLocalAddr()
ServletRequest
getLocalAddr
in interface ServletRequest
String
containing the
IP address on which the request was received.public int getLocalPort()
ServletRequest
getLocalPort
in interface ServletRequest
public java.io.BufferedReader getReader() throws java.io.UnsupportedEncodingException
ServletRequest
BufferedReader
. The reader translates the character
data according to the character encoding used on the body.
Either this method or ServletRequest.getInputStream()
may be called to read the
body, not both.
getReader
in interface ServletRequest
BufferedReader
containing the body of the request
java.io.UnsupportedEncodingException
- if the character set encoding
used is not supported and the text cannot be decodedServletRequest.getInputStream()
public java.lang.String getRemoteAddr()
ServletRequest
REMOTE_ADDR
.
getRemoteAddr
in interface ServletRequest
String
containing the
IP address of the client that sent the requestpublic java.lang.String getRemoteHost()
ServletRequest
REMOTE_HOST
.
getRemoteHost
in interface ServletRequest
String
containing the fully
qualified name of the clientpublic java.lang.String getRealPath(java.lang.String path)
ServletContext.getRealPath(java.lang.String)
instead.
getRealPath
in interface ServletRequest
public RequestDispatcher getRequestDispatcher(java.lang.String url)
ServletRequest
RequestDispatcher
object that acts as a wrapper for
the resource located at the given path.
A RequestDispatcher
object can be used to forward
a request to the resource or to include the resource in a response.
The resource can be dynamic or static.
The pathname specified may be relative, although it cannot extend
outside the current servlet context. If the path begins with
a "/" it is interpreted as relative to the current context root.
This method returns null
if the servlet container
cannot return a RequestDispatcher
.
The difference between this method and ServletContext.getRequestDispatcher(java.lang.String)
is that this method can take a
relative path.
getRequestDispatcher
in interface ServletRequest
url
- a String
specifying the pathname to the
resource. If it is relative, it must be relative against the
current servlet.
RequestDispatcher
object that acts as a
wrapper for the resource at the specified path, or null
if the servlet container cannot return a
RequestDispatcher
RequestDispatcher
,
ServletContext.getRequestDispatcher(java.lang.String)
public java.lang.String toString()
public static ServletHttpRequest unwrap(ServletRequest request)
request
-
ServletRequestWrapper
,
HttpServletRequestWrapper
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |