com.ibm.jaggr.core.impl.config

Class ConfigImpl

java.lang.Object

com.ibm.jaggr.core.impl.config.ConfigImpl

All Implemented Interfaces:

IConfig, IShutdownListener, IOptionsListener

public class ConfigImpl
extends Object
implements IConfig, IShutdownListener, IOptionsListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ConfigImpl.Alias
static class	ConfigImpl.Console Console logger for javascript runtime.
protected class	ConfigImpl.Package

Nested classes/interfaces inherited from interface com.ibm.jaggr.core.config.IConfig

IConfig.IAlias, IConfig.IPackage, IConfig.Location

Field Summary

Fields

Modifier and Type	Field and Description
protected List<IServiceRegistration>	serviceRegs

Fields inherited from interface com.ibm.jaggr.core.config.IConfig

ALIASES_CONFIGPARAM, BASEURL_CONFIGPARAM, CACHEBUST_CONFIGPARAM, COERCEUNDEFINEDTOFALSE_CONFIGPARAM, DEPS_CONFIGPARAM, DEPSINCLUDEBASEURL_CONFIGPARAM, EXPIRES_CONFIGPARAM, HAS_CONFIGPARAM, JSPLUGINDELEGATORS_CONFIGPARAM, NOT_FOUND, NOTICE_CONFIGPARAM, PACKAGES_CONFIGPARAM, PATHS_CONFIGPARAM, PKGLOCATION_CONFIGPARAM, PKGMAIN_CONFIGPARAM, PKGMAIN_DEFAULT, PKGNAME_CONFIGPARAM, TEXTPLUGINDELEGATORS_CONFIGPARAM

Constructor Summary

Constructors

Modifier	Constructor and Description
	ConfigImpl(IAggregator aggregator)
protected	ConfigImpl(IAggregator aggregator, boolean forTest) This constructor is just for testing purpose.
	ConfigImpl(IAggregator aggregator, URI configUri, org.mozilla.javascript.Scriptable rawConfig)
	ConfigImpl(IAggregator aggregator, URI configUri, String configScript)
	ConfigImpl(IAggregator aggregator, URI configUri, String configScript, boolean forTest) This constructor is just for testing purpose.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	_resolve(String name, Features features, Set<String> dependentFeatures, boolean resolveAliases, boolean evaluateHasPluginConditionals, int recursionCount, StringBuffer sb) Resolves a module id by applying alias resolution and has! loader plugin resolution.
