org.apache.jetspeed.components.portletentity
Class PersistenceBrokerPortletEntityAccess

java.lang.Object
  org.springframework.dao.support.DaoSupport
      org.springframework.orm.ojb.support.PersistenceBrokerDaoSupport
          org.apache.jetspeed.components.portletentity.PersistenceBrokerPortletEntityAccess

All Implemented Interfaces:

PortletEntityAccessComponent, org.springframework.beans.factory.InitializingBean

public class PersistenceBrokerPortletEntityAccess
extends org.springframework.orm.ojb.support.PersistenceBrokerDaoSupport
implements PortletEntityAccessComponent

PersistenceStorePortletEntityAccess

Version:

$Id: PersistenceBrokerPortletEntityAccess.java,v 1.5 2005/04/29 13:59:08 weaver Exp $

Author:

Scott T. Weaver

Field Summary

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Constructor Summary

PersistenceBrokerPortletEntityAccess(PortletRegistry registry)

PersistenceBrokerPortletEntityAccess(PortletRegistry registry, RequestContextComponent rcc)

PersistenceBrokerPortletEntityAccess(PortletRegistry registry, RequestContextComponent rcc, PageManager pageManager)

PersistenceBrokerPortletEntityAccess(PortletRegistry registry, RequestContextComponent rcc, PageManager pageManager, boolean mergeSharedPreferences)

Method Summary

protected java.lang.String	autoGenerateID(org.apache.pluto.om.portlet.PortletDefinition pd)
MutablePortletEntity	generateEntityFromFragment(ContentFragment fragment) generateEntityFromFragment
MutablePortletEntity	generateEntityFromFragment(ContentFragment fragment, java.lang.String principal) generateEntityFromFragment
org.apache.pluto.om.common.ObjectID	generateEntityKey(Fragment fragment, java.lang.String principal) generateEntityKey
java.util.Collection	getPortletEntities(org.apache.pluto.om.portlet.PortletDefinition portletDefinition) getPortletEntities
java.util.Collection	getPortletEntities(java.lang.String portletUniqueName)
MutablePortletEntity	getPortletEntity(org.apache.pluto.om.common.ObjectID id) getPortletEntity
protected MutablePortletEntity	getPortletEntity(org.apache.pluto.om.common.ObjectID id, ContentFragment fragment)
MutablePortletEntity	getPortletEntity(java.lang.String id)
MutablePortletEntity	getPortletEntityForFragment(ContentFragment fragment) getPortletEntityForFragment
MutablePortletEntity	getPortletEntityForFragment(ContentFragment fragment, java.lang.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, java.lang.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	setEntityAccessProxy(PortletEntityAccessComponent proxy)
void	setPageManager(PageManager pageManager)
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) storePreferenceSet
void	updatePortletEntity(org.apache.pluto.om.entity.PortletEntity portletEntity, ContentFragment fragment) updatePortletEntity

Methods inherited from class org.springframework.orm.ojb.support.PersistenceBrokerDaoSupport

checkDaoConfig, closePersistenceBrokerIfNecessary, convertOjbAccessException, createPersistenceBrokerTemplate, getJcdAlias, getPersistenceBroker, getPersistenceBrokerTemplate, releasePersistenceBroker, setJcdAlias, setPersistenceBrokerTemplate

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistenceBrokerPortletEntityAccess

public PersistenceBrokerPortletEntityAccess(PortletRegistry registry)

Parameters:

registry -

PersistenceBrokerPortletEntityAccess

public PersistenceBrokerPortletEntityAccess(PortletRegistry registry,
                                            RequestContextComponent rcc)

PersistenceBrokerPortletEntityAccess

public PersistenceBrokerPortletEntityAccess(PortletRegistry registry,
                                            RequestContextComponent rcc,
                                            PageManager pageManager)

PersistenceBrokerPortletEntityAccess

public PersistenceBrokerPortletEntityAccess(PortletRegistry registry,
                                            RequestContextComponent rcc,
                                            PageManager pageManager,
                                            boolean mergeSharedPreferences)

Method Detail

setEntityAccessProxy

public void setEntityAccessProxy(PortletEntityAccessComponent proxy)

setPageManager

public void setPageManager(PageManager pageManager)

generateEntityFromFragment

public MutablePortletEntity generateEntityFromFragment(ContentFragment fragment,
                                                       java.lang.String principal)
                                                throws PortletEntityNotGeneratedException

generateEntityFromFragment

Specified by:

generateEntityFromFragment in interface PortletEntityAccessComponent

Parameters:

fragment -

principal -

Returns:

@throws PortletEntityNotGeneratedException

Throws:

PortletEntityNotGeneratedException

See Also:

org.apache.jetspeed.components.portletentity.PortletEntityAccessComponent#generateEntityFromFragment(org.apache.jetspeed.om.page.Fragment, java.lang.String)

