org.apache.catalina.connector

Class RequestFacade

java.lang.Object

org.apache.catalina.connector.RequestFacade

public class RequestFacade
extends java.lang.Object

Facade class that wraps a Coyote request object. All methods are delegated to the wrapped request.

Version:

$Revision: 1781 $ $Date: 2011-07-13 12:31:38 -0400 (Wed, 13 Jul 2011) $

Author:

Craig R. McClanahan, Remy Maucherat, Jean-Francois Arcand

Field Summary

Fields

Modifier and Type	Field and Description
protected Request	request The wrapped request.
protected static StringManager	sm The string manager for this package.

Constructor Summary

Constructors

Constructor and Description
RequestFacade(Request request) Construct a wrapper for the specified request.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	authenticate(HttpServletResponse response)
void	clear() Clear facade.
protected java.lang.Object	clone() Prevent cloning the facade.
AsyncContext	getAsyncContext()
java.lang.Object	getAttribute(java.lang.String name)
java.util.Enumeration	getAttributeNames()
java.lang.String	getAuthType()
java.lang.String	getCharacterEncoding()
int	getContentLength()
java.lang.String	getContentType()
java.lang.String	getContextPath()
Cookie[]	getCookies()
long	getDateHeader(java.lang.String name)
DispatcherType	getDispatcherType()
ApplicationFilterChain	getFilterChain() Get filter chain associated with the request.
java.lang.String	getHeader(java.lang.String name)
java.util.Enumeration	getHeaderNames()
java.util.Enumeration	getHeaders(java.lang.String name)
ServletInputStream	getInputStream()
int	getIntHeader(java.lang.String name)
java.lang.String	getLocalAddr()
java.util.Locale	getLocale()
java.util.Enumeration	getLocales()
java.lang.String	getLocalName()
int	getLocalPort()
java.lang.String	getMethod()
java.lang.String	getParameter(java.lang.String name)
java.util.Map	getParameterMap()
java.util.Enumeration	getParameterNames()
java.lang.String[]	getParameterValues(java.lang.String name)
Part	getPart(java.lang.String name)
java.util.Collection<Part>	getParts()
java.lang.String	getPathInfo()
java.lang.String	getPathTranslated()
java.lang.String	getProtocol()
java.lang.String	getQueryString()
java.io.BufferedReader	getReader()
java.lang.String	getRealPath(java.lang.String path)
java.lang.String	getRemoteAddr()
java.lang.String	getRemoteHost()
int	getRemotePort()
java.lang.String	getRemoteUser()
RequestDispatcher	getRequestDispatcher(java.lang.String path)
java.lang.String	getRequestedSessionId()
java.lang.String	getRequestURI()
java.lang.StringBuffer	getRequestURL()
java.lang.String	getScheme()
java.lang.String	getServerName()
int	getServerPort()
ServletContext	getServletContext()
java.lang.String	getServletPath()
HttpSession	getSession()
HttpSession	getSession(boolean create)
java.security.Principal	getUserPrincipal()
boolean	hasSendfile()
boolean	isAsyncStarted()
boolean	isAsyncSupported()
boolean	isRequestedSessionIdFromCookie()
boolean	isRequestedSessionIdFromUrl()
boolean	isRequestedSessionIdFromURL()
boolean	isRequestedSessionIdValid()
boolean	isSecure()
boolean	isUserInRole(java.lang.String role)
void	login(java.lang.String username, java.lang.String password)
void	logout()
void	nextFilterChain() Next filter chain.
void	releaseFilterChain() Release the current filter chain.
void	removeAttribute(java.lang.String name)
void	setAttribute(java.lang.String name, java.lang.Object o)
void	setCharacterEncoding(java.lang.String env)
void	setFilterChain(ApplicationFilterChain filterChain) Set filter chain associated with the request.
AsyncContext	startAsync()
AsyncContext	startAsync(ServletRequest servletRequest, ServletResponse servletResponse)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

request

protected Request request

The wrapped request.

sm

protected static StringManager sm

The string manager for this package.

Constructor Detail

RequestFacade

public RequestFacade(Request request)

Construct a wrapper for the specified request.

Parameters:

request - The request to be wrapped

Method Detail

clear

public void clear()

Clear facade.

clone

protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException

Prevent cloning the facade.

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

getAttributeNames

public java.util.Enumeration getAttributeNames()

