com.communote.server.web.commons.resource

Interface ResourceCategoryRegistry

All Known Implementing Classes:

ResourceCategoryRegistryImpl

public interface ResourceCategoryRegistry

Author:

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

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.

Method Detail

registerCssCategoryExtensions

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

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

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

void registerCssResourceExtension(String bundleName,
                                  ResourceExtension extension)
                           throws ConcatenatedResourceStoreException

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

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

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

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.

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

void registerJsResourceExtension(String bundleName,
                                 ResourceExtension extension)
                          throws ConcatenatedResourceStoreException

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

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

void unregisterCssCategories(String bundleName)

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

Parameters:

bundleName - the name of the bundle

unregisterJsCategories

void unregisterJsCategories(String bundleName)

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

Parameters:

bundleName - the name of the bundle