org.ametys.cms.transformation

Class AttachmentURIResolver

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.transformation.AttachmentURIResolver

All Implemented Interfaces:

URIResolver, Contextualizable, LogEnabled, Serviceable

Direct Known Subclasses:

AttachmentURIResolver

public class AttachmentURIResolver
extends AbstractLogEnabled
implements URIResolver, Serviceable, Contextualizable

URIResolver for type "attachment".
These links point to a file from the attachments of the current Content.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Pattern	__PLUGIN_CONTENT_PATTERN Regular expression for contents stored under plugins
protected Context	_context The avalon context
protected URIPrefixHandler	_prefixHandler The URI prefix handler
protected AmetysObjectResolver	_resolver The ametys resolver

Constructor Summary

Constructors

Constructor and Description
AttachmentURIResolver()

Method Summary

Modifier and Type	Method and Description
protected String	_resolveImage(String uri, String uriArgument, 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.
ConsistencyChecker.CHECK	checkLink(String uri, boolean shortTest) Tests if the URI is not broken.
void	contextualize(Context context)
I18nizableText	getLabel(String uri) Get an URI label.
String	getType() Returns the type of links handled by this URIResolver.
protected String	getUriPrefix(AmetysObject object, boolean download, boolean internal, boolean absolute) Get the URI prefix
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.
protected String	resolveImageAsBase64(String uri, int height, int width, int maxHeight, int maxWidth, int cropHeight, int cropWidth) Get an image's bytes encoded as base64, optionally resized.
void	service(ServiceManager manager)

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

__PLUGIN_CONTENT_PATTERN

protected static final Pattern __PLUGIN_CONTENT_PATTERN

Regular expression for contents stored under plugins

_resolver

protected AmetysObjectResolver _resolver

The ametys resolver

_context

protected Context _context

The avalon context

_prefixHandler

protected URIPrefixHandler _prefixHandler

The URI prefix handler

Constructor Detail

AttachmentURIResolver

public AttachmentURIResolver()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getType

public String getType()

Description copied from interface: URIResolver

Returns the type of links handled by this URIResolver.

Specified by:

getType in interface URIResolver

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

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.

getUriPrefix

protected String getUriPrefix(AmetysObject object,
                              boolean download,
                              boolean internal,
                              boolean absolute)

Get the URI prefix

Parameters:

object - The object

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 URI prefix

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

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.

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

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.

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

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.

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

Parameters:

uri - the link URI.

maxHeight - the max height

maxWidth - the max width

Returns:

a base64-encoded string representing 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

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.

_resolveImage

protected String _resolveImage(String uri,
                               String uriArgument,
                               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.

Parameters:

uri - the link URI.

uriArgument - the argument to append to the 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 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

Parameters:

uri - the link URI.

cropHeight - the crop height

cropWidth - the crop width

Returns:

a base64-encoded string representing the image.

resolveImageAsBase64

protected String resolveImageAsBase64(String uri,
                                      int height,
                                      int width,
                                      int maxHeight,
                                      int maxWidth,
                                      int cropHeight,
                                      int cropWidth)

Get an image's bytes encoded as base64, optionally resized.

Parameters:

uri - the image URI.

height - the specified height. Ignored if negative.

width - the specified width. Ignored if negative.

maxHeight - the maximum image height. Ignored if height or width is specified.

maxWidth - the maximum image width. Ignored if height or width is specified.

cropHeight - The cropping height. Ignored if negative.

cropWidth - The cropping width. Ignored if negative.

Returns:

the image bytes encoded as base64.

checkLink

public ConsistencyChecker.CHECK checkLink(String uri,
                                          boolean shortTest)

Description copied from interface: URIResolver

Tests if the URI is not broken.

Specified by:

checkLink in interface URIResolver

Parameters:

uri - The uri to test

shortTest - If shortTest is to true, only fast check should be done. If false, complete test (even if long) should be done.

Returns:

SUCCESS if the test was done and ok, FAILURE if the test was done and ko, UNKNOWN if the test was not done (because too long). UNKNOWN can not be returned when shortTest is set to false

getLabel

public I18nizableText getLabel(String uri)

Description copied from interface: URIResolver

Get an URI label.

Specified by:

getLabel in interface URIResolver

Parameters:

uri - the uri which label to get.

Returns:

the label.