getCharacterEncoding

public java.lang.String getCharacterEncoding()

setCharacterEncoding

public void setCharacterEncoding(java.lang.String env)
                          throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

getContentLength

public int getContentLength()

getContentType

public java.lang.String getContentType()

getInputStream

public ServletInputStream getInputStream()
                                  throws java.io.IOException

Throws:

java.io.IOException

getParameter

public java.lang.String getParameter(java.lang.String name)

getParameterNames

public java.util.Enumeration getParameterNames()

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

getParameterMap

public java.util.Map getParameterMap()

getProtocol

public java.lang.String getProtocol()

getScheme

public java.lang.String getScheme()

getServerName

public java.lang.String getServerName()

getServerPort

public int getServerPort()

getReader

public java.io.BufferedReader getReader()
                                 throws java.io.IOException

Throws:

java.io.IOException

getRemoteAddr

public java.lang.String getRemoteAddr()

getRemoteHost

public java.lang.String getRemoteHost()

setAttribute

public void setAttribute(java.lang.String name,
                java.lang.Object o)

removeAttribute

public void removeAttribute(java.lang.String name)

getLocale

public java.util.Locale getLocale()

getLocales

public java.util.Enumeration getLocales()

isSecure

public boolean isSecure()

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(java.lang.String path)

getRealPath

public java.lang.String getRealPath(java.lang.String path)

getAuthType

public java.lang.String getAuthType()

getCookies

public Cookie[] getCookies()

getDateHeader

public long getDateHeader(java.lang.String name)

getHeader

public java.lang.String getHeader(java.lang.String name)

getHeaders

public java.util.Enumeration getHeaders(java.lang.String name)

getHeaderNames

public java.util.Enumeration getHeaderNames()

getIntHeader

public int getIntHeader(java.lang.String name)

getMethod

public java.lang.String getMethod()

getPathInfo

public java.lang.String getPathInfo()

getPathTranslated

public java.lang.String getPathTranslated()

getContextPath

public java.lang.String getContextPath()

getQueryString

public java.lang.String getQueryString()

getRemoteUser

public java.lang.String getRemoteUser()

isUserInRole

public boolean isUserInRole(java.lang.String role)

getUserPrincipal

public java.security.Principal getUserPrincipal()

getRequestedSessionId

public java.lang.String getRequestedSessionId()

getRequestURI

public java.lang.String getRequestURI()

getRequestURL

public java.lang.StringBuffer getRequestURL()

getServletPath

public java.lang.String getServletPath()

getSession

public HttpSession getSession(boolean create)

getSession

public HttpSession getSession()

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()

getLocalAddr

public java.lang.String getLocalAddr()

getLocalName

public java.lang.String getLocalName()

getLocalPort

public int getLocalPort()

getRemotePort

public int getRemotePort()

getAsyncContext

public AsyncContext getAsyncContext()

getServletContext

public ServletContext getServletContext()

isAsyncStarted

public boolean isAsyncStarted()

isAsyncSupported

public boolean isAsyncSupported()

startAsync

public AsyncContext startAsync()
                        throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

startAsync

public AsyncContext startAsync(ServletRequest servletRequest,
                      ServletResponse servletResponse)
                        throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

getDispatcherType

public DispatcherType getDispatcherType()

getFilterChain

public ApplicationFilterChain getFilterChain()

Get filter chain associated with the request.

setFilterChain

public void setFilterChain(ApplicationFilterChain filterChain)

Set filter chain associated with the request.

Parameters:

filterChain - new filter chain

nextFilterChain

public void nextFilterChain()

Next filter chain.

releaseFilterChain

public void releaseFilterChain()

Release the current filter chain.

authenticate

public boolean authenticate(HttpServletResponse response)
                     throws java.io.IOException,
                            ServletException

Throws:

java.io.IOException

ServletException

login

public void login(java.lang.String username,
         java.lang.String password)
           throws ServletException

Throws:

ServletException

logout

public void logout()
            throws ServletException

Throws:

ServletException

getPart

public Part getPart(java.lang.String name)
             throws java.io.IOException,
                    ServletException

Throws:

java.io.IOException

ServletException

getParts

public java.util.Collection<Part> getParts()
                                    throws java.io.IOException,
                                           ServletException

Throws:

java.io.IOException

ServletException

hasSendfile

public boolean hasSendfile()