protected void	callConfigModifiers(org.mozilla.javascript.Scriptable rawConfig) Calls the registered config modifiers to give them an opportunity to modify the raw config before config properties are evaluated.
protected void	callConfigScopeModifiers(org.mozilla.javascript.Scriptable scope) Calls the registered config scope modifiers to give them an opportunity to prepare the scope object prior to evaluating the config JavaScript
protected IAggregator	getAggregator()
List<IConfig.IAlias>	getAliases() Returns the list of aliases specified by the aliases config param.
IConfig.Location	getBase() Returns the value of the baseUrl config param.
String	getCacheBust() Returns the value of the cacheBust config param.
org.mozilla.javascript.Scriptable	getConfigScope() Returns the scope object used to evaluate the config JavaScript.
URI	getConfigUri() Returns the URI for the config JavaScript file from which this config was read.
Features	getDefaultFeatures(String url) Returns the default features specified using the IConfig.HAS_CONFIGPARAM config param.
List<String>	getDeps() Returns the value of the deps config param as a list of strings.
int	getExpires() Returns the value of the expires config param as an integer.
Set<String>	getJsPluginDelegators() Returns the list of plugin names specified with the IConfig.JSPLUGINDELEGATORS_CONFIGPARAM config param.
String	getNotice() Returns the content of the resource specified by the notice config param.
Map<String,IConfig.Location>	getPackageLocations() Returns an ordered mapping of module ids to resource locations for all of the packages locations defined in this config.
Map<String,IConfig.IPackage>	getPackages() Returns the packages specified by the packages config param.
Map<String,IConfig.Location>	getPaths() Returns the path mappings for module names to resource URIs specified by the paths config param.
Object	getProperty(String propname, Class<?> hint) Returns the value of the named config property.
org.mozilla.javascript.Scriptable	getRawConfig() Returns the raw config data after the config has been modified by any IConfigModifier services that have been registered for the aggregator that this config is associated with, and after any string substitutions have been performed.
Set<String>	getTextPluginDelegators() Returns the list of plugin names specified with the IConfig.TEXTPLUGINDELEGATORS_CONFIGPARAM config param.
protected void	init()
protected void	initForTest() This method is for test purposes and should not be used for production.
boolean	isCoerceUndefinedToFalse() Returns the value of the coerceUndefinedToFalse config param.
boolean	isDepsIncludeBaseUrl() Returns the value of the depsIncludeBaseUrl config param.
long	lastModified() Returns the last-modified date of the config JavaScript file at the time that it was read in order to produce this config object.
protected List<IConfig.IAlias>	loadAliases(org.mozilla.javascript.Scriptable cfg) Initializes and returns the list of aliases defined in the server-side config JavaScript
protected IConfig.Location	loadBaseURI(org.mozilla.javascript.Scriptable cfg) Initializes and returns the base URI specified by the "baseUrl" property in the server-side config JavaScript
protected String	loadCacheBust(org.mozilla.javascript.Scriptable cfg) Initializes and returns the string specified by the cacheBust property in the server-side config JavaScript.
protected boolean	loadCoerceUndefinedToFalse(org.mozilla.javascript.Scriptable cfg) Initializes and returns the flag indicating if features not specified in the feature set from the request should be treated as false when evaluating has conditionals in javascript code.
protected void	loadConfig()
protected org.mozilla.javascript.Scriptable	loadConfig(InputStream in)
protected org.mozilla.javascript.Scriptable	loadConfig(String configScript) Loads the config JavaScript and returns the parsed config in a Map
protected URI	loadConfigUri() Initializes and returns the URI to the server-side config JavaScript
protected Map<String,Object>	loadDefaultFeatures(org.mozilla.javascript.Scriptable cfg)
protected List<String>	loadDeps(org.mozilla.javascript.Scriptable cfg) Initializes and returns the list of module dependencies specified in the server-side config JavaScript.
protected boolean	loadDepsIncludeBaseUrl(org.mozilla.javascript.Scriptable cfg) Initializes and returns the flag indicating if files and directories located under the base directory should be scanned for javascript files when building the module dependency mappings.
protected int	loadExpires(org.mozilla.javascript.Scriptable cfg) Initializes and returns the expires time from the server-side config JavaScript
protected Set<String>	loadJsPluginDelegators(org.mozilla.javascript.Scriptable cfg)
protected IConfig.Location	loadLocation(Object locObj, boolean isFolder)
protected String	loadNotice(org.mozilla.javascript.Scriptable cfg) Initializes and returns the notice string specified by the notice property in the server-side config JavaScript.
protected Map<String,IConfig.IPackage>	loadPackages(org.mozilla.javascript.Scriptable cfg) Initializes and returns the map of packages based on the information in the server-side config JavaScript
protected Map<String,IConfig.Location>	loadPaths(org.mozilla.javascript.Scriptable cfg) Initializes and returns the map of paths based on the information in the server-side config JavaScript
protected Set<String>	loadPluginDelegators(org.mozilla.javascript.Scriptable cfg, String name) Common routine to load text or js plugin delegators
protected Set<String>	loadTextPluginDelegators(org.mozilla.javascript.Scriptable cfg)
URI	locateModuleResource(String mid) Returns the URI to the resource on the server for the specified module id, or null if the resource cannot be located.
protected IConfig.IAlias	newAlias(Object pattern, Object replacement)
protected ConfigImpl.Console	newConsole()
protected com.ibm.jaggr.core.impl.config.ConfigImpl.GetPropertyFunction	newGetPropertyFunction(org.mozilla.javascript.Scriptable scriptable, IAggregator aggregator)
protected com.ibm.jaggr.core.impl.config.ConfigImpl.HasFunction	newHasFunction(org.mozilla.javascript.Scriptable scriptable, Features features)
protected IConfig.IPackage	newPackage(Object obj)
void	optionsUpdated(IOptions options, long sequence) This method is called when the options are loaded/changed.
protected String	processConfig(String configScript) Add any processing logic to the config file like replacing any place holders from a properties file.
protected void	registerServices()
String	resolve(String mid, Features features, Set<String> dependentFeatures, StringBuffer sb, boolean resolveAliases) Legacy method that calls IConfig.resolve(String, Features, Set, StringBuffer, boolean, boolean) with resolveHasPlugin equal to true.
String	resolve(String mid, Features features, Set<String> dependentFeatures, StringBuffer sb, boolean resolveAliases, boolean evaluateHasPluginConditionals) Resolves a module id by applying the following mappings in the indicated order.
protected String	resolveAliases(String name, Features features, Set<String> dependentFeatures, StringBuffer sb) Applies alias mappings to a module name.
protected String	resolveHasPlugin(String expression, Features features, Set<String> dependentFeatures, boolean resolveAliases, boolean evaluateHasPluginConditionals, int recursionCount, StringBuffer sb) Resolves has! loader plugin expressions by calling _resolve() on each of the modules named in the expression.
protected void	setConfigUri(URI configUri)
protected void	setLastModified(long lastModified)
protected void	setRawConfig(org.mozilla.javascript.Scriptable rawConfig)
void	shutdown(IAggregator aggregator) This method is called from within the aggregator's GenericServlet.destroy() method to notify listeners that the servlet is shutting down.
protected URI	toResourceUri(URI uri, String remainder)
String	toString() Returns the stringized source code representation of the raw config returned by IConfig.getRawConfig().
static String	toString(Object obj)

