com.atlassian.jira.web.pagebuilder

Class DefaultJiraPageBuilderService

java.lang.Object

com.atlassian.plugin.webresource.assembler.DefaultPageBuilderService

com.atlassian.jira.web.pagebuilder.DefaultJiraPageBuilderService

All Implemented Interfaces:

JiraPageBuilderService, PageBuilderServiceSpi, com.atlassian.plugin.webresource.assembler.LegacyPageBuilderService, com.atlassian.webresource.api.assembler.PageBuilderService

public class DefaultJiraPageBuilderService
extends com.atlassian.plugin.webresource.assembler.DefaultPageBuilderService
implements JiraPageBuilderService, PageBuilderServiceSpi

Creates PageBuilder and PageBuilderSpi instances and caches them per-request.

TODO: this will be merged with its superclass once the PageBuilder interface has been tested in JIRA

Since:

v6.1

Field Summary

Fields inherited from interface com.atlassian.jira.web.pagebuilder.JiraPageBuilderService

DEFER_SCRIPTS_ON_DASHBOARD_DISABLE_FEATURE_KEY, SEND_HEAD_EARLY_FOR_DASHBOARD_DISABLE_FEATURE_KEY

Constructor Summary

Constructors

Constructor and Description
DefaultJiraPageBuilderService(com.atlassian.plugin.webresource.WebResourceIntegration webResourceIntegration, com.atlassian.plugin.webresource.prebake.PrebakeWebResourceAssemblerFactory webResourceAssemblerFactory, ServerMetricsDetailCollector serverMetricsDetailCollector)

Method Summary

Modifier and Type	Method and Description
void	clearForRequest() Clears the page builder for the current request.
PartialPageRenderer	getPartialPageRenderer() With this some parts of the page can be sent (flushed) to the browser earlier, so it can start parsing them early
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.

Methods inherited from class com.atlassian.plugin.webresource.assembler.DefaultPageBuilderService

assembler, clearRequestLocal, seed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.webresource.api.assembler.PageBuilderService

assembler, seed

Constructor Detail

DefaultJiraPageBuilderService

public DefaultJiraPageBuilderService(com.atlassian.plugin.webresource.WebResourceIntegration webResourceIntegration,
                                     com.atlassian.plugin.webresource.prebake.PrebakeWebResourceAssemblerFactory webResourceAssemblerFactory,
                                     ServerMetricsDetailCollector serverMetricsDetailCollector)

Method Detail

initForRequest

public void initForRequest(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response,
                           FlushEarlyListener flushEarlyListener,
                           javax.servlet.ServletContext servletContext)

Description copied from interface: PageBuilderServiceSpi

Creates a new page builder for the current request. If this has already been called for the current request, this is a no-op.

Specified by:

initForRequest in interface PageBuilderServiceSpi

Parameters:

request - http request

response - http response

flushEarlyListener - decorator listener

servletContext - servlet context

clearForRequest

public void clearForRequest()

Description copied from interface: PageBuilderServiceSpi

Clears the page builder for the current request.

Specified by:

clearForRequest in interface PageBuilderServiceSpi

getPartialPageRenderer

public PartialPageRenderer getPartialPageRenderer()

Description copied from interface: JiraPageBuilderService

With this some parts of the page can be sent (flushed) to the browser earlier, so it can start parsing them early

Specified by:

getPartialPageRenderer in interface JiraPageBuilderService

getSpi

public PageBuilderSpi getSpi()

Description copied from interface: PageBuilderServiceSpi

Returns the page builder spi for the current request

Specified by:

getSpi in interface PageBuilderServiceSpi

Returns:

request-local page builder spi