com.atlassian.jira.portal
Class CachingPortletConfigurationStore

java.lang.Object
  extended by com.atlassian.jira.portal.CachingPortletConfigurationStore
All Implemented Interfaces:
PortletConfigurationStore

public class CachingPortletConfigurationStore
extends Object
implements PortletConfigurationStore

Caching store for Portlet Configurations. The cache stores a id -> PortletConfigurationStore and a portalPage.id -> id mapping.

This class is not completely thread safe in that it is possible for the cache and the database to become unsynchronized.

Since:
3.13

Constructor Summary
CachingPortletConfigurationStore(PortletConfigurationStore delegateStore)
           
 
Method Summary
 PortletConfiguration add(Long pageId, String portletKey, Integer column, Integer row)
          Creates and adds a new PortletConfiguration to given PortalPage
 PortletConfiguration addGadget(Long pageId, Long portletConfigurationId, Integer column, Integer row, URI gadgetXml, com.atlassian.gadgets.dashboard.Color color, Map<String,String> userPreferences)
          Creates and adds a new PortletConfiguration to given PortalPage.
 PortletConfiguration addLegacyGadget(Long pageId, Long portletConfigurationId, Integer column, Integer row, URI gadgetXml, com.atlassian.gadgets.dashboard.Color color, Map<String,String> userPreferences, String portletKey)
          Creates and adds a new PortletConfiguration to given PortalPage.
 void delete(PortletConfiguration pc)
          Deletes the given PortletConfiguration.
 Set<PortletConfiguration> deleteByProject(Project project)
          Removes all the portlet configurations for a project on any portal page.
 void flush()
          Flush the cache by removing all entries.
 EnclosedIterable<PortletConfiguration> getAllPortletConfigurations()
          This is a non-caching call.
 List<PortletConfiguration> getByPortalPage(Long portalPageId)
          Get all PortletConfiguration objects for a given PortalPage id.
 PortletConfiguration getByPortletId(Long portletId)
          Gall a PortletConfiguration by its id.
 void store(PortletConfiguration pc)
          Saves the given PortletConfiguration.
 void updateGadgetColor(Long gadgetId, com.atlassian.gadgets.dashboard.Color color)
          Given a gadget, this method will update the color value for this gadget.
 void updateGadgetPosition(Long gadgetId, int row, int column, Long dashboardId)
          Given a gadget, this method will update it's row, column and parent dashboard id.
 void updateUserPrefs(Long gadgetId, Map<String,String> userPrefs)
          Given a gadget, this method updates all userprefs for this gadget.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CachingPortletConfigurationStore

public CachingPortletConfigurationStore(PortletConfigurationStore delegateStore)
Method Detail

getByPortalPage

public List<PortletConfiguration> getByPortalPage(Long portalPageId)
Description copied from interface: PortletConfigurationStore
Get all PortletConfiguration objects for a given PortalPage id.

Specified by:
getByPortalPage in interface PortletConfigurationStore
Parameters:
portalPageId - The id of the page to retreive all configurations for.
Returns:
The configurations associated with the given page.

deleteByProject

public Set<PortletConfiguration> deleteByProject(Project project)
Description copied from interface: PortletConfigurationStore
Removes all the portlet configurations for a project on any portal page. This is used mainly when a project is deleted. This method will find all the portletConfigurations that make use of a project filter or the project directly, and delete them.

Specified by:
deleteByProject in interface PortletConfigurationStore
Parameters:
project - The project whose portlets will be deleted
Returns:
a set of all the PortletConfigurations that were deleted

getByPortletId

public PortletConfiguration getByPortletId(Long portletId)
Description copied from interface: PortletConfigurationStore
Gall a PortletConfiguration by its id.

Specified by:
getByPortletId in interface PortletConfigurationStore
Parameters:
portletId - The id of the portlet configuration
Returns:
The configuration of the given id.

delete

public void delete(PortletConfiguration pc)
Description copied from interface: PortletConfigurationStore
Deletes the given PortletConfiguration.

Specified by:
delete in interface PortletConfigurationStore
Parameters:
pc - The PortletConfiguration to delete.

updateGadgetPosition

public void updateGadgetPosition(Long gadgetId,
                                 int row,
                                 int column,
                                 Long dashboardId)
Description copied from interface: PortletConfigurationStore
Given a gadget, this method will update it's row, column and parent dashboard id.

