com.ibm.jaggr.core.impl.deps

Class DependenciesImpl

java.lang.Object

com.ibm.jaggr.core.impl.deps.DependenciesImpl

All Implemented Interfaces:

IConfigListener, IDependencies, IShutdownListener, IOptionsListener

public class DependenciesImpl
extends Object
implements IDependencies, IConfigListener, IOptionsListener, IShutdownListener

Field Summary

Fields inherited from interface com.ibm.jaggr.core.deps.IDependencies

defaultNonJSExtensions, excludes, nonJSExtensionsCfgPropName

Constructor Summary

Constructors

Constructor and Description
DependenciesImpl(IAggregator aggregator, long stamp)

Method Summary

Methods

Modifier and Type	Method and Description
void	configLoaded(IConfig config, long sequence) This method is called when the config is loaded/reloaded, after the config has been modified by any registered IConfigModifier services.
protected IAggregator	getAggregator()
List<String>	getDelcaredDependencies(String mid) Returns the dependencies for the specified module.
Iterable<String>	getDependencyNames() Returns an Iterable over the module names that were scanned while building the dependency map.
List<String>	getDependentFeatures(String mid) Returns the list of dependent features for the specified module.
long	getLastModified() Returns the cumulative last-modified date of these dependencies which was determined the last time the dependencies were created or validated.
List<String>	getRequireDependencies(String mid) Returns the list of modules specified in the dependency lists of any require calls contained within the specified module.
URI	getURI(String mid) Returns the resource URI for the specified module id.
void	optionsUpdated(IOptions options, long sequence) This method is called when the options are loaded/changed.
protected void	processDeps(boolean validate, boolean clean, long sequence)
protected void	processDepsAsyncWorker(boolean validate, boolean clean, long sequence, ConsoleService cs)
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.
void	validateDeps(boolean clean) Validates the dependency graph by scanning the directories returned by IConfig.getPaths() and IConfig.getPackageLocations() looking for new/changed/removed files and updating the dependency graph, including the dependency graph last-modified timestamp, as needed.

Methods inherited from class java.lang.Object

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

Constructor Detail

DependenciesImpl

public DependenciesImpl(IAggregator aggregator,
                long stamp)

Method Detail

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

getAggregator

protected IAggregator getAggregator()

validateDeps

public void validateDeps(boolean clean)

Description copied from interface: IDependencies

Validates the dependency graph by scanning the directories returned by IConfig.getPaths() and IConfig.getPackageLocations() looking for new/changed/removed files and updating the dependency graph, including the dependency graph last-modified timestamp, as needed.

Specified by:

validateDeps in interface IDependencies

Parameters:

clean - If true, then any cached or previously calculated dependency graph is discarded and a new graph is generated from scratch. Use this option if file or directory last-modified dates cannot be relied upon to accurately reflect the changed state of the module files included in the graph.

configLoaded

public void configLoaded(IConfig config,
                long sequence)

Description copied from interface: IConfigListener

This method is called when the config is loaded/reloaded, after the config has been modified by any registered IConfigModifier services.

Specified by:

configLoaded in interface IConfigListener

Parameters:

config - The new config object. In order to detect and react to config changes, you can save the value returned from IConfig.toString() and compare it with the value returned in subsequent configLoaded events.

sequence - The sequence number. Notifications for different listener events (options, config, dependencies) that have the same cause have the same sequence number. Notifications resulting from servlet initialization have the sequence number 1. 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.

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.

getLastModified

public long getLastModified()

Description copied from interface: IDependencies

Returns the cumulative last-modified date of these dependencies which was determined the last time the dependencies were created or validated. In general, changes to source files which do not affect the dependencies do not cause this value to be updated, however, the addition or removal of dependencies within a dependent file cause the value returned from this method to reflect the most recent last-modified date of those files containing such changes at the time that they are detected.

Specified by:

getLastModified in interface IDependencies

Returns:

The cumulative last modified date of the module dependencies

