org.springframework.extensions.webscripts

Class MessagesWebScript

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.MessagesWebScript

All Implemented Interfaces:

org.springframework.extensions.webscripts.WebScript

public class MessagesWebScript
extends org.springframework.extensions.webscripts.AbstractWebScript

WebScript responsible for returning a JavaScript response containing a JavaScript associative array of all I18N messages name/key pairs installed on the web-tier.

The JavaScript object is created as 'SpringSurf.messages' - example usage: var msg = SpringSurf.messages["messageid"];

Author:

Kevin Roast

Nested Class Summary

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

org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.extensions.webscripts.Cache	cache As WebScript beans as singletons, we can create a new Date() once when runtime instantiates bean and use this as the "last modified" for the global messages WebScript response Cache value.
protected Map<String,String>	localeToChecksum When configured to use checksum dependencies this will contain a mapping of the locale to the last checksum generated for the cached message contents.
protected Map<String,String>	messages The response is built once per locale and cached - they do not change for the life of the server instance.

Constructor Summary

Constructors

Constructor and Description
MessagesWebScript() Construction

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res) Execute the webscript and return the cached JavaScript response
String	generateCachedLocaleChecksum(String locale) Attempts to retrieve the checksum for messages generated for the supplied locale.
String	generateCacheKey(String locale) It is necessary to include the protocol as well as the locale as the cache key.
protected String	generateMessages(String locale) Generates a String containing a JSON representation of all the i18n messages.
protected String	generateMessages(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, String locale) Generate the message for a given locale.
protected String	getMessagesPrefix(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, String locale) Generates a String prefix of JavaScript that by default sets up a namespace for the messages object to which the messages JSON output should be assigned.
protected String	getMessagesSuffix(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, String locale) Generates a String suffix of JavaScript that defaults to a closing semi-colon.
protected void	setCachedLocaleChecksum(String locale, String checksum) Maps a locale to a checksum in the cache
void	setDependencyHandler(DependencyHandler dependencyHandler) Setter provided to allow the Spring framework to set the link DependencyHandler.
void	setWebFrameworkConfigElement(WebFrameworkConfigElement webFrameworkConfigElement) Setter provided to allow the Spring framework to set the WebFrameworkConfigElement.

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

addModuleBundleToCache, checkModuleBundleCache, createArgs, createArgsM, createHeaders, createHeadersM, createScriptParameters, createStatusException, createTemplateParameters, executeScript, getContainer, getDescription, getExecuteScript, getResources, getStatusTemplate, init, renderString, renderString, renderTemplate, sendStatus, setURLModelFactory, toString

Methods inherited from class java.lang.Object

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

Field Detail

cache

protected final org.springframework.extensions.webscripts.Cache cache

As WebScript beans as singletons, we can create a new Date() once when runtime instantiates bean and use this as the "last modified" for the global messages WebScript response Cache value.

messages

protected final Map<String,String> messages

The response is built once per locale and cached - they do not change for the life of the server instance.

localeToChecksum

protected final Map<String,String> localeToChecksum

When configured to use checksum dependencies this will contain a mapping of the locale to the last checksum generated for the cached message contents.

Constructor Detail

MessagesWebScript

public MessagesWebScript()

Construction

Method Detail

setWebFrameworkConfigElement

public void setWebFrameworkConfigElement(WebFrameworkConfigElement webFrameworkConfigElement)

Setter provided to allow the Spring framework to set the WebFrameworkConfigElement.

Parameters:

webFrameworkConfigElement - WebFrameworkConfigElement

setDependencyHandler

public void setDependencyHandler(DependencyHandler dependencyHandler)

Setter provided to allow the Spring framework to set the link DependencyHandler.

Parameters:

dependencyHandler - DependencyHandler

execute

public void execute(org.springframework.extensions.webscripts.WebScriptRequest req,
           org.springframework.extensions.webscripts.WebScriptResponse res)
             throws IOException

Execute the webscript and return the cached JavaScript response

Throws:

IOException

generateCacheKey

public String generateCacheKey(String locale)

It is necessary to include the protocol as well as the locale as the cache key. This is because the response could be different for HTTP versus HTTPS (in particular when Surf is run with Alfresco it will return an image with the appropriate protocol) - see ALF-16900

Parameters:

locale - String

Returns:

String

generateCachedLocaleChecksum

public String generateCachedLocaleChecksum(String locale)

Attempts to retrieve the checksum for messages generated for the supplied locale. This checksum will only exist if the messages have already been generated (i.e. the generateMessages() method has been called.

Parameters:

locale - String

Returns:

String

setCachedLocaleChecksum

protected void setCachedLocaleChecksum(String locale,
                           String checksum)

Maps a locale to a checksum in the cache

Parameters:

locale - The locale to map against

checksum - The checksum to map

getMessagesPrefix

protected String getMessagesPrefix(org.springframework.extensions.webscripts.WebScriptRequest req,
                       org.springframework.extensions.webscripts.WebScriptResponse res,
                       String locale)
                            throws IOException

Generates a String prefix of JavaScript that by default sets up a namespace for the messages object to which the messages JSON output should be assigned.

Parameters:

req - The current WebScriptRequest

res - The current WebScriptResponse

locale - The locale for the messages being generated.

Returns:

A String containing a JavaScript prefix that defines a namespace and variale to assign the messages object to.

Throws:

IOException

getMessagesSuffix

protected String getMessagesSuffix(org.springframework.extensions.webscripts.WebScriptRequest req,
                       org.springframework.extensions.webscripts.WebScriptResponse res,
                       String locale)
                            throws IOException

Generates a String suffix of JavaScript that defaults to a closing semi-colon.

Parameters:

req - The current WebScriptRequest

res - The current WebScriptResponse

locale - The locale for the messages being generated.

Returns:

A closing semi-colon

Throws:

IOException

generateMessages

protected final String generateMessages(String locale)

Generates a String containing a JSON representation of all the i18n messages. This method also uses the associated DependencyHandler to generate a checksum from that String and maps against the supplied locale. This method has been declared as final to ensure that it the checksum is always generated and set.

Parameters:

locale - The locale to generate messages for

Returns:

A String containing the messages rendered as JSON

generateMessages

protected String generateMessages(org.springframework.extensions.webscripts.WebScriptRequest req,
                      org.springframework.extensions.webscripts.WebScriptResponse res,
                      String locale)
                           throws IOException

Generate the message for a given locale.

Parameters:

locale - Java locale format

Returns:

messages as JSON string

Throws:

IOException