Accessing params from plugin-info section in atlassian-plugin.xml

[Charles Duffy]

The plugin descriptor documentation specifies that parameters to a plugin can be created in the descriptor, as such:

<atlassian-plugin>
<plugin-info>
<param name="key">value</param>
<param name="key2">value2</param>
....
</plugin-info>
</atlassian-plugin>

However, I'm having trouble finding documentation on how to retrieve or access these parameters. I suspect that they might be the key/value pairs exposed through com.atlassian.plugin.PluginInformation.getParameters(), but the canonical mechanism for retrieving the PluginInformation object for the active plugin (without needing to have the plugin's key embedded in the source) is unclear.

[Charles Duffy · Accepted solution]

This can in fact be done.

First, add a dependency on atlassian-plugins-osgi-bridge to your pom.xml:

<dependency>
  <groupId>com.atlassian.plugins</groupId>
  <artifactId>atlassian-plugins-osgi-bridge</artifactId>
  <version>2.10.1</version>
  <scope>provided</scope>
</dependency>

Add a component import to your pom.xml:

<component-import
 key="plugin-retrieval-service"
 interface="com.atlassian.plugin.osgi.bridge.external.PluginRetrievalService"/>

Finally, retrieve a PluginRetrievalService instance through constructor dependency injection, and use it to access the parameter map:

import com.atlassian.plugin.Plugin;
import com.atlassian.plugin.osgi.bridge.external.PluginRetrievalService;

public class YourComponent {
  public YourComponent(PluginRetrievalService prs) {
    Plugin plugin = prs.getPlugin();
    Map<String,String> params = plugin
      .getPluginInformation()
      .getParameters();
    String key  = params.get("key");
    String key2 = params.get("key2");
  }
}

[Tyler Wright]

How can I get access to that package: com.atlassian.plugin.osgi.bridge.external.PluginRetrievalService? I can't find what jar its in.

[MB]

I've managed to accomplish this using one-liner:

Map params = ComponentAccessor.getPluginAccessor().getPlugin("com.example.jira.plugin.test").getModuleDescriptor("myModule").getParams();
String s = params.get("param1").toString();
...

but I'm not sure if that's JIRA 6.x specific or it can work in JIRA 5.x too. My atlassian-plugin.xml looks like this:

<atlassian-plugin key="com.example.jira.plugin.test" name="test plugin" plugins-version="2">
	<plugin-info>
		<description>${project.description}</description>
		<version>${project.version}</version>
		<vendor name="${project.organization.name}" url="${project.organization.url}" />
	</plugin-info>
	<component key="myModule" class="com.example.jira.plugin.myModule">
		<description>Test Class.</description>
		<param name="param1" value="value1" />
		<param name="param2" value="value2 blah" />
	</component>
</atlassian-plugin>

[Nic Brough -Adaptavist-]

Jira saves the values for you, then in the actual plugin, you can use code like

ParameterUtils.getStringParam(params, "key2")

Assuming key2 is a string of course.

[Charles Duffy]

Where does "params" come from in this example? To be clear -- I'm implementing a generic component, not a WebAction or similar interface where a parameter map is specified as part of the calling convention.

[Charles Duffy]

Err, "add handling for the parameters" isn't helpful until/unless I know how to get access to them through the plugin API -- can't handle something I don't know how to retrieve... hence this question being asked in the first place.

[Nic Brough -Adaptavist-]

Ahh, you'll need to add handling for the parameters yourself then - the code I've got simply reuses the parameters that are built into the report/field/workflow parameter screens already.