Package org.ametys.cms.transformation

Class AttachmentURIResolver

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.transformation.AbstractURIResolver

org.ametys.cms.transformation.AttachmentURIResolver

All Implemented Interfaces:

URIResolver, Contextualizable, LogEnabled, Serviceable

Direct Known Subclasses:

AttachmentURIResolver

public class AttachmentURIResolver
extends AbstractURIResolver
implements 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	Description
protected static final 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	Description
AttachmentURIResolver()

Method Summary

Modifier and Type	Method	Description
String	_resolve(String uri, String uriArgument, boolean download, boolean absolute, boolean internal)	Resolves a link URI for rendering. 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	getMimeType(String uri)	Get the mime type for the targeted URI.
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
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.ametys.cms.transformation.AbstractURIResolver

resolve, resolveBoundedImage, resolveBoundedImageAsBase64, resolveCroppedImage, resolveCroppedImageAsBase64, resolveImage, resolveImageAsBase64

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

__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 Details

AttachmentURIResolver

public AttachmentURIResolver()

Method Details

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,
 String uriArgument,
 boolean download,
 boolean absolute,
 boolean internal)

Description copied from class: AbstractURIResolver

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

Specified by:

_resolve in class AbstractURIResolver

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.

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

resolveImageAsBase64

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

Description copied from class: AbstractURIResolver

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

Specified by:

resolveImageAsBase64 in class AbstractURIResolver

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.

getMimeType

public String getMimeType(String uri)

Description copied from interface: URIResolver

Get the mime type for the targeted URI.

Specified by:

getMimeType in interface URIResolver

Parameters:

uri - the link URI.

Returns:

the mime type, can be empty or null.