Package org.ametys.plugins.core.upload

Class UploadReader

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.reading.AbstractReader

org.ametys.core.util.cocoon.AbstractResourceReader

org.ametys.plugins.core.upload.UploadReader

All Implemented Interfaces:

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

public class UploadReader
extends AbstractResourceReader
implements Serviceable

Reader for generating binary output of previously uploaded file.

Field Summary

Fields

Modifier and Type	Field	Description
private CurrentUserProvider	_currentUserProvider
private Upload	_upload
private UploadManager	_uploadManager

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

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

ROLE

Constructor Summary

Constructors

Constructor	Description
UploadReader()

Method Summary

Modifier and Type	Method	Description
protected void	doSetup(SourceResolver res, Map objModel, String src, Parameters par)	Called by AbstractResourceReader.setup(SourceResolver, Map, String, Parameters).
void	generate()
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.
long	getLastModified()
protected long	getLength()	Returns the resource's length.
String	getMimeType()
void	recycle()
void	service(ServiceManager serviceManager)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

_currentUserProvider

private CurrentUserProvider _currentUserProvider

_uploadManager

private UploadManager _uploadManager

_upload

private Upload _upload

Constructor Detail

UploadReader

public UploadReader()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

doSetup

protected void doSetup(SourceResolver res,
                       Map objModel,
                       String src,
                       Parameters par)

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.

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.

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

generate

public void generate()
              throws IOException,
                     SAXException,
                     ProcessingException

Specified by:

generate in interface Reader

Overrides:

generate in class AbstractResourceReader

Throws:

IOException

SAXException

ProcessingException

recycle

public void recycle()

Specified by:

recycle in interface Recyclable

Overrides:

recycle in class AbstractReader