View Javadoc

1   package com.atlassian.plugin.web;
2   
3   import com.atlassian.plugin.PluginParseException;
4   
5   import java.util.Map;
6   
7   /**
8    * Main purpose of this is to add additional context entries for the web
9    * fragment and make it available within the XML
10   */
11  public interface ContextProvider
12  {
13      /**
14       * Called after creation and autowiring.
15       *
16       * @param params The optional map of parameters specified in XML.
17       */
18      void init(Map params) throws PluginParseException;
19  
20      /**
21       * Gets the additional context map to make available for the web fragment
22       *
23       * @return context map for velocity templates
24       */
25      public Map getContextMap(Map context);
26  }