Package org.ametys.plugins.flipbook

Class Attribute2FlipbookUriResolver

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.transformation.AbstractURIResolver

org.ametys.cms.transformation.AttributeURIResolver

org.ametys.web.editor.AttributeURIResolver

org.ametys.plugins.flipbook.Attribute2FlipbookUriResolver

All Implemented Interfaces:

URIResolver, PluginAware, Contextualizable, LogEnabled, Serviceable

public class Attribute2FlipbookUriResolver
extends AttributeURIResolver
implements PluginAware

URIResolver for type "attribute-flipbook".
These links point to a document file from the resource explorer converted to flash.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	Attribute2FlipbookUriResolver.CacheThread

Nested classes/interfaces inherited from class org.ametys.cms.transformation.AttributeURIResolver

AttributeURIResolver.AttributeInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected Logger	_logger	The logger .
protected ConvertMetadata2ImagesComponent	_metadataComponent	Metadata to images convertor.
protected String	_pluginName	The plugin name.

Fields inherited from class org.ametys.web.editor.AttributeURIResolver

_prefixHandler

Fields inherited from class org.ametys.cms.transformation.AttributeURIResolver

_context, _resolver

Constructor Summary

Constructors

Constructor	Description
Attribute2FlipbookUriResolver()

Method Summary

