org.apache.wsrp4j.producer.provider.pluto.driver
Class PortletPoolImpl

java.lang.Object
  org.apache.pluto.portalImpl.services.Service
      org.apache.pluto.portalImpl.services.portletentityregistry.PortletEntityRegistryService
          org.apache.pluto.portalImpl.services.portletentityregistry.PortletEntityRegistryServiceFileImpl
              org.apache.wsrp4j.producer.provider.pluto.driver.PortletPoolImpl

All Implemented Interfaces:

PlutoPortletPool, PortletPool

public class PortletPoolImpl

extends org.apache.pluto.portalImpl.services.portletentityregistry.PortletEntityRegistryServiceFileImpl

implements PlutoPortletPool

This class implements the PortletPool interface. ProducerOfferedPortlets and ConsumerConfiguredPortlets are kept within different hashmaps associating portlet handles (keys) with portlet-objects (values). See interfaces ProducerOfferedPortlet and ConsumerConfiguredPortlet.

TODO:

• Synchronization aspects are not considered so far. This could be achieved by using a hashtable instead of a hashmap.

Version:

$Id: PortletPoolImpl.java,v 1.9 2005/08/12 12:56:52 cziegeler Exp $

Author:

Peter Fischer

See Also:

PortletPool

Field Summary

private java.util.Map	consumerConfiguredPortlets
private HandleGenerator	handleGenerator
private Logger	logger
private PersistentDataObject	persistentDataObject
private PersistentHandler	persistentHandler
private java.util.Map	producerOfferedPortlets
private Provider	provider
private static boolean	REGISTRATION_REQUIRED

Fields inherited from class org.apache.pluto.portalImpl.services.portletentityregistry.PortletEntityRegistryServiceFileImpl

CONFIG_FILE, CONFIG_MAPPING, DEFAULT_MAPPING, mapping, portletEntitiesKeyObjectID, registry, servletContext

Constructor Summary

PortletPoolImpl()
Private constructor of PortletPoolImpl.

Method Summary

Portlet	clone(java.lang.String portletHandle) Clones the portlet (ProducerOffered or ConsumerConfiguredPortlet) associated by portlet-handle.
private void	delete(PersistentDataObject persistentDataObject) Delete the object from persistent store
boolean	destroy(java.lang.String portletHandle) Deletes the portlet identified by portletHandle from the PortletPool.
java.util.Iterator	destroySeveral(java.util.Iterator portletHandles) Deletes several portlets from the portlet pool.
Portlet	get(java.lang.String portletHandle) Returns a certain portlet identified by portletHandle.
java.util.Iterator	getAllConsumerConfiguredPortlets() Returns all ConsumerConfiguredPortlets currently stored in the hashmap consumerConfiguredPortlets.
java.util.Iterator	getAllProducerOfferedPortlets() Returns all ProducerOfferedPortlet objects.
Provider	getProvider() Return the provider
void	init(javax.servlet.ServletConfig servletConfig, org.apache.pluto.portalImpl.util.Properties properties) Initialize the portlet pool
private void	restore() Restores all available ConsumerConfiguredPortlets from persistent file store
void	setProvider(Provider provider) Set the provider
private void	store(PersistentDataObject persistentDataObject) Store the object to persistent store

Methods inherited from class org.apache.pluto.portalImpl.services.portletentityregistry.PortletEntityRegistryServiceFileImpl

getPortletApplicationEntityList, getPortletEntities, getPortletEntity, load, refresh, store

Methods inherited from class org.apache.pluto.portalImpl.services.Service

destroy, destroy, init, init, postInit, postInit

Methods inherited from class java.lang.Object

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

Field Detail

provider

private Provider provider

handleGenerator

private HandleGenerator handleGenerator

persistentDataObject

private PersistentDataObject persistentDataObject

persistentHandler

private PersistentHandler persistentHandler

consumerConfiguredPortlets

private java.util.Map consumerConfiguredPortlets

producerOfferedPortlets

private java.util.Map producerOfferedPortlets

