org.apache.jetspeed.services.persistence
Class JetspeedPortalPersistenceService

java.lang.Object
  org.apache.turbine.services.BaseInitable
      org.apache.turbine.services.BaseService
          org.apache.turbine.services.TurbineBaseService
              org.apache.jetspeed.services.persistence.JetspeedPortalPersistenceService

All Implemented Interfaces:

org.apache.turbine.services.Initable, PortalPersistenceService, org.apache.turbine.services.Service

public class JetspeedPortalPersistenceService

extends org.apache.turbine.services.TurbineBaseService

implements PortalPersistenceService

Implementation of the Portal Persistence Service for storing and retrieving portlet instances.

Version:

$Id: JetspeedPortalPersistenceService.java,v 1.6 2004/05/04 00:01:29 taylor Exp $

Author:

Scott Weaver

Field Summary

Fields inherited from class org.apache.turbine.services.BaseService

configuration, name, properties, serviceBroker

Fields inherited from class org.apache.turbine.services.BaseInitable

initableBroker, isInitialized

Fields inherited from interface org.apache.jetspeed.services.persistence.PortalPersistenceService

SERVICE_NAME

Constructor Summary

JetspeedPortalPersistenceService()

Method Summary

protected void	buildAllEntries(Portlets portlets, java.util.ArrayList entries, Profile profile)
PortletInstance	getInstance(Portlet portlet, Profile profile) Retrieves a PersistentPortlet instance for this portlet.
PortletInstance	getInstance(Portlet portlet, org.apache.turbine.util.RunData data) Retrieves a portlet instance from persistent storage for the given portlet.
java.util.List	getInstances(Profile profile) Retrieves a List of portlet instances for the given profile.
java.util.List	getInstances(org.apache.turbine.util.RunData data) Retrieves a List of portlet instances for the current profile.
void	init(org.apache.turbine.util.RunData data) Use this to verify the RunData object in use is going to be the Jetspeed RunData object.
void	store(PortletInstance pPortlet) Store a portlet instance to permenant storage.

Methods inherited from class org.apache.turbine.services.TurbineBaseService

init, init, init, shutdown

Methods inherited from class org.apache.turbine.services.BaseService

getConfiguration, getName, getProperties, getServiceBroker, setName, setServiceBroker

Methods inherited from class org.apache.turbine.services.BaseInitable

getInit, getInitableBroker, setInit, setInitableBroker

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.turbine.services.Service

getConfiguration, getName, getProperties, setName, setServiceBroker

Methods inherited from interface org.apache.turbine.services.Initable

getInit, init, init, setInitableBroker, shutdown

Constructor Detail

JetspeedPortalPersistenceService

public JetspeedPortalPersistenceService()

Method Detail

init

public void init(org.apache.turbine.util.RunData data)
          throws org.apache.turbine.services.InitializationException

Use this to verify the RunData object in use is going to be the Jetspeed RunData object. This way we know right off, whether or not things are going to work.

Throws:

org.apache.turbine.services.InitializationException

getInstance

public PortletInstance getInstance(Portlet portlet,
                                   Profile profile)

Description copied from interface: PortalPersistenceService

Retrieves a PersistentPortlet instance for this portlet.

Specified by:

getInstance in interface PortalPersistenceService

Parameters:

portlet - The portlet to retrieve an instance for

profile - Retrieve instance from this profile.

Returns:

PortletInstance The instance for the given portlet.

See Also:

PortalPersistenceService.getInstance(Portlet, Profile)

getInstance

public PortletInstance getInstance(Portlet portlet,
                                   org.apache.turbine.util.RunData data)

Description copied from interface: PortalPersistenceService

Retrieves a portlet instance from persistent storage for the given portlet.

Specified by:

getInstance in interface PortalPersistenceService

Parameters:

portlet - The portlet to retrieve an instance for

data - Request rundata.

Returns:

PortletInstance The instance for the given portlet.

See Also:

PortalPersistenceService.getInstance(Portlet, RunData)

store

public void store(PortletInstance pPortlet)
           throws PortalPersistenceException

Description copied from interface: PortalPersistenceService

Store a portlet instance to permenant storage.

Specified by:

store in interface PortalPersistenceService

Parameters:

pPortlet - The portlet instance to be stored.

Throws:

PortalPersistenceException - if there were problems storing the PSMLDocument to persistent storage.

See Also:

PortalPersistenceService.store(PortletInstance)

getInstances

public java.util.List getInstances(Profile profile)
                            throws PortletException

Description copied from interface: PortalPersistenceService

Retrieves a List of portlet instances for the given profile.

Specified by:

getInstances in interface PortalPersistenceService

Parameters:

profile - Retrieve instances from this profile.

Returns:

List The list of all instances in current profile.

Throws:

PortletException

See Also:

PortalPersistenceService#getInstances(Portlet, Profile)

getInstances

public java.util.List getInstances(org.apache.turbine.util.RunData data)
                            throws PortletException

Description copied from interface: PortalPersistenceService

Retrieves a List of portlet instances for the current profile.

Specified by:

getInstances in interface PortalPersistenceService

Parameters:

data - Request rundata.

Returns:

List The list of all instances in current profile.

Throws:

PortletException

See Also:

PortalPersistenceService#getInstances(Portlet, RunData)

buildAllEntries

protected void buildAllEntries(Portlets portlets,
                               java.util.ArrayList entries,
                               Profile profile)
                        throws PortletException

Throws:

PortletException