-
Notifications
You must be signed in to change notification settings - Fork 200
Module Java JSON Client
The Java JSON client module generates the client-side libraries that will access the JSON Web service API using Jackson 2.
The Java JSON client module is configured by the java-json-client 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. |
disableCompile |
The "disableCompile" attribute prevents Enunciate from compiling its generated client source files. |
bundleSourcesWithClasses |
The "bundleSourcesWithClasses" attribute indicates whether the sources and classes should be bundled together in a single jar. |
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. |
javac-source |
The "-source" Javac parameter used to compile the JSON client. Default: "1.5". |
javac-target |
The "-target" Javac parameter used to compile the JSON client. Default: "1.5". |
The java-json-client element supports the following child elements:
The "package-conversions" subelement of the "java-json-client" 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.
An arbitrary number of "server-side-type" elements are allowed as child elements of the "java-json-client" element. The "server-side-type" element can be used to specify a server-side type that is to be ported directly over to the client-side library (as opposed to generating the client-side type from the server-side type). This can be useful to provide more useful client-side capabilities, but requires that there be no package conversions for types and web faults.
The "server-side-type" element supports one attribute, "pattern" that defines an ant-style pattern of the type(s) that are to be included (using a '.' for separating the package name).
Facet configuration for the module. See Facets.
(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.