Methods inherited from class java.lang.Object

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

Field Detail

serviceRegs

protected List<IServiceRegistration> serviceRegs

Constructor Detail

ConfigImpl

public ConfigImpl(IAggregator aggregator)
           throws IOException

Throws:

IOException

ConfigImpl

public ConfigImpl(IAggregator aggregator,
          URI configUri,
          String configScript)
           throws IOException

Throws:

IOException

ConfigImpl

public ConfigImpl(IAggregator aggregator,
          URI configUri,
          org.mozilla.javascript.Scriptable rawConfig)
           throws IOException

Throws:

IOException

ConfigImpl

protected ConfigImpl(IAggregator aggregator,
          boolean forTest)
              throws URISyntaxException,
                     FileNotFoundException

This constructor is just for testing purpose. It should not be used for production.

Parameters:

aggregator -

forTest -

Throws:

URISyntaxException

FileNotFoundException

ConfigImpl

public ConfigImpl(IAggregator aggregator,
          URI configUri,
          String configScript,
          boolean forTest)
           throws IOException

This constructor is just for testing purpose. It should not be used for production.

Parameters:

aggregator -

configUri -

configScript -

forTest -

Throws:

IOException

Method Detail

loadConfig

protected void loadConfig()
                   throws IOException,
                          URISyntaxException

Throws:

IOException

URISyntaxException

init

protected void init()
             throws IOException

Throws:

IOException

initForTest

protected void initForTest()
                    throws IOException

This method is for test purposes and should not be used for production.

Throws:

IOException

lastModified

public long lastModified()

Description copied from interface: IConfig

Returns the last-modified date of the config JavaScript file at the time that it was read in order to produce this config object.

Specified by:

lastModified in interface IConfig

Returns:

The last-modified date

getConfigUri

public URI getConfigUri()

Description copied from interface: IConfig

Returns the URI for the config JavaScript file from which this config was read. Note that the returned URI may specify an aggregator specific scheme such as namedbundleresource, so you should first use IAggregator.newResource(URI) to convert the URI into an IResource and then use IResource.getURI() to obtain a platform URI that you can use to open the file, etc.

Specified by:

getConfigUri in interface IConfig

Returns:

The config JavaScript URI

getAggregator

protected IAggregator getAggregator()

getBase

public IConfig.Location getBase()

Description copied from interface: IConfig

Returns the value of the baseUrl config param. This is the base URI to use for all relative URIs specified in this config. If baseUrl is not absolute, then it is assumed to be relative to the root of the bundle defining the servlet. Note that the property name specifies Url, with a lower-case L, instead of URI with an upper-case i, to maintain symmetry with the client-side config. Files and folders located under the folder specified by baseUrl are not scanned when the Aggregator builds the module dependency map used for require list expansion unless the depsIncludeBaseUrl config param is specified with a value of true.

Specified by:

getBase in interface IConfig

Returns:

The base location

getPackages

public Map<String,IConfig.IPackage> getPackages()

