org.ametys.plugins.core.ui.resources

Class AbstractCompiledResourceHandler

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.cocoon.AbstractResourceHandler

org.ametys.plugins.core.ui.resources.AbstractCompiledResourceHandler

All Implemented Interfaces:

ResourceHandler, LogEnabled, Component, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

LessResourceHandler, SassResourceHandler

public abstract class AbstractCompiledResourceHandler
extends AbstractResourceHandler
implements Component

Abstract reader for resources compiled during runtime, such as SASS or LESS files compiled into CSS.

Field Summary

Fields

Modifier and Type	Field and Description
private static Map<String,List<String>>	_dependenciesCache
private static Map<String,Long>	_dependenciesCacheValidity

Fields inherited from class org.ametys.core.cocoon.AbstractResourceHandler

_cocoonContext, _context, _resolver, _supportedSuffixes

Fields inherited from interface org.ametys.core.cocoon.ResourceHandler

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor and Description
AbstractCompiledResourceHandler()

Method Summary

Modifier and Type	Method and Description
private Long	_getCalculatedLastModified(Source inputSource, String sourceUri, long lastModified, HashMap<String,String> knowDependencies)
private List<String>	_getDependencies(Source inputSource, String sourceUri, long lastModified)
private String	_getDependenciesKeys(Source inputSource, String sourceUri, String fileURI, long lastModified, HashMap<String,String> knowDependencies)
private String	_getDependencyURI(String sourceUri, String dependency)
abstract String	compileResource(Source resource) Compile the current resource, and returns its value.
void	generateResource(Source source, OutputStream out, Parameters parameters) Generate the resource configured during setup, and output it
protected abstract Source	getCompiledSource(String location) Get the compiled source uri
protected abstract List<String>	getDependenciesList(Source inputSource) Calculate the list of dependencies for the given source, for validity calculations.
Serializable	getKey(Source source, Parameters parameters) Get the unique key for this resource, for cache purpose.
SourceValidity	getValidity(Source source, Parameters parameters) Get the resource validity, for cache purpose.
boolean	isSupported(String source) Determines if the resource is supported by this handler
Source	setup(String location, Parameters par) Initialize the resource handler with a resource.

Methods inherited from class org.ametys.core.cocoon.AbstractResourceHandler

configure, contextualize, getLastModified, getMimeType, getPriority, getSize, 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

Field Detail

_dependenciesCacheValidity

private static Map<String,Long> _dependenciesCacheValidity

_dependenciesCache

private static Map<String,List<String>> _dependenciesCache

Constructor Detail

AbstractCompiledResourceHandler

public AbstractCompiledResourceHandler()

Method Detail

compileResource

public abstract String compileResource(Source resource)
                                throws IOException,
                                       ProcessingException

Compile the current resource, and returns its value.

Parameters:

resource - The current resource

Returns:

The compiled value

Throws:

IOException - If an IO error occurs

ProcessingException - If a processing error occurs

getDependenciesList

protected abstract List<String> getDependenciesList(Source inputSource)

Calculate the list of dependencies for the given source, for validity calculations.

Parameters:

inputSource - The source

Returns:

The list of uri

getCompiledSource

protected abstract Source getCompiledSource(String location)
                                     throws MalformedURLException,
                                            IOException

Get the compiled source uri

Parameters:

location - The requested location

Returns:

the source

Throws:

MalformedURLException - if location is malformed.

IOException - If an IO error occurs

isSupported

public boolean isSupported(String source)

Description copied from interface: ResourceHandler

Determines if the resource is supported by this handler

Specified by:

isSupported in interface ResourceHandler

Overrides:

isSupported in class AbstractResourceHandler

Parameters:

source - The uri of resource

Returns:

true if the resource is supported

setup

public Source setup(String location,
                    Parameters par)
             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 AbstractResourceHandler

Parameters:

location - The source uri

par - The parameters

Returns:

the resolved source

Throws:

IOException - If an error occurs

ProcessingException - If an error occurs

generateResource

public void generateResource(Source source,
                             OutputStream out,
                             Parameters parameters)
                      throws IOException,
                             ProcessingException

Description copied from interface: ResourceHandler

Generate the resource configured during setup, and output it

Specified by:

generateResource in interface ResourceHandler

Parameters:

source - The source

out - The output stream to write to

parameters - The parameters

Throws:

IOException - If an error occurs

ProcessingException - If an error occurs

getKey

public Serializable getKey(Source source,
                           Parameters parameters)

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 AbstractResourceHandler

Parameters:

source - The source

parameters - The parameters

Returns:

The cache key.

getValidity

public SourceValidity getValidity(Source source,
                                  Parameters parameters)

Description copied from interface: ResourceHandler

Get the resource validity, for cache purpose.

Specified by:

getValidity in interface ResourceHandler

Overrides:

getValidity in class AbstractResourceHandler

Parameters:

source - The source

parameters - The parameters

Returns:

The resource validity.

_getCalculatedLastModified

private Long _getCalculatedLastModified(Source inputSource,
                                        String sourceUri,
                                        long lastModified,
                                        HashMap<String,String> knowDependencies)

_getDependenciesKeys

private String _getDependenciesKeys(Source inputSource,
                                    String sourceUri,
                                    String fileURI,
                                    long lastModified,
                                    HashMap<String,String> knowDependencies)

_getDependencyURI

private String _getDependencyURI(String sourceUri,
                                 String dependency)
                          throws URISyntaxException

Throws:

URISyntaxException

_getDependencies

private List<String> _getDependencies(Source inputSource,
                                      String sourceUri,
                                      long lastModified)