org.apache.cocoon.components.pipeline.impl
Class CachingProcessingPipeline

java.lang.Object
  extended byorg.apache.cocoon.util.AbstractLogEnabled
      extended byorg.apache.cocoon.components.pipeline.AbstractProcessingPipeline
          extended byorg.apache.cocoon.components.pipeline.impl.BaseCachingProcessingPipeline
              extended byorg.apache.cocoon.components.pipeline.impl.AbstractCachingProcessingPipeline
                  extended byorg.apache.cocoon.components.pipeline.impl.CachingProcessingPipeline
All Implemented Interfaces:
Disposable, Parameterizable, Poolable, org.apache.cocoon.components.pipeline.ProcessingPipeline, Recyclable, Serviceable

public class CachingProcessingPipeline
extends AbstractCachingProcessingPipeline

The CachingProcessingPipeline

Since:
2.1
Version:
$Id: CachingProcessingPipeline.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary
 
Fields inherited from class org.apache.cocoon.components.pipeline.impl.AbstractCachingProcessingPipeline
cacheCompleteResponse, cachedResponse, completeResponseIsCached, firstNotCacheableTransformerIndex, firstProcessedTransformerIndex, fromCacheKey, generatorRole, PIPELOCK_PREFIX, readerRole, serializerRole, toCacheKey, toCacheSourceValidities, transformerRoles, transientStore
 
Fields inherited from class org.apache.cocoon.components.pipeline.impl.BaseCachingProcessingPipeline
cache, xmlDeserializer, xmlSerializer
 
Fields inherited from class org.apache.cocoon.components.pipeline.AbstractProcessingPipeline
configuration, configuredExpires, configuredOutputBufferSize, expires, generator, generatorParam, generatorSource, lastConsumer, manager, newManager, outputBufferSize, parameters, reader, readerMimeType, readerParam, readerSource, serializer, serializerMimeType, serializerParam, serializerSource, sourceResolver, transformerParams, transformers, transformerSources
 
Fields inherited from interface org.apache.cocoon.components.pipeline.ProcessingPipeline
ROLE
 
Constructor Summary
CachingProcessingPipeline()
           
 
Method Summary
protected  org.apache.cocoon.caching.CachedResponse cacheResults(org.apache.cocoon.environment.Environment environment, OutputStream os)
          Cache longest cacheable key
protected  void connectCachingPipeline(org.apache.cocoon.environment.Environment environment)
          Connect the pipeline.
protected  ComponentCacheKey newComponentCacheKey(int type, String role, Serializable key)
          Create a new cache key
 
Methods inherited from class org.apache.cocoon.components.pipeline.impl.AbstractCachingProcessingPipeline
addTransformer, connectPipeline, generateCachingKey, generateLock, getKeyForEventPipeline, getValidityForEventPipeline, parameterize, processReader, processXMLPipeline, recycle, releaseLock, setGenerator, setReader, setSerializer, setupPipeline, setupValidities, validatePipeline, waitForLock
 
Methods inherited from class org.apache.cocoon.components.pipeline.impl.BaseCachingProcessingPipeline
dispose
 
Methods inherited from class org.apache.cocoon.components.pipeline.AbstractProcessingPipeline
checkIfModified, checkPipeline, connect, getGenerator, getLocation, handleException, informBranchPoint, isInternalError, prepareInternal, prepareInternalErrorHandler, preparePipeline, process, process, processErrorHandler, service, setErrorHandler, setMimeTypeForReader, setMimeTypeForSerializer, setProcessorManager, setup, setupReader
 
Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled
getLogger, setLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CachingProcessingPipeline

public CachingProcessingPipeline()
Method Detail

cacheResults

protected org.apache.cocoon.caching.CachedResponse cacheResults(org.apache.cocoon.environment.Environment environment,
                                                                OutputStream os)
                                                         throws Exception
Cache longest cacheable key

Specified by:
cacheResults in class AbstractCachingProcessingPipeline
Returns:
complete cached response or null
See issue COCOON-2009 for discussion
Throws:
Exception

newComponentCacheKey

protected ComponentCacheKey newComponentCacheKey(int type,
                                                 String role,
                                                 Serializable key)
Create a new cache key

Specified by:
newComponentCacheKey in class AbstractCachingProcessingPipeline

connectCachingPipeline

protected void connectCachingPipeline(org.apache.cocoon.environment.Environment environment)
                               throws org.apache.cocoon.ProcessingException
Connect the pipeline.

Specified by:
connectCachingPipeline in class AbstractCachingProcessingPipeline
Throws:
org.apache.cocoon.ProcessingException


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.