com.atlassian.jira.plugin.webresource
Interface JiraWebResourceManager

All Superinterfaces:

com.atlassian.plugin.webresource.WebResourceManager

All Known Implementing Classes:

JiraWebResourceManagerImpl

@PublicApi
public interface JiraWebResourceManager
extends com.atlassian.plugin.webresource.WebResourceManager

Add some additional methods to the stock WebResourceManager that we can use in JIRA.

Since:

v5.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.plugin.webresource.WebResourceManager

com.atlassian.plugin.webresource.WebResourceManager.IncludeMode

Field Summary

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

DELAYED_INCLUDE_MODE, INLINE_INCLUDE_MODE

Method Summary

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

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

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

Method Detail

putMetadata

boolean putMetadata(String key,
                    String value)

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

Parameters:

key - a unique key to store the value against

value - an HTML-safe string

Returns:

true if metadata added to map successfully

Since:

v5.0

getMetadata

Map<String,String> getMetadata()

Returns the map of key-value pairs added via putMetadata(String, String). Should return an empty map and log a warning if called more than once in a request.

Returns:

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

Since:

v5.0