java.lang.Object
jakarta.servlet.ServletRequestWrapper
jakarta.servlet.http.HttpServletRequestWrapper
cloud.piranha.core.impl.AsyncHttpDispatchWrapper
- All Implemented Interfaces:
WebApplicationRequest
,jakarta.servlet.http.HttpServletRequest
,jakarta.servlet.ServletRequest
public class AsyncHttpDispatchWrapper
extends jakarta.servlet.http.HttpServletRequestWrapper
implements WebApplicationRequest
The async HTTP dispatch wrapper.
- Author:
- Manfred Riem ([email protected])
-
Field Summary
Fields inherited from interface jakarta.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
-
Constructor Summary
ConstructorDescriptionAsyncHttpDispatchWrapper
(jakarta.servlet.http.HttpServletRequest request) Constructor. -
Method Summary
Modifier and TypeMethodDescriptiongetAttribute
(String name) jakarta.servlet.DispatcherType
jakarta.servlet.MultipartConfigElement
Returns the multipartConfig.getParameter
(String name) Get the parameter.Returns the parameter map.Returns the parameter names.String[]
getParameterValues
(String name) Returns the parameter values.jakarta.servlet.http.HttpServletRequest
Returns the request URI with query string.Returns the wrapper attributes.Returns the wrapper parameters.boolean
void
removeAttribute
(String name) void
setAsWrapperAttribute
(String name, Object value) Set as a wrapper attribute.void
setAsyncSupported
(boolean asyncSupported) Set the async supported flag.void
setAttribute
(String name, Object object) void
setAuthType
(String authType) Set the auth type.void
setContextPath
(String contextPath) Set the context path.void
setDispatcherType
(jakarta.servlet.DispatcherType dispatcherType) Set the dispatcher type.void
setPathInfo
(String pathInfo) Set the path info.void
setQueryString
(String queryString) Set the query string.void
setRequestURI
(String requestURI) Set the request URI.void
setServletPath
(String servletPath) Set the servlet path.void
setUserPrincipal
(Principal userPrincipal) Set the user principal.void
setWebApplication
(WebApplication webApplication) Set the web application.jakarta.servlet.AsyncContext
jakarta.servlet.AsyncContext
startAsync
(jakarta.servlet.ServletRequest servletRequest, jakarta.servlet.ServletResponse servletResponse) toString()
Methods inherited from class jakarta.servlet.http.HttpServletRequestWrapper
authenticate, changeSessionId, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getHttpServletMapping, getIntHeader, getMethod, getPart, getParts, getPathTranslated, getRemoteUser, getRequestedSessionId, getRequestURL, getSession, getSession, getTrailerFields, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isTrailerFieldsReady, isUserInRole, login, logout, newPushBuilder, upgrade
Methods inherited from class jakarta.servlet.ServletRequestWrapper
getAsyncContext, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getProtocolRequestId, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getRequestId, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, setCharacterEncoding, setRequest
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface jakarta.servlet.http.HttpServletRequest
authenticate, changeSessionId, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getHttpServletMapping, getIntHeader, getMethod, getPart, getParts, getPathTranslated, getRemoteUser, getRequestedSessionId, getRequestURL, getSession, getSession, getTrailerFields, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isTrailerFieldsReady, isUserInRole, login, logout, newPushBuilder, upgrade
Methods inherited from interface jakarta.servlet.ServletRequest
getAsyncContext, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getProtocolRequestId, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getRequestId, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, isAsyncSupported, isSecure, setCharacterEncoding
Methods inherited from interface cloud.piranha.core.api.WebApplicationRequest
getUpgradeHandler, getWebApplicationInputStream, isUpgraded, setRequestedSessionId, setWebApplicationInputStream
-
Constructor Details
-
AsyncHttpDispatchWrapper
public AsyncHttpDispatchWrapper(jakarta.servlet.http.HttpServletRequest request) Constructor.- Parameters:
request
- the HTTP servlet request.
-
-
Method Details
-
getRequest
public jakarta.servlet.http.HttpServletRequest getRequest()- Overrides:
getRequest
in classjakarta.servlet.ServletRequestWrapper
-
getDispatcherType
public jakarta.servlet.DispatcherType getDispatcherType()- Specified by:
getDispatcherType
in interfacejakarta.servlet.ServletRequest
- Overrides:
getDispatcherType
in classjakarta.servlet.ServletRequestWrapper
-
getServletPath
- Specified by:
getServletPath
in interfacejakarta.servlet.http.HttpServletRequest
- Overrides:
getServletPath
in classjakarta.servlet.http.HttpServletRequestWrapper
-
getPathInfo
- Specified by:
getPathInfo
in interfacejakarta.servlet.http.HttpServletRequest
- Overrides:
getPathInfo
in classjakarta.servlet.http.HttpServletRequestWrapper
-
setPathInfo
Set the path info.- Parameters:
pathInfo
- the path info.
-
getRequestURI
- Specified by:
getRequestURI
in interfacejakarta.servlet.http.HttpServletRequest
- Overrides:
getRequestURI
in classjakarta.servlet.http.HttpServletRequestWrapper
-
setRequestURI
Set the request URI.- Parameters:
requestURI
- the request URI.
-
getQueryString
- Specified by:
getQueryString
in interfacejakarta.servlet.http.HttpServletRequest
- Overrides:
getQueryString
in classjakarta.servlet.http.HttpServletRequestWrapper
-
startAsync
- Specified by:
startAsync
in interfacejakarta.servlet.ServletRequest
- Overrides:
startAsync
in classjakarta.servlet.ServletRequestWrapper
- Throws:
IllegalStateException
-
startAsync
public jakarta.servlet.AsyncContext startAsync(jakarta.servlet.ServletRequest servletRequest, jakarta.servlet.ServletResponse servletResponse) throws IllegalStateException - Specified by:
startAsync
in interfacejakarta.servlet.ServletRequest
- Overrides:
startAsync
in classjakarta.servlet.ServletRequestWrapper
- Throws:
IllegalStateException
-
isAsyncStarted
public boolean isAsyncStarted()- Specified by:
isAsyncStarted
in interfacejakarta.servlet.ServletRequest
- Overrides:
isAsyncStarted
in classjakarta.servlet.ServletRequestWrapper
-
getAttributeNames
- Specified by:
getAttributeNames
in interfacejakarta.servlet.ServletRequest
- Overrides:
getAttributeNames
in classjakarta.servlet.ServletRequestWrapper
-
getAttribute
- Specified by:
getAttribute
in interfacejakarta.servlet.ServletRequest
- Overrides:
getAttribute
in classjakarta.servlet.ServletRequestWrapper
-
setAttribute
- Specified by:
setAttribute
in interfacejakarta.servlet.ServletRequest
- Overrides:
setAttribute
in classjakarta.servlet.ServletRequestWrapper
-
removeAttribute
- Specified by:
removeAttribute
in interfacejakarta.servlet.ServletRequest
- Overrides:
removeAttribute
in classjakarta.servlet.ServletRequestWrapper
-
getParameter
Get the parameter.- Specified by:
getParameter
in interfacejakarta.servlet.ServletRequest
- Overrides:
getParameter
in classjakarta.servlet.ServletRequestWrapper
- Parameters:
name
- the name.- Returns:
- the value.
-
getParameterMap
Returns the parameter map.- Specified by:
getParameterMap
in interfacejakarta.servlet.ServletRequest
- Overrides:
getParameterMap
in classjakarta.servlet.ServletRequestWrapper
- Returns:
- the parameter map
-
getParameterNames
Returns the parameter names.- Specified by:
getParameterNames
in interfacejakarta.servlet.ServletRequest
- Overrides:
getParameterNames
in classjakarta.servlet.ServletRequestWrapper
- Returns:
- the parameter names
-
getParameterValues
Returns the parameter values.- Specified by:
getParameterValues
in interfacejakarta.servlet.ServletRequest
- Overrides:
getParameterValues
in classjakarta.servlet.ServletRequestWrapper
- Parameters:
name
- the parameter name.- Returns:
- the parameter values
-
setQueryString
Set the query string.- Parameters:
queryString
- the query string.
-
setAsWrapperAttribute
Set as a wrapper attribute.- Parameters:
name
- the name.value
- the value.
-
getWrapperAttributes
Returns the wrapper attributes.- Returns:
- the wrapper attributes
-
getWrapperParameters
Returns the wrapper parameters.- Returns:
- the wrapper parameters
-
setDispatcherType
public void setDispatcherType(jakarta.servlet.DispatcherType dispatcherType) Description copied from interface:WebApplicationRequest
Set the dispatcher type.- Specified by:
setDispatcherType
in interfaceWebApplicationRequest
- Parameters:
dispatcherType
- the dispatcher type.
-
toString
-
getRequestURIWithQueryString
Returns the request URI with query string.- Returns:
- the request URI with query string
-
setContextPath
Description copied from interface:WebApplicationRequest
Set the context path.- Specified by:
setContextPath
in interfaceWebApplicationRequest
- Parameters:
contextPath
- the context path.
-
setServletPath
Description copied from interface:WebApplicationRequest
Set the servlet path.- Specified by:
setServletPath
in interfaceWebApplicationRequest
- Parameters:
servletPath
- the servlet path.
-
setAuthType
Description copied from interface:WebApplicationRequest
Set the auth type.- Specified by:
setAuthType
in interfaceWebApplicationRequest
- Parameters:
authType
- the auth type.
-
setUserPrincipal
Description copied from interface:WebApplicationRequest
Set the user principal.- Specified by:
setUserPrincipal
in interfaceWebApplicationRequest
- Parameters:
userPrincipal
- the user principal.
-
setWebApplication
Description copied from interface:WebApplicationRequest
Set the web application.- Specified by:
setWebApplication
in interfaceWebApplicationRequest
- Parameters:
webApplication
- the web application.
-
getMultipartConfig
public jakarta.servlet.MultipartConfigElement getMultipartConfig()Description copied from interface:WebApplicationRequest
Returns the multipartConfig.- Specified by:
getMultipartConfig
in interfaceWebApplicationRequest
- Returns:
- the multipartConfig
-
setAsyncSupported
public void setAsyncSupported(boolean asyncSupported) Description copied from interface:WebApplicationRequest
Set the async supported flag.- Specified by:
setAsyncSupported
in interfaceWebApplicationRequest
- Parameters:
asyncSupported
- the async supported flag.
-