Package org.atmosphere.cpr

Interface AtmosphereRequest

All Superinterfaces:
jakarta.servlet.http.HttpServletRequest, jakarta.servlet.ServletRequest
All Known Implementing Classes:
AtmosphereRequestImpl
public interface AtmosphereRequest extends jakarta.servlet.http.HttpServletRequest
An Atmosphere request representation. An AtmosphereRequest is a two-way communication channel between the client and the server. If the AtmosphereRequestImpl.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

      boolean destroyed()

    • destroyable

      AtmosphereRequest destroyable(boolean destroyable)

    • getPathInfo

      String getPathInfo()
      Specified by:
      getPathInfo in interface jakarta.servlet.http.HttpServletRequest

    • getPathTranslated

      String getPathTranslated()
      Specified by:
      getPathTranslated in interface jakarta.servlet.http.HttpServletRequest

    • getQueryString

      String getQueryString()
      Specified by:
      getQueryString in interface jakarta.servlet.http.HttpServletRequest

    • getRemoteUser

      String getRemoteUser()
      Specified by:
      getRemoteUser in interface jakarta.servlet.http.HttpServletRequest

    • getRequestedSessionId

      String getRequestedSessionId()
      Specified by:
      getRequestedSessionId in interface jakarta.servlet.http.HttpServletRequest

    • getMethod

      String getMethod()
      Specified by:
      getMethod in interface jakarta.servlet.http.HttpServletRequest

    • getPart

      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

    • getParts

      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

    • getContentType

      String getContentType()
      Specified by:
      getContentType in interface jakarta.servlet.ServletRequest

    • getDispatcherType

      jakarta.servlet.DispatcherType getDispatcherType()
      Specified by:
      getDispatcherType in interface jakarta.servlet.ServletRequest

    • getServletPath

      String getServletPath()
      Specified by:
      getServletPath in interface jakarta.servlet.http.HttpServletRequest

    • getRequestURI

      String getRequestURI()
      Specified by:
      getRequestURI in interface jakarta.servlet.http.HttpServletRequest

    • getRequestURL

      StringBuffer getRequestURL()
      Specified by:
      getRequestURL in interface jakarta.servlet.http.HttpServletRequest

    • getHeaders

      Enumeration getHeaders(String name)
      Specified by:
      getHeaders in interface jakarta.servlet.http.HttpServletRequest

    • getIntHeader

      int getIntHeader(String name)
      Specified by:
      getIntHeader in interface jakarta.servlet.http.HttpServletRequest

    • getHeaderNames

      Enumeration<String> getHeaderNames()
      Specified by:
      getHeaderNames in interface jakarta.servlet.http.HttpServletRequest

    • authenticate

      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

    • getAuthType

      String getAuthType()
      Specified by:
      getAuthType in interface jakarta.servlet.http.HttpServletRequest

    • getContextPath

      String getContextPath()
      Specified by:
      getContextPath in interface jakarta.servlet.http.HttpServletRequest

    • getCookies

      jakarta.servlet.http.Cookie[] getCookies()
      Specified by:
      getCookies in interface jakarta.servlet.http.HttpServletRequest

    • getDateHeader

      long getDateHeader(String name)
      Specified by:
      getDateHeader in interface jakarta.servlet.http.HttpServletRequest

    • getHeader

      String getHeader(String s)
      Specified by:
      getHeader in interface jakarta.servlet.http.HttpServletRequest

    • wrappedRequest

      jakarta.servlet.http.HttpServletRequest wrappedRequest()

    • getHeader

      String getHeader(String s, boolean checkCase)

    • getParameter

      String getParameter(String s)
      Specified by:
      getParameter in interface jakarta.servlet.ServletRequest

    • getParameterMap

      Map<String,String[]> getParameterMap()
      Specified by:
      getParameterMap in interface jakarta.servlet.ServletRequest

    • getParameterNames

      Enumeration<String> getParameterNames()
      Specified by:
      getParameterNames in interface jakarta.servlet.ServletRequest

    • getParameterValues

      String[] getParameterValues(String s)
      Specified by:
      getParameterValues in interface jakarta.servlet.ServletRequest

    • getProtocol

      String getProtocol()
      Specified by:
      getProtocol in interface jakarta.servlet.ServletRequest

    • getInputStream

      jakarta.servlet.ServletInputStream getInputStream() throws IOException
      Specified by:
      getInputStream in interface jakarta.servlet.ServletRequest
      Throws:
      IOException

    • getReader

      BufferedReader getReader() throws IOException
      Specified by:
      getReader in interface jakarta.servlet.ServletRequest
      Throws:
      IOException

    • getRealPath

      String getRealPath(String path)
      Specified by:
      getRealPath in interface jakarta.servlet.ServletRequest

    • headers

      AtmosphereRequest headers(Map<String,String> headers)
      Add all headers contained within the Map.
      Parameters:
      headers -
      Returns:
      this;

    • header

      AtmosphereRequest header(String name, String value)
      Add a header.
      Parameters:
      name -
      value -
      Returns:
      this

    • queryString

      AtmosphereRequest queryString(String qs)
      Set the query string.
      Parameters:
      qs -
      Returns:
      this

    • headersMap

      Map<String,String> headersMap()

    • queryStringsMap

      Map<String,String[]> queryStringsMap()

    • method

      AtmosphereRequest method(String m)

    • contentType

      AtmosphereRequest contentType(String m)

    • body

      AtmosphereRequest body(String body)

    • body

      AtmosphereRequest body(byte[] bytes)

    • body

      AtmosphereRequest body(InputStream body)

    • body

      AtmosphereRequest body(Reader body)

    • body

      AtmosphereRequestImpl.Body body()
      Return the request's body. This method will return an empty Body if the underlying container or framework is using InputStream or Reader.
      Returns:
      the request body;

    • servletPath

      AtmosphereRequest servletPath(String servletPath)

    • contextPath

      AtmosphereRequest contextPath(String contextPath)

    • requestURI

      AtmosphereRequest requestURI(String requestURI)

    • setAttribute

      void setAttribute(String s, Object o)
      Specified by:
      setAttribute in interface jakarta.servlet.ServletRequest

    • setCharacterEncoding

      void setCharacterEncoding(String env) throws UnsupportedEncodingException
      Specified by:
      setCharacterEncoding in interface jakarta.servlet.ServletRequest
      Throws:
      UnsupportedEncodingException

    • startAsync

      jakarta.servlet.AsyncContext startAsync()
      Specified by:
      startAsync in interface jakarta.servlet.ServletRequest

    • startAsync

      jakarta.servlet.AsyncContext startAsync(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response)
      Specified by:
      startAsync in interface jakarta.servlet.ServletRequest

    • getAsyncContext

      jakarta.servlet.AsyncContext getAsyncContext()
      Specified by:
      getAsyncContext in interface jakarta.servlet.ServletRequest

    • getAttribute

      Object getAttribute(String s)
      Specified by:
      getAttribute in interface jakarta.servlet.ServletRequest

    • removeAttribute

      void removeAttribute(String name)
      Specified by:
      removeAttribute in interface jakarta.servlet.ServletRequest

    • attributes

      AtmosphereRequest.LocalAttributes attributes()
      Deprecated.
      Use localAttributes()
      Return the locally added attributes.
      Returns:
      the locally added attributes

    • getSession

      jakarta.servlet.http.HttpSession getSession()
      Specified by:
      getSession in interface jakarta.servlet.http.HttpServletRequest

    • getSession

      jakarta.servlet.http.HttpSession getSession(boolean create)
      Specified by:
      getSession in interface jakarta.servlet.http.HttpServletRequest

    • getUserPrincipal

      Principal getUserPrincipal()
      Specified by:
      getUserPrincipal in interface jakarta.servlet.http.HttpServletRequest

    • isRequestedSessionIdFromCookie

      boolean isRequestedSessionIdFromCookie()
      Specified by:
      isRequestedSessionIdFromCookie in interface jakarta.servlet.http.HttpServletRequest

    • isRequestedSessionIdFromUrl

      boolean isRequestedSessionIdFromUrl()
      Specified by:
      isRequestedSessionIdFromUrl in interface jakarta.servlet.http.HttpServletRequest

    • isRequestedSessionIdFromURL

      boolean isRequestedSessionIdFromURL()
      Specified by:
      isRequestedSessionIdFromURL in interface jakarta.servlet.http.HttpServletRequest

    • isRequestedSessionIdValid

      boolean isRequestedSessionIdValid()
      Specified by:
      isRequestedSessionIdValid in interface jakarta.servlet.http.HttpServletRequest

    • isUserInRole

      boolean isUserInRole(String role)
      Specified by:
      isUserInRole in interface jakarta.servlet.http.HttpServletRequest

    • login

      void login(String username, String password) throws jakarta.servlet.ServletException
      Specified by:
      login in interface jakarta.servlet.http.HttpServletRequest
      Throws:
      jakarta.servlet.ServletException

    • logout

      void logout() throws jakarta.servlet.ServletException
      Specified by:
      logout in interface jakarta.servlet.http.HttpServletRequest
      Throws:
      jakarta.servlet.ServletException

    • getRemoteAddr

      String getRemoteAddr()
      Specified by:
      getRemoteAddr in interface jakarta.servlet.ServletRequest

    • getRemoteHost

      String getRemoteHost()
      Specified by:
      getRemoteHost in interface jakarta.servlet.ServletRequest

    • getRemotePort

      int getRemotePort()
      Specified by:
      getRemotePort in interface jakarta.servlet.ServletRequest

    • getRequestDispatcher

      jakarta.servlet.RequestDispatcher getRequestDispatcher(String path)
      Specified by:
      getRequestDispatcher in interface jakarta.servlet.ServletRequest

    • getScheme

      String getScheme()
      Specified by:
      getScheme in interface jakarta.servlet.ServletRequest

    • getServerName

      String getServerName()
      Specified by:
      getServerName in interface jakarta.servlet.ServletRequest

    • getServerPort

      int getServerPort()
      Specified by:
      getServerPort in interface jakarta.servlet.ServletRequest

    • getServletContext

      jakarta.servlet.ServletContext getServletContext()
      Specified by:
      getServletContext in interface jakarta.servlet.ServletRequest

    • isAsyncStarted

      boolean isAsyncStarted()
      Specified by:
      isAsyncStarted in interface jakarta.servlet.ServletRequest

    • isAsyncSupported

      boolean isAsyncSupported()
      Specified by:
      isAsyncSupported in interface jakarta.servlet.ServletRequest

    • isSecure

      boolean isSecure()
      Specified by:
      isSecure in interface jakarta.servlet.ServletRequest

    • getLocalName

      String getLocalName()
      Specified by:
      getLocalName in interface jakarta.servlet.ServletRequest

    • getLocalPort

      int getLocalPort()
      Specified by:
      getLocalPort in interface jakarta.servlet.ServletRequest

    • getLocalAddr

      String getLocalAddr()
      Specified by:
      getLocalAddr in interface jakarta.servlet.ServletRequest

    • getLocale

      Locale getLocale()
      Specified by:
      getLocale in interface jakarta.servlet.ServletRequest

    • resource

      AtmosphereResource resource()
      The AtmosphereResource associated with this request.
      Returns:
      an AtmosphereResource

    • getLocales

      Enumeration<Locale> getLocales()
      Specified by:
      getLocales in interface jakarta.servlet.ServletRequest

    • dispatchRequestAsynchronously

      boolean dispatchRequestAsynchronously()
      Dispatch the request asynchronously to container. The default is false.
      Returns:
      true to dispatch the request asynchronously to container.

    • isDestroyable

      boolean isDestroyable()
      Cjeck if this object can be destroyed. Default is true.

    • pathInfo

      AtmosphereRequest pathInfo(String pathInfo)

    • getAttributeNames

      Enumeration<String> getAttributeNames()
      Specified by:
      getAttributeNames in interface jakarta.servlet.ServletRequest

    • localAttributes

      AtmosphereRequest.LocalAttributes localAttributes()
      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.
      Returns:
      a

    • getCharacterEncoding

      String getCharacterEncoding()
      Specified by:
      getCharacterEncoding in interface jakarta.servlet.ServletRequest

    • getContentLength

      int getContentLength()
      Specified by:
      getContentLength in interface jakarta.servlet.ServletRequest

    • uuid

      String uuid()
      Return the underlying AtmosphereResource.uuid(). May return "0" if no AtmosphereResource is associated with this object.
      Returns:
      the underlying AtmosphereResource.uuid()

    • destroy

      void destroy()

    • destroy

      void destroy(boolean force)

    • setRequest

      void setRequest(jakarta.servlet.ServletRequest request)

    • toString

      String toString()
      Overrides:
      toString in class Object

    • requestURL

      String requestURL()