com.caucho.portal.generic
Interface PreferencesStore

All Known Implementing Classes:

AbstractPreferencesStore, SessionPreferencesStore

public interface PreferencesStore

Factory that returns a Map that is the store for portlet preferences. The factory is used once for each namespace if needed.

Method Summary

void	finish(java.util.Map<java.lang.String,java.lang.String[]> preferencesMap) Called when a Map previously returned by getPreferencesMap() is no longer needed.
java.util.Map<java.lang.String,java.lang.String[]>	getPreferencesMap(PortletRequest request, java.lang.String namespace) Return a map of preferences.

Method Detail

getPreferencesMap

java.util.Map<java.lang.String,java.lang.String[]> getPreferencesMap(PortletRequest request,
                                                                     java.lang.String namespace)
                                                                     throws java.io.IOException

Return a map of preferences. Implementing classes use the information available from request to determine the identity of the user.

Returns:

a Map of preference names to values, or null if no preferences are available.

Throws:

java.io.IOException

finish

void finish(java.util.Map<java.lang.String,java.lang.String[]> preferencesMap)
            throws java.io.IOException

Called when a Map previously returned by getPreferencesMap() is no longer needed. A call to finish() is not guaranteed to occur for every Map returned by getPreferencesMap(). If an error occurs when processing a request, the portal may not have an opportunity to call finish().

Throws:

java.io.IOException