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 CXF Extensions for Quarkus.

Supported standards

Usage

Check the following chapters of User guide:

Configuration

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

Configuration property

Type

Default

quarkus.cxf.path

The default path for CXF resources.

⚠️ Note that the default value before Quarkus CXF version 2.0.0 was /.

Environment variable: QUARKUS_CXF_PATH

string

/services

quarkus.cxf.codegen.wsdl2java.enabled

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

boolean

true

quarkus.cxf.codegen.wsdl2java.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:

# Parameters for foo.wsdl
quarkus.cxf.codegen.wsdl2java.foo-params.includes = wsdl/foo.wsdl
quarkus.cxf.codegen.wsdl2java.foo-params.additional-params = -wsdlLocation,wsdl/foo.wsdl
# Parameters for bar.wsdl
quarkus.cxf.codegen.wsdl2java.bar-params.includes = wsdl/bar.wsdl
quarkus.cxf.codegen.wsdl2java.bar-params.additional-params = -wsdlLocation,wsdl/bar.wsdl,-xjc-Xts

Note that file extensions other than .wsdl will work during normal builds, but changes in the matching files may get overseen in Quarkus dev mode. Always using the .wsdl extension is thus recommended.

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

list of string

quarkus.cxf.codegen.wsdl2java.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.

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_EXCLUDES

list of string

quarkus.cxf.codegen.wsdl2java.additional-params

A comma separated list of additional command line parameters that should passed to CXF wsdl2java tool along with the files selected by includes and excludes. Example: -wsdlLocation,classpath:wsdl/CalculatorService.wsdl. Check wsdl2java documentation for all supported options.

You need to add io.quarkiverse.cxf:quarkus-cxf-xjc-plugins dependency to your project to be able to use -xjc-Xbg, -xjc-Xdv, -xjc-Xjavadoc, -xjc-Xproperty-listener, -xjc-Xts or -xjc-Xwsdlextension.

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA_ADDITIONAL_PARAMS

list of string

quarkus.cxf.java2ws.enabled

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

boolean

true

quarkus.cxf.java2ws.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 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

list of string

quarkus.cxf.java2ws.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.

Environment variable: QUARKUS_CXF_JAVA2WS_EXCLUDES

list of string

quarkus.cxf.java2ws.additional-params

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.

Note that only options related to generation of WSDL from Java are supported currently.

Environment variable: QUARKUS_CXF_JAVA2WS_ADDITIONAL_PARAMS

list of string

quarkus.cxf.java2ws.wsdl-name-template

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

string

%CLASSES_DIR%/wsdl/%SIMPLE_CLASS_NAME%.wsdl

quarkus.cxf.http-conduit-factory