Description copied from interface: IConfig

Returns the packages specified by the packages config param.

Specified by:

getPackages in interface IConfig

Returns:

The packages map

See Also:

IConfig.IPackage

getPaths

public Map<String,IConfig.Location> getPaths()

Description copied from interface: IConfig

Returns the path mappings for module names to resource URIs specified by the paths config param. The path URIs are assumed to be relative to baseUrl, unless the URI starts with a "/" or specfies a protocol.

Specified by:

getPaths in interface IConfig

Returns:

The paths map

getAliases

public List<IConfig.IAlias> getAliases()

Description copied from interface: IConfig

Returns the list of aliases specified by the aliases config param.

Specified by:

getAliases in interface IConfig

Returns:

The list of aliases

isDepsIncludeBaseUrl

public boolean isDepsIncludeBaseUrl()

Description copied from interface: IConfig

Returns the value of the depsIncludeBaseUrl config param.

If specified with a value of true, then the files and folders under the directory specified by baseUrl will be scanned when the Aggregator builds the module dependency map used for require list expansion. The default value is false.

Specified by:

isDepsIncludeBaseUrl in interface IConfig

Returns:

The value of the depsIncludeBaseUrl config param

getExpires

public int getExpires()

Description copied from interface: IConfig

Returns the value of the expires config param as an integer.

If specified, this value will be used to specified in the Cache-Control:max-age response header. If the value is zero (the default), then the Cache-Control:maz-age header will not be specified in the response.

Specified by:

getExpires in interface IConfig

Returns:

The value of the expires config param or zero

getDeps

public List<String> getDeps()

Description copied from interface: IConfig

Returns the value of the deps config param as a list of strings.

This property is analogous to the client-side AMD config deps property, which specifies the modules that should be loaded before the application's require.callback method is called. On the server, this property is used to trim the list of expanded dependencies for all require list expansions. Any modules listed here, along with the nested dependencies of the listed modules, will be excluded from expanded require lists for all require() calls in the application. In general, the client-side and server-side AMD configs should both specify the same modules in the deps property, although, this is not a requirement.

If the deps property is not specified in the config, then this function returns an empty list.

This method is deprecated in favor of IRequestedModuleNames.getExcludes() which is specified by Aggregator generated requests based on the modules requested in the boot layer for the application.

Specified by:

getDeps in interface IConfig

Returns:

The list of module names specified in the deps config param

isCoerceUndefinedToFalse

public boolean isCoerceUndefinedToFalse()

Description copied from interface: IConfig

Returns the value of the coerceUndefinedToFalse config param.

If true, then the Aggregator will treat undefined features as if they were defined with a value of false. This applies to has.js feature trimming of javascript code. If this value is false, then has.js conditionals for undefined features are left unchanged. If the value is true, then conditionals involving undefined features are trimmed based on the value of the feature evaluating to false. The default value for this option is false.

Specified by:

isCoerceUndefinedToFalse in interface IConfig

Returns:

the value of the coerceUndefinedToFalse config param

getNotice

public String getNotice()

Description copied from interface: IConfig

Returns the content of the resource specified by the notice config param.

This resource contains the notice text that will be output at the beginning of every Aggregator response. The notice text should be in the form of a javascript block comment. The Aggregator does not do any processing on the notice text.

Specified by:

getNotice in interface IConfig

Returns:

the notice string

getCacheBust

public String getCacheBust()

Description copied from interface: IConfig

Returns the value of the cacheBust config param.

This is an arbitrary string specified by the application that is associated with the serialized meta-data for aggregator caches and the module dependency maps. When these data structures are de-serialized on server restarts, the saved value is compared against the value that is read from the current config, and if the values don't match, then the de-serialized data is discarded and the caches and dependency maps are deleted and rebuilt.

The value of this string is also used for the client-side cacheBust property in the loader extension combo config if it is not specified by the client.

Specified by:

getCacheBust in interface IConfig

Returns:

The value of the cacheBust config param

getTextPluginDelegators

public Set<String> getTextPluginDelegators()

Description copied from interface: IConfig

Returns the list of plugin names specified with the IConfig.TEXTPLUGINDELEGATORS_CONFIGPARAM config param. Loader plugins specified here delegate the loading of the resources they handle to the text module loader. When doing server-side expansion of module dependencies for a bootstrap layer, resources specifying loader plugins included in this list will be included in the response as a text resource.

