Skip to content
This repository has been archived by the owner on Jan 22, 2024. It is now read-only.

Servlet Query Args (Pre 1.2)

Chuck Dumont edited this page Jun 24, 2015 · 5 revisions

This section describes the URL query args that are honored by the Aggregator servlet for versions of the Aggregator before 1.2.

In general, the core Aggregator does not know anything about URL query args. The Aggregator relies on extensions implementing the com.ibm.jaggr.service.httptransport extension point to translate URL query args into request attributes defined by the com.ibm.jaggr.service.transport.IHttpTransport interface. In addition, module builders (extensions implementing the com.ibm.jaggr.service.modulebuilder extension point) may support additional query args. The table below indicates which extension implements support for which query args.

Some query args have short-name aliases that are used by the transport when it generates a request in order to conserve URL space. If a query arg has a short-name alias, it is listed below the long name version in the first column.

Arg name Description implementing extension id
modules Specifies the list of modules being requested. This may be either a simple list of comma delimited names, or an encoded list which utilizes path folding in order to conserve URL space. The former is utilized by consumers when specifying the initial list of modules that include the AMD loader. The latter is used by the transport when requesting modules on behalf of the AMD loader. dojo.httptransport
count Specifies the number of modules being requested Only needed when modules specifies an encoded (path folded) list of module names. dojo.httptransport
has Specifies the comma delimited list of feature names. If the feature is true on the client, then the feature name is specified unadorned.  If the feature is false on the client, then the feature name is preceded by a "!" character. Used only for application generated requests. dojo.httptransport

hasBranching

alias=hb

This query arg corresponds to the hasBranching loader extension config property. Values may be one of true, false, 1 or 0. dojo.httptransport
hashash Specifies the MD5 hash of the feature set when the feature set is provided in the has cookie. See Sending the feature list in a cookie. dojo.httptransport

optimize

alias=opt

This query arg corresponds to the optimize loader extension config property. Values may be one of simple, whitespace, or none. dojo.httptransport

expandRequire

alias=re

This query arg corresponds to the expandRequire loader extension config property. Values may be one of true, false, 1 or 0. dojo.httptransport

exportNames

alias=en

This query arg corresponds to the exportNames loader extension config property. Values may be one of true, false, 1 or 0. dojo.httptransport

showFilenames

alias=fn

This query arg corresponds to the showFilenames loader extension config property. Values may be one of true, false, 1 or 0. dojo.httptransport

noCache

alias=nc

This query arg corresponds to the noCache loader extension config property. Values may be one of true, false,1 or 0. dojo.httptransport
require Specifies a comma delimited list of module names. These modules, together with the modules' dependencies, will be included in the response. Modules that specify a loader plugin will be included in the response if the plugin is the has! or text! loader plugin, or the plugin is listed in the textPluginDelegators or jsPluginDelegators properties in the Server-Side AMD Config file.

Note that unlike require list expansion, which only expands the dependency list of a require function call, expanded dependencies of modules specified by the required query arg are actually included in-line in the response. Any modules not included in the response will be loaded using separate, loader generated, aggregator requests.

This feature is provided for use by application generated URLs that load the AMD loader and loader config. It is never used in Aggregator generated URLs. Its purpose is to provide the ability to load, together with the loader itself, a bootstrap layer of modules for the application.

The required modules, and their expanded dependencies, will be added to the response following any modules specified using the modules query arg. The general pattern is to specify non-AMD modules such as the loader and loader config using modules and the initially required AMD modules using required in the same application generated URL.

dojo.httptransport
configVarName Specifies the name of the config var used for the loader config. The default is require. This parameter may be used to specify an alternate config var name if something other than require is used. This information is needed only for the initial request that loads the loader config and the loader. It is used to help the Aggregator locate the loader config deps property so that it can expand the module list specified in the deps property to include nested dependencies. See Require list expansion for more details.  
inlineImports A debugging aid to disable inlining of CSS imports for the request. See CSS Optimizations. Values may be one of true, false, 1 or 0, although specifying true or 1has the same effect as not specifying anything.

default.modulebuilders

(CSSModuleBuilder)

inlineImages A debugging aid to disable inlining of images in CSS files for the request. See CSS Optimizations Values may be one of true,false, 1 or 0, although specifying true or 1 has the same effect as not specifying anything.

default.modulebuilders

(CSSModuleBuilder)