org.apache.jetspeed.services.portletcache
Interface PortletCacheService

All Superinterfaces:

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

All Known Implementing Classes:

JetspeedPortletCacheService

public interface PortletCacheService

extends org.apache.turbine.services.Service

This service provides caching facilities for objects within the Jetspeed application

This interface is designed for backward compability with the previous memory cache interfaces. It may be deprecated once the caching API is refactored

Version:

$Id: PortletCacheService.java,v 1.5 2005/03/21 18:21:44 sgala Exp $

Author:

Kevin A. Burton, Raphaël Luta

Field Summary

static java.lang.String

SERVICE_NAME

Method Summary

void	addCacheable(Cacheable item) Add a Cacheable object to the cache.
Cacheable	getCacheable(java.lang.String handle) Retrieves a Cacheable object from the cache.
void	removeCacheable(java.lang.String handle) Removes a Cacheable object from the cache based on its handle

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

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

addCacheable

public void addCacheable(Cacheable item)

Add a Cacheable object to the cache.

Parameters:

item - the object to store in the Cache

removeCacheable

public void removeCacheable(java.lang.String handle)

Removes a Cacheable object from the cache based on its handle

Parameters:

handle - the identifier of the object to remove

getCacheable

public Cacheable getCacheable(java.lang.String handle)

Retrieves a Cacheable object from the cache.

Parameters:

handle - the identifier of the object we wish to retrieve

Returns:

the cacehd object or null if not found