com.atlassian.jira.plugin.webresource

Class JiraWebResourceManagerImpl

java.lang.Object

com.atlassian.plugin.webresource.WebResourceManagerImpl

com.atlassian.jira.plugin.webresource.JiraWebResourceManagerImpl

All Implemented Interfaces:

JiraWebResourceManager, com.atlassian.plugin.webresource.WebResourceManager

public class JiraWebResourceManagerImpl
extends com.atlassian.plugin.webresource.WebResourceManagerImpl
implements JiraWebResourceManager

A simple subclass of WebResourceManagerImpl that allows us to override some of its behaviour

Since:

v4.4

Field Summary

Fields inherited from class com.atlassian.plugin.webresource.WebResourceManagerImpl

pageBuilderService, webResourceIntegration

Constructor Summary

Constructors

Constructor and Description
JiraWebResourceManagerImpl(com.atlassian.plugin.webresource.PluginResourceLocator pluginResourceLocator, com.atlassian.plugin.webresource.WebResourceIntegration webResourceIntegration, com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider, com.atlassian.plugin.webresource.ResourceBatchingConfiguration batchingConfiguration)

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getMetadata() Returns the map of key-value pairs added via JiraWebResourceManager.putMetadata(String, String).
boolean	putMetadata(String key, String value) Adds key-value String pairs to a map to be rendered later.

Methods inherited from class com.atlassian.plugin.webresource.WebResourceManagerImpl

executeInNewContext, getRequestLocalAssembledResources, getRequestLocalRequiredResources, getRequiredResources, getRequiredResources, getRequiredResources, getRequiredResources, getResourceTags, getResourceTags, getStaticPluginResource, getStaticPluginResource, getStaticPluginResource, getStaticPluginResource, getStaticResourcePrefix, getStaticResourcePrefix, includeResources, includeResources, includeResources, includeResources, requireResource, requireResource, requireResource, requireResourcesForContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.plugin.webresource.WebResourceManager

executeInNewContext, getRequiredResources, getRequiredResources, getRequiredResources, getResourceTags, getResourceTags, getStaticPluginResource, getStaticPluginResource, getStaticPluginResource, getStaticPluginResource, getStaticResourcePrefix, getStaticResourcePrefix, includeResources, includeResources, includeResources, includeResources, requireResource, requireResource, requireResource, requireResourcesForContext

Constructor Detail

JiraWebResourceManagerImpl

public JiraWebResourceManagerImpl(com.atlassian.plugin.webresource.PluginResourceLocator pluginResourceLocator,
                                  com.atlassian.plugin.webresource.WebResourceIntegration webResourceIntegration,
                                  com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider,
                                  com.atlassian.plugin.webresource.ResourceBatchingConfiguration batchingConfiguration)

Method Detail

putMetadata

public boolean putMetadata(String key,
                           String value)

Description copied from interface: JiraWebResourceManager

Adds key-value String pairs to a map to be rendered later.

Specified by:

putMetadata in interface JiraWebResourceManager

Parameters:

key - a unique key to store the value against

value - an HTML-safe string

Returns:

true if metadata added to map successfully

getMetadata

public Map<String,String> getMetadata()

Description copied from interface: JiraWebResourceManager

Returns the map of key-value pairs added via JiraWebResourceManager.putMetadata(String, String).

Prior to v6.4, multiple invocations weren't supported, and only the first call would return metadata. Subsequent calls would return an empty Map. Since v6.4, multiple invocations of this method are supported. Each invocation drains and returns the metadata added since the last invocation.

Specified by:

getMetadata in interface JiraWebResourceManager

Returns:

the map of key-value pairs added via JiraWebResourceManager.putMetadata(String, String).