Package io.quarkiverse.cxf

Class CxfClientConfig

  • public class CxfClientConfig
extends Object
    A class that provides configurable options of a CXF client.

    • Field Detail

      • wsdlPath

        @ConfigItem(name="wsdl")
public Optional<String> wsdlPath
        The client WSDL path

      • soapBinding

        @ConfigItem
public Optional<String> soapBinding
        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

      • clientEndpointUrl

        @ConfigItem
public Optional<String> clientEndpointUrl
        The client endpoint URL

      • endpointNamespace

        @ConfigItem
public Optional<String> endpointNamespace
        The client endpoint namespace

      • endpointName

        @ConfigItem
public Optional<String> endpointName
        The client endpoint name

      • username

        @ConfigItem
public Optional<String> username
        The username for HTTP Basic auth

      • password

        @ConfigItem
public Optional<String> password
        The password for HTTP Basic auth

      • features

        @ConfigItem
public Optional<List<String>> 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.

      • handlers

        @ConfigItem
public Optional<List<String>> handlers
        The comma-separated list of Handler classes

      • inInterceptors

        @ConfigItem
public Optional<List<String>> inInterceptors
        The comma-separated list of InInterceptor classes

      • outInterceptors

        @ConfigItem
public Optional<List<String>> outInterceptors
        The comma-separated list of OutInterceptor classes

      • outFaultInterceptors

        @ConfigItem
public Optional<List<String>> outFaultInterceptors
        The comma-separated list of OutFaultInterceptor classes

      • inFaultInterceptors

        @ConfigItem
public Optional<List<String>> inFaultInterceptors
        The comma-separated list of InFaultInterceptor classes

      • connectionTimeout

        @ConfigItem(defaultValue="30000")
public long connectionTimeout
        Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. 0 is infinite.

      • receiveTimeout

        @ConfigItem(defaultValue="60000")
public long receiveTimeout
        Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. 0 is infinite.

      • connectionRequestTimeout

        @ConfigItem(defaultValue="60000")
public long connectionRequestTimeout
        Specifies the amount of time, in milliseconds, used when requesting a connection from the connection manager(if appliable). 0 is infinite.

      • autoRedirect

        @ConfigItem(defaultValue="false")
public boolean autoRedirect
        Specifies if the consumer will automatically follow a server issued redirection. (name is not part of standard)

      • maxRetransmits

        @ConfigItem(defaultValue="-1")
public int maxRetransmits
        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)

      • allowChunking

        @ConfigItem(defaultValue="true")
public boolean allowChunking
        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.

      • chunkingThreshold

        @ConfigItem(defaultValue="4096")
public int chunkingThreshold
        If AllowChunking is true, this sets the threshold at which messages start getting chunked. Messages under this limit do not get chunked.

      • chunkLength

        @ConfigItem(defaultValue="-1")
public int chunkLength
        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.

      • accept

        @ConfigItem
public Optional<String> accept
        Specifies the MIME types the client is prepared to handle (e.g., HTML, JPEG, GIF, etc.)

      • acceptLanguage

        @ConfigItem
public Optional<String> acceptLanguage
        Specifies the language the client desires (e.g., English, French, etc.)

      • acceptEncoding

        @ConfigItem
public Optional<String> acceptEncoding
        Specifies the encoding the client is prepared to handle (e.g., gzip)

      • contentType

        @ConfigItem
public Optional<String> contentType
        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).

      • host

        @ConfigItem
public Optional<String> 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.

      • connection

        @ConfigItem(defaultValue="Keep-Alive")
@ConvertWith(ConnectionTypeConverter.class)
public org.apache.cxf.transports.http.configuration.ConnectionType 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.

      • cacheControl

        @ConfigItem
public Optional<String> cacheControl
        Most commonly used to specify no-cache, however the standard supports a dozen or so caching related directives for requests

      • version

        @ConfigItem(defaultValue="auto")
public String version
        HTTP Version used for the connection. The "auto" default will use whatever the default is for the HTTPConduit implementation.

      • browserType

        @ConfigItem
public Optional<String> browserType
        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.

      • decoupledEndpoint

        @ConfigItem
public Optional<String> decoupledEndpoint
        Specifies the URL of a decoupled endpoint for the receipt of responses over a separate provider->consumer connection.

      • proxyServer

        @ConfigItem
public Optional<String> proxyServer
        Specifies the address of proxy server if one is used.

      • proxyServerPort

        @ConfigItem
public Optional<Integer> proxyServerPort
        Specifies the port number used by the proxy server.

      • nonProxyHosts

        @ConfigItem
public Optional<String> nonProxyHosts
        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

      • proxyServerType

        @ConfigItem(defaultValue="HTTP")
public org.apache.cxf.transports.http.configuration.ProxyServerType proxyServerType
        Specifies the type of the proxy server. Can be either HTTP or SOCKS.

      • proxyUsername

        @ConfigItem
public Optional<String> proxyUsername
        Username for the proxy authentication

      • proxyPassword

        @ConfigItem
public Optional<String> proxyPassword
        Password for the proxy authentication

      • httpConduitFactory

        @ConfigItem
public Optional<CxfClientConfig.HTTPConduitImpl> httpConduitFactory
        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.

    • Constructor Detail

      • CxfClientConfig

        public CxfClientConfig()