Package com.atlassian.jira.projectconfig.contextproviders

Class SummaryContextProvider

java.lang.Object

com.atlassian.jira.projectconfig.contextproviders.SummaryContextProvider

All Implemented Interfaces:

CacheableContextProvider, com.atlassian.plugin.web.ContextProvider

public class SummaryContextProvider
extends Object
implements CacheableContextProvider

Provides context for the main summary page, in particular the list of SimplePanel columns via leftColumn and rightColumn objects.

Since:

v4.4

Constructor Summary

Constructors

Constructor	Description
SummaryContextProvider(com.atlassian.plugin.web.api.DynamicWebInterfaceManager dynamicWebInterfaceManager, ContextProviderUtils contextProviderUtils, ModuleWebComponent moduleWebComponent, JiraAuthenticationContext authenticationContext, ProjectDescriptionRenderer projectDescriptionRenderer, EditWorkflowDiscoverHelper editWorkflowDiscoverHelper)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getContextMap(Map<String,Object> appProvidedContext)	Gets the context used when rendering the summary web panel.
String	getUniqueContextKey(Map<String,Object> context)	Return a key that is unique for the scope that this context should be scoped.
void	init(Map<String,String> params)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SummaryContextProvider

public SummaryContextProvider(com.atlassian.plugin.web.api.DynamicWebInterfaceManager dynamicWebInterfaceManager,
 ContextProviderUtils contextProviderUtils,
 ModuleWebComponent moduleWebComponent,
 JiraAuthenticationContext authenticationContext,
 ProjectDescriptionRenderer projectDescriptionRenderer,
 EditWorkflowDiscoverHelper editWorkflowDiscoverHelper)

Method Details

init

public void init(Map<String,String> params)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.web.ContextProvider

Throws:

com.atlassian.plugin.PluginParseException

getContextMap

public Map<String,Object> getContextMap(Map<String,Object> appProvidedContext)

Gets the context used when rendering the summary web panel. In particular, contains:

simpleProject

A wrapped Project that has a subset of methods and renames description descriptionHtml to allow anti-xss escaping

leftColumn

Rendered web panels that should go on the left. Determined by the location SummaryContextProvider.SUMMARY_LEFT_PANELS_LOCATION

rightColumn

Rendered web panels that should go on the right. Determined by the location SummaryContextProvider.SUMMARY_RIGHT_PANELS_LOCATION

Specified by:

getContextMap in interface com.atlassian.plugin.web.ContextProvider

Parameters:

appProvidedContext - The application provided context

Returns:

The context used when rendering the summary web panel

getUniqueContextKey

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

Description copied from interface: CacheableContextProvider

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"

Specified by:

getUniqueContextKey in interface CacheableContextProvider

Parameters:

context - the context passed into the getContextMap method.

Returns:

a key that is unique for the scope that this context