| org.apache.cocoon.components.pipeline.impl.BaseCachingProcessingPipeline
 org.apache.cocoon.components.pipeline.impl.AbstractCachingProcessingPipeline
All known Subclasses: org.apache.cocoon.components.pipeline.impl.CachingPointProcessingPipeline, org.apache.cocoon.components.pipeline.impl.CachingProcessingPipeline,
| AbstractCachingProcessingPipeline | | abstract public class AbstractCachingProcessingPipeline extends BaseCachingProcessingPipeline (Code) | | This is the base class for all caching pipeline implementations
that check different pipeline components.
since:
2.1
author:
Carsten Ziegeler
author:
Michael Melhem
version:
$Id: AbstractCachingProcessingPipeline.java 498470 2007-01-21 22:34:30Z anathaniel $ |
| Method Summary | |
| public void | addTransformer(String role, String source, Parameters param, Parameters hintParam)
Add a transformer. | | abstract protected void | cacheResults(Environment environment, OutputStream os)
| | abstract protected void | connectCachingPipeline(Environment environment)
| | protected void | connectPipeline(Environment environment)
Connect the pipeline. | | protected void | generateCachingKey(Environment environment)
The components of the pipeline are checked if they are Cacheable. | | protected boolean | generateLock(Object key)
| | public String | getKeyForEventPipeline()
| | public SourceValidity | getValidityForEventPipeline()
Return valid validity objects for the event pipeline. | | SourceValidity | getValidityForInternalPipeline(int index)
| | abstract protected ComponentCacheKey | newComponentCacheKey(int type, String role, Serializable key)
| | public void | parameterize(Parameters params)
| | protected boolean | processReader(Environment environment)
Process the pipeline using a reader. | | protected boolean | processXMLPipeline(Environment environment)
Process the given Environment, producing the output. | | public void | recycle()
| | protected boolean | releaseLock(Object key)
| | public void | setGenerator(String role, String source, Parameters param, Parameters hintParam)
Set the generator. | | public void | setReader(String role, String source, Parameters param, String mimeType)
Set the Reader. | | public void | setSerializer(String role, String source, Parameters param, Parameters hintParam, String mimeType)
Set the serializer. | | boolean | setupFromCacheKey()
| | protected void | setupPipeline(Environment environment)
Setup the evenet pipeline. | | protected void | setupValidities()
| | protected void | validatePipeline(Environment environment)
Calculate the key that can be used to get something from the cache, and
handle expires properly. | | protected boolean | waitForLock(Object key)
|
| PIPELOCK_PREFIX | | final public static String PIPELOCK_PREFIX(Code) | | |
| cacheCompleteResponse | | protected boolean cacheCompleteResponse(Code) | | Cache complete response
|
| completeResponseIsCached | | protected boolean completeResponseIsCached(Code) | | Complete response is cached
|
| firstNotCacheableTransformerIndex | | protected int firstNotCacheableTransformerIndex(Code) | | The index indicating to the first transformer which is not cacheable
|
| firstProcessedTransformerIndex | | protected int firstProcessedTransformerIndex(Code) | | The index indicating the first transformer getting input from the cache
|
| fromCacheKey | | protected PipelineCacheKey fromCacheKey(Code) | | This key indicates the response that is fetched from the cache
|
| generatorIsCacheableProcessingComponent | | protected boolean generatorIsCacheableProcessingComponent(Code) | | |
| generatorRole | | protected String generatorRole(Code) | | The role name of the generator
|
| readerRole | | protected String readerRole(Code) | | The role name of the reader
|
| serializerIsCacheableProcessingComponent | | protected boolean serializerIsCacheableProcessingComponent(Code) | | |
| serializerRole | | protected String serializerRole(Code) | | The role name of the serializer
|
| toCacheKey | | protected PipelineCacheKey toCacheKey(Code) | | This key indicates the response that will get into the cache
|
| toCacheSourceValidities | | protected SourceValidity[] toCacheSourceValidities(Code) | | The source validities used for caching
|
| transformerIsCacheableProcessingComponent | | protected boolean[] transformerIsCacheableProcessingComponent(Code) | | |
| transformerRoles | | protected ArrayList transformerRoles(Code) | | The role names of the transfomrers
|
| transientStore | | protected Store transientStore(Code) | | |
| generateLock | | protected boolean generateLock(Object key)(Code) | | makes the lock (instantiates a new object and puts it into the store)
|
| getKeyForEventPipeline | | public String getKeyForEventPipeline()(Code) | | |
| getValidityForEventPipeline | | public SourceValidity getValidityForEventPipeline()(Code) | | Return valid validity objects for the event pipeline.
If the event pipeline (the complete pipeline without the
serializer) is cacheable and valid, return all validity objects.
Otherwise, return null.
|
| getValidityForInternalPipeline | | SourceValidity getValidityForInternalPipeline(int index)(Code) | | |
| parameterize | | public void parameterize(Parameters params) throws ParameterException(Code) | | Parameterizable Interface - Configuration
|
| recycle | | public void recycle()(Code) | | Recyclable Interface
|
| releaseLock | | protected boolean releaseLock(Object key)(Code) | | releases the lock (notifies it and removes it from the store)
|
| setupFromCacheKey | | boolean setupFromCacheKey()(Code) | | |
| setupPipeline | | protected void setupPipeline(Environment environment) throws ProcessingException(Code) | | Setup the evenet pipeline.
The components of the pipeline are checked if they are
Cacheable.
|
| setupValidities | | protected void setupValidities() throws ProcessingException(Code) | | Generate validity objects for the new response
|
| validatePipeline | | protected void validatePipeline(Environment environment) throws ProcessingException(Code) | | Calculate the key that can be used to get something from the cache, and
handle expires properly.
|
| Methods inherited from org.apache.cocoon.components.pipeline.impl.BaseCachingProcessingPipeline | public void dispose()(Code)(Java Doc)
public void parameterize(Parameters params) throws ParameterException(Code)(Java Doc)
public void recycle()(Code)(Java Doc)
|
|
|