org.apache.jetspeed.container.window.impl
Class PortletWindowAccessorImpl

java.lang.Object
  extended by org.apache.jetspeed.container.window.impl.PortletWindowAccessorImpl
All Implemented Interfaces:
RegistryEventListener, PortletWindowAccessor

public class PortletWindowAccessorImpl
extends java.lang.Object
implements PortletWindowAccessor, RegistryEventListener

Portlet Window Accessor Implementation

Version:
$Id: PortletWindowAccessorImpl.java,v 1.12 2005/04/29 14:01:57 weaver Exp $
Author:
David Sean Taylor

Field Summary
protected static org.apache.commons.logging.Log log
           
 
Constructor Summary
PortletWindowAccessorImpl(PortletEntityAccessComponent entityAccessor, PortletFactory portletFactory, PortletRegistry registry, PortletWindowCache portletWindowCache, boolean validateWindows)
           
PortletWindowAccessorImpl(PortletEntityAccessComponent entityAccessor, PortletFactory portletFactory, PortletWindowCache portletWindowCache, boolean validateWindows)
           
 
Method Summary
 void applicationRemoved(MutablePortletApplication app)
          applicationRemoved - invoked when the definition of a portlet application is removed by the registry
 void applicationUpdated(MutablePortletApplication app)
          applicationUpdated - invoked when the definition of a portlet application is updated by the registry or when the state modification is otherwise detected
 org.apache.pluto.om.window.PortletWindow createPortletWindow(org.apache.pluto.om.entity.PortletEntity entity, java.lang.String windowId)
          Given a portlet entity, create a portlet window for that entity.
 org.apache.pluto.om.window.PortletWindow createPortletWindow(java.lang.String windowId)
          Create a temporary portlet window This window does not have an entity associated with it.
 org.apache.pluto.om.window.PortletWindow getPortletWindow(ContentFragment fragment)
          Get a portlet window for the given fragment
 org.apache.pluto.om.window.PortletWindow getPortletWindow(ContentFragment fragment, java.lang.String principal)
          Get the portlet window for a fragment and given principal
 org.apache.pluto.om.window.PortletWindow getPortletWindow(java.lang.String windowId)
          Lookup a portlet window in the cache If not found, return null
 java.util.Set getPortletWindows()
          Gets a Set of currently available PortletWindows within the current engine instance.
 void portletRemoved(PortletDefinitionComposite def)
          portletUpdated - invoked when the definition of a portlet definition is removed by the registry
 void portletUpdated(PortletDefinitionComposite def)
          portletUpdated - invoked when the definition of a portlet definition is updated by the registry or when the state modification is otherwise detected
protected  void removeForPortletApplication(MutablePortletApplication app)
           
protected  void removeForPortletDefinition(PortletDefinitionComposite def)
           
 void removeWindow(org.apache.pluto.om.window.PortletWindow window)
           removeWindow
 void removeWindows(org.apache.pluto.om.entity.PortletEntity portletEntity)
           removeWindows
protected  void validateWindow(ContentFragment fragment, org.apache.pluto.om.window.PortletWindow portletWindow)
           validateWindow
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected static final org.apache.commons.logging.Log log
Constructor Detail

PortletWindowAccessorImpl

public PortletWindowAccessorImpl(PortletEntityAccessComponent entityAccessor,
                                 PortletFactory portletFactory,
                                 PortletWindowCache portletWindowCache,
                                 boolean validateWindows)

PortletWindowAccessorImpl

public PortletWindowAccessorImpl(PortletEntityAccessComponent entityAccessor,
                                 PortletFactory portletFactory,
                                 PortletRegistry registry,
                                 PortletWindowCache portletWindowCache,
                                 boolean validateWindows)
Method Detail

createPortletWindow

public org.apache.pluto.om.window.PortletWindow createPortletWindow(org.apache.pluto.om.entity.PortletEntity entity,
                                                                    java.lang.String windowId)
Description copied from interface: PortletWindowAccessor
Given a portlet entity, create a portlet window for that entity.

Specified by:
createPortletWindow in interface PortletWindowAccessor
Returns:
new window

createPortletWindow

