org.apache.jetspeed.components.portletpreferences

Interface PortletPreferencesProvider

All Superinterfaces:

org.apache.pluto.container.PortletPreferencesService

public interface PortletPreferencesProvider
extends org.apache.pluto.container.PortletPreferencesService

Version:

$Id: PortletPreferencesProvider.java 1685182 2015-06-12 22:30:03Z taylor $

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getPortletWindowIds(PortletDefinition portletdefinition) Retrieve entity ids (window) given portlet definition
Set<String>	getUserNames(PortletDefinition portletdefinition, String windowId) Retrieve user names for given entity(window) id and portlet definition
Map<String,org.apache.pluto.container.PortletPreference>	getUserPreferences(PortletDefinition portletdefinition, String windowId, String userName) Retrieve entity preference names for given entity(window) id ,portlet definition and user name
void	preload() Initializes the preferences node by executing configured preloads.
void	preloadApplicationPreferences(String portletApplicationName) Preload all preferences for the given portlet application name into the preferences cache
void	preloadUserPreferences() Preload all user preferences for all users into the preferences cache.
void	removeDefaults(PortletApplication app) Remove all default preferences for all portlet definitions in a given portlet application
void	removeDefaults(PortletDefinition pd) Remove all default preferences for a given portlet definition
void	removeDefaults(PortletDefinition pd, String preferenceName) Remove default preferences by preference name for a given portlet definition
void	removeUserPreferences(String user) Remove all user preferences for a given username
Map<String,org.apache.pluto.container.PortletPreference>	retrieveDefaultPreferences(PortletDefinition pd) Retrieve the default preferences for a given portlet definition
Map<String,org.apache.pluto.container.PortletPreference>	retrieveEntityPreferences(PortletWindow window) Retrieve entity (window) default preferences for a given window
Map<String,org.apache.pluto.container.PortletPreference>	retrieveUserPreferences(PortletWindow window, String userName) Retrieve the user preferences for the window and user parameters
void	sessionCreatedEvent(javax.servlet.http.HttpSession session)
void	sessionDestroyedEvent(javax.servlet.http.HttpSession session)
void	storeDefaults(PortletApplication app) Store the default preferences for all portlets in the given portlet application
void	storeDefaults(PortletDefinition pd, Preference preference) Store the default preferences by input preference for a given portlet definition
void	storeDefaults(PortletDefinition pd, Preferences prefs) Store the default preferences by descriptor preferences for a given portlet definition
void	storeEntityPreferences(Map<String,org.apache.pluto.container.PortletPreference> map, PortletWindow window) Store entity preferences contained in the map parameter for a given window
void	storePortletPreference(PortletDefinition portletdefinition, String windowId, String userName, Map<String,org.apache.pluto.container.PortletPreference> map) Store portlet definition entity preferences contained in the map parameter for a given window and username
void	storePortletPreference(String appName, String portletName, String windowId, String userName, Map<String,org.apache.pluto.container.PortletPreference> map) Store portlet entity preferences contained in the map parameter for a given window and username
void	storeUserPreferences(Map<String,org.apache.pluto.container.PortletPreference> map, PortletWindow window, String userName) Store user preferences contained in the map parameter for a given user and window

Methods inherited from interface org.apache.pluto.container.PortletPreferencesService

getDefaultPreferences, getPreferencesValidator, getStoredPreferences, store

Method Detail

preload

void preload()
             throws Exception

Initializes the preferences node by executing configured preloads.

Throws:

Exception

preloadApplicationPreferences

void preloadApplicationPreferences(String portletApplicationName)

Preload all preferences for the given portlet application name into the preferences cache

Parameters:

portletApplicationName -

preloadUserPreferences

void preloadUserPreferences()

Preload all user preferences for all users into the preferences cache. Be careful with this method as it can chew up a lot of memory. Ensure the cache is configured to be large enough to hold all preferences

storeDefaults

