Quarkus CXF

Stable • Since 0.1.0

Core capabilities for implementing SOAP clients and JAX-WS services.

Maven coordinates

Create a new project using quarkus-cxf on code.quarkus.io or add these coordinates to your existing project:

<dependency>
    <groupId>io.quarkiverse.cxf</groupId>
    <artifactId>quarkus-cxf</artifactId>
</dependency>

Check the User guide and especially its Dependency management section for more information about writing applications with Quarkus CXF.

Supported standards

Usage

There are several chapters in the User guide covering the usage of this extension:

Configuration

Configuration property fixed at build time. All other configuration properties are overridable at runtime.

Configuration property Type Default

quarkus.cxf.codegen.wsdl2java.enabled

boolean

true

If true wsdl2java code generation is run whenever there are WSDL resources found on default or custom defined locations; otherwise wsdl2java is not executed.

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_ENABLED
Since Quarkus CXF: 2.0.0

quarkus.cxf.codegen.wsdl2java.includes

List of string

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:

# 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
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.

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_INCLUDES
Since Quarkus CXF: 2.0.0

quarkus.cxf.codegen.wsdl2java.excludes

List of string

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.

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_EXCLUDES
Since Quarkus CXF: 2.0.0

quarkus.cxf.codegen.wsdl2java.output-directory

string

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

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_OUTPUT_DIRECTORY
Since Quarkus CXF: 2.6.0

quarkus.cxf.codegen.wsdl2java.package-names

List of string

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

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_PACKAGE_NAMES
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java.exclude-namespace-uris

List of string

A comma separated list of WSDL schema namespace URIs to ignore when generating Java code.

This will be passed as option -nexclude to wsdl2java

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_EXCLUDE_NAMESPACE_URIS
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java.service-name

string

The WSDL service name to use for the generated code.

This will be passed as option -sn to wsdl2java

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_SERVICE_NAME
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java.bindings

List of string

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

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_BINDINGS
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java.validate

boolean

false

If true, WSDLs are validated before processing; otherwise the WSDLs are not validated.

This will be passed as option -validate to wsdl2java

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_VALIDATE
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java.wsdl-location

string

Specifies the value of the @WebServiceClient annotation’s wsdlLocation property.

This will be passed as option -wsdlLocation to wsdl2java

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_WSDL_LOCATION
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java.xjc

List of string

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.

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_XJC
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java.exception-super

string

java.lang.Exception

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

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_EXCEPTION_SUPER
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java.async-methods

List of string

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

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_ASYNC_METHODS
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java.bare-methods

List of string

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

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_BARE_METHODS
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java.mime-methods

List of string

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

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_MIME_METHODS
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java.additional-params

List of string

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 wsdl2java documentation for all supported options.

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_ADDITIONAL_PARAMS
Since Quarkus CXF: 2.0.0

quarkus.cxf.java2ws.enabled

boolean

true

If true java2ws WSDL generation is run whenever there are Java classes selected via includes and excludes options; otherwise java2ws is not executed.

Environment variable: QUARKUS_CXF_JAVA2WS_ENABLED
Since Quarkus CXF: 2.0.0

quarkus.cxf.java2ws.includes

List of string

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 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:

# 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.

Environment variable: QUARKUS_CXF_JAVA2WS_INCLUDES
Since Quarkus CXF: 2.0.0

quarkus.cxf.java2ws.excludes

List of string

A comma separated list of glob patterns for selecting java class names which should not be processed with java2ws tool. Same syntax as includes.

Environment variable: QUARKUS_CXF_JAVA2WS_EXCLUDES
Since Quarkus CXF: 2.0.0

quarkus.cxf.java2ws.additional-params

List of string

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 java2ws documentation for all supported options.

Supported options

Currently, only options related to generation of WSDL from Java are supported.

Environment variable: QUARKUS_CXF_JAVA2WS_ADDITIONAL_PARAMS
Since Quarkus CXF: 2.0.0

quarkus.cxf.java2ws.wsdl-name-template

string

%CLASSES_DIR%/wsdl/%SIMPLE_CLASS_NAME%.wsdl

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.

Environment variable: QUARKUS_CXF_JAVA2WS_WSDL_NAME_TEMPLATE
Since Quarkus CXF: 2.0.0

quarkus.cxf.path

string

/services

The default path for CXF resources.

Earlier versions

The default value before Quarkus CXF version 2.0.0 was /.

Environment variable: QUARKUS_CXF_PATH
Since Quarkus CXF: 1.0.0

quarkus.cxf.min-chunk-size

int

128

The size in bytes of the chunks of memory allocated when writing data.

This is a very advanced setting that should only be set if you understand exactly how it affects the output IO operations of the application.

Environment variable: QUARKUS_CXF_MIN_CHUNK_SIZE
Since Quarkus CXF: 2.6.0

quarkus.cxf.output-buffer-size

int

8191

The size of the output stream response buffer in bytes. If a response is larger than this and no content-length is provided then the response will be chunked.

Larger values may give slight performance increases for large responses, at the expense of more memory usage.

Environment variable: QUARKUS_CXF_OUTPUT_BUFFER_SIZE
Since Quarkus CXF: 2.6.0

quarkus.cxf.http-conduit-factory

QuarkusCXFDefault, CXFDefault, VertxHttpClientHTTPConduitFactory, HttpClientHTTPConduitFactory, URLConnectionHTTPConduitFactory