Specified by:

getTextPluginDelegators in interface IConfig

Returns:

The list of loader plugins that delegate to the text module loader.

getJsPluginDelegators

public Set<String> getJsPluginDelegators()

Description copied from interface: IConfig

Returns the list of plugin names specified with the IConfig.JSPLUGINDELEGATORS_CONFIGPARAM config param. Loader plugins specified here delegate the loading of the resources they handle to the javascript module loader (e.g. the i18n plugin). When doing server-side expansion of module dependencies for a bootstrap layer, resources specifying loader plugins included in this list will be included in the response as a javascript resources.

Specified by:

getJsPluginDelegators in interface IConfig

Returns:

The list of loader plugins that delegate to the javascript module loader.

getDefaultFeatures

public Features getDefaultFeatures(String url)

Description copied from interface: IConfig

Returns the default features specified using the IConfig.HAS_CONFIGPARAM config param. These are default values for features that are overridden by any features defined in the request.

The default features are specified as a property map of name/value pairs. If the value of a property is a JavaScript function, then the function is invoked at the time this method is called to evalute the value of the feature. The function takes one formal parameter which is the request URL, and the returned value will be coerced to a boolean before being assigned as the value of the feature.

Specified by:

getDefaultFeatures in interface IConfig

Parameters:

url - the request URL, or null.

Returns:

The default features.

getRawConfig

public org.mozilla.javascript.Scriptable getRawConfig()

Description copied from interface: IConfig

Returns the raw config data after the config has been modified by any IConfigModifier services that have been registered for the aggregator that this config is associated with, and after any string substitutions have been performed. The runtime type of the object is dependent upon the config processor implementation.

The returned object is read-only, so it may not be modified.

Specified by:

getRawConfig in interface IConfig

Returns:

The raw config data for this config object

See Also:

IConfigModifier

getConfigScope

public org.mozilla.javascript.Scriptable getConfigScope()

Description copied from interface: IConfig

Returns the scope object used to evaluate the config JavaScript. The runtime type of this object is depenedent upon the config processor implementation.

Specified by:

getConfigScope in interface IConfig

Returns:

The config scope object.

setRawConfig

protected void setRawConfig(org.mozilla.javascript.Scriptable rawConfig)

setLastModified

protected void setLastModified(long lastModified)

setConfigUri

protected void setConfigUri(URI configUri)

getPackageLocations

public Map<String,IConfig.Location> getPackageLocations()

Description copied from interface: IConfig

Returns an ordered mapping of module ids to resource locations for all of the packages locations defined in this config.

Specified by:

getPackageLocations in interface IConfig

Returns:

The defined package Locations

locateModuleResource

public URI locateModuleResource(String mid)

Description copied from interface: IConfig

Returns the URI to the resource on the server for the specified module id, or null if the resource cannot be located.

Specified by:

locateModuleResource in interface IConfig

Parameters:

mid - The module id

Returns:

The URI for the module.

toResourceUri

protected URI toResourceUri(URI uri,
                String remainder)
                     throws URISyntaxException

Throws:

URISyntaxException

resolve

public String resolve(String mid,
             Features features,
             Set<String> dependentFeatures,
             StringBuffer sb,
             boolean resolveAliases)

Description copied from interface: IConfig

Legacy method that calls IConfig.resolve(String, Features, Set, StringBuffer, boolean, boolean) with resolveHasPlugin equal to true.

Specified by:

resolve in interface IConfig

Parameters:

mid - The module name to resolve

features - Features that are defined in the request

dependentFeatures - Output - Set of feature names that the returned value is conditioned on. Used for cache management.

sb - If not null, then a reference to a string buffer that can be used to specify debug/diagnostic information about the module name resolution. For example, the resolver may indicate that alias resolution was not performed due to a missing required feature.

resolveAliases - If true, then module name aliases will be resolved

Returns:

the resolved module name

resolve

public String resolve(String mid,
             Features features,
             Set<String> dependentFeatures,
             StringBuffer sb,
             boolean resolveAliases,
             boolean evaluateHasPluginConditionals)

Description copied from interface: IConfig

Resolves a module id by applying the following mappings in the indicated order.

