This project has retired. For details please refer to its Attic page.

org.apache.jetspeed.components.portletentity
Interface PortletEntityAccessComponent

public interface PortletEntityAccessComponent

PortletEntityAccessComponent

Version:

$Id: PortletEntityAccessComponent.java,v 1.8 2005/04/29 13:59:46 weaver Exp $

Author:

Scott T. Weaver

Method Summary

MutablePortletEntity	generateEntityFromFragment(ContentFragment fragment) generateEntityFromFragment
MutablePortletEntity	generateEntityFromFragment(ContentFragment fragment, String principal) generateEntityFromFragment
org.apache.pluto.om.common.ObjectID	generateEntityKey(Fragment fragment, String principal) generateEntityKey
Collection	getPortletEntities(org.apache.pluto.om.portlet.PortletDefinition portletDefinition) getPortletEntities
Collection	getPortletEntities(String portletUniqueName)
MutablePortletEntity	getPortletEntity(org.apache.pluto.om.common.ObjectID id) getPortletEntity
MutablePortletEntity	getPortletEntity(String id)
MutablePortletEntity	getPortletEntityForFragment(ContentFragment fragment) getPortletEntityForFragment
MutablePortletEntity	getPortletEntityForFragment(ContentFragment fragment, String principal) getPortletEntityForFragment
boolean	isMergeSharedPreferences() All preferences were shared.
MutablePortletEntity	newPortletEntityInstance(org.apache.pluto.om.portlet.PortletDefinition portletDefinition) newPortletEntityInstance
MutablePortletEntity	newPortletEntityInstance(org.apache.pluto.om.portlet.PortletDefinition portletDefinition, String id)
void	removeFromCache(org.apache.pluto.om.entity.PortletEntity entity) removeFromCache
void	removePortletEntities(org.apache.pluto.om.portlet.PortletDefinition portletDefinition) removePortletEntities
void	removePortletEntity(org.apache.pluto.om.entity.PortletEntity portletEntity) removePortletEntity
void	storePortletEntity(org.apache.pluto.om.entity.PortletEntity portletEntity) storePortletEntity
void	storePreferenceSet(org.apache.pluto.om.common.PreferenceSet prefSet, org.apache.pluto.om.entity.PortletEntity entity)
void	updatePortletEntity(org.apache.pluto.om.entity.PortletEntity portletEntity, ContentFragment fragment) updatePortletEntity

Method Detail

getPortletEntity

MutablePortletEntity getPortletEntity(org.apache.pluto.om.common.ObjectID id)

getPortletEntity

Parameters:

id -

Returns:

getPortletEntity

MutablePortletEntity getPortletEntity(String id)

generateEntityFromFragment

MutablePortletEntity generateEntityFromFragment(ContentFragment fragment,
                                                String principal)
                                                throws PortletEntityNotGeneratedException

generateEntityFromFragment

Parameters:

fragment -

principal -

Returns:

Throws:

PortletEntityNotGeneratedException

generateEntityFromFragment

MutablePortletEntity generateEntityFromFragment(ContentFragment fragment)
                                                throws PortletEntityNotGeneratedException

generateEntityFromFragment

Parameters:

fragment -

Returns:

Throws:

PortletEntityNotGeneratedException

generateEntityKey

org.apache.pluto.om.common.ObjectID generateEntityKey(Fragment fragment,
                                                      String principal)

generateEntityKey

Parameters:

fragment -

principal -

Returns:

newPortletEntityInstance

MutablePortletEntity newPortletEntityInstance(org.apache.pluto.om.portlet.PortletDefinition portletDefinition)

newPortletEntityInstance

Parameters:

portletDefinition -

Returns:

newPortletEntityInstance

MutablePortletEntity newPortletEntityInstance(org.apache.pluto.om.portlet.PortletDefinition portletDefinition,
                                              String id)

getPortletEntityForFragment

MutablePortletEntity getPortletEntityForFragment(ContentFragment fragment,
                                                 String principal)
                                                 throws PortletEntityNotStoredException

getPortletEntityForFragment

Parameters:

fragment -

principal -

Returns:

Throws:

PortletEntityNotStoredException

getPortletEntityForFragment

MutablePortletEntity getPortletEntityForFragment(ContentFragment fragment)
                                                 throws PortletEntityNotStoredException

getPortletEntityForFragment

Parameters:

fragment -

Returns:

Throws:

PortletEntityNotStoredException

removePortletEntity

void removePortletEntity(org.apache.pluto.om.entity.PortletEntity portletEntity)
                         throws PortletEntityNotDeletedException

removePortletEntity

Parameters:

portletEntity -

Throws:

PortletEntityNotDeletedException

removeFromCache

void removeFromCache(org.apache.pluto.om.entity.PortletEntity entity)

removeFromCache

Removes a PortletEntity from the cache.

Parameters:

entity -

updatePortletEntity

void updatePortletEntity(org.apache.pluto.om.entity.PortletEntity portletEntity,
                         ContentFragment fragment)
                         throws PortletEntityNotStoredException

updatePortletEntity

Updates portlet definition associated with the portlet entity to match the fragment configuration

Parameters:

portletEntity -

fragment -

Throws:

PortletEntityNotStoredException

storePortletEntity

void storePortletEntity(org.apache.pluto.om.entity.PortletEntity portletEntity)
                        throws PortletEntityNotStoredException

storePortletEntity

Parameters:

portletEntity -

Throws:

PortletEntityNotStoredException

getPortletEntities

Collection getPortletEntities(org.apache.pluto.om.portlet.PortletDefinition portletDefinition)

getPortletEntities

Parameters:

portletDefinition -

Returns:

getPortletEntities

Collection getPortletEntities(String portletUniqueName)

removePortletEntities

void removePortletEntities(org.apache.pluto.om.portlet.PortletDefinition portletDefinition)
                           throws PortletEntityNotDeletedException

removePortletEntities

Parameters:

portletDefinition -

Throws:

PortletEntityNotDeletedException

storePreferenceSet

void storePreferenceSet(org.apache.pluto.om.common.PreferenceSet prefSet,
                        org.apache.pluto.om.entity.PortletEntity entity)
                        throws IOException

Throws:

IOException

isMergeSharedPreferences

boolean isMergeSharedPreferences()

All preferences were shared. With JS2-449, preferences are now stored 'per user'. The username is stored in the preferences FULL_PATH To turn on mergeSharedPreferences configure this property to true in your Spring configuration. This will NOT turn off per user prefs, but instead merge with them, where user prefs override.