| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.catalina.connector.Request
public class Request
Wrapper object for the Coyote request.
| Field Summary | |
|---|---|
| protected  java.util.HashMap | attributesThe attributes associated with this Request, keyed by attribute name. | 
| protected  java.lang.String | authTypeAuthentication type. | 
| protected static int | CACHED_POST_LENPost data buffer. | 
| protected  boolean | cometComet state | 
| protected  Connector | connectorAssociated Catalina connector. | 
| protected  Context | contextAssociated context. | 
| protected  javax.servlet.http.Cookie[] | cookiesThe set of cookies associated with this Request. | 
| protected  boolean | cookiesParsedCookies parsed flag. | 
| protected  Request | coyoteRequestCoyote request. | 
| protected static java.util.Locale | defaultLocaleThe default Locale if none are specified. | 
| protected  java.lang.Object | dispatcherTypeThe current dispatcher type. | 
| protected  CometEventImpl | eventAssociated event. | 
| protected  RequestFacade | facadeThe facade associated with this request. | 
| protected  javax.servlet.FilterChain | filterChainFilter chain associated with the request. | 
| protected  java.text.SimpleDateFormat[] | formatsThe set of SimpleDateFormat formats to use in getDateHeader(). | 
| protected static java.util.TimeZone | GMT_ZONE | 
| protected static java.lang.String | infoDescriptive information about this Request implementation. | 
| protected  InputBuffer | inputBufferThe associated input buffer. | 
| protected  CoyoteInputStream | inputStreamServletInputStream. | 
| protected  java.lang.String | localAddrLocal address | 
| protected  java.util.ArrayList | localesThe preferred Locales assocaited with this Request. | 
| protected  boolean | localesParsedParse locales. | 
| protected  java.lang.String | localNameLocal address | 
| protected  int | localPortLocal port | 
| protected  MappingData | mappingDataMapping data. | 
| protected  ParameterMap | parameterMapHash map used in the getParametersMap method. | 
| protected  boolean | parametersParsedRequest parameters parsed flag. | 
| protected  java.util.Map<java.lang.String,java.lang.String> | pathParametersPath parameters | 
| protected  byte[] | postData | 
| protected  CoyoteReader | readerReader. | 
| protected  java.lang.String | remoteAddrRemote address. | 
| protected  java.lang.String | remoteHostRemote host. | 
| protected  int | remotePortRemote port | 
| protected  java.lang.Object | requestDispatcherPathThe current request dispatcher path. | 
| protected  boolean | requestedSessionCookieWas the requested session ID received in a cookie? | 
| protected  java.lang.String | requestedSessionIdThe requested session ID (if any) for this request. | 
| protected  boolean | requestedSessionURLWas the requested session ID received in a URL? | 
| protected  Response | responseThe response with which this request is associated. | 
| protected  boolean | secureSecure flag. | 
| protected  Session | sessionThe currently active session for this request. | 
| protected  boolean | sessionParsedSession parsed flag. | 
| protected static StringManager | smThe string manager for this package. | 
| protected  boolean | sslAttributesParsedFlag that indicates if SSL attributes have been parsed to improve performance for applications (usually frameworks) that make multiple calls to getAttributeNames(). | 
| protected  javax.security.auth.Subject | subjectThe Subject associated with the current AccessControllerContext | 
| protected  B2CConverter | URIConverterURI byte to char converter (not recycled). | 
| protected  java.security.Principal | userPrincipalUser principal. | 
| protected  boolean | usingInputStreamUsing stream flag. | 
| protected  boolean | usingReaderUsing writer flag. | 
| protected  Wrapper | wrapperAssociated wrapper. | 
| Fields inherited from interface javax.servlet.http.HttpServletRequest | 
|---|
| BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH | 
| Constructor Summary | |
|---|---|
| Request() | |
| Method Summary | |
|---|---|
|  void | addCookie(javax.servlet.http.Cookie cookie)Add a Cookie to the set of Cookies associated with this Request. | 
|  void | addHeader(java.lang.String name,
          java.lang.String value)Add a Header to the set of Headers associated with this Request. | 
|  void | addLocale(java.util.Locale locale)Add a Locale to the set of preferred Locales for this Request. | 
|  void | addParameter(java.lang.String name,
             java.lang.String[] values)Add a parameter name and corresponding set of values to this Request. | 
| protected  void | addPathParameter(java.lang.String name,
                 java.lang.String value) | 
