com.atlassian.jira.upgrade.util

Class SimpleLegacyPortletUpgradeTask

java.lang.Object

com.atlassian.jira.upgrade.util.AbstractLegacyPortletUpgradeTask

com.atlassian.jira.upgrade.util.SimpleLegacyPortletUpgradeTask

All Implemented Interfaces:

LegacyPortletUpgradeTask

public class SimpleLegacyPortletUpgradeTask
extends AbstractLegacyPortletUpgradeTask

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

Field Summary

Fields inherited from class com.atlassian.jira.upgrade.util.AbstractLegacyPortletUpgradeTask

MULTIVALUE_SEPARATOR, PORTLET_MULTI_VALUE_SEPARATOR, SEPARATOR_ENCODED

Constructor Summary

Constructors

Constructor and Description
SimpleLegacyPortletUpgradeTask(String portletKey, String gadgetUri)
SimpleLegacyPortletUpgradeTask(String portletKey, URI gadgetUri)

Method Summary

Modifier and Type	Method and Description
Map<String,String>	convertUserPrefs(com.opensymphony.module.propertyset.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.

Methods inherited from class com.atlassian.jira.upgrade.util.AbstractLegacyPortletUpgradeTask

convertMultiSelectValue

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleLegacyPortletUpgradeTask

public SimpleLegacyPortletUpgradeTask(String portletKey,
                                      URI gadgetUri)

SimpleLegacyPortletUpgradeTask

public SimpleLegacyPortletUpgradeTask(String portletKey,
                                      String gadgetUri)

Method Detail

getPortletKey

public String getPortletKey()

Description copied from interface: LegacyPortletUpgradeTask

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'

Specified by:

getPortletKey in interface LegacyPortletUpgradeTask

Specified by:

getPortletKey in class AbstractLegacyPortletUpgradeTask

Returns:

the portletKey that this upgrade task can convert.

getGadgetUri

public URI getGadgetUri()

Description copied from interface: LegacyPortletUpgradeTask

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'

Specified by:

getGadgetUri in interface LegacyPortletUpgradeTask

Specified by:

getGadgetUri in class AbstractLegacyPortletUpgradeTask

Returns:

the gadget URI to be used for this portlet.

convertUserPrefs

public Map<String,String> convertUserPrefs(com.opensymphony.module.propertyset.PropertySet propertySet)

Description copied from interface: LegacyPortletUpgradeTask

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.

Specified by:

convertUserPrefs in interface LegacyPortletUpgradeTask

Overrides:

convertUserPrefs in class AbstractLegacyPortletUpgradeTask

Parameters:

propertySet - the old portletConfiguration propertySet to be converted

Returns:

the propertySet converted to a map of key -> value pairs.