Select the HTTPConduitFactory implementation for all clients except the ones that override this setting via quarkus.cxf.client."client-name".http-conduit-factory.

  • QuarkusCXFDefault (default): if io.quarkiverse.cxf:quarkus-cxf-rt-transports-http-hc5 is present in class path, then its HTTPConduitFactory implementation will be used; otherwise, since 3.16.0, this value is equivalent with VertxHttpClientHTTPConduitFactory. Before 3.16.0, the effective default was URLConnectionHTTPConduitFactory.

  • CXFDefault: the selection of HTTPConduitFactory implementation is left to CXF

  • VertxHttpClientHTTPConduitFactory: (Experimental) the HTTPConduitFactory for this client will be set to an implementation always returning io.quarkiverse.cxf.vertx.http.client.VertxHttpClientHTTPConduit. This will use io.vertx.core.http.HttpClient as the underlying HTTP client. Since Quarkus CXF 3.13.0.

  • HttpClientHTTPConduitFactory: the HTTPConduitFactory will be set to an implementation always returning org.apache.cxf.transport.http.HttpClientHTTPConduit. This will use java.net.http.HttpClient as the underlying HTTP client.

  • URLConnectionHTTPConduitFactory: the HTTPConduitFactory will be set to an implementation always returning org.apache.cxf.transport.http.URLConnectionHTTPConduit. This will use java.net.HttpURLConnection as the underlying HTTP client.

Environment variable: QUARKUS_CXF_HTTP_CONDUIT_FACTORY
Since Quarkus CXF: 2.3.0

quarkus.cxf.decoupled-endpoint-base

string

An URI base to use as a prefix of quarkus.cxf.client."client-name".decoupled-endpoint. You will typically want to set this to something like the following:

quarkus.cxf.decoupled-endpoint-base = https://api.example.com:${quarkus.http.ssl-port}${quarkus.cxf.path}
# or for plain HTTP
quarkus.cxf.decoupled-endpoint-base = http://api.example.com:${quarkus.http.port}${quarkus.cxf.path}

If you invoke your WS client from within a HTTP handler, you can leave this option unspecified and rather set it dynamically on the request context of your WS client using the org.apache.cxf.ws.addressing.decoupled.endpoint.base key. Here is an example how to do that from a RESTeasy handler method:

import java.util.Map;
import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.Context;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.UriInfo;
import jakarta.xml.ws.BindingProvider;
import io.quarkiverse.cxf.annotation.CXFClient;
import org.eclipse.microprofile.config.inject.ConfigProperty;

@Path("/my-rest")
public class MyRestEasyResource {

    @Inject
    @CXFClient("hello")
    HelloService helloService;

    @ConfigProperty(name = "quarkus.cxf.path")
                     String quarkusCxfPath;

    @POST
    @Path("/hello")
    @Produces(MediaType.TEXT_PLAIN)
        public String hello(String body, @Context UriInfo uriInfo) throws IOException {

        // You may consider doing this only once if you are sure that your service is accessed
        // through a single hostname
        String decoupledEndpointBase = uriInfo.getBaseUriBuilder().path(quarkusCxfPath);
        Map>String, Object< requestContext = ((BindingProvider)
        helloService).getRequestContext();
        requestContext.put("org.apache.cxf.ws.addressing.decoupled.endpoint.base",
        decoupledEndpointBase);

        return wsrmHelloService.hello(body);
    }
}

Environment variable: QUARKUS_CXF_DECOUPLED_ENDPOINT_BASE
Since Quarkus CXF: 2.7.0

quarkus.cxf.logging.enabled-for

clients, services, both, none

none

Specifies whether the message logging will be enabled for clients, services, both or none. This setting can be overridden per client or service endpoint using quarkus.cxf.endpoint."/endpoint-path".logging.enabled or quarkus.cxf.client."client-name".logging.enabled respectively.

Environment variable: QUARKUS_CXF_LOGGING_ENABLED_FOR
Since Quarkus CXF: 2.6.0

quarkus.cxf.logging.pretty

boolean

false

If true, the XML elements will be indented in the log; otherwise they will appear unindented. This setting can be overridden per client or service endpoint using quarkus.cxf.endpoint."/endpoint-path".logging.pretty or quarkus.cxf.client."client-name".logging.pretty respectively.

Environment variable: QUARKUS_CXF_LOGGING_PRETTY
Since Quarkus CXF: 2.6.0

quarkus.cxf.logging.limit

int

49152

A message length in bytes at which it is truncated in the log. This setting can be overridden per client or service endpoint using quarkus.cxf.endpoint."/endpoint-path".logging.limit or quarkus.cxf.client."client-name".logging.limit respectively.

Environment variable: QUARKUS_CXF_LOGGING_LIMIT
Since Quarkus CXF: 2.6.0

quarkus.cxf.logging.in-mem-threshold

long

-1

A message length in bytes at which it will be written to disk. -1 is unlimited. This setting can be overridden per client or service endpoint using quarkus.cxf.endpoint."/endpoint-path".logging.in-mem-threshold or quarkus.cxf.client."client-name".logging.in-mem-threshold respectively.

Environment variable: QUARKUS_CXF_LOGGING_IN_MEM_THRESHOLD
Since Quarkus CXF: 2.6.0

quarkus.cxf.logging.log-binary

boolean

false

If true, binary payloads will be logged; otherwise they won’t be logged. This setting can be overridden per client or service endpoint using quarkus.cxf.endpoint."/endpoint-path".logging.log-binary or quarkus.cxf.client."client-name".logging.log-binary respectively.

Environment variable: QUARKUS_CXF_LOGGING_LOG_BINARY
Since Quarkus CXF: 2.6.0

quarkus.cxf.logging.log-multipart

boolean

true