|  void | changeSessionId(java.lang.String newSessionId)Change the ID of the session that this request is associated with. | 
|  void | clearCookies()Clear the collection of Cookies associated with this Request. | 
|  void | clearEncoders()Clear cached encoders (to save memory for Comet requests). | 
|  void | clearHeaders()Clear the collection of Headers associated with this Request. | 
|  void | clearLocales()Clear the collection of Locales associated with this Request. | 
|  void | clearParameters()Clear the collection of parameters associated with this Request. | 
|  void | cometClose() | 
| protected  void | configureSessionCookie(javax.servlet.http.Cookie cookie)Configures the given JSESSIONID cookie. | 
|  javax.servlet.ServletInputStream | createInputStream()Create and return a ServletInputStream to read the content associated with this Request. | 
| protected  Session | doGetSession(boolean create) | 
|  void | finishRequest()Perform whatever actions are required to flush and close the input stream or reader, in a single operation. | 
|  java.lang.Object | getAttribute(java.lang.String name)Return the specified request attribute if it exists; otherwise, return null. | 
|  java.util.Enumeration | getAttributeNames()Return the names of all request attributes for this Request, or an empty Enumerationif there are none. | 
|  java.lang.String | getAuthType()Return the authentication type used for this Request. | 
|  boolean | getAvailable()Return true if bytes are available. | 
|  java.lang.String | getCharacterEncoding()Return the character encoding for this Request. | 
|  Connector | getConnector()Return the Connector through which this Request was received. | 
|  int | getContentLength()Return the content length for this Request. | 
|  java.lang.String | getContentType()Return the content type for this Request. | 
|  Context | getContext()Return the Context within which this Request is being processed. | 
|  java.lang.String | getContextPath()Return the portion of the request URI used to select the Context of the Request. | 
|  MessageBytes | getContextPathMB()Get the context path. | 
|  javax.servlet.http.Cookie[] | getCookies()Return the set of Cookies received with this Request. | 
|  Request | getCoyoteRequest()Get the Coyote request. | 
|  long | getDateHeader(java.lang.String name)Return the value of the specified date header, if any; otherwise return -1. | 
|  java.lang.String | getDecodedRequestURI()Get the decoded request URI. | 
|  MessageBytes | getDecodedRequestURIMB()Get the decoded request URI. | 
|  CometEventImpl | getEvent()Get the event associated with the request. | 
|  javax.servlet.FilterChain | getFilterChain()Get filter chain associated with the request. | 
|  java.lang.String | getHeader(java.lang.String name)Return the first value of the specified header, if any; otherwise, return null | 
|  java.util.Enumeration | getHeaderNames()Return the names of all headers received with this request. | 
|  java.util.Enumeration | getHeaders(java.lang.String name)Return all of the values of the specified header, if any; otherwise, return an empty enumeration. | 
|  Host | getHost()Return the Host within which this Request is being processed. | 
|  java.lang.String | getInfo()Return descriptive information about this Request implementation and the corresponding version number, in the format <description>/<version>. | 
|  javax.servlet.ServletInputStream | getInputStream()Return the servlet input stream for this Request. | 
|  int | getIntHeader(java.lang.String name)Return the value of the specified header as an integer, or -1 if there is no such header for this request. | 
|  java.lang.String | getLocalAddr()Returns the Internet Protocol (IP) address of the interface on which the request was received. | 
|  java.util.Locale | getLocale()Return the preferred Locale that the client will accept content in, based on the value for the first Accept-Languageheader
 that was encountered. | 
