The Enunciate configuration schema. This is provided primarily for documentation purposes and to support code editors that support XML schema validation. When Enunciate parses the configuration file, there is no validation performed. This is because Enunciate can be extended with other modules that might have additional configuration options not shown in this schema. The root "enunciate" element for the configuration. Used to define a custom validator to use to validate the web service declarations. Used to disable a rule on the validator. The set of facets to include/exclude. The set of classes to include/exclude. Used to define the deployment configuration. Custom configuration for specific services. servlet filter to apply to all web service requests. resources to copy to the war. Include filter for including/excluding libs Exclude filter for including/excluding libs resource-env-ref to add to the web.xml resource-ref to add to the web.xml env to add to the web.xml war manifest configuration Whether to disable the assembly of the web application. specifies the name of the war Whether Enunciate should take on the responsibility of compiling the server-side classes. This may not be desired if Enunciate is being used only for generating the war structure and configuration files. Whether Enunciate should take on the responsibility of copying libraries to WEB-INF/lib. This may not be desired if the Enunciate is being used only for generating the war structure and configuration files. whether Enunciate should take on the responsibility of packaging (zipping) up the war. This may not be desired if Enunicate is being used only for generating the war structure and configuration files. specifies the XSLT tranform file that the web.xml file will pass through before being copied to the WEB-INF directory. No tranformation will be applied if none is specified. the URL to an XSLT tranform that the web.xml file will pass through before being copied to the WEB-INF directory. No tranformation will be applied if none is specified. specifies the web.xml file that is to be merged into the Enunciate-generated web.xml file. No file will be merged if none is specified. the URL to a web.xml file that is to be merged into the Enunciate-generated web.xml file. No file will be merged if none is specified. a directory (could be gzipped) that supplies a "base" for the war. The directory contents will be copied to the building war directory BEFORE it is provided with any Enunciate-specific files and directories. a directory (could be gzipped) that supplies a "base" for the war. The directory contents will be copied to the building war directory AFTER it is provided with any Enunciate-specific files and directories. whether Enunciate will use the libraries from the classpath for applying the include/exclude filters. If "false" only the libs explicitly included by file (see below) will be filtered. whether Enunciate should perform its default filtering of known compile-time-only jars. Custom configuration for SOAP services. Custom configuration for REST services. Custom configuration for a specific soap service. Set of namespace declarations. A namespace declaration. The id is the prefix that will be used as needed. Set of namespace declarations. A content-type declaration. An annotation that is treated as a custom resource parameter annotation. The JAXB imports allow external dependencies on JAXB types. Set of additional api classes to be Enunciated. Set of modules to use to enunciate the web API. used to enable/disable mounting the JAX-RS resources at the rest subcontext. used to enable/disable path-based conneg Configuration for the Spring App module. spring import file for defining your own beans spring AOP interceptor to apply to all services handler interceptor additional handler mappings FQN of the class to use as the Spring context loader listener the name of the Enunciate-generated application context file. the value of the contextConfigLocation init parameter supplied to the Spring ContextLoaderListener. The spring version to target. If none is specified, an attempt will be made to autodect. Configuration for the Jersey module The init parameters to apply to the jersey servlet. used to enable/disable mounting the JAX-RS resources at the rest subcontext. used to enable/disable path-based conneg used to enable/disable the Enunciate "wildcard" resource check. The fully-qualified classname of an instance of com.sun.jersey.core.spi.component.ioc.IoCComponentProviderFactory that jersey will use. his namespace will have no prefix during XML serialization. The fully-qualified classname of an instance of the implementation of jakarta.ws.rs.core.Application that jersey will use. The GWT module configuration. Used to configure the webapp that will host the AMF endpoints and Flex applications the subcontext at which the gwt endpoints will be mounted the directory in the war to which the GWT applications will be put. The default is the root of the war. The GWT module supports the development of GWT apps that can be compiled and packaged with the generated Enunciate app. the name of the module. This is usually of the form "com.mycompany.MyModule" and it always has a corresponding ".gwt.xml" module file. where the compiled module will be placed, relative to the application directory. By default, the outputPath is the empty string (""), which means the compiled module will be placed at the root of the application directory. the (usually HTML) page to open when invoking the shell for this module (used to generate the shell script). By default, the shell page is the [moduleId].html, where [moduleId] is the (short, unqualified) name of the module. name of the GWT app source directory for the application the JavaScript style that is to be applied by the GWTCompiler additional JVM parameters that will be used when invoking GWTCompile. additional arguments that will be passed to the GWT compiler. The filesystem path to the GWT home directory. The name of the generated GWT rpc module. Set the version of GWT Enunciate will target for compiling purposes. Whether to generate JSON overlays (default:false) The name of the client jar. The GWT compiler class. Enunciate will determine the correct class based on the GWT version. The GWT subcontext. The "useWrappedServices" attribute specifies whether to use wrapped GWT client services. This is an artifact from when GWT 1.4 was supported and the generic types were unavailable. Whether to enforce namespace conformace on the server-side classes. Whether to enforce that field accessors can't be used. Whether the client jar is downloadable. The "label" attribute specifies a label for the generated GWT client filenames. By default, the label is determined by the Enunciate project label. The documentation deployment module is responsible for generating the documentation for the API. This includes both the HTML pages and any other static content put at the root of the web application. used to indicate another file or Enunciate artifact that is to be included in the "downloads" page. a name for the download the id of an Enunciate artifact that is to be included as a download. a file on the filesystem that is to be included as a download. This attribute is ignored if the "artifact" attribute is set a description of the download. This attribute is ignored if the "artifact" attribute is set. Adds an additional css to the generated documentation, e.g. to override existing styles. a file on the filesystem that is to be included as an additional css. The directory in the war to which the documentation will be put. The default is the root. the package that contains the documentation to use as the introduction to the API documentation. By default, no text is used for the introduction. the text for the copyright holder on the web page. By default, there is no copyright information displayed on the webpage. the title of the generated HTML pages. By default, the title is "Web API". whether the default downloads should be included. whether example XML should be included. whether example JSON should be included. Whether to force example JSON. Default is to allow it only if Jackson is available on the classpath. the file to be used as the cascading stylesheet for the HTML. If one isn't supplied, a default will be provided. The name of the index page. the file that is the XML Stylesheet Transform that will be applied to the documentation XML to generate the HTML docs. If no XSLT is specified, the freemarker XML processing template will be used to process the XML. the URL to the XML Stylesheet Transform that will be applied to the documentation XML to generate the HTML docs. If no XSLT is specified, the freemarker XML processing template will be used to process the XML. the file that is the freemarker XML processing template to use to generate the site. If none is supplied, a default one will be used. See http://freemarker.sourceforge.net/docs/xgui.html. the URL to the freemarker XML processing template to use to generate the site. If none is supplied, a default one will be used. See http://freemarker.sourceforge.net/docs/xgui.html. specifies a gzipped file or a directory to use as the documentation base. If none is supplied, a default base will be provided. Whether to apply a filter for the WSDL files that will attempt to resolve the soap paths dynamically. Whether to disable the REST mountpoint documentation. The default namespace for the purposes of generating documentation. How to group the REST resources together. The AMF module configuration. Used to configure the webapp that will host the AMF endpoints and Flex applications the subcontext at which the amf endpoints will be mounted the directory in the war to which the flex applications will be put. The default is the root of the war. used to configure the compiler that will be used to compile the SWC and the Flex applications. The attributes associate directly to the Flex compiler options. For details, see the documentation for the Flex compiler. additional JVM arguments, passed in order to the JVM used to invoke the compiler additional compiler arguments, passed in order to the compiler The AMF module supports the development of Flex apps that can be compiled and packaged with the generated Enunciate app. name of the Flex app source directory for the application output directory for the application the main mxml file for the app. This attribute is required. The path to this file is resolved relative to the enunciate.xml file (not to the "srcDir" attribute of the app). The filesystem path to the Flex home directory. The "label" attribute specifies a label for the generated ActionScript client filenames. By default, the label is determined by the Enunciate project label. The "swcName" attribute specifies the name of the compiled SWC. By default, the name is determined by the Enunciate project label The "swcDownloadable" attribute specifies whether the generated SWC is to be made available as a download from the generated web application. The "asSourcesDownloadable" attribute specifies whether the generated ActionScript source code is available as a download from the generated web application. specifies the services-config.xml file that is to be merged into the Enunciate-generated services-config.xml file. No file will be merged if none is specified.