If true, multipart payloads will be logged; otherwise they won’t be logged. This setting can be overridden per client or service endpoint using quarkus.cxf.endpoint."/endpoint-path".logging.log-multipart or quarkus.cxf.client."client-name".logging.log-multipart respectively.

Environment variable: QUARKUS_CXF_LOGGING_LOG_MULTIPART
Since Quarkus CXF: 2.6.0

quarkus.cxf.logging.verbose

boolean

true

If true, verbose logging will be enabled; otherwise it won’t be enabled. This setting can be overridden per client or service endpoint using quarkus.cxf.endpoint."/endpoint-path".logging.verbose or quarkus.cxf.client."client-name".logging.verbose respectively.

Environment variable: QUARKUS_CXF_LOGGING_VERBOSE
Since Quarkus CXF: 2.6.0

quarkus.cxf.logging.in-binary-content-media-types

List of string

A comma separated list of additional binary media types to add to the default values in the LoggingInInterceptor whose content will not be logged unless log-binary is true. This setting can be overridden per client or service endpoint using quarkus.cxf.endpoint."/endpoint-path".logging.in-binary-content-media-types or quarkus.cxf.client."client-name".logging.in-binary-content-media-types respectively.

Environment variable: QUARKUS_CXF_LOGGING_IN_BINARY_CONTENT_MEDIA_TYPES
Since Quarkus CXF: 2.6.0

quarkus.cxf.logging.out-binary-content-media-types

List of string

A comma separated list of additional binary media types to add to the default values in the LoggingOutInterceptor whose content will not be logged unless log-binary is true. This setting can be overridden per client or service endpoint using quarkus.cxf.endpoint."/endpoint-path".logging.out-binary-content-media-types or quarkus.cxf.client."client-name".logging.out-binary-content-media-types respectively.

Environment variable: QUARKUS_CXF_LOGGING_OUT_BINARY_CONTENT_MEDIA_TYPES
Since Quarkus CXF: 2.6.0

quarkus.cxf.logging.binary-content-media-types

List of string

A comma separated list of additional binary media types to add to the default values in the LoggingOutInterceptor and LoggingInInterceptor whose content will not be logged unless log-binary is true. This setting can be overridden per client or service endpoint using quarkus.cxf.endpoint."/endpoint-path".logging.binary-content-media-types or quarkus.cxf.client."client-name".logging.binary-content-media-types respectively.

Environment variable: QUARKUS_CXF_LOGGING_BINARY_CONTENT_MEDIA_TYPES
Since Quarkus CXF: 2.6.0

quarkus.cxf.logging.sensitive-element-names

List of string

A comma separated list of XML elements containing sensitive information to be masked in the log. This setting can be overridden per client or service endpoint using quarkus.cxf.endpoint."/endpoint-path".logging.sensitive-element-names or quarkus.cxf.client."client-name".logging.sensitive-element-names respectively.

Environment variable: QUARKUS_CXF_LOGGING_SENSITIVE_ELEMENT_NAMES
Since Quarkus CXF: 2.6.0

quarkus.cxf.logging.sensitive-protocol-header-names

List of string

A comma separated list of protocol headers containing sensitive information to be masked in the log. This setting can be overridden per client or service endpoint using quarkus.cxf.endpoint."/endpoint-path".logging.sensitive-protocol-header-names or quarkus.cxf.client."client-name".logging.sensitive-protocol-header-names respectively.

Environment variable: QUARKUS_CXF_LOGGING_SENSITIVE_PROTOCOL_HEADER_NAMES
Since Quarkus CXF: 2.6.0

quarkus.cxf.codegen.wsdl2java."named-parameter-sets".includes

List of string

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:

# 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
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.

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__INCLUDES
Since Quarkus CXF: 2.0.0

quarkus.cxf.codegen.wsdl2java."named-parameter-sets".excludes

List of string

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.

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__EXCLUDES
Since Quarkus CXF: 2.0.0

quarkus.cxf.codegen.wsdl2java."named-parameter-sets".output-directory

string

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

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__OUTPUT_DIRECTORY
Since Quarkus CXF: 2.6.0

quarkus.cxf.codegen.wsdl2java."named-parameter-sets".package-names

List of string

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

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__PACKAGE_NAMES
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java."named-parameter-sets".exclude-namespace-uris

List of string

A comma separated list of WSDL schema namespace URIs to ignore when generating Java code.

This will be passed as option -nexclude to wsdl2java

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__EXCLUDE_NAMESPACE_URIS
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java."named-parameter-sets".service-name

string

The WSDL service name to use for the generated code.

This will be passed as option -sn to wsdl2java

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__SERVICE_NAME
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java."named-parameter-sets".bindings

List of string

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

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__BINDINGS
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java."named-parameter-sets".validate

boolean

false

If true, WSDLs are validated before processing; otherwise the WSDLs are not validated.

This will be passed as option -validate to wsdl2java

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__VALIDATE
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java."named-parameter-sets".wsdl-location

string

Specifies the value of the @WebServiceClient annotation’s wsdlLocation property.

This will be passed as option -wsdlLocation to wsdl2java

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__WSDL_LOCATION
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java."named-parameter-sets".xjc

List of string

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.

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__XJC
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java."named-parameter-sets".exception-super

string

java.lang.Exception

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

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__EXCEPTION_SUPER
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java."named-parameter-sets".async-methods

List of string

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

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__ASYNC_METHODS
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java."named-parameter-sets".bare-methods

List of string

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

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__BARE_METHODS
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java."named-parameter-sets".mime-methods

List of string

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

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__MIME_METHODS
Since Quarkus CXF: 2.4.0

quarkus.cxf.codegen.wsdl2java."named-parameter-sets".additional-params