|  java.util.Enumeration | getLocales()Return the set of preferred Locales that the client will accept content in, based on the values for any Accept-Languageheaders that were encountered. | 
|  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. | 
|  MappingData | getMappingData()Return mapping data. | 
|  java.lang.String | getMethod()Return the HTTP request method used in this Request. | 
|  java.lang.Object | getNote(java.lang.String name)Return the object bound with the specified name to the internal notes for this request, or nullif no such binding exists. | 
|  java.util.Iterator | getNoteNames()Return an Iterator containing the String names of all notes bindings that exist for this request. | 
|  java.lang.String | getParameter(java.lang.String name)Return the value of the specified request parameter, if any; otherwise, return null. | 
|  java.util.Map | getParameterMap()Returns a Mapof the parameters of this request. | 
|  java.util.Enumeration | getParameterNames()Return the names of all defined request parameters for this request. | 
|  java.lang.String[] | getParameterValues(java.lang.String name)Return the defined values for the specified request parameter, if any; otherwise, return null. | 
|  java.lang.String | getPathInfo()Return the path information associated with this Request. | 
|  MessageBytes | getPathInfoMB()Get the path info. | 
| protected  java.lang.String | getPathParameter(java.lang.String name) | 
|  java.lang.String | getPathTranslated()Return the extra path information for this request, translated to a real path. | 
|  java.security.Principal | getPrincipal()Return the principal that has been authenticated for this Request. | 
|  java.lang.String | getProtocol()Return the protocol and version used to make this Request. | 
|  java.lang.String | getQueryString()Return the query string associated with this request. | 
|  java.io.BufferedReader | getReader()Read the Reader wrapping the input stream for this Request. | 
|  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 | getRemoteAddr()Return the remote IP address making this Request. | 
|  java.lang.String | getRemoteHost()Return the remote host name making this Request. | 
|  int | getRemotePort()Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request. | 
|  java.lang.String | getRemoteUser()Return the name of the remote user that has been authenticated for this Request. | 
|  javax.servlet.http.HttpServletRequest | getRequest()Return the ServletRequestfor which this object
 is the facade. | 
|  javax.servlet.RequestDispatcher | getRequestDispatcher(java.lang.String path)Return a RequestDispatcher that wraps the resource at the specified path, which may be interpreted as relative to the current request path. | 
|  java.lang.String | getRequestedSessionId()Return the session identifier included in this request, if any. | 
|  MessageBytes | getRequestPathMB()Get the request path. | 
|  java.lang.String | getRequestURI()Return the request URI for this request. | 
|  java.lang.StringBuffer | getRequestURL()Reconstructs the URL the client used to make the request. | 
|  Response | getResponse()Return the Response with which this Request is associated. | 
|  java.lang.String | getScheme()Return the scheme used to make this Request. | 
|  java.lang.String | getServerName()Return the server name responding to this Request. | 
|  int | getServerPort()Return the server port responding to this Request. | 
|  java.lang.String | getServletPath()Return the portion of the request URI used to select the servlet that will process this request. | 
|  MessageBytes | getServletPathMB()Get the servlet path. | 
|  javax.servlet.http.HttpSession | getSession()Return the session associated with this Request, creating one if necessary. | 
|  javax.servlet.http.HttpSession | getSession(boolean create)Return the session associated with this Request, creating one if necessary and requested. | 
|  Session | getSessionInternal()Return the session associated with this Request, creating one if necessary. | 
|  Session | getSessionInternal(boolean create)Return the session associated with this Request, creating one if necessary and requested. | 
|  java.io.InputStream | getStream()Return the input stream associated with this Request. | 
| protected  B2CConverter | getURIConverter()Return the URI converter. | 
|  java.security.Principal | getUserPrincipal()Return the principal that has been authenticated for this Request. | 
|  Wrapper | getWrapper()Return the Wrapper within which this Request is being processed. | 
| protected static boolean | isAlpha(java.lang.String value) | 
|  boolean | isComet()Return true if the current request is handling Comet traffic. | 
|  boolean | isParametersParsed()return true if we have parsed parameters | 
|  boolean | isRequestedSessionIdFromCookie()Return trueif the session identifier included in this
 request came from a cookie. | 
|  boolean | isRequestedSessionIdFromUrl()Deprecated. As of Version 2.1 of the Java Servlet API, use isRequestedSessionIdFromURL()instead. | 
|  boolean | isRequestedSessionIdFromURL()Return trueif the session identifier included in this
 request came from the request URI. | 
|  boolean | isRequestedSessionIdValid()Return trueif the session identifier included in this
 request identifies a valid session. | 
|  boolean | isSecure()Was this request received on a secure connection? | 
|  boolean | isUserInRole(java.lang.String role)Return trueif the authenticated user principal
 possesses the specified role name. | 
| protected  void | parseCookies()Parse cookies. | 
| protected  void | parseLocales()Parse request locales. | 
| protected  void | parseLocalesHeader(java.lang.String value)Parse accept-language header value. | 
| protected  void | parseParameters()Parse request parameters. | 
|  boolean | read()Clear cached encoders (to save memory for Comet requests). | 
| protected  byte[] | readChunkedPostBody()Read chunked post body. | 
| protected  int | readPostBody(byte[] body,
             int len)Read post body in an array. | 
