Module cloud.piranha.core.api
Package cloud.piranha.core.api

Interface WebApplicationRequest

All Superinterfaces:
jakarta.servlet.http.HttpServletRequest, jakarta.servlet.ServletRequest
All Known Implementing Classes:
AsyncHttpDispatchWrapper, DefaultWebApplicationRequest, EmbeddedRequest, HttpWebApplicationRequest
public interface WebApplicationRequest extends jakarta.servlet.http.HttpServletRequest
The WebApplicationRequest API.
Author:
Manfred Riem ([email protected])

  • Field Summary

    Fields inherited from interface jakarta.servlet.http.HttpServletRequest

    BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

  • Method Summary

    Modifier and Type
    Method
    Description
    default jakarta.servlet.MultipartConfigElement
    getMultipartConfig()
    Returns the multipartConfig.
    default jakarta.servlet.http.HttpUpgradeHandler
    getUpgradeHandler()
    Returns the upgrade handler.
    default WebApplicationInputStream
    getWebApplicationInputStream()
    Get the web application input stream.
    default boolean
    isUpgraded()
    Returns true when upgraded, false otherwise.
    void
    setAsyncSupported(boolean asyncSupported)
    Set the async supported flag.
    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.
    default void
    setRequestedSessionId(String requestedSessionId)
    Set the requested session id.
    void
    setServletPath(String servletPath)
    Set the servlet path.
    void
    setUserPrincipal(Principal userPrincipal)
    Set the user principal.
    void
    setWebApplication(WebApplication webApplication)
    Set the web application.
    default void
    setWebApplicationInputStream(WebApplicationInputStream webApplicationInputStream)
    Set the web application input stream.

    Methods inherited from interface jakarta.servlet.http.HttpServletRequest

    authenticate, changeSessionId, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getHttpServletMapping, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getTrailerFields, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isTrailerFieldsReady, isUserInRole, login, logout, newPushBuilder, upgrade

    Methods inherited from interface jakarta.servlet.ServletRequest

    getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getProtocolRequestId, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getRequestId, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

  • Method Details

    • getMultipartConfig

      default jakarta.servlet.MultipartConfigElement getMultipartConfig()
      Returns the multipartConfig.
      Returns:
      the multipartConfig

    • getUpgradeHandler

      default jakarta.servlet.http.HttpUpgradeHandler getUpgradeHandler()
      Returns the upgrade handler.
      Returns:
      the upgrade handler

    • getWebApplicationInputStream

      default WebApplicationInputStream getWebApplicationInputStream()
      Get the web application input stream.
      Returns:
      the web application input stream.

    • isUpgraded

      default boolean isUpgraded()
      Returns true when upgraded, false otherwise.
      Returns:
      true when upgraded, false otherwise

    • setAsyncSupported

      void setAsyncSupported(boolean asyncSupported)
      Set the async supported flag.
      Parameters:
      asyncSupported - the async supported flag.

    • setAuthType

      void setAuthType(String authType)
      Set the auth type.
      Parameters:
      authType - the auth type.

    • setContextPath

      void setContextPath(String contextPath)
      Set the context path.
      Parameters:
      contextPath - the context path.

    • setDispatcherType

      void setDispatcherType(jakarta.servlet.DispatcherType dispatcherType)
      Set the dispatcher type.
      Parameters:
      dispatcherType - the dispatcher type.

    • setRequestedSessionId

      default void setRequestedSessionId(String requestedSessionId)
      Set the requested session id.
      Parameters:
      requestedSessionId - the requested session id.

    • setServletPath

      void setServletPath(String servletPath)
      Set the servlet path.
      Parameters:
      servletPath - the servlet path.

    • setUserPrincipal

      void setUserPrincipal(Principal userPrincipal)
      Set the user principal.
      Parameters:
      userPrincipal - the user principal.

    • setWebApplication

      void setWebApplication(WebApplication webApplication)
      Set the web application.
      Parameters:
      webApplication - the web application.

    • setWebApplicationInputStream

      default void setWebApplicationInputStream(WebApplicationInputStream webApplicationInputStream)
      Set the web application input stream.
      Parameters:
      webApplicationInputStream - the web application input stream.