Package org.ametys.core.resources

Class ImageResourceHandler

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.resources.SimpleResourceHandler

org.ametys.core.resources.ImageResourceHandler

All Implemented Interfaces:

ResourceHandler, LogEnabled, Serviceable

Direct Known Subclasses:

PdfCoverResourceHandler, WebImageResourceHandler

public class ImageResourceHandler
extends SimpleResourceHandler

Resource handler for images

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Pattern	SAFE_SVG_PATTERN	url for safe svg files

Fields inherited from class org.ametys.core.resources.SimpleResourceHandler

_objectModel, _parameters, _readForDownload, _requestedLocation, _resolver, _source

Constructor Summary

Constructors

Constructor	Description
ImageResourceHandler()	Default constructor
ImageResourceHandler(org.ametys.core.resources.ImageResourceHandler.SizedSource sizedSource)	If the Source is already resolved by the ResourceHandlerProvider, it may provide it through the constructor to avoid resolving it again.

Method Summary

Modifier and Type	Method	Description
void	generate(OutputStream out)	Generate the resource configured during setup, and output it
Serializable	getKey()	Get the unique key for this resource, for cache purpose.
protected boolean	isUnsafeSVG(String sourceURI)	Is the SVG file denoted by the uri potentially unsafe?
Source	setup(String location, Map objectModel, Parameters par, boolean readForDownload)	Initialize the resource handler with a resource.

Methods inherited from class org.ametys.core.resources.SimpleResourceHandler

getLastModified, getMimeType, getValidity, service

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.core.resources.ResourceHandler

acceptRanges, generate, getLength, shouldUseSourceContentLength

Field Details

SAFE_SVG_PATTERN

protected static final Pattern SAFE_SVG_PATTERN

url for safe svg files

Constructor Details

ImageResourceHandler

public ImageResourceHandler()

Default constructor

ImageResourceHandler

public ImageResourceHandler(org.ametys.core.resources.ImageResourceHandler.SizedSource sizedSource)

If the Source is already resolved by the ResourceHandlerProvider, it may provide it through the constructor to avoid resolving it again.

Parameters:

sizedSource - the source.

Method Details

setup

public Source setup(String location,
 Map objectModel,
 Parameters par,
 boolean readForDownload)
             throws IOException,
ProcessingException

Description copied from interface: ResourceHandler

Initialize the resource handler with a resource.

Specified by:

setup in interface ResourceHandler

Overrides:

setup in class SimpleResourceHandler

Parameters:

location - The source uri

objectModel - The object model

par - The parameters

readForDownload - if the resource is to be downloaded and not rendered.

Returns:

the resolved source

Throws:

IOException - If an error occurs

ProcessingException - If an error occurs

isUnsafeSVG

protected boolean isUnsafeSVG(String sourceURI)

Is the SVG file denoted by the uri potentially unsafe?

Parameters:

sourceURI - The svg file uri

Returns:

true if the svg is not from a trusted source

generate

public void generate(OutputStream out)
              throws IOException,
ProcessingException

Description copied from interface: ResourceHandler

Generate the resource configured during setup, and output it

Specified by:

generate in interface ResourceHandler

Overrides:

generate in class SimpleResourceHandler

Parameters:

out - The output stream to write to

Throws:

IOException - If an error occurs

ProcessingException - If an error occurs

getKey

public Serializable getKey()

Description copied from interface: ResourceHandler

Get the unique key for this resource, for cache purpose.

Specified by:

getKey in interface ResourceHandler

Overrides:

getKey in class SimpleResourceHandler

Returns:

The cache key.