Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.mortbay.jetty.servlet.ServletHttpRequest
Field Summary | |
static String | |
static String | |
static String | |
static String |
Fields inherited from interface javax.servlet.http.HttpServletRequest | |
BASIC_AUTH , CLIENT_CERT_AUTH , DIGEST_AUTH , FORM_AUTH |
Constructor Summary | |
|
Method Summary | |
Object |
|
Enumeration |
|
String |
|
String |
|
int |
|
String |
|
String |
|
Cookie[] |
|
long |
|
String |
|
Enumeration |
|
Enumeration |
|
ServletInputStream |
|
int |
|
String |
|
String |
|
int |
|
Locale |
|
Enumeration |
|
String |
|
String |
|
Map |
|
Enumeration |
|
String[] |
|
String |
|
String |
|
String |
|
String |
|
BufferedReader |
|
String |
|
String |
|
String |
|
int |
|
String |
|
RequestDispatcher |
|
String |
|
StringBuffer |
|
String |
|
String |
|
String |
|
int |
|
ServletHttpResponse | |
String |
|
HttpSession |
|
HttpSession |
|
Principal |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
void |
|
void |
|
void |
|
String |
|
static ServletHttpRequest |
|
public static final String __SESSIONID_COOKIE
public static final String __SESSIONID_NONE
public static final String __SESSIONID_NOT_CHECKED
public static final String __SESSIONID_URL
public ServletHttpRequest(ServletHandler servletHandler, String pathInContext, HttpRequest request)
Constructor.
public Object getAttribute(String name)
Returns the value of the named attribute as anObject
, ornull
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 attributejavax.servlet.request.X509Certificate
can be used to retrieve information on the certificate of the client. Attributes can also be set programatically usingServletRequest.setAttribute(String,Object)
. This allows information to be embedded into a request before aRequestDispatcher
call. Attribute names should follow the same conventions as package names. This specification reserves names matchingjava.*
,javax.*
, andsun.*
.
- Specified by:
- getAttribute in interface ServletRequest
- Parameters:
name
- aString
specifying the name of the attribute
- Returns:
- an
Object
containing the value of the attribute, ornull
if the attribute does not exist
public Enumeration getAttributeNames()
Returns anEnumeration
containing the names of the attributes available to this request. This method returns an emptyEnumeration
if the request has no attributes available to it.
- Specified by:
- getAttributeNames in interface ServletRequest
- Returns:
- an
Enumeration
of strings containing the names of the request's attributes
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.
- Specified by:
- getAuthType in interface HttpServletRequest
- 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 getCharacterEncoding()
Returns the name of the character encoding used in the body of this request. This method returnsnull
if the request does not specify a character encoding
- Specified by:
- getCharacterEncoding in interface ServletRequest
- Returns:
- a
String
containing the name of the chararacter encoding, ornull
if the request does not specify a character encoding
public 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. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.
- Specified by:
- getContentLength in interface ServletRequest
- Returns:
- an integer containing the length of the request body or -1 if the length is not known
public String getContentType()
Returns the MIME type of the body of the request, ornull
if the type is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE.
- Specified by:
- getContentType in interface ServletRequest
- Returns:
- a
String
containing the name of the MIME type of the request, or null if the type is not known
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.
- Specified by:
- getContextPath in interface HttpServletRequest
- 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.
- Specified by:
- getCookies in interface HttpServletRequest
- 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
.
- Specified by:
- getDateHeader in interface HttpServletRequest
- 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 reqest
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.
- Specified by:
- getHeader in interface HttpServletRequest
- 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
- Specified by:
- getHeaderNames in interface HttpServletRequest
- 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 s)
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.
- Specified by:
- getHeaders in interface HttpServletRequest
- Parameters:
- 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 ServletInputStream getInputStream()
Retrieves the body of the request as binary data using aServletInputStream
. Either this method orServletRequest.getReader()
may be called to read the body, not both.
- Specified by:
- getInputStream in interface ServletRequest
- Returns:
- a
ServletInputStream
object containing the body of the request
public int getIntHeader(String name) throws NumberFormatException
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.
- Specified by:
- getIntHeader in interface HttpServletRequest
- 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 getLocalAddr()
Returns the Internet Protocol (IP) address of the interface on which the request was received.
- Specified by:
- getLocalAddr in interface ServletRequest
- Returns:
- a
String
containing the IP address on which the request was received.
- Since:
- Servlet 2.4
public String getLocalName()
Returns the host name of the Internet Protocol (IP) interface on which the request was received.
- Specified by:
- getLocalName in interface ServletRequest
- Returns:
- a
String
containing the host name of the IP on which the request was received.
- Since:
- Servlet 2.4
public int getLocalPort()
Returns the Internet Protocol (IP) port number of the interface on which the request was received.
- Specified by:
- getLocalPort in interface ServletRequest
- Returns:
- an integer specifying the port number
- Since:
- Servlet 2.4
public Locale getLocale()
Returns the preferredLocale
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.
- Specified by:
- getLocale in interface ServletRequest
- Returns:
- the preferred
Locale
for the client
public Enumeration getLocales()
Returns anEnumeration
ofLocale
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 anEnumeration
containing oneLocale
, the default locale for the server.
- Specified by:
- getLocales in interface ServletRequest
- Returns:
- an
Enumeration
of preferredLocale
objects for the client
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.
- Specified by:
- getMethod in interface HttpServletRequest
- Returns:
- a
String
specifying the name of the method with which this request was made
public String getParameter(String name)
Returns the value of a request parameter as aString
, ornull
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, useServletRequest.getParameterValues(String)
. If you use this method with a multivalued parameter, the value returned is equal to the first value in the array returned bygetParameterValues
. If the parameter data was sent in the request body, such as occurs with an HTTP POST request, then reading the body directly viaServletRequest.getInputStream()
orServletRequest.getReader()
can interfere with the execution of this method.
- Specified by:
- getParameter in interface ServletRequest
- Parameters:
name
- aString
specifying the name of the parameter
- Returns:
- a
String
representing the single value of the parameter
public Map getParameterMap()
This method is not recommended as it forces the generation of a non-optimal data structure.
- Specified by:
- getParameterMap in interface ServletRequest
public Enumeration getParameterNames()
Returns anEnumeration
ofString
objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an emptyEnumeration
.
- Specified by:
- getParameterNames in interface ServletRequest
- Returns:
- an
Enumeration
ofString
objects, eachString
containing the name of a request parameter; or an emptyEnumeration
if the request has no parameters
public String[] getParameterValues(String name)
Returns an array ofString
objects containing all of the values the given request parameter has, ornull
if the parameter does not exist. If the parameter has a single value, the array has a length of 1.
- Specified by:
- getParameterValues in interface ServletRequest
- Parameters:
name
- aString
containing the name of the parameter whose value is requested
- Returns:
- an array of
String
objects containing the parameter's values
- See Also:
ServletRequest.getParameter(String)
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.
- Specified by:
- getPathInfo in interface HttpServletRequest
- 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.
- Specified by:
- getPathTranslated in interface HttpServletRequest
- Returns:
- a
String
specifying the real path, ornull
if the URL does not have any extra path information
public String getProtocol()
Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1. For HTTP servlets, the value returned is the same as the value of the CGI variableSERVER_PROTOCOL
.
- Specified by:
- getProtocol in interface ServletRequest
- Returns:
- a
String
containing the protocol name and version number
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.
- Specified by:
- getQueryString in interface HttpServletRequest
- Returns:
- a
String
containing the query string ornull
if the URL contains no query string. The value is not decoded by the container.
public BufferedReader getReader() throws UnsupportedEncodingException
Retrieves the body of the request as character data using aBufferedReader
. The reader translates the character data according to the character encoding used on the body. Either this method orServletRequest.getInputStream()
may be called to read the body, not both.
- Specified by:
- getReader in interface ServletRequest
- Returns:
- a
BufferedReader
containing the body of the request
- See Also:
ServletRequest.getInputStream()
public String getRealPath(String path)
Deprecated. As of Version 2.1 of the Java Servlet API, use
ServletContext.getRealPath(String)
instead.
- Specified by:
- getRealPath in interface ServletRequest
public String getRemoteAddr()
Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. For HTTP servlets, same as the value of the CGI variableREMOTE_ADDR
.
- Specified by:
- getRemoteAddr in interface ServletRequest
- Returns:
- a
String
containing the IP address of the client that sent the request
public String getRemoteHost()
Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variableREMOTE_HOST
.
- Specified by:
- getRemoteHost in interface ServletRequest
- Returns:
- a
String
containing the fully qualified name of the client
public int getRemotePort()
Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
- Specified by:
- getRemotePort in interface ServletRequest
- Since:
- Servlet 2.4
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.
- Specified by:
- getRemoteUser in interface HttpServletRequest
- Returns:
- a
String
specifying the login of the user making this request, ornull
if the user login is not known
public RequestDispatcher getRequestDispatcher(String url)
Returns aRequestDispatcher
object that acts as a wrapper for the resource located at the given path. ARequestDispatcher
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 returnsnull
if the servlet container cannot return aRequestDispatcher
. The difference between this method andServletContext.getRequestDispatcher(String)
is that this method can take a relative path.
- Specified by:
- getRequestDispatcher in interface ServletRequest
- Parameters:
- Returns:
- a
RequestDispatcher
object that acts as a wrapper for the resource at the specified path, ornull
if the servlet container cannot return aRequestDispatcher
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)
.
- Specified by:
- getRequestURI in interface 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.
- Specified by:
- getRequestURL in interface HttpServletRequest
- 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
.
- Specified by:
- getRequestedSessionId in interface HttpServletRequest
- Returns:
- a
String
specifying the session ID, ornull
if the request did not specify a session ID
public String getScheme()
Returns the name of the scheme used to make this request, for example,http
,https
, orftp
. Different schemes have different rules for constructing URLs, as noted in RFC 1738.
- Specified by:
- getScheme in interface ServletRequest
- Returns:
- a
String
containing the name of the scheme used to make this request
public String getServerName()
Returns the host name of the server to which the request was sent. It is the value of the part before ":" in theHost
header, if any, or the resolved server name, or the server IP address.
- Specified by:
- getServerName in interface ServletRequest
- Returns:
- a
String
containing the name of the server
public int getServerPort()
Returns the port number to which the request was sent. It is the value of the part after ":" in theHost
header, if any, or the server port where the client connection was accepted on.
- Specified by:
- getServerPort in interface ServletRequest
- Returns:
- an integer specifying the port number
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.
- Specified by:
- getServletPath in interface HttpServletRequest
- 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.
- Specified by:
- getSession in interface HttpServletRequest
- Returns:
- the
HttpSession
associated with this request
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.
- Specified by:
- getSession in interface HttpServletRequest
- 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:
HttpServletRequest.getSession()
public 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
.
- Specified by:
- getUserPrincipal in interface HttpServletRequest
- 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.
- Specified by:
- isRequestedSessionIdFromCookie in interface HttpServletRequest
- 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.
- Specified by:
- isRequestedSessionIdFromURL in interface HttpServletRequest
- Returns:
true
if the session ID came in as part of a URL; otherwise,false
- See Also:
getSession
public boolean isRequestedSessionIdFromUrl()
Deprecated.
- Specified by:
- isRequestedSessionIdFromUrl in interface HttpServletRequest
public boolean isRequestedSessionIdValid()
Checks whether the requested session ID is still valid.
- Specified by:
- isRequestedSessionIdValid in interface HttpServletRequest
- Returns:
true
if this request has an id for a valid session in the current session context;false
otherwise
- See Also:
HttpServletRequest.getRequestedSessionId()
,getSession
,HttpSessionContext
public boolean isSecure()
Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
- Specified by:
- isSecure in interface ServletRequest
- Returns:
- a boolean indicating if the request was made using a secure channel
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
.
- Specified by:
- isUserInRole in interface HttpServletRequest
- 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
public void removeAttribute(String name)
Removes an attribute from this request. 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 withjava.*
,javax.*
, andcom.sun.*
, are reserved for use by Sun Microsystems.
- Specified by:
- removeAttribute in interface ServletRequest
- Parameters:
name
- aString
specifying the name of the attribute to remove
public void setAttribute(String name, Object value)
Stores an attribute in this request. Attributes are reset between requests. This method is most often used in conjunction withRequestDispatcher
. Attribute names should follow the same conventions as package names. Names beginning withjava.*
,javax.*
, andcom.sun.*
, are reserved for use by Sun Microsystems.
If the object passed in is null, the effect is the same as callingServletRequest.removeAttribute(String)
.
- Specified by:
- setAttribute in interface ServletRequest
- Parameters:
name
- aString
specifying the name of the attribute
public void setCharacterEncoding(String encoding) throws UnsupportedEncodingException
Overrides the name of the character encoding used in the body of this request. This method must be called prior to reading request parameters or reading input using getReader().
- Specified by:
- setCharacterEncoding in interface ServletRequest
- Parameters:
public String toString()
public static ServletHttpRequest unwrap(ServletRequest request)
Unwrap a ServletRequest.
- Parameters:
request
-
- Returns:
- The core ServletHttpRequest which must be the underlying request object