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

Class ResourceCategoryRegistryImpl

java.lang.Object

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

All Implemented Interfaces:

ResourceCategoryRegistry

public class ResourceCategoryRegistryImpl
extends Object
implements ResourceCategoryRegistry

Author:

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

Constructor Summary

Constructors

Constructor and Description
ResourceCategoryRegistryImpl(ConcatenatedResourceStore jsConcatenatedResourceStore, ConcatenatedResourceStore cssConcatenatedResourceStore) Create a new registry.

Method Summary

Modifier and Type	Method and Description
void	registerCssCategoryExtensions(String bundleName, Map<String,List<String>> resources) Extend some of the CSS categories with CSS files of a plugin.
void	registerCssResourceExtension(String bundleName, ResourceExtension extension) Add the CSS resource category extensions and definitions defined in the extension.
void	registerJsCategoryExtensions(String bundleName, Map<String,List<String>> resources) Extend some of the JavaScript categories with JavaScript files of a plugin.
void	registerJsResourceExtension(String bundleName, ResourceExtension extension) Add the JavaScript resource category extensions and definitions defined in the extension.
void	unregisterCssCategories(String bundleName) Remove all CSS extensions and definitions added by the given bundle.
void	unregisterJsCategories(String bundleName) Remove all JavaScript extensions and definitions added by the given bundle.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceCategoryRegistryImpl

public ResourceCategoryRegistryImpl(ConcatenatedResourceStore jsConcatenatedResourceStore,
                                    ConcatenatedResourceStore cssConcatenatedResourceStore)

Create a new registry.

Parameters:

jsConcatenatedResourceStore - the store that manages the JavaScript resources

cssConcatenatedResourceStore - the store that manages the CSS resources

Method Detail

registerCssCategoryExtensions

public void registerCssCategoryExtensions(String bundleName,
                                          Map<String,List<String>> resources)
                                   throws ConcatenatedResourceStoreException

Description copied from interface: ResourceCategoryRegistry

Extend some of the CSS categories with CSS files of a plugin.

Specified by:

registerCssCategoryExtensions in interface ResourceCategoryRegistry

Parameters:

bundleName - the name of the bundle for which the resources should be added

resources - mapping from category name to a list of resources

Throws:

ConcatenatedResourceStoreException - in case a category could not be updated

registerCssResourceExtension

public void registerCssResourceExtension(String bundleName,
                                         ResourceExtension extension)
                                  throws ConcatenatedResourceStoreException

Description copied from interface: ResourceCategoryRegistry

Add the CSS resource category extensions and definitions defined in the extension.

Specified by:

registerCssResourceExtension in interface ResourceCategoryRegistry

Parameters:

bundleName - the name of the bundle that provides the resource extension

extension - the object containing the category extensions and definitions

Throws:

ConcatenatedResourceStoreException - in case a category could not be updated or added

registerJsCategoryExtensions

public void registerJsCategoryExtensions(String bundleName,
                                         Map<String,List<String>> resources)
                                  throws ConcatenatedResourceStoreException

Description copied from interface: ResourceCategoryRegistry

Extend some of the JavaScript categories with JavaScript files of a plugin. This method should usually only be called if adding the JavaScript files depends on some condition like the availability of a service.

Specified by:

registerJsCategoryExtensions in interface ResourceCategoryRegistry

Parameters:

bundleName - the name of the bundle for which the resources should be added

resources - mapping from category name to a list of resources

Throws:

ConcatenatedResourceStoreException - in case a category could not be updated

registerJsResourceExtension

public void registerJsResourceExtension(String bundleName,
                                        ResourceExtension extension)
                                 throws ConcatenatedResourceStoreException

Description copied from interface: ResourceCategoryRegistry

Add the JavaScript resource category extensions and definitions defined in the extension.

Specified by:

registerJsResourceExtension in interface ResourceCategoryRegistry

Parameters:

bundleName - the name of the bundle that provides the resource extension

extension - the object containing the category extensions and definitions

Throws:

ConcatenatedResourceStoreException - in case a category could not be updated or added

unregisterCssCategories

public void unregisterCssCategories(String bundleName)

Description copied from interface: ResourceCategoryRegistry

Remove all CSS extensions and definitions added by the given bundle.

Specified by:

unregisterCssCategories in interface ResourceCategoryRegistry

Parameters:

bundleName - the name of the bundle

unregisterJsCategories

public void unregisterJsCategories(String bundleName)

Description copied from interface: ResourceCategoryRegistry

Remove all JavaScript extensions and definitions added by the given bundle.

Specified by:

unregisterJsCategories in interface ResourceCategoryRegistry

Parameters:

bundleName - the name of the bundle