Package org.ametys.plugins.explorer.resources.readers

Class AmetysResourceReader

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.reading.AbstractReader

org.ametys.core.util.cocoon.AbstractResourceReader

org.ametys.plugins.explorer.resources.readers.AmetysResourceReader

All Implemented Interfaces:

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

public class AmetysResourceReader
extends AbstractResourceReader
implements Serviceable, CacheableProcessingComponent

Reader for Resource

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected Resource	_object	The resource
protected AmetysObjectResolver	_resolver	The Ametys object resolver
protected RightManager	_rightManager	The right manager

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

__ALLOWED_OUTPUT_FORMATS, __DEFAULT_FORMAT, __UNRESIZABLE_FORMATS

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
AmetysResourceReader()

Method Summary

Modifier and Type	Method	Description
protected void	checkUserAccess()	Check the user access
protected 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()
void	service(ServiceManager sManager)

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

Methods inherited from class java.lang.Object

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

Field Details

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_object

protected Resource _object

The resource

_rightManager

protected RightManager _rightManager

The right manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

Constructor Details

AmetysResourceReader

public AmetysResourceReader()

Method Details

service

public void service(ServiceManager sManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

doSetup

protected 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.

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.

checkUserAccess

protected void checkUserAccess()
                        throws AuthorizationRequiredException,
AccessDeniedException

Check the user access

Throws:

AuthorizationRequiredException - if authorization is required

AccessDeniedException - if user has no access

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

recycle

public void recycle()

Specified by:

recycle in interface Recyclable

Overrides:

recycle in class AbstractReader