java.lang.Object
- org.apache.catalina.connector.RequestFacade

All Implemented Interfaces:

jakarta.servlet.http.HttpServletRequest, jakarta.servlet.ServletRequest
```
public class RequestFacade
extends Object
implements jakarta.servlet.http.HttpServletRequest
```
Facade class that wraps a Coyote request object. All methods are delegated to the wrapped request.

Version:

$Revision: 1.7 $ $Date: 2007/08/01 19:04:28 $

Author:

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

Field Summary

Fields
Modifier and Type Field Description

protected Request request
The wrapped request.
- Fields inherited from interface jakarta.servlet.http.HttpServletRequest
  BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors
Constructor	Description
`RequestFacade(Request request)`	Construct a wrapper for the specified request.
`RequestFacade(Request request, boolean maskDefaultContextMapping)`	Construct a wrapper for the specified request.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`authenticate(jakarta.servlet.http.HttpServletResponse response)`
`String`	`changeSessionId()`
`void`	`clear()`	Clear facade.
`protected Object`	`clone()`	Prevent cloning the facade.
`jakarta.servlet.AsyncContext`	`getAsyncContext()`	Gets the AsyncContext of this request.
`Object`	`getAttribute(String name)`
`Enumeration<String>`	`getAttributeNames()`
`String`	`getAuthType()`
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`long`	`getContentLengthLong()`
`String`	`getContentType()`
`String`	`getContextPath()`
`String`	`getContextPath(boolean maskDefaultContextMapping)`
`jakarta.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(String name)`
`jakarta.servlet.DispatcherType`	`getDispatcherType()`
`String`	`getHeader(String name)`
`Enumeration<String>`	`getHeaderNames()`
`Enumeration<String>`	`getHeaders(String name)`
`jakarta.servlet.http.HttpServletMapping`	`getHttpServletMapping()`
`jakarta.servlet.ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(String name)`
`String`	`getLocalAddr()`
`Locale`	`getLocale()`
`Enumeration<Locale>`	`getLocales()`
`String`	`getLocalName()`
`int`	`getLocalPort()`
`String`	`getMethod()`
`String`	`getParameter(String name)`
`Map<String,String[]>`	`getParameterMap()`
`Enumeration<String>`	`getParameterNames()`
`String[]`	`getParameterValues(String name)`
`jakarta.servlet.http.Part`	`getPart(String name)`
`Collection<jakarta.servlet.http.Part>`	`getParts()`
`String`	`getPathInfo()`
`String`	`getPathTranslated()`
`Principal`	`getPrincipal()`
`String`	`getProtocol()`
`String`	`getProtocolRequestId()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`String`	`getRemoteUser()`
`jakarta.servlet.RequestDispatcher`	`getRequestDispatcher(String path)`
`String`	`getRequestedSessionId()`
`String`	`getRequestId()`
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`jakarta.servlet.ServletConnection`	`getServletConnection()`
`jakarta.servlet.ServletContext`	`getServletContext()`	Gets the servlet context to which this servlet request was last dispatched.
`String`	`getServletPath()`
`jakarta.servlet.http.HttpSession`	`getSession()`
`jakarta.servlet.http.HttpSession`	`getSession(boolean create)`
`Map<String,String>`	`getTrailerFields()`
`Request`	`getUnwrappedCoyoteRequest()`	Return the original `CoyoteRequest` object.
`Principal`	`getUserPrincipal()`
`boolean`	`isAsyncStarted()`	Checks whether async processing has started on this request.
`boolean`	`isAsyncSupported()`	Checks whether this request supports async.
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isTrailerFieldsReady()`
`boolean`	`isUserInRole(String role)`
`void`	`login(String username, String password)`
`void`	`logout()`
`jakarta.servlet.http.PushBuilder`	`newPushBuilder()`
`void`	`removeAttribute(String name)`
`void`	`setAttribute(String name, Object o)`
`void`	`setCharacterEncoding(String env)`
`jakarta.servlet.AsyncContext`	`startAsync()`	Starts async processing on this request.
`jakarta.servlet.AsyncContext`	`startAsync(jakarta.servlet.ServletRequest sreq, jakarta.servlet.ServletResponse sresp)`	Starts async processing on this request.
`<T extends jakarta.servlet.http.HttpUpgradeHandler> T`	`upgrade(Class<T> handlerClass)`

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.
- Constructor Detail
  - RequestFacade