|  void | recycle()Release all object references, and initialize instance variables, in preparation for reuse of this object. | 
|  void | removeAttribute(java.lang.String name)Remove the specified request attribute if it exists. | 
|  void | removeNote(java.lang.String name)Remove any object bound to the specified name in the internal notes for this request. | 
|  void | setAttribute(java.lang.String name,
             java.lang.Object value)Set the specified request attribute to the specified value. | 
|  void | setAuthType(java.lang.String type)Set the authentication type used for this request, if any; otherwise set the type to null. | 
|  void | setCharacterEncoding(java.lang.String enc)Overrides the name of the character encoding used in the body of this request. | 
|  void | setComet(boolean comet)Set comet state. | 
|  void | setCometTimeout(long timeout) | 
|  void | setConnector(Connector connector)Set the Connector through which this Request was received. | 
|  void | setContentLength(int length)Set the content length associated with this Request. | 
|  void | setContentType(java.lang.String type)Set the content type (and optionally the character encoding) associated with this Request. | 
|  void | setContext(Context context)Set the Context within which this Request is being processed. | 
|  void | setContextPath(java.lang.String path)Set the context path for this Request. | 
|  void | setCookies(javax.servlet.http.Cookie[] cookies)Set the set of cookies recieved with this Request. | 
|  void | setCoyoteRequest(Request coyoteRequest)Set the Coyote request. | 
|  void | setDecodedRequestURI(java.lang.String uri)Set the decoded request URI. | 
|  void | setFilterChain(javax.servlet.FilterChain filterChain)Set filter chain associated with the request. | 
|  void | setHost(Host host)Set the Host within which this Request is being processed. | 
|  void | setMethod(java.lang.String method)Set the HTTP request method used for this Request. | 
|  void | setNote(java.lang.String name,
        java.lang.Object value)Bind an object to a specified name in the internal notes associated with this request, replacing any existing binding for this name. | 
|  void | setPathInfo(java.lang.String path)Set the path information for this Request. | 
|  void | setProtocol(java.lang.String protocol)Set the protocol name and version associated with this Request. | 
|  void | setQueryString(java.lang.String query)Set the query string for this Request. | 
|  void | setRemoteAddr(java.lang.String remoteAddr)Set the IP address of the remote client associated with this Request. | 
|  void | setRemoteHost(java.lang.String remoteHost)Set the fully qualified name of the remote client associated with this Request. | 
|  void | setRequestedSessionCookie(boolean flag)Set a flag indicating whether or not the requested session ID for this request came in through a cookie. | 
|  void | setRequestedSessionId(java.lang.String id)Set the requested session ID for this request. | 
|  void | setRequestedSessionURL(boolean flag)Set a flag indicating whether or not the requested session ID for this request came in through a URL. | 
|  void | setRequestURI(java.lang.String uri)Set the unparsed request URI for this Request. | 
|  void | setResponse(Response response)Set the Response with which this Request is associated. | 
|  void | setScheme(java.lang.String scheme)Set the name of the scheme associated with this request. | 
|  void | setSecure(boolean secure)Set the value to be returned by isSecure()for this Request. | 
|  void | setServerName(java.lang.String name)Set the name of the server (virtual host) to process this request. | 
|  void | setServerPort(int port)Set the port number of the server to process this request. | 
|  void | setServletPath(java.lang.String path)Set the servlet path for this Request. | 
|  void | setStream(java.io.InputStream stream)Set the input stream associated with this Request. | 
| protected  void | setURIConverter(B2CConverter URIConverter)Set the URI converter. | 
|  void | setUserPrincipal(java.security.Principal principal)Set the Principal who has been authenticated for this Request. | 
|  void | setWrapper(Wrapper wrapper)Set the Wrapper within which this Request is being processed. | 
| protected  java.lang.String | unescape(java.lang.String s) | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
|---|
protected Request coyoteRequest
protected static final java.util.TimeZone GMT_ZONE
protected static StringManager sm
protected javax.servlet.http.Cookie[] cookies
protected java.text.SimpleDateFormat[] formats
protected static java.util.Locale defaultLocale
protected java.util.HashMap attributes
protected boolean sslAttributesParsed
getAttributeNames().
protected java.util.ArrayList locales
protected java.lang.String authType
protected CometEventImpl event
protected boolean comet
protected java.lang.Object dispatcherType
protected InputBuffer inputBuffer
protected CoyoteInputStream inputStream
protected CoyoteReader reader
protected boolean usingInputStream
protected boolean usingReader
protected java.security.Principal userPrincipal
protected boolean sessionParsed
protected boolean parametersParsed
protected boolean cookiesParsed
protected boolean secure
protected transient javax.security.auth.Subject subject
protected static int CACHED_POST_LEN
protected byte[] postData
protected ParameterMap parameterMap
protected Session session
protected java.lang.Object requestDispatcherPath
protected boolean requestedSessionCookie
protected java.lang.String requestedSessionId
protected boolean requestedSessionURL
protected boolean localesParsed
protected int localPort
protected java.lang.String remoteAddr
protected java.lang.String remoteHost
protected int remotePort
protected java.lang.String localAddr
protected java.lang.String localName
protected java.util.Map<java.lang.String,java.lang.String> pathParameters
protected Connector connector
protected Context context
protected javax.servlet.FilterChain filterChain
protected static final java.lang.String info
protected MappingData mappingData
protected RequestFacade facade
protected Response response
protected B2CConverter URIConverter
protected Wrapper wrapper
| Constructor Detail | 
|---|
public Request()
| Method Detail | 
|---|
public void setCoyoteRequest(Request coyoteRequest)
coyoteRequest - The Coyote requestpublic Request getCoyoteRequest()
protected void addPathParameter(java.lang.String name,
                                java.lang.String value)
