com.communote.server.web.commons.resource.impl

Class ConcatenatedResourceStoreImpl

java.lang.Object

com.communote.server.web.commons.resource.impl.ConcatenatedResourceStoreImpl

All Implemented Interfaces:

ConcatenatedResourceStore

public class ConcatenatedResourceStoreImpl
extends Object
implements ConcatenatedResourceStore

Default implementation of the ConcatenatedResourceStore

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
ConcatenatedResourceStoreImpl(Map<String,List<String>> builtInResources, String contentType, String fileExtension) Create a new file store to handle a specific type of files and initialize it with default categories and some initial resources per category.
ConcatenatedResourceStoreImpl(Map<String,List<String>> builtInResources, String contentType, String fileExtension, String minimizedSuffix) Create a new file store to handle a specific type of files and initialize it with default categories and some initial resources per category.
ConcatenatedResourceStoreImpl(Map<String,List<String>> builtInResources, String contentType, String fileExtension, String minimizedSuffix, String propertyResourceName) Create a new file store to handle a specific type of files and initialize it with default categories and some initial resources per category.

Method Summary

Modifier and Type	Method and Description
void	addCategory(String identifier, String categoryName, List<String> coreResources, List<Pair<String,String>> extensionResources) Add a category with initial resources.
void	addCategoryWithPropertyResourceSupport(String identifier, String categoryName, List<String> coreResources, List<Pair<String,String>> extensionResources, String propertyResourceFallback) Like ConcatenatedResourceStore.addCategory(String, String, List, List) but adds a category which supports the definition of a resource as a PluginProperty.
void	addToCategory(String identifier, String categoryName, List<Pair<String,String>> resources) Add the resources of a plugin to a category.
File	getConcatenatedFile(String categoryName, boolean minimized) Return the concatenated file of a category.
long	getConcatenatedFileLastModified(String categoryName) Return the timestamp of the last modification of the concatenated file.
String	getContentType()
List<String>	getCoreResources(String categoryName, boolean minimized, boolean timestamped) Return the relative locations of the core resources of a given category.
protected static File	getMinimizedFile(String absoluteFilePath, String minimizedSuffix) Get the minimized version of a given file if it exists.
static String	getMinimizedResourceName(String resourceName, String minimizedSuffix) Return the minimized name of a resource by injecting the marker suffix.
String	getMinimizedSuffix()
List<String>	getPluginResources(String categoryName, boolean minimized, boolean timestamped) Return the relative locations of the plugin resources of a given category.
PropertyResourceContent	getPropertyResourceContent(String identifier, String categoryName) Get the content of a property resource for category that was added by a given plugin.
File	getPropertyResourceFile(String categoryName, boolean minimized) Return the file containing the current value of the property resource of a category.
long	getPropertyResourceLastModified(String categoryName) Return the timestamp of the last modification of the property resource.
void	init() Prepare the store after creation.
void	removeCategory(String identifier, String categoryName) Remove a category previously added by the plugin with the given identifier.
void	removeFromCategory(String identifier, String categoryName) Remove the resources of a category that were added by the plugin with the given identifier
void	setCacheSubdir(String subdirName) Set the name of the cache sub-directory where concatenated files will be stored.
void	setResourceConcatenator(ResourceConcatenator concatenator) Set the resource concatenator to use.
void	updatePropertyResource(String identifier, String categoryName, String propertyValue) Update the property resource for the given category and plugin.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConcatenatedResourceStoreImpl

public ConcatenatedResourceStoreImpl(Map<String,List<String>> builtInResources,
                                     String contentType,
                                     String fileExtension)

Create a new file store to handle a specific type of files and initialize it with default categories and some initial resources per category. The initial resources can be overlayed or extended by plugins via calls to addCategory(String, String, List, List) and addToCategory(String, String, List) respectively. Property resources are not supported.

The filename suffix marking a file as minimized version is set to "-min".

Parameters:

builtInResources - mapping from category names to a collection of initial resources of that category. Each entry of a collection refers to the location of a resource delivered with the application under which it can be downloaded. The category names represent the default categories.

contentType - the content/MIME type of the files managed by the store

fileExtension - the extension that all files managed by the store need to have

ConcatenatedResourceStoreImpl

public ConcatenatedResourceStoreImpl(Map<String,List<String>> builtInResources,
                                     String contentType,
                                     String fileExtension,
                                     String minimizedSuffix)