• If resolveAliases is true, then call any alias resolvers to resolve module name aliases
• If the module id specifies a has plugin and the has feature(s) are contained in the feature set provided in the request, then evaluate the has plugin expression to obtain the mapped module id.
• If the module id matches a package name, then map to the package main module id.

Specified by:

resolve in interface IConfig

Parameters:

mid - The module name to resolve

features - Features that are defined in the request

dependentFeatures - Output - Set of feature names that the returned value is conditioned on. Used for cache management.

sb - If not null, then a reference to a string buffer that can be used to specify debug/diagnostic information about the module name resolution. For example, the resolver may indicate that alias resolution was not performed due to a missing required feature.

resolveAliases - If true, then module name aliases will be resolved

evaluateHasPluginConditionals - If true, then attempt to evaluate the has plugin conditionals using the features provided in features, potentially eliminating the has! loader plugin from the returned value if all features can be resolved. If false, then the conditionals are retained in the result, although the expression may change if new conditionals are introduced by alias resolution.

Returns:

The resolved module id. If the module id is unchanged, then name should be returned.

resolveHasPlugin

protected String resolveHasPlugin(String expression,
                      Features features,
                      Set<String> dependentFeatures,
                      boolean resolveAliases,
                      boolean evaluateHasPluginConditionals,
                      int recursionCount,
                      StringBuffer sb)

Resolves has! loader plugin expressions by calling _resolve() on each of the modules named in the expression. Optionally evaluates the feature conditionals in the expression, potentially simplifying or eliminating the conditionals.

Parameters:

expression - The expression to resolve, excluding the has plugin name (e.g. feature?moduleA:moduleB)

features - Features that are defined in the request

dependentFeatures - Output - Set of feature names that the returned value is conditioned on. Used for cache management.

resolveAliases - If true, then module name aliases will be resolved

evaluateHasPluginConditionals - If true, then attempt to evaluate the has plugin conditionals using the features provided in features, potentially eliminating the has! loader plugin from the returned value if all features can be resolved. If false, then the conditionals are retained in the result, although the expression may change if new conditionals are introduced by alias resolution.

sb - If not null, then a reference to a string buffer that can be used by the resolver to indicate debug/diagnostic information about the alias resolution. For example, the resolver may indicate that alias resolution was not performed due to a missing required feature.

recursionCount - Counter used to guard against runaway recursion

Returns:

The module id with has! loader plugin resolved, or mid if the features specified by the loader plugin are not defined.

_resolve

protected String _resolve(String name,
              Features features,
              Set<String> dependentFeatures,
              boolean resolveAliases,
              boolean evaluateHasPluginConditionals,
              int recursionCount,
              StringBuffer sb)

Resolves a module id by applying alias resolution and has! loader plugin resolution.

Parameters:

name - The module name to map. May specify plugins

features - Features that are defined in the request

dependentFeatures - Output - Set of feature names that the returned value is conditioned on. Used for cache management.

resolveAliases - If true, then module name aliases will be resolved

evaluateHasPluginConditionals - If true, then attempt to evaluate the has plugin conditionals using the features provided in features, potentially eliminating the has! loader plugin from the returned value if all features can be resolved. If false, then the conditionals are retained in the result, although the expression may change if new conditionals are introduced by alias resolution.

recursionCount - Counter used to guard against runaway recursion

sb - If not null, then a reference to a string buffer that can be used by the resolver to indicate debug/diagnostic information about the alias resolution. For example, the resolver may indicate that alias resolution was not performed due to a missing required feature.

Returns:

The resolved module id.

resolveAliases

protected String resolveAliases(String name,
                    Features features,
                    Set<String> dependentFeatures,
                    StringBuffer sb)

Applies alias mappings to a module name. The name is expected to not specify a loader plugin, however, mapping may introduce a loader plugin.

Parameters:

name - The module name to map. May specify plugins

features - Features that are defined in the request

dependentFeatures - Output - Set of feature names that the returned value is conditioned on. Used for cache management.

sb - If not null, then a reference to a string buffer that can be used by the resolver to indicate debug/diagnostic information about the alias resolution. For example, the resolver may indicate that alias resolution was not performed due to a missing required feature.

Returns:

The module name with alias mappings applied, or name if there is not mapping for this module name.

loadConfigUri

