Package org.springframework.extensions.surf.extensibility

Class WebScriptExtensibilityModuleHandler

java.lang.Object

org.springframework.extensions.surf.extensibility.WebScriptExtensibilityModuleHandler

public class WebScriptExtensibilityModuleHandler
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected List<BasicExtensionModule>	extensionModules	The List of BasicExtensionModule configuration files found on the SearchPath.

Constructor Summary

Constructors

Constructor	Description
WebScriptExtensibilityModuleHandler()

Method Summary

Modifier and Type	Method	Description
List<String>	getExtendingModuleFiles(BasicExtensionModule module, String pathBeingProcessed)	Returns a List of the files that should be applied to an ExtensibilityModel being processed.
List<BasicExtensionModule>	getExtensionModules()	Sets up the list of BasicExtensionModule instances found in the configuration.
void	setConfigurationSearchPath(SearchPath configurationSearchPath)	A setter provided so that the Spring configuration can set the SearchPath

Methods inherited from class java.lang.Object

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

Field Details

extensionModules

protected List<BasicExtensionModule> extensionModules

The List of BasicExtensionModule configuration files found on the SearchPath. This List will only initialised once (the first time that it is requested).

Constructor Details

WebScriptExtensibilityModuleHandler

public WebScriptExtensibilityModuleHandler()

Method Details

setConfigurationSearchPath

public void setConfigurationSearchPath(SearchPath configurationSearchPath)

A setter provided so that the Spring configuration can set the SearchPath

Parameters:

configurationSearchPath - SearchPath

getExtensionModules

public List<BasicExtensionModule> getExtensionModules()

Sets up the list of BasicExtensionModule instances found in the configuration. This should only be called once when the bean initialises via the init method.

Returns:

A List of configured BasicExtensionModule instances.

getExtendingModuleFiles

public List<String> getExtendingModuleFiles(BasicExtensionModule 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.