com.ibm.jaggr.core.transport

Interface IRequestedModuleNames

public interface IRequestedModuleNames

This interface encapsulates the modules specified in the request which should be included in the response. The response may also contain nested dependencies of these modules, depending upon configuration and options.

The result returned by the #toString() method is intended to be used as the cache key for layers matching the same requested modules and should not require decoding of the encoded modules names to produce.

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getDeps() Returns the list of modules specified by the deps request parameter.
List<String>	getExcludes() Returns the list of modules specified by the excludes request parameter.
List<String>	getModules() Returns the list of modules requested by the Aggregator.
List<String>	getPreloads() Returns the list of modules specified by the preloads request parameter.
List<String>	getScripts() Returns the list of script modules specified by the scripts request parameter.
String	toString(boolean decode) Returns a string representation of this object.

Method Detail

getModules

List<String> getModules()
                        throws BadRequestException

Returns the list of modules requested by the Aggregator. These are modules requested by Aggregator generated requests and typically require decoding of the request information. As a performance optimization, the decoding of the request may be deferred until this method is called in attempts to try and avoid decoding if the request is already cached and the cached layer can be located using the value returned by #toString().

Returns:

the requested modules.

Throws:

BadRequestException

getDeps

List<String> getDeps()
                     throws BadRequestException

Returns the list of modules specified by the deps request parameter. Deps are specified in application generated requests to load a server-expanded layer. Dep modules are included in the layer and are automatically required by the loader. The name of this property was chosen so as to mirror the deps AMD config property.

Returns:

the list of dep modules

Throws:

BadRequestException

getPreloads

List<String> getPreloads()
                         throws BadRequestException

Returns the list of modules specified by the preloads request parameter. Preloads are specified in application generated requests to load a server-expanded layer. Preload modules are included in the layer but are not activated until required by the application.

Returns:

the list of preload modules

Throws:

BadRequestException

getScripts

List<String> getScripts()
                        throws BadRequestException

Returns the list of script modules specified by the scripts request parameter. Script modules are specified in application generated requests to load a boot layer. Script modules are non-AMD modules that are included at the beginning of a layer. These typically include the AMD loader config, the Aggregator loader config extension and the AMD loader. It can also include any other non-AMD script files needed by the application, as long as the file can be located using the AMD configuration.

Returns:

the list of script modules

Throws:

BadRequestException

getExcludes

List<String> getExcludes()
                         throws BadRequestException

Returns the list of modules specified by the excludes request parameter. Excludes are specified in application generated requests to load a static layer. The excluded modules, and their expanded dependencies, will not be included in the aggregated response.

Returns:

the list of excluded modules

Throws:

BadRequestException

toString

String toString(boolean decode)

Returns a string representation of this object. Note that Object.toString() calls this method with decode equal to false.

Parameters:

decode - if true and the request was encoded, then the decoded names will be returned.

Returns:

a string representation of the requested modules.