protected java.lang.String getPathParameter(java.lang.String name)
public void recycle()
public void clearEncoders()
public boolean read()
             throws java.io.IOException
java.io.IOExceptionpublic Connector getConnector()
public void setConnector(Connector connector)
connector - The new connectorpublic Context getContext()
public void setContext(Context context)
getContextPath(),
 and thus enables parsing of the request URI.
context - The newly associated Contextpublic javax.servlet.FilterChain getFilterChain()
public void setFilterChain(javax.servlet.FilterChain filterChain)
filterChain - new filter chainpublic Host getHost()
public void setHost(Host host)
host - The newly associated Hostpublic java.lang.String getInfo()
<description>/<version>.
public MappingData getMappingData()
public javax.servlet.http.HttpServletRequest getRequest()
ServletRequest for which this object
 is the facade.  This method must be implemented by a subclass.
public Response getResponse()
public void setResponse(Response response)
response - The new associated responsepublic java.io.InputStream getStream()
public void setStream(java.io.InputStream stream)
stream - The new input streamprotected B2CConverter getURIConverter()
protected void setURIConverter(B2CConverter URIConverter)
URIConverter - the new URI connverterpublic Wrapper getWrapper()
public void setWrapper(Wrapper wrapper)
wrapper - The newly associated Wrapper
public javax.servlet.ServletInputStream createInputStream()
                                                   throws java.io.IOException
java.io.IOException - if an input/output error occurs
public void finishRequest()
                   throws java.io.IOException
java.io.IOException - if an input/output error occurspublic java.lang.Object getNote(java.lang.String name)
null if no such binding exists.
name - Name of the note to be returnedpublic java.util.Iterator getNoteNames()
public void removeNote(java.lang.String name)
name - Name of the note to be removed
public void setNote(java.lang.String name,
                    java.lang.Object value)
name - Name to which the object should be boundvalue - Object to be bound to the specified namepublic void setContentLength(int length)
length - The new content lengthpublic void setContentType(java.lang.String type)
text/html; charset=ISO-8859-4.
type - The new content typepublic void setProtocol(java.lang.String protocol)
protocol - Protocol name and versionpublic void setRemoteAddr(java.lang.String remoteAddr)
remoteAddr - The remote IP addresspublic void setRemoteHost(java.lang.String remoteHost)
remoteHost - The remote host namepublic void setScheme(java.lang.String scheme)
http, https, and ftp.
scheme - The schemepublic void setSecure(boolean secure)
isSecure()
 for this Request.
secure - The new isSecure valuepublic void setServerName(java.lang.String name)
name - The server namepublic void setServerPort(int port)
port - The server portpublic java.lang.Object getAttribute(java.lang.String name)
null.
getAttribute in interface javax.servlet.ServletRequestname - Name of the request attribute to return
Object containing the value 
                        of the attribute, or null if
                        the attribute does not existpublic java.util.Enumeration getAttributeNames()