public org.apache.pluto.om.window.PortletWindow createPortletWindow(java.lang.String windowId)
Description copied from interface: PortletWindowAccessor
Create a temporary portlet window This window does not have an entity associated with it.

Specified by:
createPortletWindow in interface PortletWindowAccessor
Returns:

getPortletWindow

public org.apache.pluto.om.window.PortletWindow getPortletWindow(java.lang.String windowId)
Description copied from interface: PortletWindowAccessor
Lookup a portlet window in the cache If not found, return null

Specified by:
getPortletWindow in interface PortletWindowAccessor
Returns:
the window from the cache or null

getPortletWindow

public org.apache.pluto.om.window.PortletWindow getPortletWindow(ContentFragment fragment)
                                                          throws FailedToRetrievePortletWindow,
                                                                 PortletEntityNotStoredException
Description copied from interface: PortletWindowAccessor
Get a portlet window for the given fragment

Specified by:
getPortletWindow in interface PortletWindowAccessor
Returns:
Throws:
FailedToRetrievePortletWindow
PortletEntityNotStoredException

validateWindow

protected void validateWindow(ContentFragment fragment,
                              org.apache.pluto.om.window.PortletWindow portletWindow)
                       throws FailedToRetrievePortletWindow,
                              PortletEntityNotStoredException

validateWindow

Parameters:
fragment -
portletWindow -
Throws:
PortletEntityNotStoredException
InconsistentWindowStateException
FailedToRetrievePortletWindow

getPortletWindow

public org.apache.pluto.om.window.PortletWindow getPortletWindow(ContentFragment fragment,
                                                                 java.lang.String principal)
                                                          throws FailedToRetrievePortletWindow,
                                                                 FailedToCreateWindowException,
                                                                 PortletEntityNotStoredException
Description copied from interface: PortletWindowAccessor
Get the portlet window for a fragment and given principal

Specified by:
getPortletWindow in interface PortletWindowAccessor
Returns:
Throws:
FailedToRetrievePortletWindow
FailedToCreateWindowException
PortletEntityNotStoredException

removeWindows

public void removeWindows(org.apache.pluto.om.entity.PortletEntity portletEntity)
Description copied from interface: PortletWindowAccessor

removeWindows

Removes all PortletWindows associated with this PortletEntity

Specified by:
removeWindows in interface PortletWindowAccessor

removeWindow

public void removeWindow(org.apache.pluto.om.window.PortletWindow window)
Description copied from interface: PortletWindowAccessor

removeWindow

Removes a PortletWindow from the window cache.

Specified by:
removeWindow in interface PortletWindowAccessor

getPortletWindows

public java.util.Set getPortletWindows()
Description copied from interface: PortletWindowAccessor
Gets a Set of currently available PortletWindows within the current engine instance.

Specified by:
getPortletWindows in interface PortletWindowAccessor
Returns:
Set of PortletWindows, never returns null

removeForPortletDefinition

protected void removeForPortletDefinition(PortletDefinitionComposite def)

removeForPortletApplication

protected void removeForPortletApplication(MutablePortletApplication app)

applicationRemoved

public void applicationRemoved(MutablePortletApplication app)
Description copied from interface: RegistryEventListener
applicationRemoved - invoked when the definition of a portlet application is removed by the registry

Specified by:
applicationRemoved in interface RegistryEventListener

applicationUpdated

public void applicationUpdated(MutablePortletApplication app)
Description copied from interface: RegistryEventListener
applicationUpdated - invoked when the definition of a portlet application is updated by the registry or when the state modification is otherwise detected

Specified by:
applicationUpdated in interface RegistryEventListener

portletRemoved

public void portletRemoved(PortletDefinitionComposite def)
Description copied from interface: RegistryEventListener
portletUpdated - invoked when the definition of a portlet definition is removed by the registry

Specified by:
portletRemoved in interface RegistryEventListener

portletUpdated

public void portletUpdated(PortletDefinitionComposite def)
Description copied from interface: RegistryEventListener
portletUpdated - invoked when the definition of a portlet definition is updated by the registry or when the state modification is otherwise detected

Specified by:
portletUpdated in interface RegistryEventListener


Copyright © 1999-2010 Apache Software Foundation. All Rights Reserved.