List of string

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 wsdl2java documentation for all supported options.

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__ADDITIONAL_PARAMS
Since Quarkus CXF: 2.0.0

quarkus.cxf.java2ws."named-parameter-sets".includes

List of string

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 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:

# 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.

Environment variable: QUARKUS_CXF_JAVA2WS__NAMED_PARAMETER_SETS__INCLUDES
Since Quarkus CXF: 2.0.0

quarkus.cxf.java2ws."named-parameter-sets".excludes

List of string

A comma separated list of glob patterns for selecting java class names which should not be processed with java2ws tool. Same syntax as includes.

Environment variable: QUARKUS_CXF_JAVA2WS__NAMED_PARAMETER_SETS__EXCLUDES
Since Quarkus CXF: 2.0.0

quarkus.cxf.java2ws."named-parameter-sets".additional-params

List of string

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 java2ws documentation for all supported options.

Supported options

Currently, only options related to generation of WSDL from Java are supported.

Environment variable: QUARKUS_CXF_JAVA2WS__NAMED_PARAMETER_SETS__ADDITIONAL_PARAMS
Since Quarkus CXF: 2.0.0

quarkus.cxf.java2ws."named-parameter-sets".wsdl-name-template

string

%CLASSES_DIR%/wsdl/%SIMPLE_CLASS_NAME%.wsdl

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.

Environment variable: QUARKUS_CXF_JAVA2WS__NAMED_PARAMETER_SETS__WSDL_NAME_TEMPLATE
Since Quarkus CXF: 2.0.0

quarkus.cxf.client."client-name".service-interface

string

The client service interface class name

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__SERVICE_INTERFACE
Since Quarkus CXF: 1.0.0

quarkus.cxf.client."client-name".alternative

boolean

false

Indicates whether this is an alternative proxy client configuration. If true, then this configuration is ignored when configuring a client without annotation @CXFClient.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__ALTERNATIVE
Since Quarkus CXF: 1.0.0

quarkus.cxf.client."client-name".native.runtime-initialized

boolean

false

If true, the client dynamic proxy class generated by native compiler will be initialized at runtime; otherwise the proxy class will be initialized at build time.

Setting this to true makes sense if your service endpoint interface references some class initialized at runtime in its method signatures. E.g. Say, your service interface has method int add(Operands o) and the Operands class was requested to be initialized at runtime. Then, without setting this configuration parameter to true, the native compiler will throw an exception saying something like Classes that should be initialized at run time got initialized during image building: org.acme.Operands …​ jdk.proxy<some-number>.$Proxy<some-number> caused initialization of this class. jdk.proxy<some-number>.$Proxy<some-number> is the proxy class generated by the native compiler.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__NATIVE_RUNTIME_INITIALIZED
Since Quarkus CXF: 2.0.0

quarkus.cxf.endpoint."/endpoint-path".implementor

string

The service endpoint implementation class

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__IMPLEMENTOR
Since Quarkus CXF: 1.0.0

quarkus.cxf.endpoint."/endpoint-path".wsdl

string

The service endpoint WSDL path

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__WSDL
Since Quarkus CXF: 1.0.0

quarkus.cxf.endpoint."/endpoint-path".soap-binding

string

The URL of the SOAP Binding, should be one of four values:

  • http://schemas.xmlsoap.org/wsdl/soap/http for SOAP11HTTP_BINDING

  • http://schemas.xmlsoap.org/wsdl/soap/http?mtom=true for SOAP11HTTP_MTOM_BINDING

  • http://www.w3.org/2003/05/soap/bindings/HTTP/ for SOAP12HTTP_BINDING

  • http://www.w3.org/2003/05/soap/bindings/HTTP/?mtom=true for SOAP12HTTP_MTOM_BINDING

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__SOAP_BINDING
Since Quarkus CXF: 1.0.0

quarkus.cxf.endpoint."/endpoint-path".published-endpoint-url

string

The published service endpoint URL

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__PUBLISHED_ENDPOINT_URL
Since Quarkus CXF: 1.0.0

quarkus.cxf.endpoint."/endpoint-path".logging.enabled

true, false, pretty

If true or pretty, the message logging will be enabled; otherwise it will not be enabled. If the value is pretty (since 2.7.0), the pretty attribute will effectively be set to true. The default is given by quarkus.cxf.logging.enabled-for.

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__LOGGING_ENABLED
Since Quarkus CXF: 2.6.0

quarkus.cxf.endpoint."/endpoint-path".logging.pretty

boolean

If true, the XML elements will be indented in the log; otherwise they will appear unindented. The default is given by quarkus.cxf.logging.pretty

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__LOGGING_PRETTY
Since Quarkus CXF: 2.6.0

quarkus.cxf.endpoint."/endpoint-path".logging.limit

int

A message length in bytes at which it is truncated in the log. The default is given by quarkus.cxf.logging.limit

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__LOGGING_LIMIT
Since Quarkus CXF: 2.6.0

quarkus.cxf.endpoint."/endpoint-path".logging.in-mem-threshold

long

A message length in bytes at which it will be written to disk. -1 is unlimited. The default is given by quarkus.cxf.logging.in-mem-threshold

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__LOGGING_IN_MEM_THRESHOLD
Since Quarkus CXF: 2.6.0

quarkus.cxf.endpoint."/endpoint-path".logging.log-binary

boolean

If true, binary payloads will be logged; otherwise they won’t be logged. The default is given by quarkus.cxf.logging.log-binary

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__LOGGING_LOG_BINARY
Since Quarkus CXF: 2.6.0

quarkus.cxf.endpoint."/endpoint-path".logging.log-multipart