void storeDefaults(PortletDefinition pd,
                 Preferences prefs)

Store the default preferences by descriptor preferences for a given portlet definition

Parameters:

pd -

storeDefaults

void storeDefaults(PortletDefinition pd,
                 Preference preference)

Store the default preferences by input preference for a given portlet definition

Parameters:

pd -

storeDefaults

void storeDefaults(PortletApplication app)

Store the default preferences for all portlets in the given portlet application

Parameters:

app -

removeDefaults

void removeDefaults(PortletDefinition pd)

Remove all default preferences for a given portlet definition

Parameters:

pd -

removeDefaults

void removeDefaults(PortletDefinition pd,
                  String preferenceName)

Remove default preferences by preference name for a given portlet definition

Parameters:

pd -

removeDefaults

void removeDefaults(PortletApplication app)

Remove all default preferences for all portlet definitions in a given portlet application

Parameters:

app -

retrieveDefaultPreferences

Map<String,org.apache.pluto.container.PortletPreference> retrieveDefaultPreferences(PortletDefinition pd)

Retrieve the default preferences for a given portlet definition

Parameters:

pd -

Returns:

the default preferences map for a given portlet definition

retrieveUserPreferences

Map<String,org.apache.pluto.container.PortletPreference> retrieveUserPreferences(PortletWindow window,
                                                                               String userName)

Retrieve the user preferences for the window and user parameters

Parameters:

window -

userName -

Returns:

retrieveEntityPreferences

Map<String,org.apache.pluto.container.PortletPreference> retrieveEntityPreferences(PortletWindow window)

Retrieve entity (window) default preferences for a given window

Parameters:

window -

Returns:

storeUserPreferences

void storeUserPreferences(Map<String,org.apache.pluto.container.PortletPreference> map,
                        PortletWindow window,
                        String userName)
                          throws PreferencesException

Store user preferences contained in the map parameter for a given user and window

Parameters:

map -

window -

userName -

Throws:

PreferencesException

storeEntityPreferences

void storeEntityPreferences(Map<String,org.apache.pluto.container.PortletPreference> map,
                          PortletWindow window)
                            throws PreferencesException

Store entity preferences contained in the map parameter for a given window

Parameters:

map -

window -

Throws:

PreferencesException

getPortletWindowIds

Set<String> getPortletWindowIds(PortletDefinition portletdefinition)

Retrieve entity ids (window) given portlet definition

Parameters:

portletdefinition -

getUserNames

Set<String> getUserNames(PortletDefinition portletdefinition,
                       String windowId)

Retrieve user names for given entity(window) id and portlet definition

Parameters:

portletdefinition -

windowId -

getUserPreferences

Map<String,org.apache.pluto.container.PortletPreference> getUserPreferences(PortletDefinition portletdefinition,
                                                                          String windowId,
                                                                          String userName)

Retrieve entity preference names for given entity(window) id ,portlet definition and user name

Parameters:

portletdefinition -

windowId -

storePortletPreference

void storePortletPreference(PortletDefinition portletdefinition,
                          String windowId,
                          String userName,
                          Map<String,org.apache.pluto.container.PortletPreference> map)

Store portlet definition entity preferences contained in the map parameter for a given window and username

Parameters:

portletdefinition -

windowId -

userName -

map -

storePortletPreference

void storePortletPreference(String appName,
                          String portletName,
                          String windowId,
                          String userName,
                          Map<String,org.apache.pluto.container.PortletPreference> map)

Store portlet entity preferences contained in the map parameter for a given window and username

Parameters:

appName -

portletName -

windowId -

userName -

map -

removeUserPreferences

void removeUserPreferences(String user)

Remove all user preferences for a given username

Parameters:

user - the name of the user to delete all preferences for

Since:

2.3.0

sessionCreatedEvent

void sessionCreatedEvent(javax.servlet.http.HttpSession session)

sessionDestroyedEvent

void sessionDestroyedEvent(javax.servlet.http.HttpSession session)