Modifier and Type	Method	Description
private String	_resolveImage(String uri, String uriArgument, boolean absolute)
void	enableLogging(Logger logger)
String	getType()	Returns the type of links handled by this URIResolver.
String	resolve(String uri, boolean download, boolean absolute, boolean internal)	Resolves a link URI for rendering purposes. The output must be a properly encoded path, relative to the webapp context, accessible from a browser.
String	resolveBoundedImage(String uri, int maxHeight, int maxWidth, boolean download, boolean absolute, boolean internal)	Resolves a link URI for rendering image. The output must be a properly encoded path, relative to the webapp context, accessible from a browser.
String	resolveBoundedImageAsBase64(String uri, int maxHeight, int maxWidth)	Resolve an image and return it as a base64-encoded string.
String	resolveCroppedImage(String uri, int cropHeight, int cropWidth, boolean download, boolean absolute, boolean internal)	Resolves a link URI for rendering image. The output must be a properly encoded path, relative to the webapp context, accessible from a browser.
String	resolveCroppedImageAsBase64(String uri, int cropHeight, int cropWidth)	Resolve an image and return it as a base64-encoded string.
String	resolveImage(String uri, int height, int width, boolean download, boolean absolute, boolean internal)	Resolves a link URI for rendering image. The output must be a properly encoded path, relative to the webapp context, accessible from a browser.
String	resolveImageAsBase64(String uri, int height, int width)	Resolve an image and return it as a base64-encoded string.
void	service(ServiceManager serviceManager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class org.ametys.web.editor.AttributeURIResolver

getUri

Methods inherited from class org.ametys.cms.transformation.AttributeURIResolver

_getAttributeInfo, _resolve, checkLink, contextualize, getLabel, resolveImageAsBase64

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

_pluginName

protected String _pluginName

The plugin name.

_logger

protected Logger _logger

The logger .

_metadataComponent

protected ConvertMetadata2ImagesComponent _metadataComponent

Metadata to images convertor.

Constructor Detail

Attribute2FlipbookUriResolver

public Attribute2FlipbookUriResolver()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AttributeURIResolver

Throws:

ServiceException

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

enableLogging

public void enableLogging(Logger logger)

Specified by:

enableLogging in interface LogEnabled

Overrides:

enableLogging in class AbstractLogEnabled

getType

public String getType()

Description copied from interface: URIResolver

Returns the type of links handled by this URIResolver.

Specified by:

getType in interface URIResolver

Overrides:

getType in class AttributeURIResolver

Returns:

the type of links handled by this URIResolver.

resolve

public String resolve(String uri,
                      boolean download,
                      boolean absolute,
                      boolean internal)

Description copied from interface: URIResolver

Resolves a link URI for rendering purposes.
The output must be a properly encoded path, relative to the webapp context, accessible from a browser.

Specified by:

resolve in interface URIResolver

Overrides:

resolve in class AbstractURIResolver

Parameters:

uri - the link URI.

download - true if the pointed resource is to be downloaded.

absolute - true if the url must be absolute

internal - true to get an internal URI.

Returns:

the path to the resource.

_resolveImage

private String _resolveImage(String uri,
                             String uriArgument,
                             boolean absolute)

resolveImage

public String resolveImage(String uri,
                           int height,
                           int width,
                           boolean download,
                           boolean absolute,
                           boolean internal)

Description copied from interface: URIResolver

Resolves a link URI for rendering image.
The output must be a properly encoded path, relative to the webapp context, accessible from a browser.

Specified by:

resolveImage in interface URIResolver

Overrides:

resolveImage in class AbstractURIResolver

Parameters:

uri - the link URI.

height - the height of the image.

width - the width of the image

download - true if the pointed resource is to be downloaded.

absolute - true if the url must be absolute

internal - true to get an internal URI.

Returns:

the path to the image.

resolveBoundedImage

public String resolveBoundedImage(String uri,
                                  int maxHeight,
                                  int maxWidth,
                                  boolean download,
                                  boolean absolute,
                                  boolean internal)

Description copied from interface: URIResolver

Resolves a link URI for rendering image.
The output must be a properly encoded path, relative to the webapp context, accessible from a browser.

Specified by:

resolveBoundedImage in interface URIResolver

Overrides:

resolveBoundedImage in class AbstractURIResolver

Parameters:

uri - the link URI.

maxHeight - the max height

maxWidth - the max width

download - true if the pointed resource is to be downloaded.

absolute - true if the url must be absolute

internal - true to get an internal URI.

Returns:

the path to the image.

resolveCroppedImage

public String resolveCroppedImage(String uri,
                                  int cropHeight,
                                  int cropWidth,
                                  boolean download,
                                  boolean absolute,
                                  boolean internal)

Description copied from interface: URIResolver

Resolves a link URI for rendering image.
The output must be a properly encoded path, relative to the webapp context, accessible from a browser.

Specified by:

resolveCroppedImage in interface URIResolver

Overrides:

resolveCroppedImage in class AbstractURIResolver

Parameters:

uri - the link URI.

cropHeight - the crop height

cropWidth - the crop width

download - true if the pointed resource is to be downloaded.

absolute - true if the url must be absolute

internal - true to get an internal URI.

Returns:

the path to the image.

resolveImageAsBase64

public String resolveImageAsBase64(String uri,
                                   int height,
                                   int width)

Description copied from interface: URIResolver

Resolve an image and return it as a base64-encoded string.

Specified by:

resolveImageAsBase64 in interface URIResolver

Overrides:

resolveImageAsBase64 in class AbstractURIResolver

Parameters:

uri - the link URI.

height - the height of the image.

width - the width of the image

Returns:

a base64-encoded string representing the image.

resolveBoundedImageAsBase64

public String resolveBoundedImageAsBase64(String uri,
                                          int maxHeight,
                                          int maxWidth)

Description copied from interface: URIResolver

Resolve an image and return it as a base64-encoded string.

Specified by:

resolveBoundedImageAsBase64 in interface URIResolver

Overrides:

resolveBoundedImageAsBase64 in class AbstractURIResolver

Parameters:

uri - the link URI.

maxHeight - the max height

maxWidth - the max width

Returns:

a base64-encoded string representing the image.

resolveCroppedImageAsBase64

public String resolveCroppedImageAsBase64(String uri,
                                          int cropHeight,
                                          int cropWidth)

Description copied from interface: URIResolver

Resolve an image and return it as a base64-encoded string.

Specified by:

resolveCroppedImageAsBase64 in interface URIResolver

Overrides:

resolveCroppedImageAsBase64 in class AbstractURIResolver

Parameters:

uri - the link URI.

cropHeight - the crop height

cropWidth - the crop width

Returns:

a base64-encoded string representing the image.