|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.cocoon.pipeline.AbstractPipeline<T>
org.apache.cocoon.pipeline.CachingPipeline<T>
public class CachingPipeline<T extends PipelineComponent>
A Pipeline implementation that returns a cached result if, and only
if all its components support caching. A PipelineComponent is
cacheable if it implements the interface CachingPipelineComponent.
| Field Summary | |
|---|---|
protected Cache |
cache
|
protected CacheKey |
cacheKey
|
protected CachingOutputStream |
cachingOutputStream
|
| Constructor Summary | |
|---|---|
CachingPipeline()
|
|
| Method Summary | |
|---|---|
CacheKey |
constructCacheKey()
|
void |
execute()
After the pipeline has been setup ( Pipeline.setup(OutputStream, Map),
this method can be invoked in order to produce the result. |
protected CacheValue |
getCachedValue(CacheKey cacheKey)
|
CacheKey |
getCacheKey()
|
String |
getExpires()
|
long |
getLastModified()
Get the time of the last modification. |
protected boolean |
isCacheKeyValid(CacheValue cachedValue)
|
void |
setCache(Cache cache)
|
protected void |
setCachedValue(CacheKey cacheKey,
CacheValue cacheValue)
|
void |
setConfiguration(Map<String,? extends Object> parameters)
Pass pipeline specific configuration parameters to the pipeline component in a generic way. |
void |
setExpires(String expires)
|
void |
setExpiresCacheKey(Serializable expiresCacheKey)
|
void |
setup(OutputStream outputStream,
Map<String,Object> parameters)
The same as Pipeline.setup(OutputStream) but also allows passing
parameters to the pipeline components. |
| Methods inherited from class org.apache.cocoon.pipeline.AbstractPipeline |
|---|
addComponent, getComponents, getContentType, getFinisher, invokeStarter, setup, setupComponents, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected Cache cache
protected CacheKey cacheKey
protected CachingOutputStream cachingOutputStream
| Constructor Detail |
|---|
public CachingPipeline()
| Method Detail |
|---|
public CacheKey constructCacheKey()
public void execute()
throws Exception
AbstractPipelinePipeline.setup(OutputStream, Map),
this method can be invoked in order to produce the result.
execute in interface Pipeline<T extends PipelineComponent>execute in class AbstractPipeline<T extends PipelineComponent>Exception - Any problem that might occur while processing the
pipeline.Pipeline.execute()public CacheKey getCacheKey()
public String getExpires()
public long getLastModified()
Pipeline
getLastModified in interface Pipeline<T extends PipelineComponent>getLastModified in class AbstractPipeline<T extends PipelineComponent>public void setCache(Cache cache)
public void setConfiguration(Map<String,? extends Object> parameters)
setConfiguration in interface Pipeline<T extends PipelineComponent>setConfiguration in class AbstractPipeline<T extends PipelineComponent>AbstractPipeline.setConfiguration(java.util.Map)public void setExpires(String expires)
public void setExpiresCacheKey(Serializable expiresCacheKey)
public void setup(OutputStream outputStream,
Map<String,Object> parameters)
AbstractPipelinePipeline.setup(OutputStream) but also allows passing
parameters to the pipeline components.
setup in interface Pipeline<T extends PipelineComponent>setup in class AbstractPipeline<T extends PipelineComponent>outputStream - An OutputStream where the pipeline execution
result is written.parameters - A Map of parameters that are available to all
PipelineComponents.Pipeline.setup(java.io.OutputStream,
java.util.Map)protected CacheValue getCachedValue(CacheKey cacheKey)
protected boolean isCacheKeyValid(CacheValue cachedValue)
protected void setCachedValue(CacheKey cacheKey,
CacheValue cacheValue)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||