org.springframework.extensions.surf.extensibility

Interface ExtensibilityModuleHandler

All Known Implementing Classes:

BasicExtensibilityModuleHandler

public interface ExtensibilityModuleHandler

Classes implementing this interface should be able to determine paths to the files provided by a module that extend a ExtensibilityModel being processed. They should also be able to return a String representing the HTML instructions for importing client side JavaScript and CSS resource dependencies required by the extending modules.

Author:

David Draper

Method Summary

Methods

Modifier and Type	Method and Description
List<ExtensionModule>	evaluateModules(RequestContext context) Evaluates the ExtensionModule instances that are applicable for the supplied RequestContext.
List<String>	getExtendingModuleFiles(ExtensionModule module, String pathBeingProcessed) Returns a List of the files that should be applied to an ExtensibilityModel being processed.
Map<String,LinkedHashSet<String>>	getModuleCssDeps(ExtensionModule module, String path) Returns the CSS dependencies for the current extension module for the supplied path.
LinkedHashSet<String>	getModuleJsDeps(ExtensionModule module, String path) Returns the JavaScript dependencies for the current extension module for the supplied path.

Method Detail

evaluateModules

List<ExtensionModule> evaluateModules(RequestContext context)

Evaluates the ExtensionModule instances that are applicable for the supplied RequestContext.

Parameters:

context - The RequestContext to evaluate modules for.

Returns:

A List of ExtensionModule instances.

getModuleJsDeps

LinkedHashSet<String> getModuleJsDeps(ExtensionModule module,
                                    String path)

Returns the JavaScript dependencies for the current extension module for the supplied path.

Parameters:

module - The module to retrieve JavaScript dependencies from.

path - The current path being processed. This determines which dependencies are mapped.

Returns:

A list of JavaScript dependencies

getModuleCssDeps

Map<String,LinkedHashSet<String>> getModuleCssDeps(ExtensionModule module,
                                                 String path)

Returns the CSS dependencies for the current extension module for the supplied path.

Parameters:

module - The module to retrieve CSS dependencies from.

path - The current path being processed. This determines which dependencies are mapped.

Returns:

A list of CSS dependencies

getExtendingModuleFiles

List<String> getExtendingModuleFiles(ExtensionModule module,
                                   String pathBeingProcessed)

Returns a List of the files that should be applied to an ExtensibilityModel being processed.

Parameters:

pathBeingProcessed - The path of the file being processed. This will typically be a FreeMarker template, JavaScript controller or NLS properties file.

Returns:

A List of the files that extend the current file being processed.