Package org.glassfish.grizzly.servlet
Class HttpServletRequestImpl
java.lang.Object
org.glassfish.grizzly.servlet.HttpServletRequestImpl
- All Implemented Interfaces:
jakarta.servlet.http.HttpServletRequest,jakarta.servlet.ServletRequest,Holders.RequestHolder
public class HttpServletRequestImpl
extends Object
implements jakarta.servlet.http.HttpServletRequest, Holders.RequestHolder
Facade class that wraps a
Request 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
FieldsModifier and TypeFieldDescriptionprotected org.glassfish.grizzly.http.server.RequestThe wrapped request.protected HttpServletResponseImplThe corresponding servlet responseprotected booleanUsing stream flag.protected booleanUsing writer flag.Fields inherited from interface jakarta.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstruct a wrapper for the specified request. -
Method Summary
Modifier and TypeMethodDescriptionbooleanauthenticate(jakarta.servlet.http.HttpServletResponse hsr) protected Objectclone()Prevent cloning the facade.static HttpServletRequestImplcreate()voidDisables async support for this request.jakarta.servlet.AsyncContextgetAttribute(String name) intlongprotected WebappContextReturn the underlyingWebappContextjakarta.servlet.http.Cookie[]longgetDateHeader(String name) jakarta.servlet.DispatcherTypeorg.glassfish.grizzly.http.Cookie[]getHeaders(String name) jakarta.servlet.http.HttpServletMappingjakarta.servlet.http.HttpUpgradeHandlerjakarta.servlet.ServletInputStreamorg.glassfish.grizzly.http.server.RequestReturns internal GrizzlyRequestassociated with this Holder.intgetIntHeader(String name) intgetParameter(String name) String[]getParameterValues(String name) jakarta.servlet.http.PartCollection<jakarta.servlet.http.Part>getParts()intorg.glassfish.grizzly.http.server.Requestjakarta.servlet.RequestDispatchergetRequestDispatcher(String path) intjakarta.servlet.ServletConnectionjakarta.servlet.ServletContextjakarta.servlet.http.HttpSessionjakarta.servlet.http.HttpSessiongetSession(boolean create) voidinitialize(org.glassfish.grizzly.http.server.Request request, HttpServletResponseImpl servletResponse, WebappContext context) booleanbooleanbooleanbooleanbooleanbooleanisSecure()booleanbooleanbooleanisUserInRole(String role) voidvoidlogout()jakarta.servlet.http.PushBuildervoidremoveAttribute(String name) voidsetAttribute(String name, Object value) voidprotected voidsetContextImpl(WebappContext contextImpl) Set the underlyingWebappContextprotected voidsetContextPath(String contextPath) protected voidsetPathInfo(String pathInfo) voidsetServletPath(String servletPath) Programmatically set the servlet path value.jakarta.servlet.AsyncContextjakarta.servlet.AsyncContextstartAsync(jakarta.servlet.ServletRequest servletRequest, jakarta.servlet.ServletResponse servletResponse) <T extends jakarta.servlet.http.HttpUpgradeHandler>
TCreate an instance ofHttpUpgradeHandlerfor an given class and uses it for the http protocol upgrade processing.
-
Field Details
-
request
protected org.glassfish.grizzly.http.server.Request requestThe wrapped request. -
servletResponse
The corresponding servlet response -
usingInputStream
protected boolean usingInputStreamUsing stream flag. -
usingReader
protected boolean usingReaderUsing writer flag.
-
-
Constructor Details
-
HttpServletRequestImpl
protected HttpServletRequestImpl()Construct a wrapper for the specified request.
-
-
Method Details
-
create
-
initialize
public void initialize(org.glassfish.grizzly.http.server.Request request, HttpServletResponseImpl servletResponse, WebappContext context) throws IOException - Throws:
IOException
-
clone
Prevent cloning the facade.- Overrides:
clonein classObject- Throws:
CloneNotSupportedException
-
getAttribute
- Specified by:
getAttributein interfacejakarta.servlet.ServletRequest
-
getAttributeNames
- Specified by:
getAttributeNamesin interfacejakarta.servlet.ServletRequest
-
getCharacterEncoding
- Specified by:
getCharacterEncodingin interfacejakarta.servlet.ServletRequest
-
setCharacterEncoding
- Specified by:
setCharacterEncodingin interfacejakarta.servlet.ServletRequest- Throws:
UnsupportedEncodingException
-
getContentLength
public int getContentLength()- Specified by:
getContentLengthin interfacejakarta.servlet.ServletRequest
-
getContentLengthLong
public long getContentLengthLong()- Specified by:
getContentLengthLongin interfacejakarta.servlet.ServletRequest
-
getContentType
- Specified by:
getContentTypein interfacejakarta.servlet.ServletRequest
-
getInputStream
- Specified by:
getInputStreamin interfacejakarta.servlet.ServletRequest- Throws:
IOException
-
getParameter
- Specified by:
getParameterin interfacejakarta.servlet.ServletRequest
-
getParameterNames
- Specified by:
getParameterNamesin interfacejakarta.servlet.ServletRequest
-
getParameterValues
- Specified by:
getParameterValuesin interfacejakarta.servlet.ServletRequest
-
getParameterMap
- Specified by:
getParameterMapin interfacejakarta.servlet.ServletRequest
-
getProtocol
- Specified by:
getProtocolin interfacejakarta.servlet.ServletRequest
-
getScheme
- Specified by:
getSchemein interfacejakarta.servlet.ServletRequest
-
getServerName
- Specified by:
getServerNamein interfacejakarta.servlet.ServletRequest
-
getServerPort
public int getServerPort()- Specified by:
getServerPortin interfacejakarta.servlet.ServletRequest
-
getReader
- Specified by:
getReaderin interfacejakarta.servlet.ServletRequest- Throws:
IOException
-
getRemoteAddr
- Specified by:
getRemoteAddrin interfacejakarta.servlet.ServletRequest
-
getRemoteHost
- Specified by:
getRemoteHostin interfacejakarta.servlet.ServletRequest
-
setAttribute
- Specified by:
setAttributein interfacejakarta.servlet.ServletRequest
-
removeAttribute
- Specified by:
removeAttributein interfacejakarta.servlet.ServletRequest
-
getLocale
- Specified by:
getLocalein interfacejakarta.servlet.ServletRequest
-
getLocales
- Specified by:
getLocalesin interfacejakarta.servlet.ServletRequest
-
isSecure
public boolean isSecure()- Specified by:
isSecurein interfacejakarta.servlet.ServletRequest
-
getRequestDispatcher
- Specified by:
getRequestDispatcherin interfacejakarta.servlet.ServletRequest
-
getAuthType
- Specified by:
getAuthTypein interfacejakarta.servlet.http.HttpServletRequest
-
getGrizzlyCookies
public org.glassfish.grizzly.http.Cookie[] getGrizzlyCookies() -
getDateHeader
- Specified by:
getDateHeaderin interfacejakarta.servlet.http.HttpServletRequest
-
getHeader
- Specified by:
getHeaderin interfacejakarta.servlet.http.HttpServletRequest
-
getHeaders
- Specified by:
getHeadersin interfacejakarta.servlet.http.HttpServletRequest
-
getHeaderNames
- Specified by:
getHeaderNamesin interfacejakarta.servlet.http.HttpServletRequest
-
getIntHeader
- Specified by:
getIntHeaderin interfacejakarta.servlet.http.HttpServletRequest
-
getMethod
- Specified by:
getMethodin interfacejakarta.servlet.http.HttpServletRequest
-
getPathInfo
- Specified by:
getPathInfoin interfacejakarta.servlet.http.HttpServletRequest
-
getPathTranslated
- Specified by:
getPathTranslatedin interfacejakarta.servlet.http.HttpServletRequest
-
getContextPath
- Specified by:
getContextPathin interfacejakarta.servlet.http.HttpServletRequest
-
setContextPath
-
getQueryString
- Specified by:
getQueryStringin interfacejakarta.servlet.http.HttpServletRequest
-
getRemoteUser
- Specified by:
getRemoteUserin interfacejakarta.servlet.http.HttpServletRequest
-
isUserInRole
- Specified by:
isUserInRolein interfacejakarta.servlet.http.HttpServletRequest
-
getUserPrincipal
- Specified by:
getUserPrincipalin interfacejakarta.servlet.http.HttpServletRequest
-
getRequestedSessionId
- Specified by:
getRequestedSessionIdin interfacejakarta.servlet.http.HttpServletRequest
-
getRequestURI
- Specified by:
getRequestURIin interfacejakarta.servlet.http.HttpServletRequest
-
getRequestURL
- Specified by:
getRequestURLin interfacejakarta.servlet.http.HttpServletRequest
-
getServletPath
- Specified by:
getServletPathin interfacejakarta.servlet.http.HttpServletRequest
-
getSession
public jakarta.servlet.http.HttpSession getSession(boolean create) - Specified by:
getSessionin interfacejakarta.servlet.http.HttpServletRequest
-
getSession
public jakarta.servlet.http.HttpSession getSession()- Specified by:
getSessionin interfacejakarta.servlet.http.HttpServletRequest
-
changeSessionId
- Specified by:
changeSessionIdin interfacejakarta.servlet.http.HttpServletRequest
-
isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()- Specified by:
isRequestedSessionIdValidin interfacejakarta.servlet.http.HttpServletRequest
-
isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()- Specified by:
isRequestedSessionIdFromCookiein interfacejakarta.servlet.http.HttpServletRequest
-
isRequestedSessionIdFromURL
public boolean isRequestedSessionIdFromURL()- Specified by:
isRequestedSessionIdFromURLin interfacejakarta.servlet.http.HttpServletRequest
-
getCookies
public jakarta.servlet.http.Cookie[] getCookies()- Specified by:
getCookiesin interfacejakarta.servlet.http.HttpServletRequest
-
getRemotePort
public int getRemotePort()- Specified by:
getRemotePortin interfacejakarta.servlet.ServletRequest
-
getLocalName
- Specified by:
getLocalNamein interfacejakarta.servlet.ServletRequest
-
getLocalAddr
- Specified by:
getLocalAddrin interfacejakarta.servlet.ServletRequest
-
getLocalPort
public int getLocalPort()- Specified by:
getLocalPortin interfacejakarta.servlet.ServletRequest
-
getContextImpl
Return the underlyingWebappContext- Returns:
- Return the underlying
WebappContext
-
setContextImpl
Set the underlyingWebappContext- Parameters:
contextImpl- the underlyingWebappContext
-
setServletPath
Programmatically set the servlet path value. Default is an empty String.- Parameters:
servletPath- Servlet path to set.
-
setPathInfo
-
getRequest
public org.glassfish.grizzly.http.server.Request getRequest() -
getServletContext
public jakarta.servlet.ServletContext getServletContext()- Specified by:
getServletContextin interfacejakarta.servlet.ServletRequest
-
getInternalRequest
public org.glassfish.grizzly.http.server.Request getInternalRequest()Returns internal GrizzlyRequestassociated with this Holder.- Specified by:
getInternalRequestin interfaceHolders.RequestHolder
-
getDispatcherType
public jakarta.servlet.DispatcherType getDispatcherType()- Specified by:
getDispatcherTypein interfacejakarta.servlet.ServletRequest
-
startAsync
- Specified by:
startAsyncin interfacejakarta.servlet.ServletRequest- Throws:
IllegalStateException
-
startAsync
public jakarta.servlet.AsyncContext startAsync(jakarta.servlet.ServletRequest servletRequest, jakarta.servlet.ServletResponse servletResponse) throws IllegalStateException - Specified by:
startAsyncin interfacejakarta.servlet.ServletRequest- Throws:
IllegalStateException
-
isAsyncStarted
public boolean isAsyncStarted()- Specified by:
isAsyncStartedin interfacejakarta.servlet.ServletRequest
-
disableAsyncSupport
public void disableAsyncSupport()Disables async support for this request. Async support is disabled as soon as this request has passed a filter or servlet that does not support async (either via the designated annotation or declaratively). -
isAsyncSupported
public boolean isAsyncSupported()- Specified by:
isAsyncSupportedin interfacejakarta.servlet.ServletRequest
-
getAsyncContext
public jakarta.servlet.AsyncContext getAsyncContext()- Specified by:
getAsyncContextin interfacejakarta.servlet.ServletRequest
-
upgrade
public <T extends jakarta.servlet.http.HttpUpgradeHandler> T upgrade(Class<T> handlerClass) throws IOException Create an instance ofHttpUpgradeHandlerfor an given class and uses it for the http protocol upgrade processing.- Specified by:
upgradein interfacejakarta.servlet.http.HttpServletRequest- Parameters:
handlerClass- TheProtocolHandlerclass used for the upgrade.- Returns:
- an instance of the
HttpUpgradeHandler - Throws:
IOException- if an I/O error occurred during the upgrade- Since:
- Servlet 3.1
- See Also:
-
HttpUpgradeHandlerWebConnection
-
isUpgrade
public boolean isUpgrade() -
getHttpUpgradeHandler
public jakarta.servlet.http.HttpUpgradeHandler getHttpUpgradeHandler() -
authenticate
public boolean authenticate(jakarta.servlet.http.HttpServletResponse hsr) throws IOException, jakarta.servlet.ServletException - Specified by:
authenticatein interfacejakarta.servlet.http.HttpServletRequest- Throws:
IOExceptionjakarta.servlet.ServletException
-
login
- Specified by:
loginin interfacejakarta.servlet.http.HttpServletRequest- Throws:
jakarta.servlet.ServletException
-
logout
public void logout() throws jakarta.servlet.ServletException- Specified by:
logoutin interfacejakarta.servlet.http.HttpServletRequest- Throws:
jakarta.servlet.ServletException
-
getParts
public Collection<jakarta.servlet.http.Part> getParts() throws IOException, jakarta.servlet.ServletException- Specified by:
getPartsin interfacejakarta.servlet.http.HttpServletRequest- Throws:
IOExceptionjakarta.servlet.ServletException
-
getPart
public jakarta.servlet.http.Part getPart(String string) throws IOException, jakarta.servlet.ServletException - Specified by:
getPartin interfacejakarta.servlet.http.HttpServletRequest- Throws:
IOExceptionjakarta.servlet.ServletException
-
getHttpServletMapping
public jakarta.servlet.http.HttpServletMapping getHttpServletMapping()- Specified by:
getHttpServletMappingin interfacejakarta.servlet.http.HttpServletRequest
-
newPushBuilder
public jakarta.servlet.http.PushBuilder newPushBuilder()- Specified by:
newPushBuilderin interfacejakarta.servlet.http.HttpServletRequest
-
getTrailerFields
- Specified by:
getTrailerFieldsin interfacejakarta.servlet.http.HttpServletRequest
-
isTrailerFieldsReady
public boolean isTrailerFieldsReady()- Specified by:
isTrailerFieldsReadyin interfacejakarta.servlet.http.HttpServletRequest
-
getRequestId
- Specified by:
getRequestIdin interfacejakarta.servlet.ServletRequest
-
getProtocolRequestId
- Specified by:
getProtocolRequestIdin interfacejakarta.servlet.ServletRequest
-
getServletConnection
public jakarta.servlet.ServletConnection getServletConnection()- Specified by:
getServletConnectionin interfacejakarta.servlet.ServletRequest
-