Package com.atlassian.jira.plugin.webresource

Interface JiraWebResourceManager

All Superinterfaces:

com.atlassian.webresource.api.WebResourceManager

All Known Implementing Classes:

JiraWebResourceManagerImpl

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

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

Since:

v5.0

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getMetadata()	Deprecated. You should generally never need to use this API, instead you should rely on the page builder service delivering data to the client side and exposing it via the WRM.data.claim JavaScript API.
boolean	putMetadata(String key, String value)	Deprecated. Use WebResourceDataProvider instead.

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

getRequiredResources, getRequiredResources, getResourceTags, includeResources, includeResources, includeResources, requireResource, requireResource, requireResourcesForContext

Method Details

putMetadata

boolean putMetadata(String key,
 String value)

Deprecated.

Use WebResourceDataProvider instead. Since v6.4.

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()

Deprecated.

You should generally never need to use this API, instead you should rely on the page builder service delivering data to the client side and exposing it via the WRM.data.claim JavaScript API.

Returns the map of key-value pairs added via 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.

Returns:

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

Since:

v5.0