org.apache.cocoon.transformation.helpers
Class IncludeCacheManagerSession

java.lang.Object
  org.apache.cocoon.transformation.helpers.IncludeCacheManagerSession

public final class IncludeCacheManagerSession

extends Object

This object encapsulates a "caching session". A caching session has the duration of one single request. This object is used by the IncludeCacheManager and holds all required configuration for performing the caching of this request. The session can be configured during construction with the following parameters: - purge (boolean/false) : Turn on/off purging the cache - preemptive (boolean/false) : Turn on/off preemptive caching - parallel (boolean/false) : Turn on/off parallel processing - expires (long/0) : The lifetime of the cached content

Since:

2.1

Version:

$Id: IncludeCacheManagerSession.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Method Summary

long	getExpires() Get the expiration information
SourceValidity	getExpiresValidity()
boolean	isParallel() Do we process the includes in parallel?
boolean	isPreemptive() Do we use preemptive caching?
boolean	isPurging() Is the cache purged?
Source	resolveURI(String uri, SourceResolver resolver) Lookup a source object and cache it
String	toString() Print a representation of this object

Methods inherited from class java.lang.Object

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

Method Detail

getExpires

public long getExpires()

Get the expiration information

getExpiresValidity

public SourceValidity getExpiresValidity()

isPurging

public boolean isPurging()

Is the cache purged?

isPreemptive

public boolean isPreemptive()

Do we use preemptive caching?

isParallel

public boolean isParallel()

Do we process the includes in parallel?

resolveURI

public Source resolveURI(String uri,
                         SourceResolver resolver)
                  throws IOException

Lookup a source object and cache it

Parameters:

uri - Absolute URI

Returns:

Source The source obejct

Throws:

IOException

toString

public String toString()

Print a representation of this object