boolean

If true, multipart payloads will be logged; otherwise they won’t be logged. The default is given by quarkus.cxf.logging.log-multipart

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__LOGGING_LOG_MULTIPART
Since Quarkus CXF: 2.6.0

quarkus.cxf.endpoint."/endpoint-path".logging.verbose

boolean

If true, verbose logging will be enabled; otherwise it won’t be enabled. The default is given by quarkus.cxf.logging.verbose

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__LOGGING_VERBOSE
Since Quarkus CXF: 2.6.0

quarkus.cxf.endpoint."/endpoint-path".logging.in-binary-content-media-types

List of string

A comma separated list of additional binary media types to add to the default values in the LoggingInInterceptor whose content will not be logged unless log-binary is true. The default is given by quarkus.cxf.logging.in-binary-content-media-types

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__LOGGING_IN_BINARY_CONTENT_MEDIA_TYPES
Since Quarkus CXF: 2.6.0

quarkus.cxf.endpoint."/endpoint-path".logging.out-binary-content-media-types

List of string

A comma separated list of additional binary media types to add to the default values in the LoggingOutInterceptor whose content will not be logged unless log-binary is true. The default is given by quarkus.cxf.logging.out-binary-content-media-types

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__LOGGING_OUT_BINARY_CONTENT_MEDIA_TYPES
Since Quarkus CXF: 2.6.0

quarkus.cxf.endpoint."/endpoint-path".logging.binary-content-media-types

List of string

A comma separated list of additional binary media types to add to the default values in the LoggingOutInterceptor and LoggingInInterceptor whose content will not be logged unless log-binary is true. The default is given by quarkus.cxf.logging.binary-content-media-types

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__LOGGING_BINARY_CONTENT_MEDIA_TYPES
Since Quarkus CXF: 2.6.0

quarkus.cxf.endpoint."/endpoint-path".logging.sensitive-element-names

List of string

A comma separated list of XML elements containing sensitive information to be masked in the log. The default is given by quarkus.cxf.logging.sensitive-element-names

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__LOGGING_SENSITIVE_ELEMENT_NAMES
Since Quarkus CXF: 2.6.0

quarkus.cxf.endpoint."/endpoint-path".logging.sensitive-protocol-header-names

List of string

A comma separated list of protocol headers containing sensitive information to be masked in the log. The default is given by quarkus.cxf.logging.sensitive-protocol-header-names

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__LOGGING_SENSITIVE_PROTOCOL_HEADER_NAMES
Since Quarkus CXF: 2.6.0

quarkus.cxf.endpoint."/endpoint-path".features

List of string

A comma-separated list of fully qualified CXF Feature class names or named CDI beans.

Examples:

quarkus.cxf.endpoint."/hello".features = org.apache.cxf.ext.logging.LoggingFeature
quarkus.cxf.endpoint."/fruit".features = #myCustomLoggingFeature

In the second case, the #myCustomLoggingFeature bean can be produced as follows:

import org.apache.cxf.ext.logging.LoggingFeature;
import javax.enterprise.context.ApplicationScoped;
import javax.enterprise.inject.Produces;

class Producers {

    @Produces
    @ApplicationScoped
    LoggingFeature myCustomLoggingFeature() {
        LoggingFeature loggingFeature = new LoggingFeature();
        loggingFeature.setPrettyLogging(true);
        return loggingFeature;
    }
}

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__FEATURES
Since Quarkus CXF: 1.0.0

quarkus.cxf.endpoint."/endpoint-path".handlers

List of string

The comma-separated list of Handler classes

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__HANDLERS
Since Quarkus CXF: 1.0.0

quarkus.cxf.endpoint."/endpoint-path".in-interceptors

List of string

The comma-separated list of InInterceptor classes

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__IN_INTERCEPTORS
Since Quarkus CXF: 1.0.0

quarkus.cxf.endpoint."/endpoint-path".out-interceptors

List of string

The comma-separated list of OutInterceptor classes

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__OUT_INTERCEPTORS
Since Quarkus CXF: 1.0.0

quarkus.cxf.endpoint."/endpoint-path".out-fault-interceptors

List of string

The comma-separated list of OutFaultInterceptor classes

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__OUT_FAULT_INTERCEPTORS
Since Quarkus CXF: 1.0.0

quarkus.cxf.endpoint."/endpoint-path".in-fault-interceptors

List of string

The comma-separated list of InFaultInterceptor classes

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__IN_FAULT_INTERCEPTORS
Since Quarkus CXF: 1.0.0

quarkus.cxf.endpoint."/endpoint-path".schema-validation.enabled-for

in, request, out, response, both, none

Select for which messages XML Schema validation should be enabled. If not specified, no XML Schema validation will be enforced unless it is enabled by other means, such as @org.apache.cxf.annotations.SchemaValidation or @org.apache.cxf.annotations.EndpointProperty(key = "schema-validation-enabled", value = "true") annotations.

Environment variable: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__SCHEMA_VALIDATION_ENABLED_FOR
Since Quarkus CXF: 2.7.0

quarkus.cxf.client."client-name".wsdl

string

A URL, resource path or local filesystem path pointing to a WSDL document to use when generating the service proxy of this client.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__WSDL
Since Quarkus CXF: 1.0.0

quarkus.cxf.client."client-name".soap-binding

string

The URL of the SOAP Binding, should be one of four values:

  • http://schemas.xmlsoap.org/wsdl/soap/http for SOAP11HTTP_BINDING

  • http://schemas.xmlsoap.org/wsdl/soap/http?mtom=true for SOAP11HTTP_MTOM_BINDING

  • http://www.w3.org/2003/05/soap/bindings/HTTP/ for SOAP12HTTP_BINDING

  • http://www.w3.org/2003/05/soap/bindings/HTTP/?mtom=true for SOAP12HTTP_MTOM_BINDING

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__SOAP_BINDING
Since Quarkus CXF: 1.0.0

