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

org.apache.jetspeed.portal.security.portlets
Class StatefulPortletWrapper

java.lang.Object
  org.apache.jetspeed.portal.security.portlets.PortletWrapper
      org.apache.jetspeed.portal.security.portlets.StatefulPortletWrapper

All Implemented Interfaces:

Portlet, PortletState, java.io.Serializable

Direct Known Subclasses:

CacheableStatefulPortletWrapper

public class StatefulPortletWrapper

extends PortletWrapper

implements PortletState

This object is used to wrap a Portlet, ensuring that access control rules are enforced.

Version:

$Id: StatefulPortletWrapper.java,v 1.5 2004/02/23 03:27:46 jford Exp $

Author:

Santiago Gala, Mark Orciuch

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.jetspeed.portal.Portlet

PORTLET_MAXIMIZED, PORTLET_MINIMIZED, PORTLET_NORMAL

Constructor Summary

StatefulPortletWrapper(Portlet inner)

Method Summary

boolean	allowClose(org.apache.turbine.util.RunData rundata) Implements the default close behavior: any authenticated user may remove a portlet from his page
boolean	allowCustomize(org.apache.turbine.util.RunData rundata) Implements the default customize behavior: any authenticated user may customize a portlet
boolean	allowInfo(org.apache.turbine.util.RunData rundata) Implements the default info behavior: any authenticated user may get information on a portlet
boolean	allowMaximize(org.apache.turbine.util.RunData rundata) Implements the default maximize behavior: any authenticated user may maximize a portlet
boolean	allowMinimize(org.apache.turbine.util.RunData rundata) Implements the default info behavior: any authenticated user may minimize a portlet
boolean	allowPrintFriendly(org.apache.turbine.util.RunData rundata) Implements the default info behavior: any authenticated user may view portlet in print friendly format
boolean	isClosed(org.apache.turbine.util.RunData rundata) Returns true if this portlet is currently closed
boolean	isMinimized(org.apache.turbine.util.RunData rundata) Returns true if this portlet is currently minimized
void	setClosed(boolean close, org.apache.turbine.util.RunData rundata) Toggles the portlet state between closed and normal
void	setMinimized(boolean minimize, org.apache.turbine.util.RunData rundata) Change the portlet visibility state ( minimized <-> normal )

Methods inherited from class org.apache.jetspeed.portal.security.portlets.PortletWrapper

checkPermission, getAllowEdit, getAllowMaximize, getAllowView, getAttribute, getContent, getCreationTime, getDescription, getDescription, getID, getImage, getInstance, getName, getPortlet, getPortletConfig, getTitle, getTitle, init, isShowTitleBar, providesCustomization, setAttribute, setCreationTime, setDescription, setID, setImage, setName, setPortletConfig, setTitle, setTitle, supportsType, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

StatefulPortletWrapper

public StatefulPortletWrapper(Portlet inner)

Method Detail

allowClose

public final boolean allowClose(org.apache.turbine.util.RunData rundata)

Implements the default close behavior: any authenticated user may remove a portlet from his page

Specified by:

allowClose in interface PortletState

Parameters:

rundata - the RunData object for the current request

isClosed

public final boolean isClosed(org.apache.turbine.util.RunData rundata)

Returns true if this portlet is currently closed

Specified by:

isClosed in interface PortletState

setClosed

public final void setClosed(boolean close,
                            org.apache.turbine.util.RunData rundata)

Toggles the portlet state between closed and normal

Specified by:

setClosed in interface PortletState

Parameters:

rundata - the RunData for this request

allowInfo

public final boolean allowInfo(org.apache.turbine.util.RunData rundata)

Implements the default info behavior: any authenticated user may get information on a portlet

Specified by:

allowInfo in interface PortletState

Parameters:

rundata - the RunData object for the current request

allowCustomize

public final boolean allowCustomize(org.apache.turbine.util.RunData rundata)

Implements the default customize behavior: any authenticated user may customize a portlet

Specified by:

allowCustomize in interface PortletState

Parameters:

rundata - the RunData object for the current request

allowMaximize

public boolean allowMaximize(org.apache.turbine.util.RunData rundata)

Implements the default maximize behavior: any authenticated user may maximize a portlet

Specified by:

allowMaximize in interface PortletState

Parameters:

rundata - the RunData object for the current request

allowMinimize

public boolean allowMinimize(org.apache.turbine.util.RunData rundata)

Implements the default info behavior: any authenticated user may minimize a portlet

Specified by:

allowMinimize in interface PortletState

Parameters:

rundata - the RunData object for the current request

isMinimized

public boolean isMinimized(org.apache.turbine.util.RunData rundata)

Returns true if this portlet is currently minimized

Specified by:

isMinimized in interface PortletState

setMinimized

public void setMinimized(boolean minimize,
                         org.apache.turbine.util.RunData rundata)

Change the portlet visibility state ( minimized <-> normal )

Specified by:

setMinimized in interface PortletState

Parameters:

minimize - True if the portlet change to minimized

rundata - A RunData object

allowPrintFriendly

public boolean allowPrintFriendly(org.apache.turbine.util.RunData rundata)

Implements the default info behavior: any authenticated user may view portlet in print friendly format

Specified by:

allowPrintFriendly in interface PortletState

Parameters:

rundata - the RunData object for the current request