Select the HTTPConduitFactory implementation for all clients except the ones that override this setting via quarkus.cxf.client.myClient.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 this value is equivalent with URLConnectionHTTPConduitFactory (this may change, once issue #992 gets resolved in CXF)

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

  • 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

QuarkusCXFDefault, CXFDefault, HttpClientHTTPConduitFactory, URLConnectionHTTPConduitFactory

quarkus.cxf.min-chunk-size

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

int

128

quarkus.cxf.output-buffer-size

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

int

8191

quarkus.cxf.codegen.wsdl2java."named-parameter-sets".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:

# Parameters for foo.wsdl
quarkus.cxf.codegen.wsdl2java.foo-params.includes = wsdl/foo.wsdl
quarkus.cxf.codegen.wsdl2java.foo-params.additional-params = -wsdlLocation,wsdl/foo.wsdl
# Parameters for bar.wsdl
quarkus.cxf.codegen.wsdl2java.bar-params.includes = wsdl/bar.wsdl
quarkus.cxf.codegen.wsdl2java.bar-params.additional-params = -wsdlLocation,wsdl/bar.wsdl,-xjc-Xts

Note that file extensions other than .wsdl will work during normal builds, but changes in the matching files may get overseen in Quarkus dev mode. Always using the .wsdl extension is thus recommended.

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

list of string

quarkus.cxf.codegen.wsdl2java."named-parameter-sets".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.

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__EXCLUDES

list of string

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

A comma separated list of additional command line parameters that should passed to CXF wsdl2java tool along with the files selected by includes and excludes. Example: -wsdlLocation,classpath:wsdl/CalculatorService.wsdl. Check wsdl2java documentation for all supported options.

You need to add io.quarkiverse.cxf:quarkus-cxf-xjc-plugins dependency to your project to be able to use -xjc-Xbg, -xjc-Xdv, -xjc-Xjavadoc, -xjc-Xproperty-listener, -xjc-Xts or -xjc-Xwsdlextension.

Environment variable: QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__ADDITIONAL_PARAMS

list of string

quarkus.cxf.java2ws."named-parameter-sets".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 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

list of string

quarkus.cxf.java2ws."named-parameter-sets".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.

Environment variable: QUARKUS_CXF_JAVA2WS__NAMED_PARAMETER_SETS__EXCLUDES

list of string

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

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.

Note that only options related to generation of WSDL from Java are supported currently.

Environment variable: QUARKUS_CXF_JAVA2WS__NAMED_PARAMETER_SETS__ADDITIONAL_PARAMS

list of string

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

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

string

%CLASSES_DIR%/wsdl/%SIMPLE_CLASS_NAME%.wsdl

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

The client service interface class name

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__SERVICE_INTERFACE

string

quarkus.cxf.client."clients".alternative

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__CLIENTS__ALTERNATIVE

boolean

false

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

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__CLIENTS__NATIVE_RUNTIME_INITIALIZED

boolean

false

quarkus.cxf.endpoint."endpoints".implementor

The service endpoint implementation class

Environment variable: QUARKUS_CXF_ENDPOINT__ENDPOINTS__IMPLEMENTOR

string

quarkus.cxf.endpoint."endpoints".wsdl

The service endpoint WSDL path

Environment variable: QUARKUS_CXF_ENDPOINT__ENDPOINTS__WSDL

string

quarkus.cxf.endpoint."endpoints".soap-binding

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__ENDPOINTS__SOAP_BINDING

string

quarkus.cxf.endpoint."endpoints".published-endpoint-url

The published service endpoint URL

Environment variable: QUARKUS_CXF_ENDPOINT__ENDPOINTS__PUBLISHED_ENDPOINT_URL

string

quarkus.cxf.endpoint."endpoints".features

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;
    }
}

Note that the LoggingFeature is available through the Logging Feature extension.

Environment variable: QUARKUS_CXF_ENDPOINT__ENDPOINTS__FEATURES

list of string

quarkus.cxf.endpoint."endpoints".handlers

The comma-separated list of Handler classes

Environment variable: QUARKUS_CXF_ENDPOINT__ENDPOINTS__HANDLERS

list of string

quarkus.cxf.endpoint."endpoints".in-interceptors

The comma-separated list of InInterceptor classes

Environment variable: QUARKUS_CXF_ENDPOINT__ENDPOINTS__IN_INTERCEPTORS

list of string

quarkus.cxf.endpoint."endpoints".out-interceptors

The comma-separated list of OutInterceptor classes

Environment variable: QUARKUS_CXF_ENDPOINT__ENDPOINTS__OUT_INTERCEPTORS

list of string

quarkus.cxf.endpoint."endpoints".out-fault-interceptors

The comma-separated list of OutFaultInterceptor classes

Environment variable: QUARKUS_CXF_ENDPOINT__ENDPOINTS__OUT_FAULT_INTERCEPTORS

list of string

quarkus.cxf.endpoint."endpoints".in-fault-interceptors

The comma-separated list of InFaultInterceptor classes

Environment variable: QUARKUS_CXF_ENDPOINT__ENDPOINTS__IN_FAULT_INTERCEPTORS

list of string

quarkus.cxf.client."clients".wsdl

The client WSDL path

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__WSDL

string

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

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__CLIENTS__SOAP_BINDING

string

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

