public class BigPipeWebPanelModuleDescriptor
extends com.atlassian.plugin.web.descriptors.DefaultWebPanelModuleDescriptor
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
XML_ELEMENT_NAME
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) |
Modifier and Type | Method and Description |
---|---|
com.atlassian.plugin.web.model.WebPanel |
getModule() |
void |
init(com.atlassian.plugin.Plugin plugin,
org.dom4j.Element element) |
disabled, enabled, getLocation, getWeight, provideValidationRules
equals, getCondition, getContextProvider, getTooltip, getWebLabel, getWebParams, hashCode, makeCondition, makeConditions, makeConditions, makeContextProvider, setWebInterfaceManager
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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getCondition, getTooltip, getWebLabel, getWebParams
destroy, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken
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)
public void init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element) throws com.atlassian.plugin.PluginParseException
init
in interface com.atlassian.plugin.ModuleDescriptor<com.atlassian.plugin.web.model.WebPanel>
init
in class com.atlassian.plugin.web.descriptors.DefaultWebPanelModuleDescriptor
com.atlassian.plugin.PluginParseException
public com.atlassian.plugin.web.model.WebPanel getModule()
getModule
in interface com.atlassian.plugin.ModuleDescriptor<com.atlassian.plugin.web.model.WebPanel>
getModule
in class com.atlassian.plugin.web.descriptors.DefaultWebPanelModuleDescriptor
Copyright © 2002-2018 Atlassian. All Rights Reserved.