XFire Client Module
The XFire client deployment module generates the client-side libraries that will access the deployed web app using XFire.
The order of the XFire client deployment module is 0, as it doesn't depend on any artifacts exported by any other module.
Steps
generate
The "generate" step is by far the most intensive and complex step in the execution of the XFire client module. The "generate" step generates all source code for accessing the deployed API.
There XFire client deployment module currently generates code compatible with the JDK 1.4 and above as well as code for Java 5 and above. The only difference between the two libraries is that the Java 5 libraries take advantage of the newest Java 5 constructs, including typesafe enums and generics. The logic of serialization/deserialization is the same between the two libraries.
For more information about the XFire client libraries, see the Javadoc API for the XFire client tools.
compile
During the "compile" step, the XFire client module compiles the code that was generated.
build
The "build" step assembles the classes that were assembled into a jar. It also creates a source jar for the libraries.
Configuration
The XFire client module is configured by the "xfire-client" element under the "modules" element of the enunciate configuration file. It supports the following attributes:
- 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 label, or a default will be supplied.
The "package-conversions" element
The "package-conversions" subelement of the "xfire-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.
Artifacts
The XFire client deployment module exports the following artifacts:
- The JDK 1.4 libraries and sources are exported under the id "client.jdk14.library". (Note that this is a bundle, so if exporting to a directory multiple files will be exported. If exporting to a file, the bundle will be zipped first.)
- The JDK 1.5 libraries and sources are exported under the id "client.jdk15.library". (Note that this is a bundle, so if exporting to a directory multiple files will be exported. If exporting to a file, the bundle will be zipped first.)