org.springframework.extensions.webscripts

Class LocalWebScriptRuntimeContainer

java.lang.Object

org.springframework.extensions.webscripts.AbstractRuntimeContainer

org.springframework.extensions.webscripts.PresentationContainer

org.springframework.extensions.webscripts.LocalWebScriptRuntimeContainer

All Implemented Interfaces:

EventListener, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener, org.springframework.extensions.config.HasAikauVersion, org.springframework.extensions.surf.extensibility.HandlesExtensibility, org.springframework.extensions.webscripts.Container, org.springframework.extensions.webscripts.RuntimeContainer

public class LocalWebScriptRuntimeContainer
extends org.springframework.extensions.webscripts.PresentationContainer
implements org.springframework.extensions.surf.extensibility.HandlesExtensibility, org.springframework.extensions.config.HasAikauVersion

WebScript Runtime Container for a Surf WebScript based component.

The web-tier PresentationContainer is extended to provide additional script and template parameters. Also a ThreadLocal is used to maintain and provide access to the Surf RequestContext for the currently executing thread.

Author:

kevinr, David Draper

Field Summary

Fields inherited from class org.springframework.extensions.webscripts.AbstractRuntimeContainer

applicationContext

Constructor Summary

Constructors

Constructor and Description
LocalWebScriptRuntimeContainer()

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtensibilityDirectives(Map<String,Object> freeMarkerModel, org.springframework.extensions.surf.extensibility.ExtensibilityModel extModel)
void	addExtensionBundleToCache(String webScriptId, org.springframework.extensions.webscripts.WebScriptPropertyResourceBundle extensionBundle) Adds a new extended bundle to the cache of the current RequestContext.
void	bindModelObject(ModelObject object)
void	bindRequestContext(RequestContext context) Bind the RequestContext to the current thread.
void	closeExtensibilityModel(org.springframework.extensions.surf.extensibility.ExtensibilityModel model, Writer out)
void	executeScript(org.springframework.extensions.webscripts.WebScriptRequest scriptReq, org.springframework.extensions.webscripts.WebScriptResponse scriptRes, org.springframework.extensions.webscripts.Authenticator auth)
String	getAikauVersion() Returns the current Aikau version.
ResourceBundle	getCachedExtendedBundle(String webScriptId) Checks the current RequestContext to see if it has cached an extended bundle (that is a basic ResourceBundle that has had extension modules applied to it.
org.springframework.extensions.surf.extensibility.ExtensibilityModel	getCurrentExtensibilityModel()
org.springframework.extensions.webscripts.ScriptConfigModel	getExtendedScriptConfigModel(String xmlConfig)
org.springframework.extensions.webscripts.TemplateConfigModel	getExtendedTemplateConfigModel(String xmlConfig)
List<String>	getExtendingModuleFiles(String pathBeingProcessed)
ExtensibilityModuleHandler	getExtensibilityModuleHandler()
String	getFileBeingProcessed() Retrieves the path of the current file being processed.
protected ModelObject	getModelObject()
protected RequestContext	getRequestContext()
Map<String,Object>	getScriptParameters()
Map<String,Object>	getTemplateParameters()
org.springframework.extensions.webscripts.URLModelFactory	getUrlModelFactory()
boolean	isExtensibilitySuppressed()
org.springframework.extensions.surf.extensibility.ExtensibilityModel	openExtensibilityModel()
void	reset()
void	setExtensibilityModuleHandler(ExtensibilityModuleHandler extensibilityModuleHandler)
void	setFileBeingProcessed(String file) Sets the path of the current file being processed.
void	setProcessorModelHelper(ProcessorModelHelper processorModelHelper)
void	setUrlModelFactory(org.springframework.extensions.webscripts.URLModelFactory urlModelFactory)
void	suppressExtensibility()
void	unbindModelObject()
void	unbindRequestContext() Unbind the RequestContext from the current thread - must be called at some point after the bind() method, in a finally block or similar.
void	unsuppressExtensibility()
void	updateExtendingModuleDependencies(String pathBeingProcessed, Map<String,Object> model)

Methods inherited from class org.springframework.extensions.webscripts.PresentationContainer

getDescription, setBeanName

Methods inherited from class org.springframework.extensions.webscripts.AbstractRuntimeContainer

allowCallbacks, authenticate, getApplicationContext, getConfigService, getFormatRegistry, getName, getRegistry, getRequiredAuthentication, getScriptParameterFactoryRegistry, getScriptProcessorRegistry, getSearchPath, getTemplateProcessorRegistry, onApplicationEvent, setAllowCallbacks, setApplicationContext, setConfigService, setFormatRegistry, setName, setRegistry, setScriptObjects, setScriptParameterFactoryRegistry, setScriptProcessorRegistry, setSearchPath, setTemplateObjects, setTemplateProcessorRegistry

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalWebScriptRuntimeContainer

public LocalWebScriptRuntimeContainer()

Method Detail

setProcessorModelHelper

public void setProcessorModelHelper(ProcessorModelHelper processorModelHelper)

bindRequestContext

public void bindRequestContext(RequestContext context)

Bind the RequestContext to the current thread.

bindModelObject

public void bindModelObject(ModelObject object)

unbindRequestContext

public void unbindRequestContext()

Unbind the RequestContext from the current thread - must be called at some point after the bind() method, in a finally block or similar.

unbindModelObject

public void unbindModelObject()

getRequestContext

protected RequestContext getRequestContext()

Returns:

the RequestContext for this thread.

getModelObject

protected ModelObject getModelObject()

reset

public void reset()

Specified by:

reset in interface org.springframework.extensions.webscripts.Container

Overrides:

reset in class org.springframework.extensions.webscripts.PresentationContainer

getScriptParameters

public Map<String,Object> getScriptParameters()

Specified by:

getScriptParameters in interface org.springframework.extensions.webscripts.Container

Overrides:

getScriptParameters in class org.springframework.extensions.webscripts.AbstractRuntimeContainer

getTemplateParameters

public Map<String,Object> getTemplateParameters()

Specified by:

getTemplateParameters in interface org.springframework.extensions.webscripts.Container

Overrides:

getTemplateParameters in class org.springframework.extensions.webscripts.AbstractRuntimeContainer

executeScript

public void executeScript(org.springframework.extensions.webscripts.WebScriptRequest scriptReq,
                 org.springframework.extensions.webscripts.WebScriptResponse scriptRes,
                 org.springframework.extensions.webscripts.Authenticator auth)
                   throws IOException

Specified by:

executeScript in interface org.springframework.extensions.webscripts.RuntimeContainer

Overrides:

executeScript in class org.springframework.extensions.webscripts.PresentationContainer

Throws:

IOException

setExtensibilityModuleHandler

public void setExtensibilityModuleHandler(ExtensibilityModuleHandler extensibilityModuleHandler)

getExtensibilityModuleHandler

public ExtensibilityModuleHandler getExtensibilityModuleHandler()

getCurrentExtensibilityModel

public org.springframework.extensions.surf.extensibility.ExtensibilityModel getCurrentExtensibilityModel()

Specified by:

getCurrentExtensibilityModel in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility

openExtensibilityModel

public org.springframework.extensions.surf.extensibility.ExtensibilityModel openExtensibilityModel()

Specified by:

openExtensibilityModel in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility

closeExtensibilityModel

public void closeExtensibilityModel(org.springframework.extensions.surf.extensibility.ExtensibilityModel model,
                           Writer out)

Specified by:

closeExtensibilityModel in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility

updateExtendingModuleDependencies

public void updateExtendingModuleDependencies(String pathBeingProcessed,
                                     Map<String,Object> model)

Specified by:

updateExtendingModuleDependencies in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility

getExtendingModuleFiles

public List<String> getExtendingModuleFiles(String pathBeingProcessed)

Specified by:

getExtendingModuleFiles in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility

getFileBeingProcessed

public String getFileBeingProcessed()

Retrieves the path of the current file being processed. This request is delegated to the associated RequestContext.

Specified by:

getFileBeingProcessed in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility

setFileBeingProcessed

public void setFileBeingProcessed(String file)

Sets the path of the current file being processed. This request is delegated to the associated RequestContext.

Specified by:

setFileBeingProcessed in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility

getUrlModelFactory

public org.springframework.extensions.webscripts.URLModelFactory getUrlModelFactory()

Overrides:

getUrlModelFactory in class org.springframework.extensions.webscripts.PresentationContainer

setUrlModelFactory

public void setUrlModelFactory(org.springframework.extensions.webscripts.URLModelFactory urlModelFactory)

getCachedExtendedBundle

public ResourceBundle getCachedExtendedBundle(String webScriptId)

Checks the current RequestContext to see if it has cached an extended bundle (that is a basic ResourceBundle that has had extension modules applied to it. Extended bundles can only be safely cached once per request as the modules applied can vary for each request.

Specified by:

getCachedExtendedBundle in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility

Parameters:

webScriptId - The id of the WebScript to retrieve the extended bundle for.

Returns:

A cached bundle or null if the bundle has not previously been cached.

addExtensionBundleToCache

public void addExtensionBundleToCache(String webScriptId,
                             org.springframework.extensions.webscripts.WebScriptPropertyResourceBundle extensionBundle)

Adds a new extended bundle to the cache of the current RequestContext. An extended bundle is a WebScript ResourceBundle that has had ResourceBundle instances merged into it from extension modules that have been applied. These can only be cached for the lifetime of the request as different modules may be applied to the same WebScript for different requests.

Specified by:

addExtensionBundleToCache in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility

Parameters:

webScriptId - The id of the WebScript to cache the extended bundle against.

extensionBundle - The extended bundle to cache.

getExtendedScriptConfigModel

public org.springframework.extensions.webscripts.ScriptConfigModel getExtendedScriptConfigModel(String xmlConfig)

Specified by:

getExtendedScriptConfigModel in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility

getExtendedTemplateConfigModel

public org.springframework.extensions.webscripts.TemplateConfigModel getExtendedTemplateConfigModel(String xmlConfig)

Specified by:

getExtendedTemplateConfigModel in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility

addExtensibilityDirectives

public void addExtensibilityDirectives(Map<String,Object> freeMarkerModel,
                              org.springframework.extensions.surf.extensibility.ExtensibilityModel extModel)

Specified by:

addExtensibilityDirectives in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility

suppressExtensibility

public void suppressExtensibility()

unsuppressExtensibility

public void unsuppressExtensibility()

isExtensibilitySuppressed

public boolean isExtensibilitySuppressed()

Specified by:

isExtensibilitySuppressed in interface org.springframework.extensions.surf.extensibility.HandlesExtensibility

getAikauVersion

public String getAikauVersion()

Returns the current Aikau version. This will found in the version of Aikau that is in use. It will typically be the latest version of Aikau found unless module deployment order has been manually set to use a different version.

Specified by:

getAikauVersion in interface org.springframework.extensions.config.HasAikauVersion

Returns:

A String containing the current Aikau version.