com.atlassian.jira.plugin.bigpipe

Class BigPipeWebPanelModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor<com.atlassian.plugin.web.model.WebPanel>

com.atlassian.plugin.web.descriptors.DefaultWebPanelModuleDescriptor

com.atlassian.jira.plugin.bigpipe.BigPipeWebPanelModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<com.atlassian.plugin.web.model.WebPanel>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware, com.atlassian.plugin.web.descriptors.ConditionalDescriptor, com.atlassian.plugin.web.descriptors.ContextAware, com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor<com.atlassian.plugin.web.model.WebPanel>, com.atlassian.plugin.web.descriptors.WebPanelModuleDescriptor, com.atlassian.plugin.web.descriptors.WeightedDescriptor

public class BigPipeWebPanelModuleDescriptor
extends com.atlassian.plugin.web.descriptors.DefaultWebPanelModuleDescriptor

Extension of DefaultWebPanelModuleDescriptor that allows content to be loaded through BigPipe. Content rendering of BigPipe enabled panel is deferred to the end of the request (or to another thread), allowing user to see intermediate result faster. Until actual content is rendered and sent to browser user will see temporary placeholder (which should be static so its generation is very fast). In order to enable BigPipe for web-panel resource named bigPipe must added like so:

     <web-panel key="myPanel" location="general">
          [...]
         <resource name="bigPipe" type="static">
          <param name="bigPipeId" value="activity-panel-pipe-id" />
          <![CDATA[
                    <big-pipe data-id="activity-panel-pipe-id"><div>Placeholder</div></big-pipe>
          ]]>
         </resource>
     </web-panel>
 

And com.atlassian.jira.config.BIG_PIPE dark feature must be enabled as well. To do that using jmake just pass the following parameter:

-J-Datlassian.darkfeature.com.atlassian.jira.config.BIG_PIPE=true

Since:

v7.1

Field Summary

Fields inherited from class com.atlassian.plugin.web.descriptors.DefaultWebPanelModuleDescriptor

XML_ELEMENT_NAME

Fields inherited from class com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor

condition, contextProvider, element, label, params, tooltip, webInterfaceManager

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources, singleton

Constructor Summary

Constructors

Constructor and Description
BigPipeWebPanelModuleDescriptor(com.atlassian.plugin.hostcontainer.HostContainer hostContainer, com.atlassian.plugin.module.ModuleFactory moduleClassFactory, com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager, BigPipeService bigPipeService, FeatureManager featureManager, ServerMetricsDetailCollector detailCollector)

Method Summary

Modifier and Type	Method and Description
com.atlassian.plugin.web.model.WebPanel	getModule()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)

Methods inherited from class com.atlassian.plugin.web.descriptors.DefaultWebPanelModuleDescriptor

disabled, enabled, getLocation, getWeight, provideValidationRules

Methods inherited from class com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor

equals, getCondition, getContextProvider, getTooltip, getWebLabel, getWebParams, hashCode, makeCondition, makeConditions, makeConditions, makeContextProvider, setWebInterfaceManager

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, destroy, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, getScopeKey, isBroken, isEnabled, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, satisfiesMinJavaVersion, setBroken, setPlugin, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor

getCondition, getTooltip, getWebLabel, getWebParams

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

destroy, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

Methods inherited from interface com.atlassian.plugin.ScopeAware

getScopeKey

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation

Methods inherited from interface com.atlassian.plugin.web.descriptors.ContextAware

getContextProvider

Constructor Detail

BigPipeWebPanelModuleDescriptor

public BigPipeWebPanelModuleDescriptor(com.atlassian.plugin.hostcontainer.HostContainer hostContainer,
                                       com.atlassian.plugin.module.ModuleFactory moduleClassFactory,
                                       com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager,
                                       BigPipeService bigPipeService,
                                       FeatureManager featureManager,
                                       ServerMetricsDetailCollector detailCollector)

Method Detail

init

public void init(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<com.atlassian.plugin.web.model.WebPanel>

Overrides:

init in class com.atlassian.plugin.web.descriptors.DefaultWebPanelModuleDescriptor

Throws:

com.atlassian.plugin.PluginParseException

getModule

public com.atlassian.plugin.web.model.WebPanel getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<com.atlassian.plugin.web.model.WebPanel>

Overrides:

getModule in class com.atlassian.plugin.web.descriptors.DefaultWebPanelModuleDescriptor