Specified by:
updateGadgetPosition in interface PortletConfigurationStore
Parameters:
gadgetId - The id of the gadget being updated
row - The new row value for this gadget
column - The new column value for this gadget
dashboardId - The new parent dashboard id value for this gadget

updateGadgetColor

public void updateGadgetColor(Long gadgetId,
                              com.atlassian.gadgets.dashboard.Color color)
Description copied from interface: PortletConfigurationStore
Given a gadget, this method will update the color value for this gadget.

Specified by:
updateGadgetColor in interface PortletConfigurationStore
Parameters:
gadgetId - The id of the gadget being updated
color - The new color value for this gadget

updateUserPrefs

public void updateUserPrefs(Long gadgetId,
                            Map<String,String> userPrefs)
Description copied from interface: PortletConfigurationStore
Given a gadget, this method updates all userprefs for this gadget.

Specified by:
updateUserPrefs in interface PortletConfigurationStore
Parameters:
gadgetId - The id of the gadget being updated
userPrefs - The new userprefs to set for this gadget.

store

public void store(PortletConfiguration pc)
Description copied from interface: PortletConfigurationStore
Saves the given PortletConfiguration.

Specified by:
store in interface PortletConfigurationStore
Parameters:
pc - The PortletConfiguration to save.

add

public PortletConfiguration add(Long pageId,
                                String portletKey,
                                Integer column,
                                Integer row)
Description copied from interface: PortletConfigurationStore
Creates and adds a new PortletConfiguration to given PortalPage

Specified by:
add in interface PortletConfigurationStore
Parameters:
pageId - The id of the page to add the configuration to.
portletKey - The key of the portlet.
column - The column position of the portlet.
row - The row position of the portlet
Returns:
The new PortletConfiguration with the id set.

addGadget

public PortletConfiguration addGadget(Long pageId,
                                      Long portletConfigurationId,
                                      Integer column,
                                      Integer row,
                                      URI gadgetXml,
                                      com.atlassian.gadgets.dashboard.Color color,
                                      Map<String,String> userPreferences)
Description copied from interface: PortletConfigurationStore
Creates and adds a new PortletConfiguration to given PortalPage. This should be used to add a gadget.

Specified by:
addGadget in interface PortletConfigurationStore
Parameters:
pageId - The id of the page to add the configuration to.
portletConfigurationId - The id to use for adding the gadget. This will correspond to JiraGadgetStateFactory.createGadgetState(java.net.URI). May be null for a generated id.
column - The column position of the portlet.
row - The row position of the portlet
gadgetXml - A URI specifying the location of the gadget XML. May be null if this is a legacy portlet.
color - The chrome color for the gadget.
userPreferences - A map of key -> value user preference pairs used to store gadget configuration.
Returns:
The new PortletConfiguration with the id set.

addLegacyGadget

public PortletConfiguration addLegacyGadget(Long pageId,
                                            Long portletConfigurationId,
                                            Integer column,
                                            Integer row,
                                            URI gadgetXml,
                                            com.atlassian.gadgets.dashboard.Color color,
                                            Map<String,String> userPreferences,
                                            String portletKey)
Description copied from interface: PortletConfigurationStore
Creates and adds a new PortletConfiguration to given PortalPage. This should be used to add a legacy gadget only!

Specified by:
addLegacyGadget in interface PortletConfigurationStore
Parameters:
pageId - The id of the page to add the configuration to.
portletConfigurationId - The id to use for adding the gadget. This will correspond to JiraGadgetStateFactory.createGadgetState(java.net.URI). May be null for a generated id.
column - The column position of the portlet.
row - The row position of the portlet
gadgetXml - A URI specifying the location of the gadget XML. May be null if this is a legacy portlet.
color - The chrome color for the gadget.
userPreferences - A map of key -> value user preference pairs used to store gadget configuration.
portletKey - The portletKey of the old portlet.
Returns:
The new PortletConfiguration with the id set.

flush

public void flush()
Flush the cache by removing all entries.


getAllPortletConfigurations

public EnclosedIterable<PortletConfiguration> getAllPortletConfigurations()
This is a non-caching call. Will delegate straight through to the db store.

Specified by:
getAllPortletConfigurations in interface PortletConfigurationStore
Returns:
iterable over all PortletConfigurations available in the database


Copyright © 2002-2009 Atlassian. All Rights Reserved.