Package org.atmosphere.cpr

Class AtmosphereRequestImpl

java.lang.Object
jakarta.servlet.ServletRequestWrapper
jakarta.servlet.http.HttpServletRequestWrapper
org.atmosphere.cpr.AtmosphereRequestImpl
All Implemented Interfaces:
jakarta.servlet.http.HttpServletRequest, jakarta.servlet.ServletRequest, AtmosphereRequest
public class AtmosphereRequestImpl extends jakarta.servlet.http.HttpServletRequestWrapper implements AtmosphereRequest
An Atmosphere request representation. An AtmosphereRequest is a two-way communication channel between the client and the server. If the isDestroyable() is set to false, or if its associated AtmosphereResource has been suspended, this object can be re-used at any moment between requests. You can use its associated AtmosphereResponse to write bytes at any moment, making this object bi-directional.
Author:
Jeanfrancois Arcand

  • Method Details

    • destroyed

      public boolean destroyed()
      Specified by:
      destroyed in interface AtmosphereRequest

    • destroyable

      public AtmosphereRequest destroyable(boolean destroyable)
      Specified by:
      destroyable in interface AtmosphereRequest

    • getPathInfo

      public String getPathInfo()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getPathInfo in interface AtmosphereRequest
      Specified by:
      getPathInfo in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getPathInfo in class jakarta.servlet.http.HttpServletRequestWrapper

    • getPathTranslated

      public String getPathTranslated()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getPathTranslated in interface AtmosphereRequest
      Specified by:
      getPathTranslated in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getPathTranslated in class jakarta.servlet.http.HttpServletRequestWrapper

    • getQueryString

      public String getQueryString()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getQueryString in interface AtmosphereRequest
      Specified by:
      getQueryString in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getQueryString in class jakarta.servlet.http.HttpServletRequestWrapper

    • getRemoteUser

      public String getRemoteUser()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getRemoteUser in interface AtmosphereRequest
      Specified by:
      getRemoteUser in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getRemoteUser in class jakarta.servlet.http.HttpServletRequestWrapper

    • getRequestedSessionId

      public String getRequestedSessionId()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getRequestedSessionId in interface AtmosphereRequest
      Specified by:
      getRequestedSessionId in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getRequestedSessionId in class jakarta.servlet.http.HttpServletRequestWrapper

    • getMethod

      public String getMethod()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getMethod in interface AtmosphereRequest
      Specified by:
      getMethod in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getMethod in class jakarta.servlet.http.HttpServletRequestWrapper

    • getPart

      public jakarta.servlet.http.Part getPart(String name) throws IOException, jakarta.servlet.ServletException
      Description copied from interface: AtmosphereRequest
      Specified by:
      getPart in interface AtmosphereRequest
      Specified by:
      getPart in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getPart in class jakarta.servlet.http.HttpServletRequestWrapper
      Throws:
      IOException
      jakarta.servlet.ServletException

    • getParts

      public Collection<jakarta.servlet.http.Part> getParts() throws IOException, jakarta.servlet.ServletException
      Description copied from interface: AtmosphereRequest
      Specified by:
      getParts in interface AtmosphereRequest
      Specified by:
      getParts in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getParts in class jakarta.servlet.http.HttpServletRequestWrapper
      Throws:
      IOException
      jakarta.servlet.ServletException

    • getContentType

      public String getContentType()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getContentType in interface AtmosphereRequest
      Specified by:
      getContentType in interface jakarta.servlet.ServletRequest
      Overrides:
      getContentType in class jakarta.servlet.ServletRequestWrapper

    • getDispatcherType

      public jakarta.servlet.DispatcherType getDispatcherType()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getDispatcherType in interface AtmosphereRequest
      Specified by:
      getDispatcherType in interface jakarta.servlet.ServletRequest
      Overrides:
      getDispatcherType in class jakarta.servlet.ServletRequestWrapper

    • getServletPath

      public String getServletPath()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getServletPath in interface AtmosphereRequest
      Specified by:
      getServletPath in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getServletPath in class jakarta.servlet.http.HttpServletRequestWrapper

    • getRequestURI

      public String getRequestURI()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getRequestURI in interface AtmosphereRequest
      Specified by:
      getRequestURI in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getRequestURI in class jakarta.servlet.http.HttpServletRequestWrapper

    • getRequestURL

      public StringBuffer getRequestURL()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getRequestURL in interface AtmosphereRequest
      Specified by:
      getRequestURL in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getRequestURL in class jakarta.servlet.http.HttpServletRequestWrapper

    • getHeaders

      public Enumeration getHeaders(String name)
      Description copied from interface: AtmosphereRequest
      Specified by:
      getHeaders in interface AtmosphereRequest
      Specified by:
      getHeaders in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getHeaders in class jakarta.servlet.http.HttpServletRequestWrapper

    • getIntHeader

      public int getIntHeader(String name)
      Description copied from interface: AtmosphereRequest
      Specified by:
      getIntHeader in interface AtmosphereRequest
      Specified by:
      getIntHeader in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getIntHeader in class jakarta.servlet.http.HttpServletRequestWrapper

    • getHeaderNames

      public Enumeration<String> getHeaderNames()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getHeaderNames in interface AtmosphereRequest
      Specified by:
      getHeaderNames in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getHeaderNames in class jakarta.servlet.http.HttpServletRequestWrapper

    • authenticate

      public boolean authenticate(jakarta.servlet.http.HttpServletResponse response) throws IOException, jakarta.servlet.ServletException
      Description copied from interface: AtmosphereRequest
      Specified by:
      authenticate in interface AtmosphereRequest
      Specified by:
      authenticate in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      authenticate in class jakarta.servlet.http.HttpServletRequestWrapper
      Throws:
      IOException
      jakarta.servlet.ServletException

    • getAuthType

      public String getAuthType()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getAuthType in interface AtmosphereRequest
      Specified by:
      getAuthType in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getAuthType in class jakarta.servlet.http.HttpServletRequestWrapper

    • getContextPath

      public String getContextPath()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getContextPath in interface AtmosphereRequest
      Specified by:
      getContextPath in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getContextPath in class jakarta.servlet.http.HttpServletRequestWrapper

    • getCookies

      public jakarta.servlet.http.Cookie[] getCookies()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getCookies in interface AtmosphereRequest
      Specified by:
      getCookies in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getCookies in class jakarta.servlet.http.HttpServletRequestWrapper

    • getDateHeader

      public long getDateHeader(String name)
      Description copied from interface: AtmosphereRequest
      Specified by:
      getDateHeader in interface AtmosphereRequest
      Specified by:
      getDateHeader in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getDateHeader in class jakarta.servlet.http.HttpServletRequestWrapper

    • getHeader

      public String getHeader(String s)
      Description copied from interface: AtmosphereRequest
      Specified by:
      getHeader in interface AtmosphereRequest
      Specified by:
      getHeader in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getHeader in class jakarta.servlet.http.HttpServletRequestWrapper

    • wrappedRequest

      public jakarta.servlet.http.HttpServletRequest wrappedRequest()
      Specified by:
      wrappedRequest in interface AtmosphereRequest

    • getHeader

      public String getHeader(String s, boolean checkCase)
      Specified by:
      getHeader in interface AtmosphereRequest

    • getParameter

      public String getParameter(String s)
      Description copied from interface: AtmosphereRequest
      Specified by:
      getParameter in interface AtmosphereRequest
      Specified by:
      getParameter in interface jakarta.servlet.ServletRequest
      Overrides:
      getParameter in class jakarta.servlet.ServletRequestWrapper

    • getParameterMap

      public Map<String,String[]> getParameterMap()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getParameterMap in interface AtmosphereRequest
      Specified by:
      getParameterMap in interface jakarta.servlet.ServletRequest
      Overrides:
      getParameterMap in class jakarta.servlet.ServletRequestWrapper

    • getParameterNames

      public Enumeration<String> getParameterNames()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getParameterNames in interface AtmosphereRequest
      Specified by:
      getParameterNames in interface jakarta.servlet.ServletRequest
      Overrides:
      getParameterNames in class jakarta.servlet.ServletRequestWrapper

    • getParameterValues

      public String[] getParameterValues(String s)
      Description copied from interface: AtmosphereRequest
      Specified by:
      getParameterValues in interface AtmosphereRequest
      Specified by:
      getParameterValues in interface jakarta.servlet.ServletRequest
      Overrides:
      getParameterValues in class jakarta.servlet.ServletRequestWrapper

    • getProtocol

      public String getProtocol()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getProtocol in interface AtmosphereRequest
      Specified by:
      getProtocol in interface jakarta.servlet.ServletRequest
      Overrides:
      getProtocol in class jakarta.servlet.ServletRequestWrapper

    • getInputStream

      public jakarta.servlet.ServletInputStream getInputStream() throws IOException
      Description copied from interface: AtmosphereRequest
      Specified by:
      getInputStream in interface AtmosphereRequest
      Specified by:
      getInputStream in interface jakarta.servlet.ServletRequest
      Overrides:
      getInputStream in class jakarta.servlet.ServletRequestWrapper
      Throws:
      IOException

    • getReader

      public BufferedReader getReader() throws IOException
      Description copied from interface: AtmosphereRequest
      Specified by:
      getReader in interface AtmosphereRequest
      Specified by:
      getReader in interface jakarta.servlet.ServletRequest
      Overrides:
      getReader in class jakarta.servlet.ServletRequestWrapper
      Throws:
      IOException

    • getRealPath

      public String getRealPath(String path)
      Description copied from interface: AtmosphereRequest
      Specified by:
      getRealPath in interface AtmosphereRequest
      Specified by:
      getRealPath in interface jakarta.servlet.ServletRequest
      Overrides:
      getRealPath in class jakarta.servlet.ServletRequestWrapper

    • headers

      public AtmosphereRequest headers(Map<String,String> headers)
      Description copied from interface: AtmosphereRequest
      Add all headers contained within the Map.
      Specified by:
      headers in interface AtmosphereRequest
      Parameters:
      headers -
      Returns:
      this;

    • header

      public AtmosphereRequest header(String name, String value)
      Description copied from interface: AtmosphereRequest
      Add a header.
      Specified by:
      header in interface AtmosphereRequest
      Parameters:
      name -
      value -
      Returns:
      this

    • queryString

      public AtmosphereRequest queryString(String qs)
      Description copied from interface: AtmosphereRequest
      Set the query string.
      Specified by:
      queryString in interface AtmosphereRequest
      Parameters:
      qs -
      Returns:
      this

    • headersMap

      public Map<String,String> headersMap()
      Specified by:
      headersMap in interface AtmosphereRequest

    • queryStringsMap

      public Map<String,String[]> queryStringsMap()
      Specified by:
      queryStringsMap in interface AtmosphereRequest

    • method

      public AtmosphereRequest method(String m)
      Specified by:
      method in interface AtmosphereRequest

    • contentType

      public AtmosphereRequest contentType(String m)
      Specified by:
      contentType in interface AtmosphereRequest

    • body

      public AtmosphereRequest body(String body)
      Specified by:
      body in interface AtmosphereRequest

    • body

      public AtmosphereRequest body(byte[] bytes)
      Specified by:
      body in interface AtmosphereRequest

    • body

      public AtmosphereRequest body(InputStream body)
      Specified by:
      body in interface AtmosphereRequest

    • body

      public AtmosphereRequest body(Reader body)
      Specified by:
      body in interface AtmosphereRequest

    • body

      public AtmosphereRequestImpl.Body body()
      Description copied from interface: AtmosphereRequest
      Return the request's body. This method will return an empty Body if the underlying container or framework is using InputStream or Reader.
      Specified by:
      body in interface AtmosphereRequest
      Returns:
      the request body;

    • servletPath

      public AtmosphereRequest servletPath(String servletPath)
      Specified by:
      servletPath in interface AtmosphereRequest

    • contextPath

      public AtmosphereRequest contextPath(String contextPath)
      Specified by:
      contextPath in interface AtmosphereRequest

    • requestURI

      public AtmosphereRequest requestURI(String requestURI)
      Specified by:
      requestURI in interface AtmosphereRequest

    • setAttribute

      public void setAttribute(String s, Object o)
      Description copied from interface: AtmosphereRequest
      Specified by:
      setAttribute in interface AtmosphereRequest
      Specified by:
      setAttribute in interface jakarta.servlet.ServletRequest
      Overrides:
      setAttribute in class jakarta.servlet.ServletRequestWrapper

    • setCharacterEncoding

      public void setCharacterEncoding(String env) throws UnsupportedEncodingException
      Description copied from interface: AtmosphereRequest
      Specified by:
      setCharacterEncoding in interface AtmosphereRequest
      Specified by:
      setCharacterEncoding in interface jakarta.servlet.ServletRequest
      Overrides:
      setCharacterEncoding in class jakarta.servlet.ServletRequestWrapper
      Throws:
      UnsupportedEncodingException

    • startAsync

      public jakarta.servlet.AsyncContext startAsync()
      Description copied from interface: AtmosphereRequest
      Specified by:
      startAsync in interface AtmosphereRequest
      Specified by:
      startAsync in interface jakarta.servlet.ServletRequest
      Overrides:
      startAsync in class jakarta.servlet.ServletRequestWrapper

    • startAsync

      public jakarta.servlet.AsyncContext startAsync(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response)
      Description copied from interface: AtmosphereRequest
      Specified by:
      startAsync in interface AtmosphereRequest
      Specified by:
      startAsync in interface jakarta.servlet.ServletRequest
      Overrides:
      startAsync in class jakarta.servlet.ServletRequestWrapper

    • getAsyncContext

      public jakarta.servlet.AsyncContext getAsyncContext()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getAsyncContext in interface AtmosphereRequest
      Specified by:
      getAsyncContext in interface jakarta.servlet.ServletRequest
      Overrides:
      getAsyncContext in class jakarta.servlet.ServletRequestWrapper

    • getAttribute

      public Object getAttribute(String s)
      Description copied from interface: AtmosphereRequest
      Specified by:
      getAttribute in interface AtmosphereRequest
      Specified by:
      getAttribute in interface jakarta.servlet.ServletRequest
      Overrides:
      getAttribute in class jakarta.servlet.ServletRequestWrapper

    • removeAttribute

      public void removeAttribute(String name)
      Description copied from interface: AtmosphereRequest
      Specified by:
      removeAttribute in interface AtmosphereRequest
      Specified by:
      removeAttribute in interface jakarta.servlet.ServletRequest
      Overrides:
      removeAttribute in class jakarta.servlet.ServletRequestWrapper

    • attributes

      public AtmosphereRequest.LocalAttributes attributes()
      Description copied from interface: AtmosphereRequest
      Return the locally added attributes.
      Specified by:
      attributes in interface AtmosphereRequest
      Returns:
      the locally added attributes

    • getSession

      public jakarta.servlet.http.HttpSession getSession()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getSession in interface AtmosphereRequest
      Specified by:
      getSession in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getSession in class jakarta.servlet.http.HttpServletRequestWrapper

    • getSession

      public jakarta.servlet.http.HttpSession getSession(boolean create)
      Description copied from interface: AtmosphereRequest
      Specified by:
      getSession in interface AtmosphereRequest
      Specified by:
      getSession in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getSession in class jakarta.servlet.http.HttpServletRequestWrapper

    • getUserPrincipal

      public Principal getUserPrincipal()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getUserPrincipal in interface AtmosphereRequest
      Specified by:
      getUserPrincipal in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getUserPrincipal in class jakarta.servlet.http.HttpServletRequestWrapper

    • isRequestedSessionIdFromCookie

      public boolean isRequestedSessionIdFromCookie()
      Description copied from interface: AtmosphereRequest
      Specified by:
      isRequestedSessionIdFromCookie in interface AtmosphereRequest
      Specified by:
      isRequestedSessionIdFromCookie in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      isRequestedSessionIdFromCookie in class jakarta.servlet.http.HttpServletRequestWrapper

    • isRequestedSessionIdFromUrl

      public boolean isRequestedSessionIdFromUrl()
      Description copied from interface: AtmosphereRequest
      Specified by:
      isRequestedSessionIdFromUrl in interface AtmosphereRequest
      Specified by:
      isRequestedSessionIdFromUrl in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      isRequestedSessionIdFromUrl in class jakarta.servlet.http.HttpServletRequestWrapper

    • isRequestedSessionIdFromURL

      public boolean isRequestedSessionIdFromURL()
      Description copied from interface: AtmosphereRequest
      Specified by:
      isRequestedSessionIdFromURL in interface AtmosphereRequest
      Specified by:
      isRequestedSessionIdFromURL in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      isRequestedSessionIdFromURL in class jakarta.servlet.http.HttpServletRequestWrapper

    • isRequestedSessionIdValid

      public boolean isRequestedSessionIdValid()
      Description copied from interface: AtmosphereRequest
      Specified by:
      isRequestedSessionIdValid in interface AtmosphereRequest
      Specified by:
      isRequestedSessionIdValid in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      isRequestedSessionIdValid in class jakarta.servlet.http.HttpServletRequestWrapper

    • isUserInRole

      public boolean isUserInRole(String role)
      Description copied from interface: AtmosphereRequest
      Specified by:
      isUserInRole in interface AtmosphereRequest
      Specified by:
      isUserInRole in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      isUserInRole in class jakarta.servlet.http.HttpServletRequestWrapper

    • login

      public void login(String username, String password) throws jakarta.servlet.ServletException
      Description copied from interface: AtmosphereRequest
      Specified by:
      login in interface AtmosphereRequest
      Specified by:
      login in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      login in class jakarta.servlet.http.HttpServletRequestWrapper
      Throws:
      jakarta.servlet.ServletException

    • logout

      public void logout() throws jakarta.servlet.ServletException
      Description copied from interface: AtmosphereRequest
      Specified by:
      logout in interface AtmosphereRequest
      Specified by:
      logout in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      logout in class jakarta.servlet.http.HttpServletRequestWrapper
      Throws:
      jakarta.servlet.ServletException

    • getRemoteAddr

      public String getRemoteAddr()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getRemoteAddr in interface AtmosphereRequest
      Specified by:
      getRemoteAddr in interface jakarta.servlet.ServletRequest
      Overrides:
      getRemoteAddr in class jakarta.servlet.ServletRequestWrapper

    • getRemoteHost

      public String getRemoteHost()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getRemoteHost in interface AtmosphereRequest
      Specified by:
      getRemoteHost in interface jakarta.servlet.ServletRequest
      Overrides:
      getRemoteHost in class jakarta.servlet.ServletRequestWrapper

    • getRemotePort

      public int getRemotePort()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getRemotePort in interface AtmosphereRequest
      Specified by:
      getRemotePort in interface jakarta.servlet.ServletRequest
      Overrides:
      getRemotePort in class jakarta.servlet.ServletRequestWrapper

    • getRequestDispatcher

      public jakarta.servlet.RequestDispatcher getRequestDispatcher(String path)
      Description copied from interface: AtmosphereRequest
      Specified by:
      getRequestDispatcher in interface AtmosphereRequest
      Specified by:
      getRequestDispatcher in interface jakarta.servlet.ServletRequest
      Overrides:
      getRequestDispatcher in class jakarta.servlet.ServletRequestWrapper

    • getScheme

      public String getScheme()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getScheme in interface AtmosphereRequest
      Specified by:
      getScheme in interface jakarta.servlet.ServletRequest
      Overrides:
      getScheme in class jakarta.servlet.ServletRequestWrapper

    • getServerName

      public String getServerName()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getServerName in interface AtmosphereRequest
      Specified by:
      getServerName in interface jakarta.servlet.ServletRequest
      Overrides:
      getServerName in class jakarta.servlet.ServletRequestWrapper

    • getServerPort

      public int getServerPort()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getServerPort in interface AtmosphereRequest
      Specified by:
      getServerPort in interface jakarta.servlet.ServletRequest
      Overrides:
      getServerPort in class jakarta.servlet.ServletRequestWrapper

    • getServletContext

      public jakarta.servlet.ServletContext getServletContext()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getServletContext in interface AtmosphereRequest
      Specified by:
      getServletContext in interface jakarta.servlet.ServletRequest
      Overrides:
      getServletContext in class jakarta.servlet.ServletRequestWrapper

    • isAsyncStarted

      public boolean isAsyncStarted()
      Description copied from interface: AtmosphereRequest
      Specified by:
      isAsyncStarted in interface AtmosphereRequest
      Specified by:
      isAsyncStarted in interface jakarta.servlet.ServletRequest
      Overrides:
      isAsyncStarted in class jakarta.servlet.ServletRequestWrapper

    • isAsyncSupported

      public boolean isAsyncSupported()
      Description copied from interface: AtmosphereRequest
      Specified by:
      isAsyncSupported in interface AtmosphereRequest
      Specified by:
      isAsyncSupported in interface jakarta.servlet.ServletRequest
      Overrides:
      isAsyncSupported in class jakarta.servlet.ServletRequestWrapper

    • isSecure

      public boolean isSecure()
      Description copied from interface: AtmosphereRequest
      Specified by:
      isSecure in interface AtmosphereRequest
      Specified by:
      isSecure in interface jakarta.servlet.ServletRequest
      Overrides:
      isSecure in class jakarta.servlet.ServletRequestWrapper

    • getLocalName

      public String getLocalName()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getLocalName in interface AtmosphereRequest
      Specified by:
      getLocalName in interface jakarta.servlet.ServletRequest
      Overrides:
      getLocalName in class jakarta.servlet.ServletRequestWrapper

    • getLocalPort

      public int getLocalPort()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getLocalPort in interface AtmosphereRequest
      Specified by:
      getLocalPort in interface jakarta.servlet.ServletRequest
      Overrides:
      getLocalPort in class jakarta.servlet.ServletRequestWrapper

    • getLocalAddr

      public String getLocalAddr()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getLocalAddr in interface AtmosphereRequest
      Specified by:
      getLocalAddr in interface jakarta.servlet.ServletRequest
      Overrides:
      getLocalAddr in class jakarta.servlet.ServletRequestWrapper

    • getLocale

      public Locale getLocale()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getLocale in interface AtmosphereRequest
      Specified by:
      getLocale in interface jakarta.servlet.ServletRequest
      Overrides:
      getLocale in class jakarta.servlet.ServletRequestWrapper

    • resource

      public AtmosphereResource resource()
      Description copied from interface: AtmosphereRequest
      The AtmosphereResource associated with this request.
      Specified by:
      resource in interface AtmosphereRequest
      Returns:
      an AtmosphereResource

    • getLocales

      public Enumeration<Locale> getLocales()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getLocales in interface AtmosphereRequest
      Specified by:
      getLocales in interface jakarta.servlet.ServletRequest
      Overrides:
      getLocales in class jakarta.servlet.ServletRequestWrapper

    • dispatchRequestAsynchronously

      public boolean dispatchRequestAsynchronously()
      Description copied from interface: AtmosphereRequest
      Dispatch the request asynchronously to container. The default is false.
      Specified by:
      dispatchRequestAsynchronously in interface AtmosphereRequest
      Returns:
      true to dispatch the request asynchronously to container.

    • isDestroyable

      public boolean isDestroyable()
      Description copied from interface: AtmosphereRequest
      Cjeck if this object can be destroyed. Default is true.
      Specified by:
      isDestroyable in interface AtmosphereRequest

    • pathInfo

      public AtmosphereRequest pathInfo(String pathInfo)
      Specified by:
      pathInfo in interface AtmosphereRequest

    • getAttributeNames

      public Enumeration<String> getAttributeNames()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getAttributeNames in interface AtmosphereRequest
      Specified by:
      getAttributeNames in interface jakarta.servlet.ServletRequest
      Overrides:
      getAttributeNames in class jakarta.servlet.ServletRequestWrapper

    • localAttributes

      public AtmosphereRequest.LocalAttributes localAttributes()
      Description copied from interface: AtmosphereRequest
      Return a subset of the attributes set on this AtmosphereRequest, set locally by the framework or by an application. Attributes added using this method won't be propagated to the original, container-only, native request object.
      Specified by:
      localAttributes in interface AtmosphereRequest
      Returns:
      a

    • getCharacterEncoding

      public String getCharacterEncoding()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getCharacterEncoding in interface AtmosphereRequest
      Specified by:
      getCharacterEncoding in interface jakarta.servlet.ServletRequest
      Overrides:
      getCharacterEncoding in class jakarta.servlet.ServletRequestWrapper

    • getContentLength

      public int getContentLength()
      Description copied from interface: AtmosphereRequest
      Specified by:
      getContentLength in interface AtmosphereRequest
      Specified by:
      getContentLength in interface jakarta.servlet.ServletRequest
      Overrides:
      getContentLength in class jakarta.servlet.ServletRequestWrapper

    • uuid

      public String uuid()
      Description copied from interface: AtmosphereRequest
      Return the underlying AtmosphereResource.uuid(). May return "0" if no AtmosphereResource is associated with this object.
      Specified by:
      uuid in interface AtmosphereRequest
      Returns:
      the underlying AtmosphereResource.uuid()

    • destroy

      public void destroy()
      Specified by:
      destroy in interface AtmosphereRequest

    • destroy

      public void destroy(boolean force)
      Specified by:
      destroy in interface AtmosphereRequest

    • setRequest

      public void setRequest(jakarta.servlet.ServletRequest request)
      Description copied from interface: AtmosphereRequest
      Specified by:
      setRequest in interface AtmosphereRequest
      Overrides:
      setRequest in class jakarta.servlet.ServletRequestWrapper

    • newInstance

      public static AtmosphereRequest newInstance()
      Create an instance of this class without an associated HttpServletRequest.
      Returns:
      an instance of this class without an associated HttpServletRequest

    • wrap

      public static AtmosphereRequest wrap(jakarta.servlet.http.HttpServletRequest request)
      Wrap an HttpServletRequest.
      Parameters:
      request - HttpServletRequest
      Returns:
      an AtmosphereRequest

    • cloneRequest

      public static AtmosphereRequest cloneRequest(jakarta.servlet.http.HttpServletRequest request, boolean loadInMemory, boolean copySession, boolean isDestroyable, boolean createSession)
      Copy the HttpServletRequest content inside an AtmosphereRequest. By default the returned AtmosphereRequest is not destroyable.
      Parameters:
      request - HttpServletRequest
      Returns:
      an AtmosphereRequest

    • toString

      public String toString()
      Specified by:
      toString in interface AtmosphereRequest
      Overrides:
      toString in class Object

    • requestURL

      public String requestURL()
      Specified by:
      requestURL in interface AtmosphereRequest