```
public RequestFacade(Request request)
```
    Construct a wrapper for the specified request.
    
    Parameters:
    
    request - The request to be wrapped
  - RequestFacade
```
public RequestFacade(Request request,
                     boolean maskDefaultContextMapping)
```
    Construct a wrapper for the specified request.
    
    Parameters:
    
    request - The request to be wrapped
    
    maskDefaultContextMapping - true if the fact that a request received at the root context was mapped to a default-web-module will be masked, false otherwise
- Method Detail
  - clone
```
protected Object clone()
                throws CloneNotSupportedException
```
    Prevent cloning the facade.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    never
    
    Throws:
    
    CloneNotSupportedException - always
  - clear
```
public void clear()
```
    Clear facade.
  - getAttribute
```
public Object getAttribute(String name)
```
    Specified by:
    
    getAttribute in interface jakarta.servlet.ServletRequest
  - getAttributeNames
```
public Enumeration<String> getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface jakarta.servlet.ServletRequest
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface jakarta.servlet.ServletRequest
  - setCharacterEncoding
```
public void setCharacterEncoding(String env)
                          throws UnsupportedEncodingException
```
    Specified by:
    
    setCharacterEncoding in interface jakarta.servlet.ServletRequest
    
    Throws:
    
    UnsupportedEncodingException
  - getContentLength
```
public int getContentLength()
```
    Specified by:
    
    getContentLength in interface jakarta.servlet.ServletRequest
  - getContentLengthLong
```
public long getContentLengthLong()
```
    Specified by:
    
    getContentLengthLong in interface jakarta.servlet.ServletRequest
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface jakarta.servlet.ServletRequest
  - getInputStream
```
public jakarta.servlet.ServletInputStream getInputStream()
                                                  throws IOException
```
    Specified by:
    
    getInputStream in interface jakarta.servlet.ServletRequest
    
    Throws:
    
    IOException
  - getHttpServletMapping
```
public jakarta.servlet.http.HttpServletMapping getHttpServletMapping()
```
    Specified by:
    
    getHttpServletMapping in interface jakarta.servlet.http.HttpServletRequest
  - getParameter
```
public String getParameter(String name)
```
    Specified by:
    
    getParameter in interface jakarta.servlet.ServletRequest
  - getParameterNames
```
public Enumeration<String> getParameterNames()
```
    Specified by:
    
    getParameterNames in interface jakarta.servlet.ServletRequest
  - getParameterValues
```
public String[] getParameterValues(String name)
```
    Specified by:
    
    getParameterValues in interface jakarta.servlet.ServletRequest
  - getParameterMap
```
public Map<String,String[]> getParameterMap()
```
    Specified by:
    
    getParameterMap in interface jakarta.servlet.ServletRequest
  - getProtocol
```
public String getProtocol()
```
    Specified by:
    
    getProtocol in interface jakarta.servlet.ServletRequest
  - getScheme
```
public String getScheme()
```
    Specified by:
    
    getScheme in interface jakarta.servlet.ServletRequest
  - getServerName
```
public String getServerName()
```
    Specified by:
    
    getServerName in interface jakarta.servlet.ServletRequest
  - getServerPort
```
public int getServerPort()
```
    Specified by:
    
    getServerPort in interface jakarta.servlet.ServletRequest
  - getReader
```
public BufferedReader getReader()
                         throws IOException