logger

private Logger logger

REGISTRATION_REQUIRED

private static boolean REGISTRATION_REQUIRED

Constructor Detail

PortletPoolImpl

public PortletPoolImpl()

Private constructor of PortletPoolImpl. Creates a HashMap for the ProducerOfferedPortlet and ConsumerConfiguredPortlet object instances. If the subdirectory for the persistent file store is not already available, it will be created. If the file store is available, it will be scanned for xml files to be restored to ProducerOfferedPortlet objects. See the restore() method for more details.

Method Detail

init

public void init(javax.servlet.ServletConfig servletConfig,
                 org.apache.pluto.portalImpl.util.Properties properties)
          throws java.lang.Exception

Initialize the portlet pool

Parameters:

servletConfig - servlet configuration

properties -

Throws:

java.lang.Exception

getProvider

public Provider getProvider()

Return the provider

Specified by:

getProvider in interface PlutoPortletPool

Returns:

Provider

setProvider

public void setProvider(Provider provider)

Set the provider

Specified by:

setProvider in interface PlutoPortletPool

Parameters:

provider -

clone

public Portlet clone(java.lang.String portletHandle)

Clones the portlet (ProducerOffered or ConsumerConfiguredPortlet) associated by portlet-handle. Only the portlet-object is cloned, not the portlet-description the portlet references, i.e. the resulting cloned portlet references the same portlet-description as its original.

Assigns a new portletHandle to the clone to enable identification.

Adds the new ConsumerConfiguredPortlet to the hashmap after cloning.

Specified by:

clone in interface PortletPool

Parameters:

portletHandle - String identifying the portlet to be cloned.

Returns:

ConsumerConfiguredPortlet The portlet-clone.

getAllProducerOfferedPortlets

public java.util.Iterator getAllProducerOfferedPortlets()

Returns all ProducerOfferedPortlet objects.

Specified by:

getAllProducerOfferedPortlets in interface PortletPool

Returns:

Iterator of an portlet collection

getAllConsumerConfiguredPortlets

public java.util.Iterator getAllConsumerConfiguredPortlets()

Returns all ConsumerConfiguredPortlets currently stored in the hashmap consumerConfiguredPortlets.

Specified by:

getAllConsumerConfiguredPortlets in interface PortletPool

Returns:

Iterator of an portlet collection containing all portlets.

get

public Portlet get(java.lang.String portletHandle)
            throws WSRPException

Returns a certain portlet identified by portletHandle.

Specified by:

get in interface PortletPool

Parameters:

portletHandle - String representing the portletHandle.

Returns:

ProducerOfferedPortlet object associated with portletHandle.

Throws:

WSRPException

destroy

public boolean destroy(java.lang.String portletHandle)

Deletes the portlet identified by portletHandle from the PortletPool. Only consumer configured portlets can be deleted, NOT producer offered ones. After update, the persistent file store is refreshed. Deletes all existing portlet sessions (SessionHandler) and portlet states (PortletStateManager) as well.

Specified by:

destroy in interface PortletPool

Parameters:

portletHandle - String representing the portletHandle.

Returns:

Boolean indicating if deletion was successful. Returns false if the portlet handle refers to a producer offered portlet.

destroySeveral

public java.util.Iterator destroySeveral(java.util.Iterator portletHandles)

Deletes several portlets from the portlet pool.

Specified by:

destroySeveral in interface PortletPool

Parameters:

portletHandles - Iterator of portletHandles.

Returns:

Iterator of portlet handles refering to those portlets that could not be deleted (e.g. producer offered portlets)

store

private void store(PersistentDataObject persistentDataObject)
            throws WSRPException

Store the object to persistent store

Parameters:

persistentDataObject -

Throws:

WSRPException

restore

private void restore()
              throws WSRPException

Restores all available ConsumerConfiguredPortlets from persistent file store

Throws:

WSRPException

delete

private void delete(PersistentDataObject persistentDataObject)

Delete the object from persistent store

Parameters:

persistentDataObject -