org.ametys.cms.content

Class ContentFileReader

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.reading.AbstractReader

org.ametys.core.util.cocoon.AbstractResourceReader

org.ametys.cms.content.ContentFileReader

All Implemented Interfaces:

Poolable, Recyclable, Component, LogEnabled, CacheableProcessingComponent, Reader, SitemapModelComponent, SitemapOutputComponent

public class ContentFileReader
extends AbstractResourceReader
implements CacheableProcessingComponent

Reader for binary or file metadata.

Field Summary

Fields

Modifier and Type	Field and Description
private Content	_content
private File	_file
private String	_path

Fields inherited from class org.apache.cocoon.reading.AbstractReader

objectModel, out, parameters, resolver, source

Fields inherited from interface org.apache.cocoon.reading.Reader

ROLE

Constructor Summary

Constructors

Constructor and Description
ContentFileReader()

Method Summary

Modifier and Type	Method and Description
protected RichText	_getMeta(CompositeMetadata meta, String metadataName) Get the rich text meta
void	doSetup(SourceResolver res, Map objModel, String src, Parameters par) Called by AbstractResourceReader.setup(SourceResolver, Map, String, Parameters).
protected String	getEncodedFilename() If needed, returns the resource's name, properly encoded for using in a "Content-Disposition" HTTP header. May be null, in which case the result of AbstractResourceReader.getFilename() is used instead.
protected String	getFilename() Returns the resource's name.
protected InputStream	getInputStream() Returns the resource's InputStream.
Serializable	getKey()
long	getLastModified()
protected long	getLength() Returns the resource's length.
String	getMimeType()
SourceValidity	getValidity()
void	recycle()

Methods inherited from class org.ametys.core.util.cocoon.AbstractResourceReader

generate, getKeySuffix, processImage, setup

Methods inherited from class org.apache.cocoon.reading.AbstractReader

setOutputStream, shouldSetContentLength

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

Field Detail

_content

private Content _content

_file

private File _file

_path

private String _path

Constructor Detail

ContentFileReader

public ContentFileReader()

Method Detail

doSetup

public void doSetup(SourceResolver res,
                    Map objModel,
                    String src,
                    Parameters par)
             throws ProcessingException,
                    IOException

Description copied from class: AbstractResourceReader

Called by AbstractResourceReader.setup(SourceResolver, Map, String, Parameters). This method should be implemented by subclasses to retrieve the actual resource.

Specified by:

doSetup in class AbstractResourceReader

Parameters:

res - the SourceResolver.

objModel - the Cocoon's object model.

src - the source, as given by the sitemap.

par - the parameters, as given by the sitemap.

Throws:

ProcessingException - if an error occurs while processing the resource.

IOException - if an error occurs while accessing the resource.

getKey

public Serializable getKey()

Specified by:

getKey in interface CacheableProcessingComponent

getValidity

public SourceValidity getValidity()

Specified by:

getValidity in interface CacheableProcessingComponent

getLastModified

public long getLastModified()

Specified by:

getLastModified in interface Reader

Overrides:

getLastModified in class AbstractReader

getMimeType

public String getMimeType()

Specified by:

getMimeType in interface SitemapOutputComponent

Overrides:

getMimeType in class AbstractReader

getInputStream

protected InputStream getInputStream()

Description copied from class: AbstractResourceReader

Returns the resource's InputStream.

Specified by:

getInputStream in class AbstractResourceReader

Returns:

the resource's InputStream.

getFilename

protected String getFilename()

Description copied from class: AbstractResourceReader

Returns the resource's name.

Specified by:

getFilename in class AbstractResourceReader

Returns:

the resource's name.

getEncodedFilename

protected String getEncodedFilename()

Description copied from class: AbstractResourceReader

If needed, returns the resource's name, properly encoded for using in a "Content-Disposition" HTTP header.
May be null, in which case the result of AbstractResourceReader.getFilename() is used instead.

Specified by:

getEncodedFilename in class AbstractResourceReader

Returns:

the encoded resource's name, if any.

getLength

protected long getLength()

Description copied from class: AbstractResourceReader

Returns the resource's length.

Specified by:

getLength in class AbstractResourceReader

Returns:

the resource's length.

_getMeta

protected RichText _getMeta(CompositeMetadata meta,
                            String metadataName)

Get the rich text meta

Parameters:

meta - The composite meta

metadataName - The metadata name (with /)

Returns:

The rich text meta

recycle

public void recycle()

Specified by:

recycle in interface Recyclable

Overrides:

recycle in class AbstractReader