```
    Specified by:
    
    getReader in interface jakarta.servlet.ServletRequest
    
    Throws:
    
    IOException
  - getRemoteAddr
```
public String getRemoteAddr()
```
    Specified by:
    
    getRemoteAddr in interface jakarta.servlet.ServletRequest
  - getRemoteHost
```
public String getRemoteHost()
```
    Specified by:
    
    getRemoteHost in interface jakarta.servlet.ServletRequest
  - setAttribute
```
public void setAttribute(String name,
                         Object o)
```
    Specified by:
    
    setAttribute in interface jakarta.servlet.ServletRequest
  - removeAttribute
```
public void removeAttribute(String name)
```
    Specified by:
    
    removeAttribute in interface jakarta.servlet.ServletRequest
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface jakarta.servlet.ServletRequest
  - getLocales
```
public Enumeration<Locale> getLocales()
```
    Specified by:
    
    getLocales in interface jakarta.servlet.ServletRequest
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure in interface jakarta.servlet.ServletRequest
  - getRequestDispatcher
```
public jakarta.servlet.RequestDispatcher getRequestDispatcher(String path)
```
    Specified by:
    
    getRequestDispatcher in interface jakarta.servlet.ServletRequest
  - getAuthType
```
public String getAuthType()
```
    Specified by:
    
    getAuthType in interface jakarta.servlet.http.HttpServletRequest
  - getCookies
```
public jakarta.servlet.http.Cookie[] getCookies()
```
    Specified by:
    
    getCookies in interface jakarta.servlet.http.HttpServletRequest
  - getDateHeader
```
public long getDateHeader(String name)
```
    Specified by:
    
    getDateHeader in interface jakarta.servlet.http.HttpServletRequest
  - getHeader
```
public String getHeader(String name)
```
    Specified by:
    
    getHeader in interface jakarta.servlet.http.HttpServletRequest
  - getHeaders
```
public Enumeration<String> getHeaders(String name)
```
    Specified by:
    
    getHeaders in interface jakarta.servlet.http.HttpServletRequest
  - getHeaderNames
```
public Enumeration<String> getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface jakarta.servlet.http.HttpServletRequest
  - getIntHeader
```
public int getIntHeader(String name)
```
    Specified by:
    
    getIntHeader in interface jakarta.servlet.http.HttpServletRequest
  - getTrailerFields
```
public Map<String,String> getTrailerFields()
```
    Specified by:
    
    getTrailerFields in interface jakarta.servlet.http.HttpServletRequest
  - isTrailerFieldsReady
```
public boolean isTrailerFieldsReady()
```
    Specified by:
    
    isTrailerFieldsReady in interface jakarta.servlet.http.HttpServletRequest
  - getMethod
```
public String getMethod()
```
    Specified by:
    
    getMethod in interface jakarta.servlet.http.HttpServletRequest
  - getPathInfo
```
public String getPathInfo()
```
    Specified by:
    
    getPathInfo in interface jakarta.servlet.http.HttpServletRequest
  - getPathTranslated
```
public String getPathTranslated()
```
    Specified by:
    
    getPathTranslated in interface jakarta.servlet.http.HttpServletRequest
  - getServletContext
```
public jakarta.servlet.ServletContext getServletContext()
```
    Gets the servlet context to which this servlet request was last dispatched.
    
    Specified by:
    
    getServletContext in interface jakarta.servlet.ServletRequest
    
    Returns:
    
    the servlet context to which this servlet request was last dispatched
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath in interface jakarta.servlet.http.HttpServletRequest
  - getContextPath
```
public String getContextPath(boolean maskDefaultContextMapping)
```
  - getQueryString
```
public String getQueryString()
```
    Specified by:
    
    getQueryString in interface jakarta.servlet.http.HttpServletRequest
  - getRemoteUser
