org.apache.jetspeed.components.portletentity
Class PortletEntityImpl

java.lang.Object
  org.apache.jetspeed.components.portletentity.PortletEntityImpl

All Implemented Interfaces:

RenderTrackable, RemovalAware, MutablePortletEntity, PrincipalAware, org.apache.pluto.om.Controller, org.apache.pluto.om.entity.PortletEntity, org.apache.pluto.om.entity.PortletEntityCtrl, org.apache.pluto.om.Model

public class PortletEntityImpl
extends java.lang.Object
implements MutablePortletEntity, PrincipalAware, RemovalAware, RenderTrackable

Portlet Entity default implementation.

Version:

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

Author:

David Sean Taylor , Scott T. Weaver

Field Summary

protected java.lang.String	appName
static java.lang.String	ENTITY_DEFAULT_PRINCIPAL
protected long	expiration
static java.lang.String	NO_PRINCIPAL
protected java.util.Map	originalValues
protected static PortletEntityAccessComponent	pac
protected PrefsPreferenceSetImpl	pagePreferenceSet
protected java.util.Map	perPrincipalPrefs
protected static PageManager	pm
protected java.lang.String	portletName
protected static RequestContextComponent	rcc
protected static PortletRegistry	registry
protected int	timeoutCount

Fields inherited from interface org.apache.jetspeed.om.common.portlet.MutablePortletEntity

PORTLET_ENTITY_ROOT

Constructor Summary

PortletEntityImpl()

PortletEntityImpl(Fragment fragment)

Method Summary

protected void	backupValues(org.apache.pluto.om.common.PreferenceSet preferenceSet) backupValues
org.apache.pluto.om.common.Description	getDescription(java.util.Locale arg0)
long	getExpiration()
org.apache.pluto.om.common.ObjectID	getId()
long	getOid()
org.apache.pluto.om.entity.PortletApplicationEntity	getPortletApplicationEntity()
org.apache.pluto.om.portlet.PortletDefinition	getPortletDefinition()
java.lang.String	getPortletUniqueName()
org.apache.pluto.om.window.PortletWindowList	getPortletWindowList()
org.apache.pluto.om.common.PreferenceSet	getPreferenceSet() getPreferenceSet
org.apache.pluto.om.common.PreferenceSet	getPreferenceSet(java.security.Principal principal)
java.security.Principal	getPrincipal()
int	getRenderTimeoutCount()
void	incrementRenderTimeoutCount()
void	postRemoval(PersistenceStore store) postRemoval
void	preRemoval(PersistenceStore store) preRemoval
void	reset() reset
void	setExpiration(long expiration)
void	setFragment(Fragment fragment)
void	setId(java.lang.String id)
void	setPortletDefinition(org.apache.pluto.om.portlet.PortletDefinition composite) setPortletDefinition
void	setRenderTimeoutCount(int timeoutCount)
void	store() store
void	store(java.security.Principal principal)
void	success()
java.lang.String	toString()
java.lang.String	toString(int indent)

Methods inherited from class java.lang.Object

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

Field Detail

pac

protected static PortletEntityAccessComponent pac

registry

protected static PortletRegistry registry

rcc

protected static RequestContextComponent rcc

pm

protected static PageManager pm

pagePreferenceSet

protected PrefsPreferenceSetImpl pagePreferenceSet

perPrincipalPrefs

protected java.util.Map perPrincipalPrefs

originalValues

protected java.util.Map originalValues

portletName

protected java.lang.String portletName

appName

protected java.lang.String appName

timeoutCount

protected transient int timeoutCount

expiration

protected transient long expiration

NO_PRINCIPAL

public static final java.lang.String NO_PRINCIPAL

See Also:

Constant Field Values

ENTITY_DEFAULT_PRINCIPAL

public static final java.lang.String ENTITY_DEFAULT_PRINCIPAL

See Also:

Constant Field Values

Constructor Detail

PortletEntityImpl

public PortletEntityImpl(Fragment fragment)

PortletEntityImpl

public PortletEntityImpl()

Method Detail

getId

public org.apache.pluto.om.common.ObjectID getId()

Specified by:

