org.sakaiproject.portal.render.portlet.services

Class SakaiOptionalPortletContainerServices.SakaiPortletPreferencesService

java.lang.Object

org.sakaiproject.portal.render.portlet.services.SakaiOptionalPortletContainerServices.SakaiPortletPreferencesService

All Implemented Interfaces:

org.apache.pluto.spi.ContainerService, org.apache.pluto.spi.optional.PortletPreferencesService

Enclosing class:

SakaiOptionalPortletContainerServices

public class SakaiOptionalPortletContainerServices.SakaiPortletPreferencesService
extends Object
implements org.apache.pluto.spi.optional.PortletPreferencesService

Constructor Summary

Constructors

Constructor and Description
SakaiPortletPreferencesService()

Method Summary

Modifier and Type	Method and Description
org.apache.pluto.internal.InternalPortletPreference[]	getStoredPreferences(org.apache.pluto.PortletWindow portletWindow, javax.portlet.PortletRequest request) Returns the stored portlet preferences array.
void	store(org.apache.pluto.PortletWindow portletWindow, javax.portlet.PortletRequest request, org.apache.pluto.internal.InternalPortletPreference[] preferences) Stores the portlet preferences to the in-memory storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

SakaiPortletPreferencesService

public SakaiPortletPreferencesService()

Method Detail

getStoredPreferences

public org.apache.pluto.internal.InternalPortletPreference[] getStoredPreferences(org.apache.pluto.PortletWindow portletWindow,
                                                                                  javax.portlet.PortletRequest request)
                                                                           throws org.apache.pluto.PortletContainerException

Returns the stored portlet preferences array. The preferences managed by this service should be protected from being directly accessed, so this method returns a cloned copy of the stored preferences.

Specified by:

getStoredPreferences in interface org.apache.pluto.spi.optional.PortletPreferencesService

Parameters:

portletWindow - the portlet window.

request - the portlet request from which the remote user is retrieved.

Returns:

a copy of the stored portlet preferences array.

Throws:

org.apache.pluto.PortletContainerException

store

public void store(org.apache.pluto.PortletWindow portletWindow,
                  javax.portlet.PortletRequest request,
                  org.apache.pluto.internal.InternalPortletPreference[] preferences)
           throws org.apache.pluto.PortletContainerException

Stores the portlet preferences to the in-memory storage. This method should be invoked after the portlet preferences are validated by the preference validator (if defined).

The preferences managed by this service should be protected from being directly accessed, so this method clones the passed-in preferences array and saves it.

Specified by:

store in interface org.apache.pluto.spi.optional.PortletPreferencesService

Parameters:

portletWindow - the portlet window

request - the portlet request from which the remote user is retrieved.

preferences - the portlet preferences to store.

Throws:

org.apache.pluto.PortletContainerException

See Also:

PortletPreferences.store()