quarkus.cxf.client."client-name".client-endpoint-url

string

The client endpoint URL

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__CLIENT_ENDPOINT_URL
Since Quarkus CXF: 1.0.0

quarkus.cxf.client."client-name".endpoint-namespace

string

The client endpoint namespace

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__ENDPOINT_NAMESPACE
Since Quarkus CXF: 1.0.0

quarkus.cxf.client."client-name".endpoint-name

string

The client endpoint name

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__ENDPOINT_NAME
Since Quarkus CXF: 1.0.0

quarkus.cxf.client."client-name".username

string

The username for HTTP Basic authentication

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__USERNAME
Since Quarkus CXF: 1.0.0

quarkus.cxf.client."client-name".password

string

The password for HTTP Basic authentication

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__PASSWORD
Since Quarkus CXF: 1.0.0

quarkus.cxf.client."client-name".secure-wsdl-access

boolean

false

If true, then the Authentication header will be sent preemptively when requesting the WSDL, as long as the username is set; otherwise the WSDL will be requested anonymously.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__SECURE_WSDL_ACCESS
Since Quarkus CXF: 2.7.0

quarkus.cxf.client."client-name".logging.enabled

true, false, pretty

If true or pretty, the message logging will be enabled; otherwise it will not be enabled. If the value is pretty (since 2.7.0), the pretty attribute will effectively be set to true. The default is given by quarkus.cxf.logging.enabled-for.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__LOGGING_ENABLED
Since Quarkus CXF: 2.6.0

quarkus.cxf.client."client-name".logging.pretty

boolean

If true, the XML elements will be indented in the log; otherwise they will appear unindented. The default is given by quarkus.cxf.logging.pretty

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__LOGGING_PRETTY
Since Quarkus CXF: 2.6.0

quarkus.cxf.client."client-name".logging.limit

int

A message length in bytes at which it is truncated in the log. The default is given by quarkus.cxf.logging.limit

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__LOGGING_LIMIT
Since Quarkus CXF: 2.6.0

quarkus.cxf.client."client-name".logging.in-mem-threshold

long

A message length in bytes at which it will be written to disk. -1 is unlimited. The default is given by quarkus.cxf.logging.in-mem-threshold

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__LOGGING_IN_MEM_THRESHOLD
Since Quarkus CXF: 2.6.0

quarkus.cxf.client."client-name".logging.log-binary

boolean

If true, binary payloads will be logged; otherwise they won’t be logged. The default is given by quarkus.cxf.logging.log-binary

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__LOGGING_LOG_BINARY
Since Quarkus CXF: 2.6.0

quarkus.cxf.client."client-name".logging.log-multipart

boolean

If true, multipart payloads will be logged; otherwise they won’t be logged. The default is given by quarkus.cxf.logging.log-multipart

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__LOGGING_LOG_MULTIPART
Since Quarkus CXF: 2.6.0

quarkus.cxf.client."client-name".logging.verbose

boolean

If true, verbose logging will be enabled; otherwise it won’t be enabled. The default is given by quarkus.cxf.logging.verbose

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__LOGGING_VERBOSE
Since Quarkus CXF: 2.6.0

quarkus.cxf.client."client-name".logging.in-binary-content-media-types

List of string

A comma separated list of additional binary media types to add to the default values in the LoggingInInterceptor whose content will not be logged unless log-binary is true. The default is given by quarkus.cxf.logging.in-binary-content-media-types

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__LOGGING_IN_BINARY_CONTENT_MEDIA_TYPES
Since Quarkus CXF: 2.6.0

quarkus.cxf.client."client-name".logging.out-binary-content-media-types

List of string

A comma separated list of additional binary media types to add to the default values in the LoggingOutInterceptor whose content will not be logged unless log-binary is true. The default is given by quarkus.cxf.logging.out-binary-content-media-types

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__LOGGING_OUT_BINARY_CONTENT_MEDIA_TYPES
Since Quarkus CXF: 2.6.0

quarkus.cxf.client."client-name".logging.binary-content-media-types

List of string

A comma separated list of additional binary media types to add to the default values in the LoggingOutInterceptor and LoggingInInterceptor whose content will not be logged unless log-binary is true. The default is given by quarkus.cxf.logging.binary-content-media-types

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__LOGGING_BINARY_CONTENT_MEDIA_TYPES
Since Quarkus CXF: 2.6.0

quarkus.cxf.client."client-name".logging.sensitive-element-names

List of string

A comma separated list of XML elements containing sensitive information to be masked in the log. The default is given by quarkus.cxf.logging.sensitive-element-names

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__LOGGING_SENSITIVE_ELEMENT_NAMES
Since Quarkus CXF: 2.6.0

quarkus.cxf.client."client-name".logging.sensitive-protocol-header-names

List of string

A comma separated list of protocol headers containing sensitive information to be masked in the log. The default is given by quarkus.cxf.logging.sensitive-protocol-header-names

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__LOGGING_SENSITIVE_PROTOCOL_HEADER_NAMES
Since Quarkus CXF: 2.6.0

quarkus.cxf.client."client-name".features

List of string

A comma-separated list of fully qualified CXF Feature class names.

Example:

quarkus.cxf.endpoint."/my-endpoint".features = org.apache.cxf.ext.logging.LoggingFeature

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__FEATURES
Since Quarkus CXF: 1.0.0

