org.apache.cocoon.components.pipeline
Class CachingStreamPipeline

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLoggable
        |
        +--org.apache.cocoon.components.pipeline.AbstractStreamPipeline
              |
              +--org.apache.cocoon.components.pipeline.CachingStreamPipeline

All Implemented Interfaces:

org.apache.avalon.framework.component.Component, org.apache.avalon.framework.component.Composable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.logger.Loggable, org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.framework.component.Recomposable, org.apache.avalon.excalibur.pool.Recyclable, StreamPipeline

public class CachingStreamPipeline

extends AbstractStreamPipeline

A StreamPipeline either

• collects a Reader and let it process
• or connects a EventPipeline with a Serializer and let them produce the requested resource

This stream pipeline is able to cache the response, if

• a) the serializer is cacheable
• b) the EventPipeline is cacheable

Version:

CVS $Id: CachingStreamPipeline.java,v 1.8.2.1 2002/08/05 11:20:41 cziegeler Exp $

Author:

Carsten Ziegeler

Fields inherited from class org.apache.cocoon.components.pipeline.AbstractStreamPipeline

eventPipeline, manager, newManager, reader, readerMimeType, readerParam, readerSelector, readerSource, serializer, serializerMimeType, serializerParam, serializerSelector, serializerSource, sitemapReaderMimeType, sitemapSerializerMimeType

Fields inherited from interface org.apache.cocoon.components.pipeline.StreamPipeline

ROLE

Constructor Summary

CachingStreamPipeline()

Method Summary

void	compose(org.apache.avalon.framework.component.ComponentManager manager) Pass the ComponentManager to the Composable.
void	dispose()
boolean	process(Environment environment) Process the request.
protected boolean	processReader(Environment environment) Process the pipeline using a reader.
void	recycle() Recycle this component
void	setReader(java.lang.String role, java.lang.String source, org.apache.avalon.framework.parameters.Parameters param, java.lang.String mimeType) Set the Reader.
void	setSerializer(java.lang.String role, java.lang.String source, org.apache.avalon.framework.parameters.Parameters param, java.lang.String mimeType) Set the serializer.

Methods inherited from class org.apache.cocoon.components.pipeline.AbstractStreamPipeline

checkPipeline, connectPipeline, getEventPipeline, recompose, setEventPipeline, setReader, setSerializer, setupPipeline

Methods inherited from class org.apache.avalon.framework.logger.AbstractLoggable

getLogger, setLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CachingStreamPipeline

public CachingStreamPipeline()

Method Detail

compose

public void compose(org.apache.avalon.framework.component.ComponentManager manager)
             throws org.apache.avalon.framework.component.ComponentException

Description copied from class: AbstractStreamPipeline

Pass the ComponentManager to the Composable. The Composable implementation should use the specified ComponentManager to acquire the components it needs for execution.

Overrides:

compose in class AbstractStreamPipeline

Following copied from class: org.apache.cocoon.components.pipeline.AbstractStreamPipeline

Parameters:

manager - The ComponentManager which this Composable uses.

Throws:

org.apache.avalon.framework.component.ComponentException -

dispose

public void dispose()

Overrides:

dispose in class AbstractStreamPipeline

setSerializer

public void setSerializer(java.lang.String role,
                          java.lang.String source,
                          org.apache.avalon.framework.parameters.Parameters param,
                          java.lang.String mimeType)
                   throws java.lang.Exception

Set the serializer.

Overrides:

setSerializer in class AbstractStreamPipeline

setReader

public void setReader(java.lang.String role,
                      java.lang.String source,
                      org.apache.avalon.framework.parameters.Parameters param,
                      java.lang.String mimeType)
               throws java.lang.Exception

Set the Reader.

Overrides:

setReader in class AbstractStreamPipeline

processReader

protected boolean processReader(Environment environment)
                         throws ProcessingException

Process the pipeline using a reader.

Overrides:

processReader in class AbstractStreamPipeline

Throws:

ProcessingException - if

process

public boolean process(Environment environment)
                throws ProcessingException

Process the request.

Overrides:

process in class AbstractStreamPipeline

recycle

public void recycle()

Recycle this component

Overrides:

recycle in class AbstractStreamPipeline