Package org.ametys.cms.content
Class FileReader
- java.lang.Object
-
- org.apache.avalon.framework.logger.AbstractLogEnabled
-
- org.apache.cocoon.reading.AbstractReader
-
- org.ametys.core.util.cocoon.AbstractResourceReader
-
- org.ametys.cms.content.FileReader
-
- All Implemented Interfaces:
Poolable
,Recyclable
,Component
,LogEnabled
,Serviceable
,CacheableProcessingComponent
,Reader
,SitemapModelComponent
,SitemapOutputComponent
public class FileReader extends AbstractResourceReader implements Serviceable, CacheableProcessingComponent
Reader for binary or file metadata.
-
-
Field Summary
Fields Modifier and Type Field Description private MetadataAwareAmetysObject
_ametysObject
private BinaryMetadata
_binary
private String
_path
protected AmetysObjectResolver
_resolver
The ametys object resolver.-
Fields inherited from class org.ametys.core.util.cocoon.AbstractResourceReader
__ALLOWED_FORMATS, __DEFAULT_FORMAT
-
Fields inherited from class org.apache.cocoon.reading.AbstractReader
objectModel, out, parameters, resolver, source
-
-
Constructor Summary
Constructors Constructor Description FileReader()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
doSetup(SourceResolver res, Map objModel, String src, Parameters par)
protected MetadataAwareAmetysObject
getAmetysObject()
Get the ametys object.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 ofAbstractResourceReader.getFilename()
is used instead.protected String
getFilename()
Returns the resource's name.protected InputStream
getInputStream()
Returns the resource'sInputStream
.Serializable
getKey()
long
getLastModified()
protected long
getLength()
Returns the resource's length.String
getMimeType()
SourceValidity
getValidity()
void
recycle()
void
service(ServiceManager serviceManager)
-
Methods inherited from class org.ametys.core.util.cocoon.AbstractResourceReader
generate, generateThumbnail, 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
-
-
-
-
Field Detail
-
_resolver
protected AmetysObjectResolver _resolver
The ametys object resolver.
-
_ametysObject
private MetadataAwareAmetysObject _ametysObject
-
_binary
private BinaryMetadata _binary
-
-
Constructor Detail
-
FileReader
public FileReader()
-
-
Method Detail
-
service
public void service(ServiceManager serviceManager) throws ServiceException
- Specified by:
service
in interfaceServiceable
- Throws:
ServiceException
-
doSetup
public void doSetup(SourceResolver res, Map objModel, String src, Parameters par) throws ProcessingException, IOException
Description copied from class:AbstractResourceReader
Called byAbstractResourceReader.setup(SourceResolver, Map, String, Parameters)
. This method should be implemented by subclasses to retrieve the actual resource.- Specified by:
doSetup
in classAbstractResourceReader
- Parameters:
res
- theSourceResolver
.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.
-
getAmetysObject
protected MetadataAwareAmetysObject getAmetysObject() throws ProcessingException
Get the ametys object.- Returns:
- the ametys object.
- Throws:
ProcessingException
- if the information provided was insufficient to resolve an object.
-
getInputStream
protected InputStream getInputStream()
Description copied from class:AbstractResourceReader
Returns the resource'sInputStream
.- Specified by:
getInputStream
in classAbstractResourceReader
- Returns:
- the resource's
InputStream
.
-
getFilename
protected String getFilename()
Description copied from class:AbstractResourceReader
Returns the resource's name.- Specified by:
getFilename
in classAbstractResourceReader
- 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 ofAbstractResourceReader.getFilename()
is used instead.- Specified by:
getEncodedFilename
in classAbstractResourceReader
- 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 classAbstractResourceReader
- Returns:
- the resource's length.
-
getKey
public Serializable getKey()
- Specified by:
getKey
in interfaceCacheableProcessingComponent
-
getValidity
public SourceValidity getValidity()
- Specified by:
getValidity
in interfaceCacheableProcessingComponent
-
getLastModified
public long getLastModified()
- Specified by:
getLastModified
in interfaceReader
- Overrides:
getLastModified
in classAbstractReader
-
getMimeType
public String getMimeType()
- Specified by:
getMimeType
in interfaceSitemapOutputComponent
- Overrides:
getMimeType
in classAbstractReader
-
recycle
public void recycle()
- Specified by:
recycle
in interfaceRecyclable
- Overrides:
recycle
in classAbstractReader
-
-