Package io.quarkiverse.cxf.deployment

Interface CxfBuildTimeConfig.Wsdl2JavaParameterSet

Enclosing interface:
CxfBuildTimeConfig
public static interface CxfBuildTimeConfig.Wsdl2JavaParameterSet

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<List<String>>
    additionalParams()
    A comma separated list of additional command line parameters that should be passed to CXF `wsdl2java` tool along with the files selected by `includes` and `excludes`.
    Optional<List<String>>
    asyncMethods()
    A comma separated list of SEI methods for which asynchronous sibling methods should be generated; similar to `enableAsyncMapping` in a JAX-WS binding file This will be passed as option `-asyncMethods` to `wsdl2java`
    Optional<List<String>>
    bareMethods()
    A comma separated list of SEI methods for which wrapper style sibling methods should be generated; similar to `enableWrapperStyle` in JAX-WS binding file This will be passed as option `-bareMethods` to `wsdl2java`
    Optional<List<String>>
    bindings()
    A list of paths pointing at JAXWS or JAXB binding files or XMLBeans context files.
    String
    exceptionSuper()
    A fully qualified class name to use as a superclass for fault beans generated from `wsdl:fault` elements This will be passed as option `-exceptionSuper` to `wsdl2java`
    Optional<List<String>>
    excludeNamespaceUris()
    A comma separated list of WSDL schema namespace URIs to ignore when generating Java code.
    Optional<List<String>>
    excludes()
    A comma separated list of path patterns for selecting WSDL files which should *not* be processed with `wsdl2java` tool.
    Optional<List<String>>
    includes()
    A comma separated list of glob patterns for selecting WSDL files which should be processed with `wsdl2java` tool.
    Optional<List<String>>
    mimeMethods()
    A comma separated list of SEI methods for which `mime:content` mapping should be enabled; similar to `enableMIMEContent` in JAX-WS binding file This will be passed as option `-mimeMethods` to `wsdl2java`
    Optional<String>
    outputDirectory()
    A directory into which the generated files will be written, either absolute or relative to the current Maven or Gradle module directory.
    Optional<List<String>>
    packageNames()
    A comma separated list of tokens; each token can be one of the following: - A Java package under which the Java source files should be generated - A string of the form `namespaceURI=packageName` - in this case the entities coming from the given namespace URI will be generated under the given Java package.
    Optional<String>
    serviceName()
    The WSDL service name to use for the generated code.
    boolean
    validate()
    If `true`, WSDLs are validated before processing; otherwise the WSDLs are not validated.
    Optional<String>
    wsdlLocation()
    Specifies the value of the `@WebServiceClient` annotation's wsdlLocation property.
    Optional<List<String>>
    xjc()
    A comma separated list of XJC extensions to enable.

  • Method Details

    • includes

      Optional<List<String>> includes()
      A comma separated list of glob patterns for selecting WSDL files which should be processed with `wsdl2java` tool. The paths are relative to `src/main/resources` or `src/test/resources` directories of the current Maven or Gradle module. The glob syntax is specified in `io.quarkus.util.GlobUtil`. Examples: - `calculator.wsdl,fruits.wsdl` will match `src/main/resources/calculator.wsdl` and `src/main/resources/fruits.wsdl` under the current Maven or Gradle module, but will not match anything like `src/main/resources/subdir/calculator.wsdl` - `my-++*++-service.wsdl` will match `src/main/resources/my-foo-service.wsdl` and `src/main/resources/my-bar-service.wsdl` - `++**++.wsdl` will match any of the above There is a separate `wsdl2java` execution for each of the matching WSDL files. If you need different `additional-params` for each WSDL file, you may want to define a separate named parameter set for each one of them. Here is an example: [source,properties] ---- # Parameters for foo.wsdl quarkus.cxf.codegen.wsdl2java.foo-params.includes = wsdl/foo.wsdl quarkus.cxf.codegen.wsdl2java.foo-params.wsdl-location = wsdl/foo.wsdl # Parameters for bar.wsdl quarkus.cxf.codegen.wsdl2java.bar-params.includes = wsdl/bar.wsdl quarkus.cxf.codegen.wsdl2java.bar-params.wsdl-location = wsdl/bar.wsdl quarkus.cxf.codegen.wsdl2java.bar-params.xjc = ts ---- [NOTE] .File extensions ==== File extensions other than `.wsdl` will work during normal builds, but changes in the matching files may get overseen in Quarkus dev mode. We recommend that you always use the `.wsdl` extension. ==== There is no default value for this option, so `wsdl2java` code generation is disabled by default. Specifying `quarkus.cxf.codegen.wsdl2java.my-name.excludes` without setting any `includes` will cause a build time error. Make sure that the file sets selected by `quarkus.cxf.codegen.wsdl2java.includes` and `quarkus.cxf.codegen.wsdl2java.++[++whatever-name++]++.includes` do not overlap. Otherwise a build time exception will be thrown. The files from `src/main/resources` selected by `includes` and `excludes` are automatically included in native image and therefore you do not need to include them via `quarkus.cxf.wsdl-path` (deprecated) or `quarkus.native.resources.includes/excludes`.
      Since:
      2.0.0

    • excludes

      Optional<List<String>> excludes()
      A comma separated list of path patterns for selecting WSDL files which should *not* be processed with `wsdl2java` tool. The paths are relative to `src/main/resources` or `src/test/resources` directories of the current Maven or Gradle module. Same syntax as `includes`.
      Since:
      2.0.0

    • outputDirectory

      Optional<String> outputDirectory()
      A directory into which the generated files will be written, either absolute or relative to the current Maven or Gradle module directory. The default value is build tool dependent: for Maven, it is typically `target/generated-sources/wsdl2java`, while for Gradle it is `build/classes/java/quarkus-generated-sources/wsdl2java`. Quarkus tooling is only able to set up the default value as a source folder for the given build tool. If you set this to a custom path it is up to you to make sure that your build tool recognizes the path a as source folder. Also, if you choose a path outside `target` directory for Maven or outside `build` directory for Gradle, you need to take care for cleaning stale resources generated by previous builds. E.g. if you change the value of `package-names` option from `org.foo` to `org.bar` you need to take care for the removal of the removal of the old package `org.foo`. This will be passed as option `-d` to `wsdl2java`
      Since:
      2.6.0

    • packageNames

      Optional<List<String>> packageNames()
      A comma separated list of tokens; each token can be one of the following: - A Java package under which the Java source files should be generated - A string of the form `namespaceURI=packageName` - in this case the entities coming from the given namespace URI will be generated under the given Java package. This will be passed as option `-p` to `wsdl2java`
      Since:
      2.4.0

    • excludeNamespaceUris

      Optional<List<String>> excludeNamespaceUris()
      A comma separated list of WSDL schema namespace URIs to ignore when generating Java code. This will be passed as option `-nexclude` to `wsdl2java`
      Since:
      2.4.0

    • serviceName

      Optional<String> serviceName()
      The WSDL service name to use for the generated code. This will be passed as option `-sn` to `wsdl2java`
      Since:
      2.4.0

    • bindings

      Optional<List<String>> bindings()
      A list of paths pointing at JAXWS or JAXB binding files or XMLBeans context files. The path to be either absolute or relative to the current Maven or Gradle module. This will be passed as option `-b` to `wsdl2java`
      Since:
      2.4.0

    • validate

      @WithDefault("false") boolean validate()
      If `true`, WSDLs are validated before processing; otherwise the WSDLs are not validated. This will be passed as option `-validate` to `wsdl2java`
      Since:
      2.4.0

    • wsdlLocation

      Optional<String> wsdlLocation()
      Specifies the value of the `@WebServiceClient` annotation's wsdlLocation property. This will be passed as option `-wsdlLocation` to `wsdl2java`
      Since:
      2.4.0

    • xjc

      Optional<List<String>> xjc()
      A comma separated list of XJC extensions to enable. The following extensions are available through `io.quarkiverse.cxf:quarkus-cxf-xjc-plugins` dependency: - `bg` - generate `getX()` methods for boolean fields instead of `isX()` - `bgi` - generate both `isX()` and `getX()` methods for boolean fields - `dv` - initialize fields mapped from elements/attributes with their default values - `javadoc` - generates JavaDoc based on `xsd:documentation` - `property-listener` - add a property listener and the code for triggering the property change events to setter methods - `ts` - generate `toString()` methods - `wsdlextension` - generate WSDL extension methods in root classes These values correspond to `-wsdl2java` options `-xjc-Xbg`, `-xjc-Xbgi`, `-xjc-Xdv`, `-xjc-Xjavadoc`, `-xjc-Xproperty-listener`, `-xjc-Xts` and `-xjc-Xwsdlextension` respectively.
      Since:
      2.4.0

    • exceptionSuper

      @WithDefault("java.lang.Exception") String exceptionSuper()
      A fully qualified class name to use as a superclass for fault beans generated from `wsdl:fault` elements This will be passed as option `-exceptionSuper` to `wsdl2java`
      Since:
      2.4.0

    • asyncMethods

      Optional<List<String>> asyncMethods()
      A comma separated list of SEI methods for which asynchronous sibling methods should be generated; similar to `enableAsyncMapping` in a JAX-WS binding file This will be passed as option `-asyncMethods` to `wsdl2java`
      Since:
      2.4.0

    • bareMethods

      Optional<List<String>> bareMethods()
      A comma separated list of SEI methods for which wrapper style sibling methods should be generated; similar to `enableWrapperStyle` in JAX-WS binding file This will be passed as option `-bareMethods` to `wsdl2java`
      Since:
      2.4.0

    • mimeMethods

      Optional<List<String>> mimeMethods()
      A comma separated list of SEI methods for which `mime:content` mapping should be enabled; similar to `enableMIMEContent` in JAX-WS binding file This will be passed as option `-mimeMethods` to `wsdl2java`
      Since:
      2.4.0

    • additionalParams

      Optional<List<String>> additionalParams()
      A comma separated list of additional command line parameters that should be passed to CXF `wsdl2java` tool along with the files selected by `includes` and `excludes`. Example: `-keep,-dex,false`. Check link:https://cxf.apache.org/docs/wsdl-to-java.html[`wsdl2java` documentation] for all supported options.
      Since:
      2.0.0