Package com.atlassian.jira.plugin.webfragment

Interface CacheableContextProvider

All Superinterfaces:
com.atlassian.plugin.web.ContextProvider
All Known Implementing Classes:
ActivityBlockViewIssueContextProvider, AddCommentContextProvider, AttachmentBlockContextProvider, ComponentsSummaryPanelContextProvider, DateBlockContextProvider, FieldsSummaryPanelContextProvider, IssueTypeConfigContextProvider, IssueTypesSummaryPanelContextProvider, LinkBlockContextProvider, NotificationsSummaryPanelContextProvider, PeopleBlockContextProvider, PermissionsSummaryPanelContextProvider, PrioritiesSummaryPanelContextProvider, ProjectFieldsContextProvider, ProjectIssueSecurityContextProvider, ProjectIssueTypeContextProvider, ProjectNotificationContextProvider, ProjectPeopleContextProvider, ProjectPermissionContextProvider, ProjectPrioritiesContextProvider, ProjectRoleContextProvider, ProjectScreensContextProvider, RolesSummaryPanelContextProvider, ScreensSummaryPanelContextProvider, SettingsSummaryPanelContextProvider, SubTasksContextProvider, SubTasksProgressContextProvider, SummaryContextProvider, TimeTrackingViewIssueContextProvider, VersionsSummaryPanelContextProvider, WorkflowContextProvider, WorkflowSummaryPanelContextProvider
@PublicSpi public interface CacheableContextProvider extends com.atlassian.plugin.web.ContextProvider
Implementing ContextProviders will be wrapped with CacheableContextProviderDecorator on creation in JiraWebFragmentHelper, and have ContextProvider.getContextMap(java.util.Map) invocation results cached in the request.
Since:
v4.4

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getUniqueContextKey(Map<String,Object> context)
    Return a key that is unique for the scope that this context should be scoped.

    Methods inherited from interface com.atlassian.plugin.web.ContextProvider

    getContextMap, init

  • Method Details

    • getUniqueContextKey

      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