com.atlassian.plugin.web
Interface ContextProvider

All Known Implementing Classes:

NoOpContextProvider

public interface ContextProvider

Main purpose of this is to add additional context entries for the web fragment and make it available within the XML

Method Summary

java.util.Map<java.lang.String,java.lang.Object>	getContextMap(java.util.Map<java.lang.String,java.lang.Object> context) Gets the additional context map to make available for the web fragment
void	init(java.util.Map<java.lang.String,java.lang.String> params) Called after creation and autowiring.

Method Detail

init

void init(java.util.Map<java.lang.String,java.lang.String> params)
          throws PluginParseException

Called after creation and autowiring.

Parameters:

params - The optional map of parameters specified in XML.

Throws:

PluginParseException

getContextMap

java.util.Map<java.lang.String,java.lang.Object> getContextMap(java.util.Map<java.lang.String,java.lang.Object> context)

Gets the additional context map to make available for the web fragment

Parameters:

context - immutable render context provided by the app.

Returns:

context map for velocity templates