All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface org.apache.tomcat.core.Request

public interface Request

Method Index

 o getAttribute(String)
 o getAttributeNames()
 o getAuthType()
 o getCharacterEncoding()
 o getContainer()
 o getContentLength()
 o getContentType()
 o getContext()
 o getContextManager()
 o getCookies()
Return the cookies
 o getFacade()
One-to-One with Facade
 o getHeader(String)
 o getHeaderNames()
 o getHeaders(String)
 o getInputStream()
 o getJvmRoute()
 o getLookupPath()
 o getMappedPath()
The file - result of mapping the request ( using aliases and other mapping rules. Deprecated.
 o getMethod()
 o getParameterNames()
 o getParameters()
Deprecated.
 o getParameterValues(String)
 o getPathInfo()
Path Info - set be mappers or from adapter
 o getPathTranslated()
Real Path - should be implemented as a callback ( override it in adapters).
 o getProtocol()
 o getQueryString()
 o getReader()
 o getRemoteAddr()
 o getRemoteHost()
Expensive - should be implemented as a callback where possible!
 o getRemoteUser()
 o getRequestedSessionId()
 o getRequestURI()
 o getResponse()
One-to-One with Response
 o getScheme()
 o getServerName()
 o getServerPort()
 o getServletPath()
 o getSession(boolean)
 o getUserPrincipal()
Deprecated.
 o getWrapper()
Wrapper - the servlet that will execute the request Similar with "handler" in Apache. Deprecated.
 o isRequestedSessionIdFromCookie()
 o isRequestedSessionIdFromURL()
 o isRequestedSessionIdValid()
 o isSecure()
 o isUserInRole(String)
Deprecated.
 o recycle()
Support for "pools"
 o removeAttribute(String)
 o setAttribute(String, Object)
 o setAuthType(String)
 o setCharEncoding(String)
 o setContainer(Container)
 o setContentLength(int)
 o setContentType(String)
 o setContext(Context)
Context - will be set by contextMap stage of request interceptors
 o setContextManager(ContextManager)
Pointer to the server engine - for errors, etc
 o setLookupPath(String)
Everything after context path ( servletPath + pathInfo + queryInfo )
 o setMappedPath(String)
Deprecated.
 o setParameters(Hashtable)
Deprecated.
 o setPathInfo(String)
 o setPathTranslated(String)
 o setQueryString(String)
Set query string - will be called by forward
 o setRemoteUser(String)
 o setRequestedSessionId(String)
 o setRequestedSessionIdFromCookie(boolean)
 o setRequestedSessionIdFromURL(boolean)
 o setRequestURI(String)
 o setResponse(Response)
 o setServerName(String)
 o setServletPath(String)
Servlet Path
 o setSession(HttpSession)
 o setWrapper(ServletWrapper)
Deprecated.

Methods

 o getJvmRoute
 public abstract String getJvmRoute()
 o getScheme
 public abstract String getScheme()
 o getMethod
 public abstract String getMethod()
 o getRequestURI
 public abstract String getRequestURI()
 o setRequestURI
 public abstract void setRequestURI(String r)
 o getQueryString
 public abstract String getQueryString()
 o getProtocol
 public abstract String getProtocol()
 o getServerName
 public abstract String getServerName()
 o setServerName
 public abstract void setServerName(String serverName)
 o getServerPort
 public abstract int getServerPort()
 o getRemoteAddr
 public abstract String getRemoteAddr()
 o getRemoteHost
 public abstract String getRemoteHost()
Expensive - should be implemented as a callback where possible!

 o getHeader
 public abstract String getHeader(String name)
 o getHeaderNames
 public abstract Enumeration getHeaderNames()
 o getHeaders
 public abstract Enumeration getHeaders(String name)
 o getCookies
 public abstract Cookie[] getCookies()
Return the cookies

 o getContentLength
 public abstract int getContentLength()
 o setContentLength
 public abstract void setContentLength(int len)
 o getContentType
 public abstract String getContentType()
 o setContentType
 public abstract void setContentType(String type)
 o setCharEncoding
 public abstract void setCharEncoding(String enc)
 o getCharacterEncoding
 public abstract String getCharacterEncoding()
 o setContext
 public abstract void setContext(Context context)
Context - will be set by contextMap stage of request interceptors

 o getContext
 public abstract Context getContext()
 o setLookupPath
 public abstract void setLookupPath(String l)
Everything after context path ( servletPath + pathInfo + queryInfo )

 o getLookupPath
 public abstract String getLookupPath()
 o getPathTranslated
 public abstract String getPathTranslated()
Real Path - should be implemented as a callback ( override it in adapters). Map interceptor should set it to something reasonable ( context home + path ) MappedPath is similar - it contain mappings inside a context, for normal contexts pathTranslated==context.docBase + mappedPath

 o setPathTranslated
 public abstract void setPathTranslated(String path)
 o getPathInfo
 public abstract String getPathInfo()
Path Info - set be mappers or from adapter

 o setPathInfo
 public abstract void setPathInfo(String pathInfo)
 o setServletPath
 public abstract void setServletPath(String servletPath)
Servlet Path

 o getServletPath
 public abstract String getServletPath()
 o getContainer
 public abstract Container getContainer()
 o setContainer
 public abstract void setContainer(Container handler)
 o getAuthType
 public abstract String getAuthType()
 o setAuthType
 public abstract void setAuthType(String authType)
 o getRemoteUser
 public abstract String getRemoteUser()
 o setRemoteUser
 public abstract void setRemoteUser(String s)
 o isSecure
 public abstract boolean isSecure()
 o getRequestedSessionId
 public abstract String getRequestedSessionId()
 o setRequestedSessionId
 public abstract void setRequestedSessionId(String reqSessionId)
 o isRequestedSessionIdFromCookie
 public abstract boolean isRequestedSessionIdFromCookie()
 o setRequestedSessionIdFromCookie
 public abstract void setRequestedSessionIdFromCookie(boolean newState)
 o isRequestedSessionIdFromURL
 public abstract boolean isRequestedSessionIdFromURL()
 o setRequestedSessionIdFromURL
 public abstract void setRequestedSessionIdFromURL(boolean newState)
 o setSession
 public abstract void setSession(HttpSession serverSession)
 o getSession
 public abstract HttpSession getSession(boolean create)
 o isRequestedSessionIdValid
 public abstract boolean isRequestedSessionIdValid()
 o setQueryString
 public abstract void setQueryString(String queryString)
Set query string - will be called by forward

 o getParameterValues
 public abstract String[] getParameterValues(String name)
 o getParameterNames
 public abstract Enumeration getParameterNames()
 o getAttribute
 public abstract Object getAttribute(String name)
 o setAttribute
 public abstract void setAttribute(String name,
                                   Object value)
 o removeAttribute
 public abstract void removeAttribute(String name)
 o getAttributeNames
 public abstract Enumeration getAttributeNames()
 o getReader
 public abstract BufferedReader getReader() throws IOException
 o getInputStream
 public abstract ServletInputStream getInputStream() throws IOException
 o recycle
 public abstract void recycle()
Support for "pools"

 o getResponse
 public abstract Response getResponse()
One-to-One with Response

 o setResponse
 public abstract void setResponse(Response response)
 o getFacade
 public abstract HttpServletRequestFacade getFacade()
One-to-One with Facade

 o setContextManager
 public abstract void setContextManager(ContextManager cm)
Pointer to the server engine - for errors, etc

 o getContextManager
 public abstract ContextManager getContextManager()
 o setParameters
 public abstract void setParameters(Hashtable h)
Note: setParameters() is deprecated. internal use only

 o getParameters
 public abstract Hashtable getParameters()
Note: getParameters() is deprecated. internal use only

 o getUserPrincipal
 public abstract Principal getUserPrincipal()
Note: getUserPrincipal() is deprecated.

 o isUserInRole
 public abstract boolean isUserInRole(String role)
Note: isUserInRole() is deprecated.

 o getWrapper
 public abstract ServletWrapper getWrapper()
Note: getWrapper() is deprecated. - use Container instead

Wrapper - the servlet that will execute the request Similar with "handler" in Apache.

 o setWrapper
 public abstract void setWrapper(ServletWrapper handler)
Note: setWrapper() is deprecated. - use Container instead

 o getMappedPath
 public abstract String getMappedPath()
Note: getMappedPath() is deprecated. - internal use only

The file - result of mapping the request ( using aliases and other mapping rules. Usefull only for static resources.

 o setMappedPath
 public abstract void setMappedPath(String m)
Note: setMappedPath() is deprecated. - internal use only


All Packages  Class Hierarchy  This Package  Previous  Next  Index