org.apache.cocoon.components.pipeline
Interface CacheableEventPipeline

All Known Implementing Classes:

CachingEventPipeline

public interface CacheableEventPipeline

This marker interface declares an EventPipeline as cacheable.

Version:

CVS $Id: CacheableEventPipeline.java,v 1.4 2002/02/22 07:00:11 cziegeler Exp $

Author:

Carsten Ziegeler

Method Summary

PipelineCacheKey	generateKey(Environment environment) Generate the unique key.
java.util.Map	generateValidity(Environment environment) Generate the validity object.
void	setStreamPipelineCaches(boolean flag) The stream pipeline (or the content aggregator) calls this method to tell the event pipeline if it must not cache the result

Method Detail

generateKey

public PipelineCacheKey generateKey(Environment environment)
                             throws java.lang.Exception

Generate the unique key. This key is the PipelineCacheKey for the whole EventPipeline.

Parameters:

environment - The current environment of the request.

Returns:

The generated key or null if the pipeline is currently not cacheable as a whole.

generateValidity

public java.util.Map generateValidity(Environment environment)
                               throws java.lang.Exception

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

Parameters:

environment - The current environment of the request.

Returns:

The generated validity objects for the whole pipeline or null if the pipeline is currently not cacheable.

setStreamPipelineCaches

public void setStreamPipelineCaches(boolean flag)

The stream pipeline (or the content aggregator) calls this method to tell the event pipeline if it must not cache the result