com.atlassian.jira.portal
Class CachingPortletConfigurationStore

java.lang.Object
  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
void	delete(PortletConfiguration pc) Deletes the given PortletConfiguration.
void	flush() Flush the cache by removing all entries.
List	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.

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 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.

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.

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.

flush

public void flush()

Flush the cache by removing all entries.