protected URI loadConfigUri()
                     throws URISyntaxException,
                            FileNotFoundException

Initializes and returns the URI to the server-side config JavaScript

Returns:

The config URI

Throws:

URISyntaxException

FileNotFoundException

loadBaseURI

protected IConfig.Location loadBaseURI(org.mozilla.javascript.Scriptable cfg)
                                throws URISyntaxException

Initializes and returns the base URI specified by the "baseUrl" property in the server-side config JavaScript

Parameters:

cfg - the parsed config JavaScript

Returns:

the base URI

Throws:

URISyntaxException

loadConfig

protected org.mozilla.javascript.Scriptable loadConfig(InputStream in)
                                                throws MalformedURLException,
                                                       IOException

Throws:

MalformedURLException

IOException

processConfig

protected String processConfig(String configScript)

Add any processing logic to the config file like replacing any place holders from a properties file. This method is provided for subclasses to override

Parameters:

configScript - The javascript config as a text string

Returns:

the processed config script

loadConfig

protected org.mozilla.javascript.Scriptable loadConfig(String configScript)
                                                throws IOException

Loads the config JavaScript and returns the parsed config in a Map

Parameters:

configScript - The javascript config as a text string

Returns:

the parsed config in a properties map

Throws:

IOException

loadPackages

protected Map<String,IConfig.IPackage> loadPackages(org.mozilla.javascript.Scriptable cfg)
                                             throws URISyntaxException

Initializes and returns the map of packages based on the information in the server-side config JavaScript

Parameters:

cfg - The parsed config JavaScript as a properties map

Returns:

the package map

Throws:

URISyntaxException

loadPaths

protected Map<String,IConfig.Location> loadPaths(org.mozilla.javascript.Scriptable cfg)
                                          throws URISyntaxException

Initializes and returns the map of paths based on the information in the server-side config JavaScript

Parameters:

cfg - The parsed config JavaScript as a properties map

Returns:

the map of path-name/path-URI pairs

Throws:

URISyntaxException

loadAliases

protected List<IConfig.IAlias> loadAliases(org.mozilla.javascript.Scriptable cfg)
                                    throws IOException

Initializes and returns the list of aliases defined in the server-side config JavaScript

Parameters:

cfg - The parsed config JavaScript as a properties map

Returns:

the list of aliases

Throws:

IOException

loadDeps

protected List<String> loadDeps(org.mozilla.javascript.Scriptable cfg)

Initializes and returns the list of module dependencies specified in the server-side config JavaScript.

Parameters:

cfg - The parsed config JavaScript as a properties map

Returns:

the list of module dependencies

loadExpires

protected int loadExpires(org.mozilla.javascript.Scriptable cfg)

Initializes and returns the expires time from the server-side config JavaScript

Parameters:

cfg - The parsed config JavaScript as a properties map

Returns:

the expires time

loadDepsIncludeBaseUrl

protected boolean loadDepsIncludeBaseUrl(org.mozilla.javascript.Scriptable cfg)

Initializes and returns the flag indicating if files and directories located under the base directory should be scanned for javascript files when building the module dependency mappings. The default is false.

Parameters:

cfg - The parsed config JavaScript as a properties map

Returns:

true if files and folder under the base directory should be scanned

loadCoerceUndefinedToFalse

protected boolean loadCoerceUndefinedToFalse(org.mozilla.javascript.Scriptable cfg)

Initializes and returns the flag indicating if features not specified in the feature set from the request should be treated as false when evaluating has conditionals in javascript code. The default is false.

Parameters:

cfg - The parsed config JavaScript as a properties map

Returns:

True if un-specified features should be treated as false.

loadNotice

protected String loadNotice(org.mozilla.javascript.Scriptable cfg)
                     throws IOException,
                            URISyntaxException

Initializes and returns the notice string specified by the notice property in the server-side config JavaScript.

Parameters:

cfg - The parsed config JavaScript as a properties map

Returns:

the notice property value

Throws:

IOException

URISyntaxException

loadPluginDelegators

protected Set<String> loadPluginDelegators(org.mozilla.javascript.Scriptable cfg,
                               String name)

Common routine to load text or js plugin delegators

Parameters:

cfg - the config object as a Scriptable

name - the name of the plugin delegator selector

Returns:

the set of plugin delegators for the selector