quarkus.cxf.client."client-name".handlers

List of string

The comma-separated list of Handler classes

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__HANDLERS
Since Quarkus CXF: 1.0.0

quarkus.cxf.client."client-name".in-interceptors

List of string

The comma-separated list of InInterceptor classes

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__IN_INTERCEPTORS
Since Quarkus CXF: 1.0.0

quarkus.cxf.client."client-name".out-interceptors

List of string

The comma-separated list of OutInterceptor classes

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__OUT_INTERCEPTORS
Since Quarkus CXF: 1.0.0

quarkus.cxf.client."client-name".out-fault-interceptors

List of string

The comma-separated list of OutFaultInterceptor classes

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__OUT_FAULT_INTERCEPTORS
Since Quarkus CXF: 1.0.0

quarkus.cxf.client."client-name".in-fault-interceptors

List of string

The comma-separated list of InFaultInterceptor classes

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__IN_FAULT_INTERCEPTORS
Since Quarkus CXF: 1.0.0

quarkus.cxf.client."client-name".connection-timeout

long

30000

Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. 0 is infinite.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__CONNECTION_TIMEOUT
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".receive-timeout

long

60000

Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. 0 is infinite.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__RECEIVE_TIMEOUT
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".connection-request-timeout

long

60000

Specifies the amount of time, in milliseconds, used when requesting a connection from the connection manager(if appliable). 0 is infinite.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__CONNECTION_REQUEST_TIMEOUT
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".auto-redirect

boolean

false

Specifies if the consumer will automatically follow a server issued redirection. (name is not part of standard)

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__AUTO_REDIRECT
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".max-retransmits

int

-1

Specifies the maximum amount of retransmits that are allowed for redirects. Retransmits for authorization is included in the retransmit count. Each redirect may cause another retransmit for a UNAUTHORIZED response code, ie. 401. Any negative number indicates unlimited retransmits, although, loop protection is provided. The default is unlimited. (name is not part of standard)

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__MAX_RETRANSMITS
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".allow-chunking

boolean

true

If true, the client is free to use chunking streams if it wants, but it is not required to use chunking streams. If false, the client must use regular, non-chunked requests in all cases.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__ALLOW_CHUNKING
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".chunking-threshold

int

4096

If AllowChunking is true, this sets the threshold at which messages start getting chunked. Messages under this limit do not get chunked.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__CHUNKING_THRESHOLD
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".chunk-length

int

-1

Specifies the chunk length for a HttpURLConnection. This value is used in java.net.HttpURLConnection.setChunkedStreamingMode(int chunklen). chunklen indicates the number of bytes to write in each chunk. If chunklen is less than or equal to zero, a default value will be used.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__CHUNK_LENGTH
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".accept

string

Specifies the MIME types the client is prepared to handle (e.g., HTML, JPEG, GIF, etc.)

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__ACCEPT
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".accept-language

string

Specifies the language the client desires (e.g., English, French, etc.)

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__ACCEPT_LANGUAGE
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".accept-encoding

string

Specifies the encoding the client is prepared to handle (e.g., gzip)

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__ACCEPT_ENCODING
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".content-type

string

Specifies the content type of the stream being sent in a post request. (this should be text/xml for web services, or can be set to application/x-www-form-urlencoded if the client is sending form data).

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__CONTENT_TYPE
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".host

string

Specifies the Internet host and port number of the resource on which the request is being invoked. This is sent by default based upon the URL. Certain DNS scenarios or application designs may request you to set this, but typically it is not required.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__HOST
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".connection

close, keep-alive

keep-alive

The connection disposition. If close the connection to the server is closed after each request/response dialog. If Keep-Alive the client requests the server to keep the connection open, and if the server honors the keep alive request, the connection is reused. Many servers and proxies do not honor keep-alive requests.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__CONNECTION
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".cache-control

string

Most commonly used to specify no-cache, however the standard supports a dozen or so caching related directives for requests

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__CACHE_CONTROL
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".version

string

auto

HTTP Version used for the connection. The default value auto will use whatever the default is for the HTTPConduit implementation defined via quarkus.cxf.client."client-name".http-conduit-factory. Other possible values: 1.1, 2.

Some of these values might be unsupported by some HTTPConduit implementations.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__VERSION
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".browser-type

string

The value of the User-Agent HTTP header.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__BROWSER_TYPE
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".decoupled-endpoint

string

An URI path (starting with /) or a full URI for the receipt of responses over a separate provider → consumer connection. If the value starts with /, then it is prefixed with the base URI configured via quarkus.cxf.client."client-name".decoupled-endpoint-base before being used as a value for the WS-Addressing ReplyTo message header.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__DECOUPLED_ENDPOINT
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".proxy-server

string

Specifies the address of proxy server if one is used.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__PROXY_SERVER
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".proxy-server-port

int

Specifies the port number used by the proxy server.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__PROXY_SERVER_PORT
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".non-proxy-hosts

string

Specifies the list of hostnames that will not use the proxy configuration. Examples:

  • localhost - a single hostname

  • localhost|www.google.com - two hostnames that will not use the proxy configuration

  • localhost|www.google.*|*.apache.org - hostname patterns

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__NON_PROXY_HOSTS
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".proxy-server-type

http, socks

http

Specifies the type of the proxy server. Can be either HTTP or SOCKS.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__PROXY_SERVER_TYPE
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".proxy-username

string

Username for the proxy authentication

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__PROXY_USERNAME
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".proxy-password

string

Password for the proxy authentication

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__PROXY_PASSWORD
Since Quarkus CXF: 2.2.3

quarkus.cxf.client."client-name".http-conduit-factory

