@PublicApi public interface

JiraWebResourceManager

implements WebResourceManager
com.atlassian.jira.plugin.webresource.JiraWebResourceManager
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

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

Summary

Public Methods
Map<StringString> getMetadata()
This method is 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)
This method is deprecated. Use com.atlassian.webresource.api.data.WebResourceDataProvider instead. Since v6.4.
[Expand]
Inherited Methods
From interface com.atlassian.plugin.webresource.WebResourceManager

Public Methods

public Map<StringString> getMetadata ()

This method is 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

public boolean putMetadata (String key, String value)

This method is deprecated.
Use com.atlassian.webresource.api.data.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