loadTextPluginDelegators

protected Set<String> loadTextPluginDelegators(org.mozilla.javascript.Scriptable cfg)

loadJsPluginDelegators

protected Set<String> loadJsPluginDelegators(org.mozilla.javascript.Scriptable cfg)

loadLocation

protected IConfig.Location loadLocation(Object locObj,
                            boolean isFolder)
                                 throws URISyntaxException

Throws:

URISyntaxException

loadCacheBust

protected String loadCacheBust(org.mozilla.javascript.Scriptable cfg)

Initializes and returns the string specified by the cacheBust property in the server-side config JavaScript.

Parameters:

cfg - The parsed config JavaScript as a properties map

Returns:

the cacheBust property value

loadDefaultFeatures

protected Map<String,Object> loadDefaultFeatures(org.mozilla.javascript.Scriptable cfg)

callConfigModifiers

protected void callConfigModifiers(org.mozilla.javascript.Scriptable rawConfig)

Calls the registered config modifiers to give them an opportunity to modify the raw config before config properties are evaluated.

Parameters:

rawConfig - The config object as a Scriptable.

callConfigScopeModifiers

protected void callConfigScopeModifiers(org.mozilla.javascript.Scriptable scope)

Calls the registered config scope modifiers to give them an opportunity to prepare the scope object prior to evaluating the config JavaScript

Parameters:

scope - The object representing the execution scope for the evaluation.

toString

public String toString()

Description copied from interface: IConfig

Returns the stringized source code representation of the raw config returned by IConfig.getRawConfig(). Changes in this string may be used to track config changes. This method is preferable to using IConfig.lastModified() because external factors besides the config file (such as changes in the values of string substitution variables) may result in config changes.

Specified by:

toString in interface IConfig

Overrides:

toString in class Object

Returns:

The stringized JavaScript source representation of the current config

getProperty

public Object getProperty(String propname,
                 Class<?> hint)

Description copied from interface: IConfig

Returns the value of the named config property. If the value is not a primitive type (String, Number, Boolean), then this function will attempt to convert the property value to the class specified by hint.

The value returned may be one of the following:

• Boolean
• Number
• String
• An implementation specific representation of the value native to the config processor if the value is not one of the above and hint is null
• An object of the type specified by hint if the value can be converted
• null, if the value is null or undefined
• IConfig.NOT_FOUND

Specified by:

getProperty in interface IConfig

Parameters:

propname - the name of the config property

hint - the class to try to convert the value to if not a primitive type

Returns:

the value of the property (may be null).

optionsUpdated

public void optionsUpdated(IOptions options,
                  long sequence)

Description copied from interface: IOptionsListener

This method is called when the options are loaded/changed.

Specified by:

optionsUpdated in interface IOptionsListener

Parameters:

options - The new options. Note that changes to the options may occur in-place, using the same IOptions object with updated values, or may result in a new object instance. This interface does not specify which approach is used by an implementation.

sequence - The sequence number. Notifications for different listener events (options, config, dependencies) that have the same cause have the same sequence number. The sequence number is incremented for subsequent event causes, but there is no guarantee about the the values for subsequent notifications other than that they will be increasing.

shutdown

public void shutdown(IAggregator aggregator)

Description copied from interface: IShutdownListener

This method is called from within the aggregator's GenericServlet.destroy() method to notify listeners that the servlet is shutting down.

Specified by:

shutdown in interface IShutdownListener

Parameters:

aggregator - The aggregator that is shutting down

registerServices

protected void registerServices()

toString

public static String toString(Object obj)

newGetPropertyFunction

protected com.ibm.jaggr.core.impl.config.ConfigImpl.GetPropertyFunction newGetPropertyFunction(org.mozilla.javascript.Scriptable scriptable,
                                                                                   IAggregator aggregator)

newHasFunction

protected com.ibm.jaggr.core.impl.config.ConfigImpl.HasFunction newHasFunction(org.mozilla.javascript.Scriptable scriptable,
                                                                   Features features)

newConsole

protected ConfigImpl.Console newConsole()

newPackage

protected IConfig.IPackage newPackage(Object obj)
                               throws URISyntaxException

Throws:

URISyntaxException

newAlias

protected IConfig.IAlias newAlias(Object pattern,
                      Object replacement)