Create a new file store to handle a specific type of files and initialize it with default categories and some initial resources per category. The initial resources can be overlayed or extended by plugins via calls to addCategory(String, String, List, List) and addToCategory(String, String, List) respectively. Property resources are not supported.

Parameters:

builtInResources - mapping from category names to a collection of initial resources of that category. Each entry of a collection refers to the location of a resource delivered with the application under which it can be downloaded. The category names represent the default categories.

contentType - the content/MIME type of the files managed by the store

fileExtension - the extension that all files managed by the store need to have

minimizedSuffix - filename suffix that marks a file as the minimized version of the file with the same name but without the suffix

ConcatenatedResourceStoreImpl

public ConcatenatedResourceStoreImpl(Map<String,List<String>> builtInResources,
                                     String contentType,
                                     String fileExtension,
                                     String minimizedSuffix,
                                     String propertyResourceName)

Create a new file store to handle a specific type of files and initialize it with default categories and some initial resources per category. The initial resources can be overlayed or extended by plugins via calls to addCategory(String, String, List, List) and addToCategory(String, String, List) respectively.

Parameters:

builtInResources - mapping from category names to a collection of initial resources of that category. Each entry of a collection refers to the location of a resource delivered with the application under which it can be downloaded. The category names represent the default categories.

contentType - the content/MIME type of the files managed by the store

fileExtension - the extension that all files managed by the store need to have

minimizedSuffix - filename suffix that marks a file as the minimized version of the file with the same name but without the suffix

propertyResourceName - identifier for property resources. This identifier is used as prefix for the property key when storing or retrieving from database. If omitted PropertyResources are not supported and an exception will be thrown when trying to add or update a property resource.

Method Detail

getMinimizedFile

protected static File getMinimizedFile(String absoluteFilePath,
                                       String minimizedSuffix)

Get the minimized version of a given file if it exists. The minimized version of a file has the minimized file name suffix passed to the constructor.

Parameters:

absoluteFilePath - the absolute file name of the file

minimizedSuffix - filename suffix that marks a file as the minimized version of the file with the same name but without the suffix

Returns:

the minimized file or null if it does not exist or is not readable

getMinimizedResourceName

public static String getMinimizedResourceName(String resourceName,
                                              String minimizedSuffix)

Return the minimized name of a resource by injecting the marker suffix.

Parameters:

resourceName - the resource name to process

minimizedSuffix - filename suffix that marks a file as the minimized version of the file with the same name but without the suffix

Returns:

the name of the minimized version of a resource

addCategory

public void addCategory(String identifier,
                        String categoryName,
                        List<String> coreResources,
                        List<Pair<String,String>> extensionResources)
                 throws ConcatenatedResourceStoreException

Description copied from interface: ConcatenatedResourceStore

Add a category with initial resources. If the category already exists because it was added by another plugin via a call to this method or it is one of the built-in categories, the initial resources passed to this method will overlay those of the existing category. That is, the existing initial resources won't be rendered until the plugin removes the category.

When rendering the resources of this category the provided initial resources will be rendered first. Afterwards any plugin resources added to this category by ConcatenatedResourceStore.addToCategory(String, String, List) will be rendered in the order they were added.

Specified by:

addCategory in interface ConcatenatedResourceStore

Parameters:

identifier - the identifier of the plugin

categoryName - the name of the category to add or create an overlay for

coreResources - a collection of resources which are delivered with the application and should be added first when rendering the resources of the given category. Each entry of the collection refers to the relative location of a resource under which it can be downloaded. If the file of a resource cannot be resolved it will be ignored. Can be null if the category does not need to have core resources.

extensionResources - a collection of pairs where each pair describes an initial resource provided by the plugin. The left part refers to the relative location of the resource under which it can be downloaded. Therefore, it has to start with the bundle name of the plugin that is prefixed with a slash. The right part of the pair holds the absolute file location of the resource on disk. Any resource that does not exist on disk will be ignored. When rendering the resources of the provided category these resources will be added after the coreResources. Can be null if the category does not need to have plugin resources.

Throws:

ConcatenatedResourceStoreException - in case adding the category failed

addCategoryWithPropertyResourceSupport

public void addCategoryWithPropertyResourceSupport(String identifier,
                                                   String categoryName,
                                                   List<String> coreResources,
                                                   List<Pair<String,String>> extensionResources,
                                                   String propertyResourceFallback)
                                            throws ConcatenatedResourceStoreException

Description copied from interface: ConcatenatedResourceStore

Like ConcatenatedResourceStore.addCategory(String, String, List, List) but adds a category which supports the definition of a resource as a PluginProperty. This so called property resource will be rendered last.