The client endpoint URL

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__CLIENT_ENDPOINT_URL

string

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

The client endpoint namespace

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__ENDPOINT_NAMESPACE

string

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

The client endpoint name

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__ENDPOINT_NAME

string

quarkus.cxf.client."clients".username

The username for HTTP Basic auth

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__USERNAME

string

quarkus.cxf.client."clients".password

The password for HTTP Basic auth

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__PASSWORD

string

quarkus.cxf.client."clients".features

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

Example:

quarkus.cxf.endpoint.myClient.features = org.apache.cxf.ext.logging.LoggingFeature

Note that the LoggingFeature is available through the Logging Feature extension.

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__FEATURES

list of string

quarkus.cxf.client."clients".handlers

The comma-separated list of Handler classes

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__HANDLERS

list of string

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

The comma-separated list of InInterceptor classes

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__IN_INTERCEPTORS

list of string

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

The comma-separated list of OutInterceptor classes

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__OUT_INTERCEPTORS

list of string

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

The comma-separated list of OutFaultInterceptor classes

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__OUT_FAULT_INTERCEPTORS

list of string

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

The comma-separated list of InFaultInterceptor classes

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__IN_FAULT_INTERCEPTORS

list of string

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

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__CLIENTS__CONNECTION_TIMEOUT

long

30000

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

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__CLIENTS__RECEIVE_TIMEOUT

long

60000

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

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__CLIENTS__CONNECTION_REQUEST_TIMEOUT

long

60000

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

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

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__AUTO_REDIRECT

boolean

false

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

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__CLIENTS__MAX_RETRANSMITS

int

-1

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

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__CLIENTS__ALLOW_CHUNKING

boolean

true

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

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__CLIENTS__CHUNKING_THRESHOLD

int

4096

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

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__CLIENTS__CHUNK_LENGTH

int

-1

quarkus.cxf.client."clients".accept

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

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__ACCEPT

string

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

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

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__ACCEPT_LANGUAGE

string

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

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

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__ACCEPT_ENCODING

string

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

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__CLIENTS__CONTENT_TYPE

string

quarkus.cxf.client."clients".host

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__CLIENTS__HOST

string

quarkus.cxf.client."clients".connection

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__CLIENTS__CONNECTION

CLOSE, KEEP_ALIVE

keep-alive

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

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__CLIENTS__CACHE_CONTROL

string

quarkus.cxf.client."clients".version

HTTP Version used for the connection. The "auto" default will use whatever the default is for the HTTPConduit implementation.

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__VERSION

string

auto

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

aka User-Agent Specifies the type of browser is sending the request. This is usually only needed when sites have HTML customized to Netscape vs IE, etc, but can also be used to optimize for different SOAP stacks.

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__BROWSER_TYPE

string

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

Specifies the URL of a decoupled endpoint for the receipt of responses over a separate provider→consumer connection.

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__DECOUPLED_ENDPOINT

string

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

Specifies the address of proxy server if one is used.

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__PROXY_SERVER

string

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

Specifies the port number used by the proxy server.

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__PROXY_SERVER_PORT

int

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

Specifies the list of hostnames that will not use the proxy configuration. Examples of value: * "localhost" → A single hostname * "localhost|www.google.com" → 2 hostnames that will not use the proxy configuration * "localhost|www.google.*|*.apache.org" → It’s also possible to use a pattern-like value

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__NON_PROXY_HOSTS

string

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

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

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__PROXY_SERVER_TYPE

http, socks

http

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

Username for the proxy authentication

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__PROXY_USERNAME

string

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

Password for the proxy authentication

Environment variable: QUARKUS_CXF_CLIENT__CLIENTS__PROXY_PASSWORD

string

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

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 this value is equivalent with URLConnectionHTTPConduitFactory (this may change, once issue #992 gets resolved in CXF)

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

  • 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__CLIENTS__HTTP_CONDUIT_FACTORY

QuarkusCXFDefault, CXFDefault, HttpClientHTTPConduitFactory, URLConnectionHTTPConduitFactory