processDeps

protected void processDeps(boolean validate,
               boolean clean,
               long sequence)

processDepsAsyncWorker

protected void processDepsAsyncWorker(boolean validate,
                          boolean clean,
                          long sequence,
                          ConsoleService cs)
                               throws Exception

Throws:

Exception

getDelcaredDependencies

public List<String> getDelcaredDependencies(String mid)
                                     throws ProcessingDependenciesException

Description copied from interface: IDependencies

Returns the dependencies for the specified module. This is the list of modules listed in the module's define function. The module ids are normalized to remove relative paths.

Specified by:

getDelcaredDependencies in interface IDependencies

Parameters:

mid - The module id

Returns:

An unmodifiable list of explicitly specified dependent modules, or null if the specified module was not found when the dependencies were processed.

Throws:

ProcessingDependenciesException

getRequireDependencies

public List<String> getRequireDependencies(String mid)
                                    throws ProcessingDependenciesException

Description copied from interface: IDependencies

Returns the list of modules specified in the dependency lists of any require calls contained within the specified module. If the specified module does not contain any require calls, then an empty list is returned.

Note that no attempt is made to determine if the require call will ever be executed by the client by looking for dead code, etc. Any require calls that appear within the module will be used in collecting require dependencies.

Specified by:

getRequireDependencies in interface IDependencies

Parameters:

mid - The module id

Returns:

An unmodifiable list of require call dependencies, or null if the specified module was not found when the dependencies were processed.

Throws:

ProcessingDependenciesException

getURI

public URI getURI(String mid)
           throws ProcessingDependenciesException

Description copied from interface: IDependencies

Returns the resource URI for the specified module id. Module ids returned by IDependencies.getDependencyNames() will return a non-null value. Any other value passed for mid will result in a return value of null.

Specified by:

getURI in interface IDependencies

Parameters:

mid - the module id

Returns:

the resource URI for the module, or null

Throws:

ProcessingDependenciesException

getDependentFeatures

public List<String> getDependentFeatures(String mid)
                                  throws ProcessingDependenciesException

Description copied from interface: IDependencies

Returns the list of dependent features for the specified module. This includes features specified as string literals in has() function calls, as well as features specified using a has! loader plugin in require and define dependency lists.

Note that not all feature names used in has() function calls may be returned in this list. Only features that are used in has() function calls who's return value is used as a boolean are included (e.g. if (has('isIE')) { ). If the result of the has function call is used as another type, then the feature may not be be included in the returned list (e.g. var isIE = has('isIE'); or if (has('isIE') < 8) { ). This is because feature values are specified in aggregator requests as booleans, so aggregator optimizations based on defined features may not be safely performed if the result of a feature evaluation is used as a type other than boolean.

Specified by:

getDependentFeatures in interface IDependencies

Parameters:

mid - the module id

Returns:

an unmodifiable list of the dependent features, or null if the specified module was not found when the dependencies were processed.

Throws:

ProcessingDependenciesException

getDependencyNames

public Iterable<String> getDependencyNames()
                                    throws ProcessingDependenciesException

Description copied from interface: IDependencies

Returns an Iterable over the module names that were scanned while building the dependency map. This includes JavaScript modules as well as selected non-JavaScript modules.

Non-JavaScript modules included in the result include the following:

• modules with extensions specified in IDependencies.defaultNonJSExtensions
• modules with extensions specified in the server-side config property named IDependencies.nonJSExtensionsCfgPropName
• modules with extensions specified by the IModuleBuilderExtensionPoint.EXTENSION_ATTRIBUTE config property for the registered module builders

Only JavaScript modules have dependencies. If a non-JavaScript module included in the result is passed to IDependencies.getDelcaredDependencies(String) or IDependencies.getDependentFeatures(String), an empty list will be returned.

Specified by:

getDependencyNames in interface IDependencies

Returns:

the module names in the dependency map.

Throws:

ProcessingDependenciesException