Servlet Query Args

This section describes the URL query args that are honored by the Aggregator servlet, version 1.2 and greater. For pre-1.2 versions, see Servlet Query Args (Pre-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.core.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 are used only in application generated requests to load a boot layer while others are used only in loader generated requests to load additional modules. The comments in the table below indicate which apply. Loader generated requests employ various types of data encoding to conserve space, making it difficult or impossible for a human observer to decipher the request. A request decoder module is provided to allow for the decoding of loader generated requests on the client for diagnostic or debugging purposes.

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 and moduleIds	Together, these specify encodings of the modules being requested. Used only for loader generated requests.	dojo.httptransport
count	Specifies the number of modules requested by the modules and moduleIds query args. Used only for loader generated requets.	dojo.httptransport
scripts	Specifies a comma separated list of non-AMD script modules to include in the response. Typically used by application generated requests to load the loader config, the loader extension config, and the AMD loader, plus any other non-AMD script files that should be included in the application boot layer.	dojo.httptransport
deps	Specifies a comma separated list of AMD modules to include in the response. Used by application generated requests to specify the modules to include in the boot layer for the application. The specified modules, along with the expanded dependencies of the specified modules will be added to the boot layer, and a synthetic require call will be invoked to initialize the modules.	dojo.httptransport
preloads	Like deps, but these modules, along with their expanded dependencies, will not be initialized using a synthetic require call unless they are also direct or indirect dependencies of the modules specified in deps. Instead, they will reside in the loader's cache, uninitialized, until required ether explicitly, or implicitly by being a dependency of a module that has been required. This query arg is used only in application generated requests	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. Loader generated requests us the hasEnc query arg for this purpose.	dojo.httptransport
hasEnc	Specifies an encoded representation of the features defined on the client. The encoding is used to reduce the amount of space needed to represent the data. Used only by loader 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
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, 0, or log.	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
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)