getId in interface org.apache.pluto.om.entity.PortletEntity

getOid

public long getOid()

setId

public void setId(java.lang.String id)

Specified by:

setId in interface org.apache.pluto.om.entity.PortletEntityCtrl

getPreferenceSet

public org.apache.pluto.om.common.PreferenceSet getPreferenceSet()

getPreferenceSet

Specified by:

getPreferenceSet in interface org.apache.pluto.om.entity.PortletEntity

Returns:

See Also:

PortletEntity.getPreferenceSet()

getPreferenceSet

public org.apache.pluto.om.common.PreferenceSet getPreferenceSet(java.security.Principal principal)

backupValues

protected void backupValues(org.apache.pluto.om.common.PreferenceSet preferenceSet)

backupValues

getPortletDefinition

public org.apache.pluto.om.portlet.PortletDefinition getPortletDefinition()

Specified by:

getPortletDefinition in interface org.apache.pluto.om.entity.PortletEntity

getPortletApplicationEntity

public org.apache.pluto.om.entity.PortletApplicationEntity getPortletApplicationEntity()

Specified by:

getPortletApplicationEntity in interface org.apache.pluto.om.entity.PortletEntity

getPortletWindowList

public org.apache.pluto.om.window.PortletWindowList getPortletWindowList()

Specified by:

getPortletWindowList in interface org.apache.pluto.om.entity.PortletEntity

store

public void store()
           throws java.io.IOException

store

Specified by:

store in interface org.apache.pluto.om.entity.PortletEntityCtrl

Throws:

java.io.IOException

store

public void store(java.security.Principal principal)
           throws java.io.IOException

Throws:

java.io.IOException

reset

public void reset()
           throws java.io.IOException

reset

Specified by:

reset in interface org.apache.pluto.om.entity.PortletEntityCtrl

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(int indent)

getDescription

public org.apache.pluto.om.common.Description getDescription(java.util.Locale arg0)

Specified by:

getDescription in interface org.apache.pluto.om.entity.PortletEntity

See Also:

PortletEntity.getDescription(java.util.Locale)

setPortletDefinition

public void setPortletDefinition(org.apache.pluto.om.portlet.PortletDefinition composite)

setPortletDefinition

Specified by:

setPortletDefinition in interface org.apache.pluto.om.entity.PortletEntityCtrl

Parameters:

composite -

getPrincipal

public java.security.Principal getPrincipal()

Specified by:

getPrincipal in interface PrincipalAware

Returns:

Returns the principal.

postRemoval

public void postRemoval(PersistenceStore store)

postRemoval

Specified by:

postRemoval in interface RemovalAware

Parameters:

store -

Throws:

{@link - org.apache.jetspeed.persistence.store.PersistenceStoreRuntimeExcpetion} if the removal of the java.util.prefs.Preference related to this entity fails

See Also:

RemovalAware.postRemoval(org.apache.jetspeed.components.persistence.store.PersistenceStore)

preRemoval

public void preRemoval(PersistenceStore store)

preRemoval

not implemented.

Specified by:

preRemoval in interface RemovalAware

Parameters:

store -

See Also:

RemovalAware.preRemoval(org.apache.jetspeed.components.persistence.store.PersistenceStore)

getPortletUniqueName

public java.lang.String getPortletUniqueName()

Specified by:

getPortletUniqueName in interface MutablePortletEntity

setFragment

public void setFragment(Fragment fragment)

Specified by:

setFragment in interface MutablePortletEntity

getRenderTimeoutCount

public int getRenderTimeoutCount()

Specified by:

getRenderTimeoutCount in interface RenderTrackable

incrementRenderTimeoutCount

public void incrementRenderTimeoutCount()

Specified by:

incrementRenderTimeoutCount in interface RenderTrackable

setExpiration

public void setExpiration(long expiration)

Specified by:

setExpiration in interface RenderTrackable

getExpiration

public long getExpiration()

Specified by:

getExpiration in interface RenderTrackable

success

public void success()

Specified by:

success in interface RenderTrackable

setRenderTimeoutCount

public void setRenderTimeoutCount(int timeoutCount)

Specified by:

setRenderTimeoutCount in interface RenderTrackable