org.apache.cocoon.caching
Interface CacheableProcessingComponent

All Known Implementing Classes:

AbstractServerPage, AbstractTextSerializer, AsciiArtSVGGenerator, CalendarGenerator, CIncludeTransformer, CleanupTransformer, ContentAggregator, DASLTransformer, DatabaseReader, DirectoryGenerator, EventCacheGenerator, ExtendedParserTransformer, FileGenerator, FilterTransformer, FOPSerializer, FragmentExtractorGenerator, FragmentExtractorTransformer, HTMLGenerator, HTMLRootTransformer, I18nTransformer, IncludeTransformer, iTextSerializer, JXTemplateGenerator, JXTemplateGenerator, LexicalTransformer, LinkGatherer, LinkTranslator, LuceneIndexTransformer, NekoHTMLGenerator, Paginator, ParserTransformer, PatternTransformer, ResourceReader, RoleFilterTransformer, RSSTransformer, ServerPagesGenerator, SlopGenerator, SVGSerializer, TextGenerator, TraversableGenerator, TraxTransformer, ValidatingTransformer, ValidationReportTransformer, WebDAVTransformer, XIncludeTransformer, XMLDBCollectionGenerator, XMLDBGenerator, XMLDBTransformer

public interface CacheableProcessingComponent

This marker interface declares a (sitemap) component as cacheable. This interface deprecates the org.apache.cocoon.caching.Cacheable interface!

Since:

2.1

Version:

CVS $Id: CacheableProcessingComponent.java 433543 2006-08-22 06:22:54Z crossley $

Author:

Carsten Ziegeler

Method Summary

Serializable	getKey() Generate the unique key.
SourceValidity	getValidity() Generate the validity object.

Method Detail

getKey

public Serializable getKey()

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

Returns:

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

getValidity

public SourceValidity getValidity()

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

Returns:

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