generateEntityFromFragment

public MutablePortletEntity generateEntityFromFragment(ContentFragment fragment)
                                                throws PortletEntityNotGeneratedException

generateEntityFromFragment

Specified by:

generateEntityFromFragment in interface PortletEntityAccessComponent

Parameters:

fragment -

Returns:

@throws PortletEntityNotGeneratedException

Throws:

PortletEntityNotGeneratedException

See Also:

org.apache.jetspeed.components.portletentity.PortletEntityAccessComponent#generateEntityFromFragment(org.apache.jetspeed.om.page.Fragment)

generateEntityKey

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

generateEntityKey

Specified by:

generateEntityKey in interface PortletEntityAccessComponent

Parameters:

fragment -

principal -

Returns:

See Also:

PortletEntityAccessComponent.generateEntityKey(org.apache.jetspeed.om.page.Fragment, java.lang.String)

getPortletEntities

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

getPortletEntities

Specified by:

getPortletEntities in interface PortletEntityAccessComponent

Parameters:

portletDefinition -

Returns:

See Also:

PortletEntityAccessComponent.getPortletEntities(org.apache.pluto.om.portlet.PortletDefinition)

getPortletEntities

public java.util.Collection getPortletEntities(java.lang.String portletUniqueName)

Specified by:

getPortletEntities in interface PortletEntityAccessComponent

getPortletEntity

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

Description copied from interface: PortletEntityAccessComponent

getPortletEntity

Specified by:

getPortletEntity in interface PortletEntityAccessComponent

Returns:

getPortletEntity

protected MutablePortletEntity getPortletEntity(org.apache.pluto.om.common.ObjectID id,
                                                ContentFragment fragment)
                                         throws PortletEntityNotStoredException

Throws:

PortletEntityNotStoredException

getPortletEntity

public MutablePortletEntity getPortletEntity(java.lang.String id)

Specified by:

getPortletEntity in interface PortletEntityAccessComponent

getPortletEntityForFragment

public MutablePortletEntity getPortletEntityForFragment(ContentFragment fragment,
                                                        java.lang.String principal)
                                                 throws PortletEntityNotStoredException

Description copied from interface: PortletEntityAccessComponent

getPortletEntityForFragment

Specified by:

getPortletEntityForFragment in interface PortletEntityAccessComponent

Returns:

Throws:

PortletEntityNotStoredException

getPortletEntityForFragment

public MutablePortletEntity getPortletEntityForFragment(ContentFragment fragment)
                                                 throws PortletEntityNotStoredException

Description copied from interface: PortletEntityAccessComponent

getPortletEntityForFragment

Specified by:

getPortletEntityForFragment in interface PortletEntityAccessComponent

Returns:

Throws:

PortletEntityNotStoredException

newPortletEntityInstance

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

Description copied from interface: PortletEntityAccessComponent

newPortletEntityInstance

Specified by:

newPortletEntityInstance in interface PortletEntityAccessComponent

Returns:

newPortletEntityInstance

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

Specified by:

newPortletEntityInstance in interface PortletEntityAccessComponent

removeFromCache

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

Description copied from interface: PortletEntityAccessComponent

removeFromCache

Removes a PortletEntity from the cache.

Specified by:

removeFromCache in interface PortletEntityAccessComponent

removePortletEntities

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

Description copied from interface: PortletEntityAccessComponent

removePortletEntities

Specified by:

removePortletEntities in interface PortletEntityAccessComponent

Throws:

PortletEntityNotDeletedException

removePortletEntity

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

Description copied from interface: PortletEntityAccessComponent

removePortletEntity

Specified by:

removePortletEntity in interface PortletEntityAccessComponent

Throws:

PortletEntityNotDeletedException

updatePortletEntity

public 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

Specified by:

updatePortletEntity in interface PortletEntityAccessComponent

Parameters:

portletEntity -

fragment -

Throws:

PortletEntityNotStoredException

storePortletEntity

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

Description copied from interface: PortletEntityAccessComponent

storePortletEntity

Specified by:

storePortletEntity in interface PortletEntityAccessComponent

Throws:

PortletEntityNotStoredException

storePreferenceSet

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

storePreferenceSet

Specified by:

storePreferenceSet in interface PortletEntityAccessComponent

Parameters:

prefSet -

Throws:

java.io.IOException

See Also:

org.apache.jetspeed.components.portletentity.PortletEntityAccessComponent#storePreferenceSet(org.apache.pluto.om.common.PreferenceSet)

autoGenerateID

protected java.lang.String autoGenerateID(org.apache.pluto.om.portlet.PortletDefinition pd)

isMergeSharedPreferences

public boolean isMergeSharedPreferences()

Description copied from interface: PortletEntityAccessComponent

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.

Specified by:

isMergeSharedPreferences in interface PortletEntityAccessComponent