Package org.apache.catalina.connector
Class RequestFacade
- 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
-
-
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 originalCoyoteRequest
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>
Tupgrade(Class<T> handlerClass)
-
-
-
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 wrappedmaskDefaultContextMapping
- 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 classObject
- Returns:
- never
- Throws:
CloneNotSupportedException
- always
-
clear
public void clear()
Clear facade.
-
getAttribute
public Object getAttribute(String name)
- Specified by:
getAttribute
in interfacejakarta.servlet.ServletRequest
-
getAttributeNames
public Enumeration<String> getAttributeNames()
- Specified by:
getAttributeNames
in interfacejakarta.servlet.ServletRequest
-
getCharacterEncoding
public String getCharacterEncoding()
- Specified by:
getCharacterEncoding
in interfacejakarta.servlet.ServletRequest
-
setCharacterEncoding
public void setCharacterEncoding(String env) throws UnsupportedEncodingException
- Specified by:
setCharacterEncoding
in interfacejakarta.servlet.ServletRequest
- Throws:
UnsupportedEncodingException
-
getContentLength
public int getContentLength()
- Specified by:
getContentLength
in interfacejakarta.servlet.ServletRequest
-
getContentLengthLong
public long getContentLengthLong()
- Specified by:
getContentLengthLong
in interfacejakarta.servlet.ServletRequest
-
getContentType
public String getContentType()
- Specified by:
getContentType
in interfacejakarta.servlet.ServletRequest
-
getInputStream
public jakarta.servlet.ServletInputStream getInputStream() throws IOException
- Specified by:
getInputStream
in interfacejakarta.servlet.ServletRequest
- Throws:
IOException
-
getHttpServletMapping
public jakarta.servlet.http.HttpServletMapping getHttpServletMapping()
- Specified by:
getHttpServletMapping
in interfacejakarta.servlet.http.HttpServletRequest
-
getParameter
public String getParameter(String name)
- Specified by:
getParameter
in interfacejakarta.servlet.ServletRequest
-
getParameterNames
public Enumeration<String> getParameterNames()
- Specified by:
getParameterNames
in interfacejakarta.servlet.ServletRequest
-
getParameterValues
public String[] getParameterValues(String name)
- Specified by:
getParameterValues
in interfacejakarta.servlet.ServletRequest
-
getParameterMap
public Map<String,String[]> getParameterMap()
- Specified by:
getParameterMap
in interfacejakarta.servlet.ServletRequest
-
getProtocol
public String getProtocol()
- Specified by:
getProtocol
in interfacejakarta.servlet.ServletRequest
-
getScheme
public String getScheme()
- Specified by:
getScheme
in interfacejakarta.servlet.ServletRequest
-
getServerName
public String getServerName()
- Specified by:
getServerName
in interfacejakarta.servlet.ServletRequest
-
getServerPort
public int getServerPort()
- Specified by:
getServerPort
in interfacejakarta.servlet.ServletRequest
-
getReader
public BufferedReader getReader() throws IOException
- Specified by:
getReader
in interfacejakarta.servlet.ServletRequest
- Throws:
IOException
-
getRemoteAddr
public String getRemoteAddr()
- Specified by:
getRemoteAddr
in interfacejakarta.servlet.ServletRequest
-
getRemoteHost
public String getRemoteHost()
- Specified by:
getRemoteHost
in interfacejakarta.servlet.ServletRequest
-
setAttribute
public void setAttribute(String name, Object o)
- Specified by:
setAttribute
in interfacejakarta.servlet.ServletRequest
-
removeAttribute
public void removeAttribute(String name)
- Specified by:
removeAttribute
in interfacejakarta.servlet.ServletRequest
-
getLocale
public Locale getLocale()
- Specified by:
getLocale
in interfacejakarta.servlet.ServletRequest
-
getLocales
public Enumeration<Locale> getLocales()
- Specified by:
getLocales
in interfacejakarta.servlet.ServletRequest
-
isSecure
public boolean isSecure()
- Specified by:
isSecure
in interfacejakarta.servlet.ServletRequest
-
getRequestDispatcher
public jakarta.servlet.RequestDispatcher getRequestDispatcher(String path)
- Specified by:
getRequestDispatcher
in interfacejakarta.servlet.ServletRequest
-
getAuthType
public String getAuthType()
- Specified by:
getAuthType
in interfacejakarta.servlet.http.HttpServletRequest
-
getCookies
public jakarta.servlet.http.Cookie[] getCookies()
- Specified by:
getCookies
in interfacejakarta.servlet.http.HttpServletRequest
-
getDateHeader
public long getDateHeader(String name)
- Specified by:
getDateHeader
in interfacejakarta.servlet.http.HttpServletRequest
-
getHeader
public String getHeader(String name)
- Specified by:
getHeader
in interfacejakarta.servlet.http.HttpServletRequest
-
getHeaders
public Enumeration<String> getHeaders(String name)
- Specified by:
getHeaders
in interfacejakarta.servlet.http.HttpServletRequest
-
getHeaderNames
public Enumeration<String> getHeaderNames()
- Specified by:
getHeaderNames
in interfacejakarta.servlet.http.HttpServletRequest
-
getIntHeader
public int getIntHeader(String name)
- Specified by:
getIntHeader
in interfacejakarta.servlet.http.HttpServletRequest
-
getTrailerFields
public Map<String,String> getTrailerFields()
- Specified by:
getTrailerFields
in interfacejakarta.servlet.http.HttpServletRequest
-
isTrailerFieldsReady
public boolean isTrailerFieldsReady()
- Specified by:
isTrailerFieldsReady
in interfacejakarta.servlet.http.HttpServletRequest
-
getMethod
public String getMethod()
- Specified by:
getMethod
in interfacejakarta.servlet.http.HttpServletRequest
-
getPathInfo
public String getPathInfo()
- Specified by:
getPathInfo
in interfacejakarta.servlet.http.HttpServletRequest
-
getPathTranslated
public String getPathTranslated()
- Specified by:
getPathTranslated
in interfacejakarta.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 interfacejakarta.servlet.ServletRequest
- Returns:
- the servlet context to which this servlet request was last dispatched
-
getContextPath
public String getContextPath()
- Specified by:
getContextPath
in interfacejakarta.servlet.http.HttpServletRequest
-
getContextPath
public String getContextPath(boolean maskDefaultContextMapping)
-
getQueryString
public String getQueryString()
- Specified by:
getQueryString
in interfacejakarta.servlet.http.HttpServletRequest
-
getRemoteUser
public String getRemoteUser()
- Specified by:
getRemoteUser
in interfacejakarta.servlet.http.HttpServletRequest
-
isUserInRole
public boolean isUserInRole(String role)
- Specified by:
isUserInRole
in interfacejakarta.servlet.http.HttpServletRequest
-
getPrincipal
public Principal getPrincipal()
-
getUserPrincipal
public Principal getUserPrincipal()
- Specified by:
getUserPrincipal
in interfacejakarta.servlet.http.HttpServletRequest
-
getRequestedSessionId
public String getRequestedSessionId()
- Specified by:
getRequestedSessionId
in interfacejakarta.servlet.http.HttpServletRequest
-
getRequestURI
public String getRequestURI()
- Specified by:
getRequestURI
in interfacejakarta.servlet.http.HttpServletRequest
-
getRequestURL
public StringBuffer getRequestURL()
- Specified by:
getRequestURL
in interfacejakarta.servlet.http.HttpServletRequest
-
getServletPath
public String getServletPath()
- Specified by:
getServletPath
in interfacejakarta.servlet.http.HttpServletRequest
-
getSession
public jakarta.servlet.http.HttpSession getSession(boolean create)
- Specified by:
getSession
in interfacejakarta.servlet.http.HttpServletRequest
-
getSession
public jakarta.servlet.http.HttpSession getSession()
- Specified by:
getSession
in interfacejakarta.servlet.http.HttpServletRequest
-
changeSessionId
public String changeSessionId()
- Specified by:
changeSessionId
in interfacejakarta.servlet.http.HttpServletRequest
-
isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()
- Specified by:
isRequestedSessionIdValid
in interfacejakarta.servlet.http.HttpServletRequest
-
isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()
- Specified by:
isRequestedSessionIdFromCookie
in interfacejakarta.servlet.http.HttpServletRequest
-
isRequestedSessionIdFromURL
public boolean isRequestedSessionIdFromURL()
- Specified by:
isRequestedSessionIdFromURL
in interfacejakarta.servlet.http.HttpServletRequest
-
getLocalAddr
public String getLocalAddr()
- Specified by:
getLocalAddr
in interfacejakarta.servlet.ServletRequest
-
getLocalName
public String getLocalName()
- Specified by:
getLocalName
in interfacejakarta.servlet.ServletRequest
-
getLocalPort
public int getLocalPort()
- Specified by:
getLocalPort
in interfacejakarta.servlet.ServletRequest
-
getRemotePort
public int getRemotePort()
- Specified by:
getRemotePort
in interfacejakarta.servlet.ServletRequest
-
getDispatcherType
public jakarta.servlet.DispatcherType getDispatcherType()
- Specified by:
getDispatcherType
in interfacejakarta.servlet.ServletRequest
-
startAsync
public jakarta.servlet.AsyncContext startAsync() throws IllegalStateException
Starts async processing on this request.- Specified by:
startAsync
in interfacejakarta.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 interfacejakarta.servlet.ServletRequest
- Throws:
IllegalStateException
-
isAsyncStarted
public boolean isAsyncStarted()
Checks whether async processing has started on this request.- Specified by:
isAsyncStarted
in interfacejakarta.servlet.ServletRequest
-
isAsyncSupported
public boolean isAsyncSupported()
Checks whether this request supports async.- Specified by:
isAsyncSupported
in interfacejakarta.servlet.ServletRequest
-
getAsyncContext
public jakarta.servlet.AsyncContext getAsyncContext()
Gets the AsyncContext of this request.- Specified by:
getAsyncContext
in interfacejakarta.servlet.ServletRequest
-
getParts
public Collection<jakarta.servlet.http.Part> getParts() throws IOException, jakarta.servlet.ServletException
- Specified by:
getParts
in interfacejakarta.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 interfacejakarta.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 interfacejakarta.servlet.http.HttpServletRequest
- Throws:
IOException
jakarta.servlet.ServletException
-
login
public void login(String username, String password) throws jakarta.servlet.ServletException
- Specified by:
login
in interfacejakarta.servlet.http.HttpServletRequest
- Throws:
jakarta.servlet.ServletException
-
logout
public void logout() throws jakarta.servlet.ServletException
- Specified by:
logout
in interfacejakarta.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 interfacejakarta.servlet.http.HttpServletRequest
- Throws:
IOException
jakarta.servlet.ServletException
-
newPushBuilder
public jakarta.servlet.http.PushBuilder newPushBuilder()
- Specified by:
newPushBuilder
in interfacejakarta.servlet.http.HttpServletRequest
-
getRequestId
public String getRequestId()
- Specified by:
getRequestId
in interfacejakarta.servlet.ServletRequest
-
getProtocolRequestId
public String getProtocolRequestId()
- Specified by:
getProtocolRequestId
in interfacejakarta.servlet.ServletRequest
-
getServletConnection
public jakarta.servlet.ServletConnection getServletConnection()
- Specified by:
getServletConnection
in interfacejakarta.servlet.ServletRequest
-
getUnwrappedCoyoteRequest
public Request getUnwrappedCoyoteRequest() throws AccessControlException
Return the originalCoyoteRequest
object.- Throws:
AccessControlException
-
-