Package com.atlassian.sal.api.web.context

Interface HttpContext

public interface HttpContext
Provides access to the key objects provided by the servlet API when processing an HTTP request.

Use this interface rather than making static calls to classes like ServletActionContext directly.

Note that this interface makes no guarantees about which wrapper for the active request, response or session will be returned. Callers should not rely on retrieving any particular wrapper. It is only guaranteed to be populated on a http request thread, after login, and before decoration.

Since:
2.8

  • Method Summary

    Modifier and Type
    Method
    Description
    javax.servlet.http.HttpServletRequest
    getRequest()
    Returns the active HTTP request or null if one cannot be found.
    javax.servlet.http.HttpServletResponse
    getResponse()
    Returns the active HTTP response or null if one cannot be found.
    javax.servlet.http.HttpSession
    getSession(boolean create)
    Returns the session associated with the active request or, if there is no current session and create is true, returns a new session.

  • Method Details

    • getRequest

      @Nullable javax.servlet.http.HttpServletRequest getRequest()
      Returns the active HTTP request or null if one cannot be found.

    • getResponse

      @Nullable javax.servlet.http.HttpServletResponse getResponse()
      Returns the active HTTP response or null if one cannot be found.

    • getSession

      @Nullable javax.servlet.http.HttpSession getSession(boolean create)
      Returns the session associated with the active request or, if there is no current session and create is true, returns a new session.
      Parameters:
      create - should be true to create a new session for the active request or false to return null if there is no current session
      Returns:
      the HttpSession associated with this request or null if create is false and the request has no session, or if there is no active request