Package org.ametys.plugins.flipbook

Class ConvertResource2ImagesComponent

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.flipbook.AbstractConvertDocument2ImagesComponent

org.ametys.plugins.flipbook.ConvertResource2ImagesComponent

All Implemented Interfaces:

Initializable, Component, LogEnabled, Serviceable, ThreadSafe

public class ConvertResource2ImagesComponent
extends AbstractConvertDocument2ImagesComponent

Implementation of a AbstractConvertDocument2ImagesComponent for a Resource

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	Avalon ROLE.

Fields inherited from class org.ametys.plugins.flipbook.AbstractConvertDocument2ImagesComponent

_cocoonContext, _documentToImages, _resolver

Constructor Summary

Constructors

Constructor	Description
ConvertResource2ImagesComponent()

Method Summary

Modifier and Type	Method	Description
String	doCache(Resource resource, String siteName)	Put the file in cache
void	doCleanCache(String path, String resourcePath)	Remove a resource from the flipbook cache.

Methods inherited from class org.ametys.plugins.flipbook.AbstractConvertDocument2ImagesComponent

cache, cleanCache, createImages, getCacheFile, initialize, isMimeTypeSupported, service

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

ROLE

public static final String ROLE

Avalon ROLE.

Constructor Details

ConvertResource2ImagesComponent

public ConvertResource2ImagesComponent()

Method Details

doCache

public String doCache(Resource resource,
 String siteName)
               throws Exception

Put the file in cache

Parameters:

resource - the resource to cache

siteName - the name of the site

Returns:

The absolute cache path

Throws:

Exception - if an error occurs while caching the file

doCleanCache

public void doCleanCache(String path,
 String resourcePath)

Remove a resource from the flipbook cache. This method will first try to determine if the provided path either point to shared resource or a site resource. If it's neither, the method won't do anything as this component only handle resource

Parameters:

path - the JCR path of the resource

resourcePath - the resource path (as return by Resource:getResourcePath)