org.apache.cocoon.caching
Interface Cacheable

All Known Implementing Classes:

AbstractServerPage, CachingCIncludeTransformer, FilterTransformer, FragmentExtractorTransformer, TraxTransformer, ContentAggregator, SVGSerializer, AbstractTextSerializer, FOPSerializer, HTMLGenerator, XMLDBGenerator, XMLDBCollectionGenerator, FragmentExtractorGenerator, ServerPagesGenerator, FileGenerator, DatabaseReader, ResourceReader

public interface Cacheable

This marker interface declares a (sitemap) component as cacheable.

Version:

CVS $Id: Cacheable.java,v 1.5 2002/02/22 07:03:49 cziegeler Exp $

Author:

Carsten Ziegeler

Method Summary

long	generateKey() Generate the unique key.
CacheValidity	generateValidity() Generate the validity object.

Method Detail

generateKey

public long generateKey()

Generate the unique key. This key must be unique inside the space of this component. This method must be invoked before the generateValidity() method.

Returns:

The generated key or 0 if the component is currently not cacheable.

generateValidity

public CacheValidity generateValidity()

Generate the validity object. Before this method can be invoked the generateKey() method must be invoked.

Returns:

The generated validity object or null if the component is currently not cacheable.