```
public String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in interface jakarta.servlet.http.HttpServletRequest
  - isUserInRole
```
public boolean isUserInRole(String role)
```
    Specified by:
    
    isUserInRole in interface jakarta.servlet.http.HttpServletRequest
  - getPrincipal
```
public Principal getPrincipal()
```
  - getUserPrincipal
```
public Principal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal in interface jakarta.servlet.http.HttpServletRequest
  - getRequestedSessionId
```
public String getRequestedSessionId()
```
    Specified by:
    
    getRequestedSessionId in interface jakarta.servlet.http.HttpServletRequest
  - getRequestURI
```
public String getRequestURI()
```
    Specified by:
    
    getRequestURI in interface jakarta.servlet.http.HttpServletRequest
  - getRequestURL
```
public StringBuffer getRequestURL()
```
    Specified by:
    
    getRequestURL in interface jakarta.servlet.http.HttpServletRequest
  - getServletPath
```
public String getServletPath()
```
    Specified by:
    
    getServletPath in interface jakarta.servlet.http.HttpServletRequest
  - getSession
```
public jakarta.servlet.http.HttpSession getSession(boolean create)
```
    Specified by:
    
    getSession in interface jakarta.servlet.http.HttpServletRequest
  - getSession
```
public jakarta.servlet.http.HttpSession getSession()
```
    Specified by:
    
    getSession in interface jakarta.servlet.http.HttpServletRequest
  - changeSessionId
```
public String changeSessionId()
```
    Specified by:
    
    changeSessionId in interface jakarta.servlet.http.HttpServletRequest
  - isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
    Specified by:
    
    isRequestedSessionIdValid in interface jakarta.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromCookie
```
public boolean isRequestedSessionIdFromCookie()
```
    Specified by:
    
    isRequestedSessionIdFromCookie in interface jakarta.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromURL
```
public boolean isRequestedSessionIdFromURL()
```
    Specified by:
    
    isRequestedSessionIdFromURL in interface jakarta.servlet.http.HttpServletRequest
  - getLocalAddr
```
public String getLocalAddr()
```
    Specified by:
    
    getLocalAddr in interface jakarta.servlet.ServletRequest
  - getLocalName
```
public String getLocalName()
```
    Specified by:
    
    getLocalName in interface jakarta.servlet.ServletRequest
  - getLocalPort
```
public int getLocalPort()
```
    Specified by:
    
    getLocalPort in interface jakarta.servlet.ServletRequest
  - getRemotePort
```
public int getRemotePort()
```
    Specified by:
    
    getRemotePort in interface jakarta.servlet.ServletRequest
  - getDispatcherType
```
public jakarta.servlet.DispatcherType getDispatcherType()
```
    Specified by:
    
    getDispatcherType in interface jakarta.servlet.ServletRequest
  - startAsync
```
public jakarta.servlet.AsyncContext startAsync()
                                        throws IllegalStateException
```
    Starts async processing on this request.
    
    Specified by:
    
    startAsync in interface jakarta.servlet.ServletRequest
    
    Throws:
    
    IllegalStateException
  - startAsync
```
public jakarta.servlet.AsyncContext startAsync(jakarta.servlet.ServletRequest sreq,
                                               jakarta.servlet.ServletResponse sresp)
                                        throws IllegalStateException
```
    Starts async processing on this request.
    
    Specified by:
    
    startAsync in interface jakarta.servlet.ServletRequest
    
    Throws:
    
    IllegalStateException
  - isAsyncStarted
```
public boolean isAsyncStarted()
```
    Checks whether async processing has started on this request.
    
    Specified by:
    
    isAsyncStarted in interface jakarta.servlet.ServletRequest
  - isAsyncSupported
```
public boolean isAsyncSupported()
```
    Checks whether this request supports async.
    
    Specified by:
    
    isAsyncSupported in interface jakarta.servlet.ServletRequest
  - getAsyncContext
```
public jakarta.servlet.AsyncContext getAsyncContext()
```
    Gets the AsyncContext of this request.
    
    Specified by:
    
    getAsyncContext in interface jakarta.servlet.ServletRequest
  - getParts
