org.apache.cocoon.components.source.impl
Class InspectableTraversableCachingSource

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.components.source.impl.CachingSource
          org.apache.cocoon.components.source.impl.TraversableCachingSource
              org.apache.cocoon.components.source.impl.InspectableTraversableCachingSource

All Implemented Interfaces:

Initializable, LogEnabled, Serviceable, InspectableSource, Source, TraversableSource, XMLizable

public class InspectableTraversableCachingSource
extends TraversableCachingSource
implements InspectableSource

TraversableCachingSource that adds support for SourceProperty caching.

Nested Class Summary

protected static class

InspectableTraversableCachingSource.InspectableSourceMeta

Nested classes/interfaces inherited from class org.apache.cocoon.components.source.impl.TraversableCachingSource

TraversableCachingSource.TraversableSourceMeta

Nested classes/interfaces inherited from class org.apache.cocoon.components.source.impl.CachingSource

CachingSource.SourceMeta

Field Summary

Fields inherited from class org.apache.cocoon.components.source.impl.CachingSource

async, cache, CACHE_EXPIRES_PARAM, CACHE_NAME_PARAM, cacheKey, cacheName, eventAware, expires, manager, protocol, source, sourceUri, uri

Constructor Summary

InspectableTraversableCachingSource(CachingSourceFactory factory, String protocol, String uri, String sourceUri, InspectableSource source, int expires, String cacheName, boolean async, boolean eventAware)

Method Summary

SourceProperty[]	getSourceProperties() Get alll informations
SourceProperty	getSourceProperty(String namespace, String name) To get a meta information from a source
protected CachingSource.SourceMeta	readMeta(Source source) Read meta data from source.
void	removeSourceProperty(String namespace, String name) Remove property
void	setSourceProperty(SourceProperty property) To set a meta information

Methods inherited from class org.apache.cocoon.components.source.impl.TraversableCachingSource

createSource, getChild, getChildren, getName, getParent, isCollection

Methods inherited from class org.apache.cocoon.components.source.impl.CachingSource

dispose, exists, getBinaryResponse, getCacheKey, getCacheValidities, getContentLength, getExpiration, getInputStream, getLastModified, getMimeType, getResponseMeta, getScheme, getSourceURI, getURI, getValidity, getXMLResponse, initialize, readBinaryResponse, readXMLResponse, refresh, service, toSAX

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

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.excalibur.source.Source

exists, getContentLength, getInputStream, getLastModified, getMimeType, getScheme, getURI, getValidity, refresh

Constructor Detail

InspectableTraversableCachingSource

public InspectableTraversableCachingSource(CachingSourceFactory factory,
                                           String protocol,
                                           String uri,
                                           String sourceUri,
                                           InspectableSource source,
                                           int expires,
                                           String cacheName,
                                           boolean async,
                                           boolean eventAware)

Method Detail

getSourceProperty

public SourceProperty getSourceProperty(String namespace,
                                        String name)
                                 throws SourceException

Description copied from interface: InspectableSource

To get a meta information from a source

Specified by:

getSourceProperty in interface InspectableSource

Throws:

SourceException

setSourceProperty

public void setSourceProperty(SourceProperty property)
                       throws SourceException

Description copied from interface: InspectableSource

To set a meta information

Specified by:

setSourceProperty in interface InspectableSource

Throws:

SourceException

getSourceProperties

public SourceProperty[] getSourceProperties()
                                     throws SourceException

Description copied from interface: InspectableSource

Get alll informations

Specified by:

getSourceProperties in interface InspectableSource

Throws:

SourceException

removeSourceProperty

public void removeSourceProperty(String namespace,
                                 String name)
                          throws SourceException

Description copied from interface: InspectableSource

Remove property

Specified by:

removeSourceProperty in interface InspectableSource

Throws:

SourceException

readMeta

protected CachingSource.SourceMeta readMeta(Source source)
                                     throws SourceException

Description copied from class: CachingSource

Read meta data from source.

Overrides:

readMeta in class TraversableCachingSource

Throws:

SourceException