Package com.atlassian.jira.web.pagebuilder

Interface PageBuilderServiceSpi

All Known Implementing Classes:
BootstrapPageBuilderServiceSpi, DefaultJiraPageBuilderService
public interface PageBuilderServiceSpi
Interface for creating and initialising page builders.
Since:
v6.1

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clearForRequest()
    Clears the page builder for the current request.
    PageBuilderSpi
    getSpi()
    Returns the page builder spi for the current request
    void
    initForRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, FlushEarlyListener flushEarlyListener, javax.servlet.ServletContext servletContext)
    Creates a new page builder for the current request.

  • Method Details

    • initForRequest

      void initForRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, FlushEarlyListener flushEarlyListener, javax.servlet.ServletContext servletContext)
      Creates a new page builder for the current request. If this has already been called for the current request, this is a no-op.
      Parameters:
      request - http request
      response - http response
      flushEarlyListener - decorator listener
      servletContext - servlet context

    • clearForRequest

      void clearForRequest()
      Clears the page builder for the current request.

    • getSpi

      PageBuilderSpi getSpi()
      Returns the page builder spi for the current request
      Returns:
      request-local page builder spi
      Throws:
      IllegalStateException - if no page builder spi has been set for the current request