```
public Collection<jakarta.servlet.http.Part> getParts()
                                               throws IOException,
                                                      jakarta.servlet.ServletException
```
    Specified by:
    
    getParts in interface jakarta.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    jakarta.servlet.ServletException
  - getPart
```
public jakarta.servlet.http.Part getPart(String name)
                                  throws IOException,
                                         jakarta.servlet.ServletException
```
    Specified by:
    
    getPart in interface jakarta.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    jakarta.servlet.ServletException
  - authenticate
```
public boolean authenticate(jakarta.servlet.http.HttpServletResponse response)
                     throws IOException,
                            jakarta.servlet.ServletException
```
    Specified by:
    
    authenticate in interface jakarta.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    jakarta.servlet.ServletException
  - login
```
public void login(String username,
                  String password)
           throws jakarta.servlet.ServletException
```
    Specified by:
    
    login in interface jakarta.servlet.http.HttpServletRequest
    
    Throws:
    
    jakarta.servlet.ServletException
  - logout
```
public void logout()
            throws jakarta.servlet.ServletException
```
    Specified by:
    
    logout in interface jakarta.servlet.http.HttpServletRequest
    
    Throws:
    
    jakarta.servlet.ServletException
  - upgrade
```
public <T extends jakarta.servlet.http.HttpUpgradeHandler> T upgrade(Class<T> handlerClass)
                                                              throws IOException,
                                                                     jakarta.servlet.ServletException
```
    Specified by:
    
    upgrade in interface jakarta.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    jakarta.servlet.ServletException
  - newPushBuilder
```
public jakarta.servlet.http.PushBuilder newPushBuilder()
```
    Specified by:
    
    newPushBuilder in interface jakarta.servlet.http.HttpServletRequest
  - getRequestId
```
public String getRequestId()
```
    Specified by:
    
    getRequestId in interface jakarta.servlet.ServletRequest
  - getProtocolRequestId
```
public String getProtocolRequestId()
```
    Specified by:
    
    getProtocolRequestId in interface jakarta.servlet.ServletRequest
  - getServletConnection
```
public jakarta.servlet.ServletConnection getServletConnection()
```
    Specified by:
    
    getServletConnection in interface jakarta.servlet.ServletRequest
  - getUnwrappedCoyoteRequest
```
public Request getUnwrappedCoyoteRequest()
                                  throws AccessControlException
```
    Return the original CoyoteRequest object.
    
    Throws:
    
    AccessControlException

Class RequestFacade

Field Summary

Fields inherited from interface jakarta.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

request

Constructor Detail

RequestFacade

RequestFacade

Method Detail

clone

clear

getAttribute

getAttributeNames

getCharacterEncoding

setCharacterEncoding

getContentLength

getContentLengthLong

getContentType

getInputStream

getHttpServletMapping

getParameter

getParameterNames

getParameterValues

getParameterMap

getProtocol

getScheme

getServerName

getServerPort

getReader

getRemoteAddr

getRemoteHost

setAttribute

removeAttribute

getLocale

getLocales

isSecure

getRequestDispatcher

getAuthType

getCookies

getDateHeader

getHeader

getHeaders

getHeaderNames

getIntHeader

getTrailerFields

isTrailerFieldsReady

getMethod

getPathInfo

getPathTranslated

getServletContext

getContextPath

getContextPath

getQueryString

getRemoteUser

isUserInRole

getPrincipal

getUserPrincipal

getRequestedSessionId

getRequestURI

getRequestURL

getServletPath

getSession

getSession

changeSessionId

isRequestedSessionIdValid

isRequestedSessionIdFromCookie

isRequestedSessionIdFromURL

getLocalAddr

getLocalName

getLocalPort

getRemotePort

getDispatcherType

startAsync

startAsync

isAsyncStarted

isAsyncSupported

getAsyncContext