Package org.ametys.core.resources

Class SimpleResourceHandler

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.resources.SimpleResourceHandler

All Implemented Interfaces:

ResourceHandler, LogEnabled, Serviceable

Direct Known Subclasses:

AbstractCompiledResourceHandler, AbstractSourceMapResourceHandler, DefaultResourceHandler, ExpiresResourceHandler, I18nTextResourceHandler, ImageResourceHandler, MinimizedCSSResourceHandler, SassSourceMapResourceHandler, UncompiledSassResourceHandler

public class SimpleResourceHandler
extends AbstractLogEnabled
implements ResourceHandler, Serviceable

Simple common ancestor for all ResourceHandler implementations, delegating all methods to the underlying Source.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map	_objectModel	The object model
protected Parameters	_parameters	The sitemap parameters
protected boolean	_readForDownload	if the resource has been request for download
protected String	_requestedLocation	The initially requested resource location
protected SourceResolver	_resolver	The source resolver
protected Source	_source	The resolved source

Constructor Summary

Constructors

Constructor	Description
SimpleResourceHandler()	Default constructor.
SimpleResourceHandler(Source source)	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.
long	getLastModified()	Get the resource last modified time
String	getMimeType()	Return the mime type of the configured resource.
SourceValidity	getValidity()	Get the resource validity, for cache purpose.
void	service(ServiceManager manager)
Source	setup(String location, Map objectModel, Parameters parameters, boolean readForDownload)	Initialize the resource handler with a resource.

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

_resolver

protected SourceResolver _resolver

The source resolver

_source

protected Source _source

The resolved source

_parameters

protected Parameters _parameters

The sitemap parameters

_objectModel

protected Map _objectModel

The object model

_readForDownload

protected boolean _readForDownload

if the resource has been request for download

_requestedLocation

protected String _requestedLocation

The initially requested resource location

Constructor Details

SimpleResourceHandler

public SimpleResourceHandler()

Default constructor.

SimpleResourceHandler

public SimpleResourceHandler(Source source)

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

Parameters:

source - the source.

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setup

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

Description copied from interface: ResourceHandler

Initialize the resource handler with a resource.

Specified by:

setup in interface ResourceHandler

Parameters:

location - The source uri

objectModel - The object model

parameters - 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

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

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

Returns:

The cache key.

getValidity

public SourceValidity getValidity()

Description copied from interface: ResourceHandler

Get the resource validity, for cache purpose.

Specified by:

getValidity in interface ResourceHandler

Returns:

The resource validity.

getLastModified

public long getLastModified()

Description copied from interface: ResourceHandler

Get the resource last modified time

Specified by:

getLastModified in interface ResourceHandler

Returns:

The last modified

getMimeType

public String getMimeType()

Description copied from interface: ResourceHandler

Return the mime type of the configured resource.

Specified by:

getMimeType in interface ResourceHandler

Returns:

The mime type.