public class

SimpleLegacyPortletUpgradeTask

extends AbstractLegacyPortletUpgradeTask
java.lang.Object
   ↳ com.atlassian.jira.upgrade.util.AbstractLegacyPortletUpgradeTask
     ↳ com.atlassian.jira.upgrade.util.SimpleLegacyPortletUpgradeTask

Class Overview

Simple legacy portlet upgrade task where no extra work needs to be done to map from existing user preferences to new user preferences.

Summary

[Expand]
Inherited Constants
From class com.atlassian.jira.upgrade.util.AbstractLegacyPortletUpgradeTask
Public Constructors
SimpleLegacyPortletUpgradeTask(String portletKey, URI gadgetUri)
SimpleLegacyPortletUpgradeTask(String portletKey, String gadgetUri)
Public Methods
Map<String, String> convertUserPrefs(PropertySet propertySet)
Converts the propertySet in use by this portletConfiguration to a Map.
URI getGadgetUri()
Returns the gadget URI to be used for this portlet.
String getPortletKey()
Returns the portletKey that this upgrade task can convert.
[Expand]
Inherited Methods
From class com.atlassian.jira.upgrade.util.AbstractLegacyPortletUpgradeTask
From class java.lang.Object
From interface com.atlassian.jira.upgrade.util.LegacyPortletUpgradeTask

Public Constructors

public SimpleLegacyPortletUpgradeTask (String portletKey, URI gadgetUri)

public SimpleLegacyPortletUpgradeTask (String portletKey, String gadgetUri)

Public Methods

public Map<String, String> convertUserPrefs (PropertySet propertySet)

Converts the propertySet in use by this portletConfiguration to a Map. Please note that multi value values (values separated by _*|*_ in the propertyset) should be converted to values simply separated by '|'. If '|' occurs in a value it needs to be % encoded to '%7C'.

Implementations may choose to convert properties to userprefs depending on the new gadgets requirements. This doesn't have to represent a 1 to 1 mapping.

Parameters
propertySet the old portletConfiguration propertySet to be converted
Returns
  • the propertySet converted to a map of key -> value pairs.

public URI getGadgetUri ()

Returns the gadget URI to be used for this portlet. Should be a relative URI pointing to the gadget replacing this portlet. For example: 'rest/gadgets/1.0/g/com.atlassian.jira.gadgets/gadgets/filter-results-gadget.xml'

Returns
  • the gadget URI to be used for this portlet.

public String getPortletKey ()

Returns the portletKey that this upgrade task can convert. Note that this is the full key that can be contained via com.atlassian.jira.portal.Portlet#getId(). For example: 'com.atlassian.jira.plugin.system.portlets:inprogress'

Returns
  • the portletKey that this upgrade task can convert.