Enumeration if there are none. Note that the attribute
 names return will only be those for the attributes set via
 setAttribute(String, Object). Tomcat internal attributes will
 not be included although they are accessible via
 getAttribute(String). The Tomcat internal attributes include:
 Globals.DISPATCHER_TYPE_ATTRGlobals.DISPATCHER_REQUEST_PATH_ATTRGlobals.CERTIFICATES_ATTR (SSL connections only)Globals.CIPHER_SUITE_ATTR (SSL connections only)Globals.KEY_SIZE_ATTR (SSL connections only)Globals.SSL_SESSION_ID_ATTR (SSL connections only)Globals.PARAMETER_PARSE_FAILED_ATTR
getAttributeNames in interface javax.servlet.ServletRequestEnumeration of strings 
                        containing the names 
                        of the request's attributespublic java.lang.String getCharacterEncoding()
getCharacterEncoding in interface javax.servlet.ServletRequestString containing the name of 
                        the character encoding, or null
                        if the request does not specify a character encodingpublic int getContentLength()
getContentLength in interface javax.servlet.ServletRequestpublic java.lang.String getContentType()
getContentType in interface javax.servlet.ServletRequestString containing the name 
                        of the MIME type of 
                        the request, or null if the type is not known
public javax.servlet.ServletInputStream getInputStream()
                                                throws java.io.IOException
createInputStream().
getInputStream in interface javax.servlet.ServletRequestServletInputStream object containing
                                the body of the request
java.lang.IllegalStateException - if getReader() has
  already been called for this request
java.io.IOException - if an input/output error occurspublic java.util.Locale getLocale()
Accept-Language header
 that was encountered.  If the request did not specify a preferred
 language, the server's default Locale is returned.
getLocale in interface javax.servlet.ServletRequestLocale for the clientpublic java.util.Enumeration getLocales()
Accept-Language
 headers that were encountered.  If the request did not specify a
 preferred language, the server's default Locale is returned.
getLocales in interface javax.servlet.ServletRequestEnumeration of preferred 
                  Locale objects for the clientpublic java.lang.String getParameter(java.lang.String name)
null.  If there is more than one value defined,
 return only the first one.
getParameter in interface javax.servlet.ServletRequestname - Name of the desired request parameter
String representing the 
                        single value of the parameterServletRequest.getParameterValues(java.lang.String)public java.util.Map getParameterMap()
Map of the parameters of this request.
 Request parameters are extra information sent with the request.
 For HTTP servlets, parameters are contained in the query string
 or posted form data.
getParameterMap in interface javax.servlet.ServletRequestMap containing parameter names as keys
  and parameter values as map values.public java.util.Enumeration getParameterNames()
getParameterNames in interface javax.servlet.ServletRequestEnumeration 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)
null.
getParameterValues in interface javax.servlet.ServletRequestname - Name of the desired request parameter
String objects 
                        containing the parameter's valuesServletRequest.getParameter(java.lang.String)public java.lang.String getProtocol()
getProtocol in interface javax.servlet.ServletRequestString containing the protocol 
                        name and version number
public java.io.BufferedReader getReader()
                                 throws java.io.IOException
BufferedReader around the
 servlet input stream returned by createInputStream().
getReader in interface javax.servlet.ServletRequestBufferedReader
                                                containing the body of the request
java.lang.IllegalStateException - if getInputStream()
  has already been called for this request
java.io.IOException - if an input/output error occursServletRequest.getInputStream()public java.lang.String getRealPath(java.lang.String path)
ServletContext.getRealPath().
getRealPath in interface javax.servlet.ServletRequestpath - Path to be translatedpublic java.lang.String getRemoteAddr()
getRemoteAddr in interface javax.servlet.ServletRequestString containing the 
                        IP address of the client that sent the requestpublic java.lang.String getRemoteHost()
getRemoteHost in interface javax.servlet.ServletRequestString containing the fully 
                        qualified name of the clientpublic int getRemotePort()
getRemotePort in interface javax.servlet.ServletRequestpublic java.lang.String getLocalName()
getLocalName in interface javax.servlet.ServletRequestString containing the host
                name of the IP on which the request was received.public java.lang.String getLocalAddr()
getLocalAddr in interface javax.servlet.ServletRequestString containing the
                IP address on which the request was received.public int getLocalPort()
