Package io.quarkiverse.cxf.deployment

Interface CxfBuildTimeConfig.Java2WsParameterSet

Enclosing interface:
CxfBuildTimeConfig
public static interface CxfBuildTimeConfig.Java2WsParameterSet

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    JAVA2WS_CONFIG_KEY_PREFIX
     

  • 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 `java2ws` tool along with the files selected by `includes` and `excludes`.
    Optional<List<String>>
    excludes()
    A comma separated list of glob patterns for selecting java class names which should *not* be processed with `java2ws` tool.
    Optional<List<String>>
    includes()
    A comma separated list of glob patterns for selecting class names which should be processed with `java2ws` tool.
    default void
    validate(String prefix)
    Throws an `IllegalStateException` if this `Java2WsParameterSet` is invalid.
    String
    wsdlNameTemplate()
    A template for the names of generated WSDL files.

  • Field Details

  • Method Details

    • includes

      Optional<List<String>> includes()
      A comma separated list of glob patterns for selecting class names which should be processed with `java2ws` tool. The glob syntax is specified in `io.quarkus.util.GlobUtil`. The patterns are matched against fully qualified class names, such as `org.acme.MyClass`. The universe of class names to which `includes` and `excludes` are applied is defined as follows: 1. Only classes link:https://quarkus.io/guides/cdi-reference#bean_discovery[visible in Jandex] are considered. 2. From those, only the ones annotated with `@WebService` are selected. Examples: Let's say that the application contains two classes annotated with `@WebService` and that both are visible in Jandex. Their names are `org.foo.FruitWebService` and `org.bar.HelloWebService`. Then - `quarkus.cxf.java2ws.includes = ++**++.++*++WebService` will match both class names - `quarkus.cxf.java2ws.includes = org.foo.++*++` will match only `org.foo.FruitWebService` There is a separate `java2ws` execution for each of the matching class names. If you need different `additional-params` for each class, you may want to define a separate named parameter set for each one of them. Here is an example: [source,properties] ---- # Parameters for the foo package quarkus.cxf.java2ws.foo-params.includes = org.foo.* quarkus.cxf.java2ws.foo-params.additional-params = -servicename,FruitService # Parameters for the bar package quarkus.cxf.java2ws.bar-params.includes = org.bar.* quarkus.cxf.java2ws.bar-params.additional-params = -servicename,HelloService ---- There is no default value for this option, so `java2ws` WSDL generation is effectively disabled by default. Specifying `quarkus.cxf.java2ws.excludes` without setting any `includes` will cause a build time error. Make sure that the class names selected by `quarkus.cxf.java2ws.includes` and `quarkus.cxf.java2ws.++[++whatever-name++]++.includes` do not overlap. Otherwise a build time exception will be thrown. If you would like to include the generated WSDL files in native image, you need to add them yourself using `quarkus.native.resources.includes/excludes`.
      Since:
      2.0.0

    • excludes

      Optional<List<String>> excludes()
      A comma separated list of glob patterns for selecting java class names which should *not* be processed with `java2ws` tool. Same syntax as `includes`.
      Since:
      2.0.0

    • additionalParams

      Optional<List<String>> additionalParams()
      A comma separated list of additional command line parameters that should be passed to CXF `java2ws` tool along with the files selected by `includes` and `excludes`. Example: `-portname,12345`. Check link:https://cxf.apache.org/docs/java-to-ws.html[`java2ws` documentation] for all supported options. [NOTE] .Supported options ==== Currently, only options related to generation of WSDL from Java are supported. ====
      Since:
      2.0.0

    • wsdlNameTemplate

      @WithDefault("%CLASSES_DIR%/wsdl/%SIMPLE_CLASS_NAME%.wsdl") String wsdlNameTemplate()
      A template for the names of generated WSDL files. There are 4 place holders, which can be used in the template: - `%SIMPLE_CLASS_NAME%` - the simple class name of the Java class from which we are generating - `%FULLY_QUALIFIED_CLASS_NAME%` - the fully qualified name from which we are generating with all dots are replaced replaced by underscores - `%TARGET_DIR%` - the target directory of the current module of the current build tool; typically `target` for Maven and `build` for Gradle. - `%CLASSES_DIR%` - the compiler output directory of the current module of the current build tool; typically `target/classes` for Maven and `build/classes` for Gradle.
      Since:
      2.0.0

    • validate

      default void validate(String prefix)
      Throws an `IllegalStateException` if this `Java2WsParameterSet` is invalid.
      Parameters:
      prefix - the property prefix such as quarkus.cxf.java2ws.foo to use in the exception message if this CxfBuildTimeConfig.Java2WsParameterSet is invalid