org.apache.cocoon.caching
Interface CacheableProcessingComponent

All Known Implementing Classes:
AbstractServerPage, AbstractTextSerializer, AsciiArtSVGGenerator, CalendarGenerator, CIncludeTransformer, CleanupTransformer, ContentAggregator, CSVGenerator, DASLTransformer, DatabaseReader, DeliTransformer, DirectoryGenerator, EncodeURLTransformer, EventAwareGenerator, EventAwareReader, EventCacheGenerator, ExtendedParserTransformer, FileGenerator, FilterTransformer, FOPSerializer, FragmentExtractorGenerator, FragmentExtractorTransformer, HTMLGenerator, HTMLRootTransformer, HTMLSerializer, I18nTransformer, ImageDirectoryGenerator, ImageOpReader, ImageReader, IncludeTransformer, IncludingHTMLSerializer, iTextSerializer, JSGenerator, JXTemplateGenerator, JXTemplateGenerator, LexicalTransformer, LinkGatherer, LinkTranslator, LuceneIndexTransformer, MP3DirectoryGenerator, NekoHTMLGenerator, Paginator, ParserTransformer, PatternTransformer, PortalToolsI18nTransformer, PythonGenerator, ResourceReader, RoleFilterTransformer, RSSTransformer, RTFSerializer, ServerPagesGenerator, SlopGenerator, StripNameSpacesTransformer, SVGSerializer, SWFGenerator, TextGenerator, TextSerializer, TraversableGenerator, TraversableSourceDescriptionGenerator, TraxTransformer, ValidatingTransformer, ValidationReportTransformer, WebDAVTransformer, XIncludeTransformer, XMLDBCollectionGenerator, XMLDBGenerator, XMLDBTransformer, XMLSerializer, XPathDirectoryGenerator, XPathTraversableGenerator, XSPGenerator

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.html 1304258 2012-03-23 10:09:27Z ilgrosso $
Author:
Carsten Ziegeler

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

Method Detail

getKey

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

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.


Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.