@PublicSpi public interface

CacheableContextProvider

implements ContextProvider
com.atlassian.jira.plugin.webfragment.CacheableContextProvider
Known Indirect Subclasses

@PublicSpi

This interface is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Class Overview

Implementing ContextProviders will be wrapped with CacheableContextProviderDecorator on creation in JiraWebFragmentHelper, and have getContextMap(java.util.Map) invocation results cached in the request.

Summary

Public Methods
String getUniqueContextKey(Map<String, Object> context)
Return a key that is unique for the scope that this context should be scoped.
[Expand]
Inherited Methods
From interface com.atlassian.plugin.web.ContextProvider

Public Methods

public String getUniqueContextKey (Map<String, Object> context)

Return a key that is unique for the scope that this context should be scoped. E.g. If the context is unique per issue, per user return "JRA-11234:nmenere"

Parameters
context the context passed into the getContextMap method.
Returns
  • a key that is unique for the scope that this context