Summary: Methods | [Expand All]
@PublicApi public interface

HttpServletVariables

com.atlassian.jira.web.HttpServletVariables
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

This component can provide the variables that a typical javax.servlet.http.HttpServlet would receive.

Note this only makes sense to use inside a HTTP request thread of execution and hence if you are not inside one it will throw an IllegalStateException.

Summary

Public Methods
HttpServletRequest getHttpRequest()
HttpServletResponse getHttpResponse()
HttpSession getHttpSession()
ServletContext getServletContext()

Public Methods

public HttpServletRequest getHttpRequest ()

Returns
  • the HttpServletRequest in play
Throws
IllegalStateException if you are not inside a HTTP request thread

public HttpServletResponse getHttpResponse ()

Returns
  • the HttpServletResponse in play
Throws
IllegalStateException if you are not inside a HTTP request thread

public HttpSession getHttpSession ()

Returns
  • the HttpSession in play
Throws
IllegalStateException if you are not inside a HTTP request thread

public ServletContext getServletContext ()

Returns
  • the ServletContext of the JIRA web application