org.alfresco.web.scripts

Class MessagesWebScript

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.MessagesWebScript

org.alfresco.web.scripts.MessagesWebScript

All Implemented Interfaces:

org.springframework.extensions.webscripts.WebScript

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

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 'Alfresco.messages' - example usage: var msg = Alfresco.messages["messageid"];

Nested Class Summary

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

org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails

Field Summary

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

cache, localeToChecksum, messages

Constructor Summary

Constructors

Constructor and Description
MessagesWebScript()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	generateMessages(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, java.lang.String locale) Generate the message for a given locale.
protected java.lang.String	getMessagesPrefix(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, java.lang.String locale)
protected java.lang.String	getMessagesSuffix(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, java.lang.String locale)

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

execute, generateCachedLocaleChecksum, generateMessages, setCachedLocaleChecksum, setDependencyHandler, setWebFrameworkConfigElement

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

Constructor Detail

MessagesWebScript

public MessagesWebScript()

Method Detail

generateMessages

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

Generate the message for a given locale.

Overrides:

generateMessages in class org.springframework.extensions.webscripts.MessagesWebScript

Parameters:

locale - Java locale format

Returns:

messages as JSON string

Throws:

java.io.IOException

getMessagesPrefix

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

Overrides:

getMessagesPrefix in class org.springframework.extensions.webscripts.MessagesWebScript

Throws:

java.io.IOException

getMessagesSuffix

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

Overrides:

getMessagesSuffix in class org.springframework.extensions.webscripts.MessagesWebScript

Throws:

java.io.IOException