Package io.quarkiverse.cxf

Interface CxfClientConfig

public interface CxfClientConfig
A class that provides configurable options of a CXF client.

  • Method Details

    • wsdlPath

      @WithName("wsdl") Optional<String> wsdlPath()
      The client WSDL path

    • soapBinding

      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

      Optional<String> clientEndpointUrl()
      The client endpoint URL

    • endpointNamespace

      Optional<String> endpointNamespace()
      The client endpoint namespace

    • endpointName

      Optional<String> endpointName()
      The client endpoint name

    • username

      Optional<String> username()
      The username for HTTP Basic authentication

    • password

      Optional<String> password()
      The password for HTTP Basic authentication

    • secureWsdlAccess

      @WithDefault("false") boolean secureWsdlAccess()
      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.
      Since:
      2.7.0

    • logging

      LoggingConfig.PerClientOrServiceLoggingConfig logging()
      Logging related configuration

    • features

      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

      Optional<List<String>> handlers()
      The comma-separated list of Handler classes

    • inInterceptors

      Optional<List<String>> inInterceptors()
      The comma-separated list of InInterceptor classes

    • outInterceptors

      Optional<List<String>> outInterceptors()
      The comma-separated list of OutInterceptor classes

    • outFaultInterceptors

      Optional<List<String>> outFaultInterceptors()
      The comma-separated list of OutFaultInterceptor classes

    • inFaultInterceptors

      Optional<List<String>> inFaultInterceptors()
      The comma-separated list of InFaultInterceptor classes

    • connectionTimeout

      @WithDefault("30000") 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.
      Since:
      2.2.3

    • receiveTimeout

      @WithDefault("60000") long receiveTimeout()
      Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. 0 is infinite.
      Since:
      2.2.3

    • connectionRequestTimeout

      @WithDefault("60000") long connectionRequestTimeout()
      Specifies the amount of time, in milliseconds, used when requesting a connection from the connection manager(if appliable). 0 is infinite.
      Since:
      2.2.3

    • autoRedirect

      @WithDefault("false") boolean autoRedirect()
      Specifies if the consumer will automatically follow a server issued redirection. (name is not part of standard)
      Since:
      2.2.3

    • maxRetransmits

      @WithDefault("-1") 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)
      Since:
      2.2.3

    • allowChunking

      @WithDefault("true") 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.
      Since:
      2.2.3

    • chunkingThreshold

      @WithDefault("4096") int chunkingThreshold()
      If AllowChunking is true, this sets the threshold at which messages start getting chunked. Messages under this limit do not get chunked.
      Since:
      2.2.3

    • chunkLength

      @WithDefault("-1") 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.
      Since:
      2.2.3

    • accept

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

    • acceptLanguage

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

    • acceptEncoding

      Optional<String> acceptEncoding()
      Specifies the encoding the client is prepared to handle (e.g., gzip)
      Since:
      2.2.3

    • contentType

      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).
      Since:
      2.2.3

    • host

      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.
      Since:
      2.2.3

    • connection

      @WithDefault("Keep-Alive") @WithConverter(ConnectionTypeConverter.class) @WithConverter(ConnectionTypeConverter.class) 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.
      Since:
      2.2.3

    • cacheControl

      Optional<String> cacheControl()
      Most commonly used to specify no-cache, however the standard supports a dozen or so caching related directives for requests
      Since:
      2.2.3

    • version

      @WithDefault("auto") String version()
      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.myClient.http-conduit-factory. Other possible values: 1.1, 2. Note that some of these values might be unsupported by some HTTPConduit implementations.
      Since:
      2.2.3

    • browserType

      Optional<String> browserType()
      The value of the User-Agent HTTP header.
      Since:
      2.2.3

    • decoupledEndpoint

      Optional<String> decoupledEndpoint()
      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.myClient.decoupled-endpoint-base before being used as a value for the WS-Addressing ReplyTo message header.
      Since:
      2.2.3

    • proxyServer

      Optional<String> proxyServer()
      Specifies the address of proxy server if one is used.
      Since:
      2.2.3

    • proxyServerPort

      Optional<Integer> proxyServerPort()
      Specifies the port number used by the proxy server.
      Since:
      2.2.3

    • nonProxyHosts

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

    • proxyServerType

      @WithDefault("HTTP") org.apache.cxf.transports.http.configuration.ProxyServerType proxyServerType()
      Specifies the type of the proxy server. Can be either HTTP or SOCKS.
      Since:
      2.2.3

    • proxyUsername

      Optional<String> proxyUsername()
      Username for the proxy authentication
      Since:
      2.2.3

    • proxyPassword

      Optional<String> proxyPassword()
      Password for the proxy authentication
      Since:
      2.2.3

    • httpConduitFactory

      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.

    • trustStore

      Optional<String> trustStore()
      The trust store location for this client. The resource is first looked up in the classpath, then in the file system.

    • trustStorePassword

      Optional<String> trustStorePassword()
      The trust store password

    • trustStoreType

      @WithDefault("JKS") String trustStoreType()
      The type of the trust store.

    • hostnameVerifier

      Optional<String> hostnameVerifier()
      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().

    • schemaValidationEnabledFor

      @WithName("schema-validation.enabled-for") Optional<org.apache.cxf.annotations.SchemaValidation.SchemaValidationType> schemaValidationEnabledFor()
      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 &#64;org.apache.cxf.annotations.SchemaValidation or &#64;org.apache.cxf.annotations.EndpointProperty(key = "schema-validation-enabled", value = "true") annotations.
      Since:
      2.7.0