org.springframework.extensions.surf.extensibility.impl

Class BasicExtensibilityModuleHandler

java.lang.Object

org.springframework.extensions.surf.extensibility.WebScriptExtensibilityModuleHandler

org.springframework.extensions.surf.extensibility.impl.BasicExtensibilityModuleHandler

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, ExtensibilityModuleHandler

public class BasicExtensibilityModuleHandler
extends org.springframework.extensions.surf.extensibility.WebScriptExtensibilityModuleHandler
implements ExtensibilityModuleHandler, org.springframework.context.ApplicationContextAware

This is the default ExtensibilityModuleHandler provided for Spring Surf and is configured as a Spring bean.

Author:

David Draper

Field Summary

Fields inherited from class org.springframework.extensions.surf.extensibility.WebScriptExtensibilityModuleHandler

extensionModules

Constructor Summary

Constructors

Constructor and Description
BasicExtensibilityModuleHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	applyModule(ModuleDeployment module, RequestContext context) Determines whether or not to apply the supplied ModuleDeployment based on the supplied RequestContext.
List<ExtensionModule>	evaluateModules(RequestContext context) Retrieves a list of modules that can be applied to the file defined by the supplied path.
List<String>	getExtendingModuleFiles(ExtensionModule module, String path) Returns a list of template paths that could provide valid extensions to the supplied template.
ModelObjectService	getModelObjectService()
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.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setDefaultModuleEvaluator(ExtensionModuleEvaluator defaultModuleEvaluator)
void	setModelObjectService(ModelObjectService modelObjectService)
void	setModuleDeploymentService(ModuleDeploymentService moduleDeploymentService)

Methods inherited from class org.springframework.extensions.surf.extensibility.WebScriptExtensibilityModuleHandler

getExtendingModuleFiles, getExtensionModules, setConfigurationSearchPath

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicExtensibilityModuleHandler

public BasicExtensibilityModuleHandler()

Method Detail

setModuleDeploymentService

public void setModuleDeploymentService(ModuleDeploymentService moduleDeploymentService)

getModelObjectService

public ModelObjectService getModelObjectService()

setModelObjectService

public void setModelObjectService(ModelObjectService modelObjectService)

setDefaultModuleEvaluator

public void setDefaultModuleEvaluator(ExtensionModuleEvaluator defaultModuleEvaluator)

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

getExtendingModuleFiles

public List<String> getExtendingModuleFiles(ExtensionModule module,
                                   String path)

Returns a list of template paths that could provide valid extensions to the supplied template. These paths are derived from the module names defined in all the extension configurations for the application. There is no guarantee that these template paths will map to a file so there existence should be validated by the template processor before attempted to process them.

Specified by:

getExtendingModuleFiles in interface ExtensibilityModuleHandler

Parameters:

path - The path of the template being processed to look for extensions for.

Returns:

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

getModuleJsDeps

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

Description copied from interface: ExtensibilityModuleHandler

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

Specified by:

getModuleJsDeps in interface ExtensibilityModuleHandler

Parameters:

module - ExtensionModule

path - String

Returns:

LinkedHashSet

getModuleCssDeps

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

Description copied from interface: ExtensibilityModuleHandler

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

Specified by:

getModuleCssDeps in interface ExtensibilityModuleHandler

Parameters:

module - ExtensionModule

path - String

Returns:

Map

evaluateModules

public List<ExtensionModule> evaluateModules(RequestContext context)

Retrieves a list of modules that can be applied to the file defined by the supplied path. The path supplied could be to a FreeMarker template, JavaScript controller or NLS properties file. Modules will only be added to the list returned if they meet target and evaluation criteria.

Specified by:

evaluateModules in interface ExtensibilityModuleHandler

Parameters:

context - The current RequestContext

Returns:

A list of ExtensionModule instances that are applicable to the file being processed.

applyModule

protected boolean applyModule(ModuleDeployment module,
                  RequestContext context)

Determines whether or not to apply the supplied ModuleDeployment based on the supplied RequestContext.

Parameters:

module - The ModuleDeployment to test

context - The current RequestContext

Returns:

true if the module should be applied and false otherwise.