getLocalPort in interface javax.servlet.ServletRequestpublic javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
getRequestDispatcher in interface javax.servlet.ServletRequestpath - Path of the resource to be wrapped
RequestDispatcher object
                  that acts as a wrapper for the resource
                  at the specified path, or null
                  if the servlet container cannot return a
                  RequestDispatcherRequestDispatcher, 
ServletContext.getRequestDispatcher(java.lang.String)public java.lang.String getScheme()
getScheme in interface javax.servlet.ServletRequestString containing the name 
                        of the scheme used to make this requestpublic java.lang.String getServerName()
getServerName in interface javax.servlet.ServletRequestString containing the name 
                        of the serverpublic int getServerPort()
getServerPort in interface javax.servlet.ServletRequestpublic boolean isSecure()
isSecure in interface javax.servlet.ServletRequestpublic void removeAttribute(java.lang.String name)
removeAttribute in interface javax.servlet.ServletRequestname - Name of the request attribute to remove
public void setAttribute(java.lang.String name,
                         java.lang.Object value)
setAttribute in interface javax.servlet.ServletRequestname - Name of the request attribute to setvalue - The associated value
public void setCharacterEncoding(java.lang.String enc)
                          throws java.io.UnsupportedEncodingException
getReader().
setCharacterEncoding in interface javax.servlet.ServletRequestenc - The character encoding to be used
java.io.UnsupportedEncodingException - if the specified encoding
  is not supportedpublic void addCookie(javax.servlet.http.Cookie cookie)
cookie - The new cookie
public void addHeader(java.lang.String name,
                      java.lang.String value)
name - The new header namevalue - The new header valuepublic void addLocale(java.util.Locale locale)
locale - The new preferred Locale
public void addParameter(java.lang.String name,
                         java.lang.String[] values)
name - Name of this request parametervalues - Corresponding values for this request parameterpublic void clearCookies()
public void clearHeaders()
public void clearLocales()
public void clearParameters()
public void setAuthType(java.lang.String type)
null.  Typical values are "BASIC",
 "DIGEST", or "SSL".
type - The authentication type usedpublic void setContextPath(java.lang.String path)
path - The context pathpublic void setMethod(java.lang.String method)
method - The request methodpublic void setQueryString(java.lang.String query)
query - The query stringpublic void setPathInfo(java.lang.String path)
path - The path informationpublic void setRequestedSessionCookie(boolean flag)
flag - The new flagpublic void setRequestedSessionId(java.lang.String id)
id - The new session idpublic void setRequestedSessionURL(boolean flag)
flag - The new flagpublic void setRequestURI(java.lang.String uri)
uri - The request URIpublic void setDecodedRequestURI(java.lang.String uri)
uri - The decoded request URIpublic java.lang.String getDecodedRequestURI()
public MessageBytes getDecodedRequestURIMB()
public void setServletPath(java.lang.String path)
path - The servlet pathpublic void setUserPrincipal(java.security.Principal principal)
getRemoteUser() method.
principal - The user Principalpublic java.lang.String getAuthType()
getAuthType in interface javax.servlet.http.HttpServletRequestnull if the request was 
                        not authenticated.public java.lang.String getContextPath()
getContextPath in interface javax.servlet.http.HttpServletRequestString specifying the
                        portion of the request URI that indicates the context
                        of the requestpublic MessageBytes getContextPathMB()
public javax.servlet.http.Cookie[] getCookies()
getCookies in interface javax.servlet.http.HttpServletRequestCookies
                        included with this request, or null
                        if the request has no cookiespublic void setCookies(javax.servlet.http.Cookie[] cookies)
public long getDateHeader(java.lang.String name)
getDateHeader in interface javax.servlet.http.HttpServletRequestname - Name of the requested date 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
java.lang.IllegalArgumentException - if the specified header value
  cannot be converted to a datepublic java.lang.String getHeader(java.lang.String name)
null
getHeader in interface javax.servlet.http.HttpServletRequestname - Name of the requested header
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 name)
getHeaders in interface javax.servlet.http.HttpServletRequestname - Name of the requested header
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 java.util.Enumeration getHeaderNames()
getHeaderNames in interface javax.servlet.http.HttpServletRequestnullpublic int getIntHeader(java.lang.String name)
getIntHeader in interface javax.servlet.http.HttpServletRequestname - Name of the requested header
java.lang.IllegalArgumentException - if the specified header value
  cannot be converted to an integerpublic java.lang.String getMethod()
getMethod in interface javax.servlet.http.HttpServletRequestString 
                                specifying the name
                                of the method with which
                                this request was madepublic java.lang.String getPathInfo()
