This project has retired. For details please refer to its Attic page.

org.apache.cocoon.caching
Interface Cacheable

All Known Implementing Classes:

AbstractServerPage, CachingCIncludeTransformer, JSGenerator, PythonGenerator, XSPGenerator

Deprecated. by the CacheableProcessingComponent interface

public interface Cacheable

This marker interface declares a (sitemap) component as cacheable. Although this interface is deprecated it is still used for compatibility!

Version:

CVS $Id: Cacheable.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Carsten Ziegeler

Method Summary

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

Method Detail

generateKey

long generateKey()

Deprecated.

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

CacheValidity generateValidity()

Deprecated.

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.