QuarkusCXFDefault, CXFDefault, VertxHttpClientHTTPConduitFactory, HttpClientHTTPConduitFactory, URLConnectionHTTPConduitFactory

Select the HTTPConduitFactory implementation for this client.

  • QuarkusCXFDefault (default): if io.quarkiverse.cxf:quarkus-cxf-rt-transports-http-hc5 is present in class path, then its HTTPConduitFactory implementation will be used; otherwise, since 3.16.0, this value is equivalent with VertxHttpClientHTTPConduitFactory. Before 3.16.0, the effective default was URLConnectionHTTPConduitFactory.

  • CXFDefault: the selection of HTTPConduitFactory implementation is left to CXF

  • VertxHttpClientHTTPConduitFactory: the HTTPConduitFactory for this client will be set to an implementation always returning io.quarkiverse.cxf.vertx.http.client.VertxHttpClientHTTPConduit. This will use io.vertx.core.http.HttpClient as the underlying HTTP client. Since Quarkus CXF 3.13.0.

  • HttpClientHTTPConduitFactory: the HTTPConduitFactory for this client will be set to an implementation always returning org.apache.cxf.transport.http.HttpClientHTTPConduit. This will use java.net.http.HttpClient as the underlying HTTP client.

  • URLConnectionHTTPConduitFactory: the HTTPConduitFactory for this client will be set to an implementation always returning org.apache.cxf.transport.http.URLConnectionHTTPConduit. This will use java.net.HttpURLConnection as the underlying HTTP client.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__HTTP_CONDUIT_FACTORY
Since Quarkus CXF: 2.3.0

quarkus.cxf.client."client-name".tls-configuration-name

string

The name of the TLS configuration to use for setting up trust store and keystore for this SOAP client.

If not set and .trust-store or .key-store is configured then that the configuration from .trust-store* and .key-store* family of options will be used. If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown at runtime. Setting .tls-configuration-name and any of .trust-store or .key-store leads to an exception at runtime.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__TLS_CONFIGURATION_NAME
Since Quarkus CXF: 3.15.0

quarkus.cxf.client."client-name".key-store

string

The key store location for this client. The resource is first looked up in the classpath, then in the file system.

Deprecated - use quarkus.cxf.client."client-name".tls-configuration-name instead.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__KEY_STORE
Since Quarkus CXF: 3.8.1

quarkus.cxf.client."client-name".key-store-password

string

The key store password.

Deprecated - use quarkus.cxf.client."client-name".tls-configuration-name instead.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__KEY_STORE_PASSWORD
Since Quarkus CXF: 3.8.1

quarkus.cxf.client."client-name".key-store-type

string

JKS

The type of the key store.

Deprecated - use quarkus.cxf.client."client-name".tls-configuration-name instead.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__KEY_STORE_TYPE
Since Quarkus CXF: 3.8.1

quarkus.cxf.client."client-name".key-password

string

The key password.

Deprecated - use quarkus.cxf.client."client-name".tls-configuration-name instead.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__KEY_PASSWORD
Since Quarkus CXF: 3.8.1

quarkus.cxf.client."client-name".trust-store

string

The trust store location for this client. The resource is first looked up in the classpath, then in the file system.

Deprecated - use quarkus.cxf.client."client-name".tls-configuration-name instead.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__TRUST_STORE
Since Quarkus CXF: 2.5.0

quarkus.cxf.client."client-name".trust-store-password

string

The trust store password.

Deprecated - use quarkus.cxf.client."client-name".tls-configuration-name instead.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__TRUST_STORE_PASSWORD
Since Quarkus CXF: 2.5.0

quarkus.cxf.client."client-name".trust-store-type

string

JKS

The type of the trust store.

Deprecated - use quarkus.cxf.client."client-name".tls-configuration-name instead.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__TRUST_STORE_TYPE
Since Quarkus CXF: 2.5.0

quarkus.cxf.client."client-name".hostname-verifier

string

Can be one of the following:

  • One of the well known values: AllowAllHostnameVerifier, HttpsURLConnectionDefaultHostnameVerifier

  • A fully qualified class name implementing javax.net.ssl.HostnameVerifier to look up in the CDI container.

  • A bean name prefixed with # that will be looked up in the CDI container; example: #myHostnameVerifier

If not specified, then the creation of the HostnameVerifier is delegated to CXF, which boils down to org.apache.cxf.transport.https.httpclient.DefaultHostnameVerifier with the default org.apache.cxf.transport.https.httpclient.PublicSuffixMatcherLoader as returned from PublicSuffixMatcherLoader.getDefault().

Setting this option when the conduit factory of this client is set to VertxHttpClientHTTPConduitFactory (default since Quarkus CXF 3.16.0) leads to an exception at runtime. The AllowAllHostnameVerifier value of this option can be replaced by using a named TLS configuration with hostname-verification-algorithm set to NONE. Otherwise, there is no way to implement custom hostname verification for Vert.x HTTP client.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__HOSTNAME_VERIFIER
Since Quarkus CXF: 2.5.0

quarkus.cxf.client."client-name".schema-validation.enabled-for

in, request, out, response, both, none

Select for which messages XML Schema validation should be enabled. If not specified, no XML Schema validation will be enforced unless it is enabled by other means, such as @org.apache.cxf.annotations.SchemaValidation or @org.apache.cxf.annotations.EndpointProperty(key = "schema-validation-enabled", value = "true") annotations.

Environment variable: QUARKUS_CXF_CLIENT__CLIENT_NAME__SCHEMA_VALIDATION_ENABLED_FOR
Since Quarkus CXF: 2.7.0