org.springframework.extensions.surf.processor

Class JSScriptWithTokensProcessor

java.lang.Object

org.springframework.extensions.webscripts.processor.BaseProcessor

org.springframework.extensions.webscripts.processor.BaseRegisterableScriptProcessor

org.springframework.extensions.webscripts.processor.AbstractScriptProcessor

org.springframework.extensions.webscripts.processor.JSScriptProcessor

org.springframework.extensions.surf.processor.JSScriptWithTokensProcessor

All Implemented Interfaces:

EventListener, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener, org.springframework.extensions.surf.core.processor.Processor, org.springframework.extensions.surf.core.scripts.ScriptResourceLoader, org.springframework.extensions.webscripts.ScriptProcessor

public class JSScriptWithTokensProcessor
extends org.springframework.extensions.webscripts.processor.JSScriptProcessor

This extends the the default JSScriptProcessor to provide the capability to substitute variables in the requested resource name. This currently only supports the replacing the "aikauVersion" token in order that page model library files can be accurately located in the version of Aikau that is in use. In the future this could be further enhanced to support additional tokens but was initially created to address a single use-case.

Author:

Dave Draper

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.processor.JSScriptProcessor

org.springframework.extensions.webscripts.processor.JSScriptProcessor.PresentationWrapFactory

Field Summary

Fields inherited from class org.springframework.extensions.webscripts.processor.BaseProcessor

processorExtensions

Constructor Summary

Constructors

Constructor and Description
JSScriptWithTokensProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAikauVersion() Returns the current Aikau version.
WebFrameworkConfigElement	getWebFrameworkConfigElement() Returns the configuration for the web framework.
String	loadScriptResource(String resource) Extends the inherited method to replace any "{aikauVersion}" tokens with the current version of Aikau that is in use.
void	setWebFrameworkConfigElement(WebFrameworkConfigElement webFrameworkConfigElement) Required by Spring to inject the Web Framework configuration.

Methods inherited from class org.springframework.extensions.webscripts.processor.JSScriptProcessor

executeScript, executeScript, findScript, getExtension, getName, init, initProcessor, initScope, isDebugMode, reset, setCompile, setConfigService, setShareSealedScopes, unwrapValue

Methods inherited from class org.springframework.extensions.webscripts.processor.AbstractScriptProcessor

addProcessorModelExtensions, getScriptLoader, getSearchPath, initLoaders, register, setSearchPath

Methods inherited from class org.springframework.extensions.webscripts.processor.BaseRegisterableScriptProcessor

getScriptProcessorRegistry, onApplicationEvent, setApplicationContext, setScriptProcessorRegistry

Methods inherited from class org.springframework.extensions.webscripts.processor.BaseProcessor

registerProcessorExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Constructor Detail

JSScriptWithTokensProcessor

public JSScriptWithTokensProcessor()

Method Detail

getWebFrameworkConfigElement

public WebFrameworkConfigElement getWebFrameworkConfigElement()

Returns the configuration for the web framework.

Returns:

WebFrameworkConfigElement

setWebFrameworkConfigElement

public void setWebFrameworkConfigElement(WebFrameworkConfigElement webFrameworkConfigElement)

Required by Spring to inject the Web Framework configuration.

Parameters:

webFrameworkConfigElement - WebFrameworkConfigElement

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.

Returns:

A String containing the current Aikau version.

loadScriptResource

public String loadScriptResource(String resource)

Extends the inherited method to replace any "{aikauVersion}" tokens with the current version of Aikau that is in use.

Specified by:

loadScriptResource in interface org.springframework.extensions.surf.core.scripts.ScriptResourceLoader

Overrides:

loadScriptResource in class org.springframework.extensions.webscripts.processor.JSScriptProcessor

Parameters:

resource - Script resource to load. Supports either classpath: prefix syntax or a resource path within the WebScript stores.

Returns:

The content from the resource, null if not recognised format