getPathInfo in interface javax.servlet.http.HttpServletRequestString, 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 MessageBytes getPathInfoMB()
public java.lang.String getPathTranslated()
getPathTranslated in interface javax.servlet.http.HttpServletRequestString specifying the
                        real path, or null if
                        the URL does not have any extra path
                        informationpublic java.lang.String getQueryString()
getQueryString in interface javax.servlet.http.HttpServletRequestString 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 getRemoteUser()
getRemoteUser in interface javax.servlet.http.HttpServletRequestString specifying the login
                        of the user making this request, or null
                        if the user login is not knownpublic MessageBytes getRequestPathMB()
public java.lang.String getRequestedSessionId()
getRequestedSessionId in interface javax.servlet.http.HttpServletRequestString specifying the session
                        ID, or null if the request did
                        not specify a session IDHttpServletRequest.isRequestedSessionIdValid()public java.lang.String getRequestURI()
getRequestURI in interface javax.servlet.http.HttpServletRequestString containing
                        the part of the URL from the 
                        protocol name up to the query stringpublic java.lang.StringBuffer 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.
getRequestURL in interface javax.servlet.http.HttpServletRequestStringBuffer object containing the
  reconstructed URLpublic java.lang.String getServletPath()
getServletPath in interface javax.servlet.http.HttpServletRequestString 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 MessageBytes getServletPathMB()
public javax.servlet.http.HttpSession getSession()
getSession in interface javax.servlet.http.HttpServletRequestHttpSession associated
                        with this requestHttpServletRequest.getSession(boolean)public javax.servlet.http.HttpSession getSession(boolean create)
getSession in interface javax.servlet.http.HttpServletRequestcreate - Create a new session if one does not exist
HttpSession associated 
                        with this request or null if
                        create is false
                        and the request has no valid sessionHttpServletRequest.getSession()public boolean isRequestedSessionIdFromCookie()
true if the session identifier included in this
 request came from a cookie.
isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequesttrue if the session ID
                                came in as a
                                cookie; otherwise, falseHttpServletRequest.getSession(boolean)public boolean isRequestedSessionIdFromURL()
true if the session identifier included in this
 request came from the request URI.
isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequesttrue if the session ID
                                came in as part of a URL; otherwise,
                                falseHttpServletRequest.getSession(boolean)public boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromURL() instead.
true if the session identifier included in this
 request came from the request URI.
isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequestpublic boolean isRequestedSessionIdValid()
true if the session identifier included in this
 request identifies a valid session.
isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequesttrue if this
                                request has an id for a valid session
                                in the current session context;
                                false otherwiseHttpServletRequest.getRequestedSessionId(), 
HttpServletRequest.getSession(boolean), 
HttpSessionContextpublic boolean isUserInRole(java.lang.String role)
true if the authenticated user principal
 possesses the specified role name.
isUserInRole in interface javax.servlet.http.HttpServletRequestrole - Role name to be validated
boolean indicating whether
                        the user making this request belongs to a given role;
                        false if the user has not been 
                        authenticatedpublic java.security.Principal getPrincipal()
public java.security.Principal getUserPrincipal()
getUserPrincipal in interface javax.servlet.http.HttpServletRequestjava.security.Principal containing
                        the name of the user making this request;
                        null if the user has not been 
                        authenticatedpublic Session getSessionInternal()
public void changeSessionId(java.lang.String newSessionId)
newSessionId - The new session ID to usepublic Session getSessionInternal(boolean create)
create - Create a new session if one does not existpublic CometEventImpl getEvent()
public boolean isComet()
public void setComet(boolean comet)
public boolean isParametersParsed()
public boolean getAvailable()
public void cometClose()
public void setCometTimeout(long timeout)
protected Session doGetSession(boolean create)
protected void configureSessionCookie(javax.servlet.http.Cookie cookie)
cookie - The JSESSIONID cookie to be configuredprotected java.lang.String unescape(java.lang.String s)
protected void parseCookies()
protected void parseParameters()
protected int readPostBody(byte[] body,
                           int len)
                    throws java.io.IOException
java.io.IOException
protected byte[] readChunkedPostBody()
                              throws java.io.IOException
java.io.IOExceptionprotected void parseLocales()
protected void parseLocalesHeader(java.lang.String value)
protected static final boolean isAlpha(java.lang.String value)
| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||