org.ametys.cms.script

Class ScriptManager

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.script.ScriptManager

All Implemented Interfaces:

Component, Contextualizable, LogEnabled, Serviceable

public class ScriptManager
extends AbstractLogEnabled
implements Component, Contextualizable, Serviceable

Script manager. Can be used to retrieves global script functions and help text defined in various configuration files

Field Summary

Fields

Modifier and Type	Field and Description
protected Context	_context Cocoon context
protected I18nUtils	_i18nUtils i18n utils
protected static List<Configuration>	_scriptConfigurations The list of script configuration
private SourceResolver	_sourceResolver Source resolver
static String	ROLE The Avalon role

Constructor Summary

Constructors

Constructor and Description
ScriptManager()

Method Summary

Modifier and Type	Method and Description
protected List<Configuration>	_getScriptConfigurations() Initialize the static script files if needed.
protected I18nizableText	_parseI18nizableText(Configuration config, String pluginName, String name) Parses an i18n text.
void	contextualize(Context context)
String	getGlobalScripts() Retrieves the configured scripts
Map<String,Object>	getScriptHtmlDescription() Retrieves and concatenates the script descriptions
void	service(ServiceManager manager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon role

_scriptConfigurations

protected static List<Configuration> _scriptConfigurations

The list of script configuration

_context

protected Context _context

Cocoon context

_i18nUtils

protected I18nUtils _i18nUtils

i18n utils

_sourceResolver

private SourceResolver _sourceResolver

Source resolver

Constructor Detail

ScriptManager

public ScriptManager()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

_getScriptConfigurations

protected List<Configuration> _getScriptConfigurations()
                                                throws ConfigurationException,
                                                       SAXException,
                                                       IOException

Initialize the static script files if needed. Returns list of configurations for these files.

Returns:

list of configurations

Throws:

ConfigurationException - If the configuration is wrong

SAXException - If an error occurred

IOException - If an error occurred

getGlobalScripts

public String getGlobalScripts()
                        throws ConfigurationException,
                               SAXException,
                               IOException

Retrieves the configured scripts

Returns:

a String containing all the configured scripts

Throws:

IOException - If an error occurred

SAXException - If an error occurred

ConfigurationException - If the configuration is wrong

getScriptHtmlDescription

public Map<String,Object> getScriptHtmlDescription()
                                            throws ConfigurationException,
                                                   SAXException,
                                                   IOException

Retrieves and concatenates the script descriptions

Returns:

a String containing the concatenated description

Throws:

IOException - If an error occurred

SAXException - If an error occurred

ConfigurationException - If the configuration is wrong

_parseI18nizableText

protected I18nizableText _parseI18nizableText(Configuration config,
                                              String pluginName,
                                              String name)

Parses an i18n text.

Parameters:

config - the configuration to use.

pluginName - the current plugin name.

name - the child name.

Returns:

the i18n text.