Specified by:

addCategoryWithPropertyResourceSupport in interface ConcatenatedResourceStore

Parameters:

identifier - the identifier of the plugin

categoryName - the name of the category to add or create an overlay for

coreResources - a collection of resources which are delivered with the application and should be added first when rendering the resources of the given category. Each entry of the collection refers to the relative location of a resource under which it can be downloaded. If the file of a resource cannot be resolved it will be ignored. Can be null if the category does not need to have core resources.

extensionResources - a collection of pairs where each pair describes an initial resource provided by the plugin. The left part refers to the relative location of the resource under which it can be downloaded. Therefore, it has to start with the bundle name of the plugin that is prefixed with a slash. The right part of the pair holds the absolute file location of the resource on disk. Any resource that does not exist on disk will be ignored. When rendering the resources of the provided category these resources will be added after the coreResources. Can be null if the category does not need to have plugin resources.

propertyResourceFallback - a fallback of the property resource which will be included if the property is not set. Absolute file location of the resource on disk. If not provided or the resource that does not exist on disk there will be no fallback for the property resource.

Throws:

ConcatenatedResourceStoreException - in case property resources are not supported by this store or adding the category failed

addToCategory

public void addToCategory(String identifier,
                          String categoryName,
                          List<Pair<String,String>> resources)
                   throws ConcatenatedResourceStoreException

Description copied from interface: ConcatenatedResourceStore

Add the resources of a plugin to a category. If the category does not exist the resources will become available as soon as the category is added. If the category exists the provided resources will be rendered after the resources that were added with the category. If another plugin added resources for this category these resources will be rendered before the provided resources.

Specified by:

addToCategory in interface ConcatenatedResourceStore

Parameters:

identifier - the identifier of the plugin

categoryName - the name of the category to which the resources should be added

resources - a collection of pairs where each pair describes a resource of the plugin. The left part refers to the relative location of the resource under which it can be downloaded. Therefore, it has to start with the bundle name of the plugin that is prefixed with a slash. The right part of the pair holds the absolute file location of the resource on disk. Any resource that does not exist on disk will be ignored.

Throws:

ConcatenatedResourceStoreException - in case adding the resources to the category failed

getConcatenatedFile

public File getConcatenatedFile(String categoryName,
                                boolean minimized)

Description copied from interface: ConcatenatedResourceStore

Return the concatenated file of a category.

Specified by:

getConcatenatedFile in interface ConcatenatedResourceStore

Parameters:

categoryName - the name of the category

minimized - whether the minimized version of the file should be returned

Returns:

the concatenated file or null if the category is not known

getConcatenatedFileLastModified

public long getConcatenatedFileLastModified(String categoryName)

Description copied from interface: ConcatenatedResourceStore

Return the timestamp of the last modification of the concatenated file. The concatenated file of a category is modified each time a plugin adds or removes resources from the category or adds an overlay for the category. If there is a property resources for a category, changes to the property will also lead to a new modification timestamp.

Specified by:

getConcatenatedFileLastModified in interface ConcatenatedResourceStore

Parameters:

categoryName - the name of the category

Returns:

the timestamp of the last modification or -1 if the category is not known

getContentType

public String getContentType()

Specified by:

getContentType in interface ConcatenatedResourceStore

Returns:

the content/MIME type of the files managed by the store

getCoreResources

public List<String> getCoreResources(String categoryName,
                                     boolean minimized,
                                     boolean timestamped)

Description copied from interface: ConcatenatedResourceStore

Return the relative locations of the core resources of a given category. This covers all resources that are assigned to the category and are provided by the application. The relative location represents the location under which a resource can be downloaded.

Specified by:

getCoreResources in interface ConcatenatedResourceStore

Parameters:

categoryName - the name of the category

minimized - whether to get the location of the minimized version

timestamped - if true the last modification timestamp of the file will be append to the location in the form of a request parameter with name 't'.

Returns:

the locations of the resources or null if the category is not known

getMinimizedSuffix

public String getMinimizedSuffix()

Specified by:

getMinimizedSuffix in interface ConcatenatedResourceStore

Returns:

the filename suffix that marks a resource as the minimized version

getPluginResources

public List<String> getPluginResources(String categoryName,
                                       boolean minimized,
                                       boolean timestamped)

Description copied from interface: ConcatenatedResourceStore

