Module GWT JSON Overlay

GWT JSON Overlay Module

The GWT JSON Overlay module generates the GWT JSON Overlays that will access the JSON Web service API using GWT.

Configuration

The GWT JSON Overlay module is configured by the gwt-json-overlay element under the modules element of the enunciate configuration file. It supports the following attributes:

attribute	description
slug	The "slug" attribute is used to determine the name of the client-side artifact files. The default is the Enunciate project slug.
jarName	The "jarName" attribute specifies the name of the jar file(s) that are to be created. If no jar name is specified, the name will be calculated from the enunciate slug, or a default will be supplied.
groupId	The "groupId" attribute specifies the Maven groupId associated with this artifact, currently used for documentation purposes only.
artifactId	The "artifactId" attribute specifies the Maven artifactId associated with this artifact, currently used for documentation purposes only.
version	The "version" attribute specifies the Maven version associated with this artifact, currently used for documentation purposes only.

Elements

The gwt-json-overlay element supports the following child elements:

package-conversions

The "package-conversions" subelement of the "gwt-json-overlay" element is used to map packages from the original API packages to different package names. This element supports an arbitrary number of "convert" child elements that are used to specify the conversions. These "convert" elements support the following attributes:

• The "from" attribute specifies the package that is to be converted. This package will match all classes in the package as well as any subpackages of the package. This means that if "org.enunciate" were specified, it would match "org.enunciate", "org.enunciate.api", and "org.enunciate.api.impl".
• The "to" attribute specifies what the package is to be converted to. Only the part of the package that matches the "from" attribute will be converted.

facets

Facet configuration for the module. See Facets.

manifest

(Since 2.13.)

A "manifest" element allows configuration of entries in the manifest of the generated jar.

The "manifest" element allows multiple child elements "entry" that each support a "name" and a "value" pattern to configure the manifest entries.