Return the relative locations of the plugin resources of a given category. This covers all resources that are provided by plugins and were added as part of the initial plugin resources passed to ConcatenatedResourceStore.addCategory(String, String, List, List) or those added via ConcatenatedResourceStore.addToCategory(String, String, List). The relative location represents the location under which the plugin resource can be downloaded. It starts with a slash followed by the bundle name of the plugin.

Specified by:

getPluginResources in interface ConcatenatedResourceStore

Parameters:

categoryName - the name of the category

minimized - whether to get the location of the minimized version

timestamped - if true the last modification timestamp of the file will be append to the location in the form of a request parameter with name 't'.

Returns:

the locations of the resources or null if the category is not known

getPropertyResourceContent

public PropertyResourceContent getPropertyResourceContent(String identifier,
                                                          String categoryName)
                                                   throws ConcatenatedResourceStoreException

Description copied from interface: ConcatenatedResourceStore

Get the content of a property resource for category that was added by a given plugin. This method is useful to get the content provided by a certain plugin especially if several plugins provide a property resource for the same category and thus there are overlays for the property resource. For cases where the current property resource is needed #getPropertyResource(String) should be used.

Specified by:

getPropertyResourceContent in interface ConcatenatedResourceStore

Parameters:

identifier - the identifier of the plugin

categoryName - the name of the category

Returns:

the content or null if the plugin did not define a property resource for the category. The value of the content might be null.

Throws:

ConcatenatedResourceStoreException - in case getting the content failed

getPropertyResourceFile

public File getPropertyResourceFile(String categoryName,
                                    boolean minimized)

Description copied from interface: ConcatenatedResourceStore

Return the file containing the current value of the property resource of a category.

Specified by:

getPropertyResourceFile in interface ConcatenatedResourceStore

Parameters:

categoryName - the name of the category

minimized - whether the minimized version of the file should be returned

Returns:

the file or null if the category is not known

getPropertyResourceLastModified

public long getPropertyResourceLastModified(String categoryName)

Description copied from interface: ConcatenatedResourceStore

Return the timestamp of the last modification of the property resource. The property resource of a category is modified each time the property is updated or another plugin adds an overlay for the category and that overlay contains a property resource.

Specified by:

getPropertyResourceLastModified in interface ConcatenatedResourceStore

Parameters:

categoryName - the name of the category

Returns:

the timestamp of the last modification or -1 if the category is not known

init

public void init()

Prepare the store after creation. Should be called after all properties (like the ResourceConcatenator) have been set.

removeCategory

public void removeCategory(String identifier,
                           String categoryName)
                    throws ConcatenatedResourceStoreException

Remove a category previously added by the plugin with the given identifier.

Specified by:

removeCategory in interface ConcatenatedResourceStore

Parameters:

identifier - the identifier of the plugin

categoryName - the name of the category to remove

Throws:

ConcatenatedResourceStoreException - in case the category couldn't be removed. The store can be in an inconsistent state.

removeFromCategory

public void removeFromCategory(String identifier,
                               String categoryName)
                        throws ConcatenatedResourceStoreException

Remove the resources of a category that were added by the plugin with the given identifier

Specified by:

removeFromCategory in interface ConcatenatedResourceStore

Parameters:

identifier - the identifier of the plugin

categoryName - the name of the category for which the resources should be removed

Throws:

ConcatenatedResourceStoreException - in case the resources of the category couldn't be removed. The store can be in an inconsistent state.

setCacheSubdir

public void setCacheSubdir(String subdirName)

Set the name of the cache sub-directory where concatenated files will be stored. Can be used to override the default which is the file extension, without leading dot, handled by this store. When having several resource stores at runtime it is important to define a unique sub-directory for each store to avoid conflicts.

Parameters:

subdirName - the name of the cache sub-directory to use

setResourceConcatenator

public void setResourceConcatenator(ResourceConcatenator concatenator)

Set the resource concatenator to use. Can be used to override the default for example with a concatenator which does some in-place content substitution.

Parameters:

concatenator - the concatenator

updatePropertyResource

public void updatePropertyResource(String identifier,
                                   String categoryName,
                                   String propertyValue)
                            throws ConcatenatedResourceStoreException

Description copied from interface: ConcatenatedResourceStore

Update the property resource for the given category and plugin. The application property of the plugin is updated or removed and if the property resource is the current one, it will be updated.

Specified by:

updatePropertyResource in interface ConcatenatedResourceStore

Parameters:

identifier - the identifier of the plugin

categoryName - the name of the category

propertyValue - the new value. Can be null to clear the application property and use the fallback of the plugin.

Throws:

ConcatenatedResourceStoreException - in case the update failed or the store does not support property resources