Package io.quarkiverse.cxf
Interface CxfClientConfig
-
public interface CxfClientConfigA class that provides configurable options of a CXF client.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classCxfClientConfig.HTTPConduitImplstatic classCxfClientConfig.WellKnownHostnameVerifier
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Optional<String>accept()Specifies the MIME types the client is prepared to handle (e.g., HTML, JPEG, GIF, etc.)Optional<String>acceptEncoding()Specifies the encoding the client is prepared to handle (e.g., gzip)Optional<String>acceptLanguage()Specifies the language the client desires (e.g., English, French, etc.)booleanallowChunking()If true, the client is free to use chunking streams if it wants, but it is not required to use chunking streams.booleanautoRedirect()Specifies if the consumer will automatically follow a server issued redirection.Optional<String>browserType()aka User-Agent Specifies the type of browser is sending the request.Optional<String>cacheControl()Most commonly used to specify no-cache, however the standard supports a dozen or so caching related directives for requestsintchunkingThreshold()If AllowChunking is true, this sets the threshold at which messages start getting chunked.intchunkLength()Specifies the chunk length for a HttpURLConnection.Optional<String>clientEndpointUrl()The client endpoint URL@WithConverter(ConnectionTypeConverter.class) org.apache.cxf.transports.http.configuration.ConnectionTypeconnection()The connection disposition.longconnectionRequestTimeout()Specifies the amount of time, in milliseconds, used when requesting a connection from the connection manager(if appliable).longconnectionTimeout()Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out.Optional<String>contentType()Specifies the content type of the stream being sent in a post request.Optional<String>decoupledEndpoint()Specifies the URL of a decoupled endpoint for the receipt of responses over a separate provider->consumer connection.Optional<String>endpointName()The client endpoint nameOptional<String>endpointNamespace()The client endpoint namespaceOptional<List<String>>features()A comma-separated list of fully qualified CXF Feature class names.Optional<List<String>>handlers()The comma-separated list of Handler classesOptional<String>host()Specifies the Internet host and port number of the resource on which the request is being invoked.Optional<String>hostnameVerifier()Can be one of the following: One of the well known values:AllowAllHostnameVerifier,HttpsURLConnectionDefaultHostnameVerifierA fully qualified class name implementingjavax.net.ssl.HostnameVerifierto look up in the CDI container.Optional<CxfClientConfig.HTTPConduitImpl>httpConduitFactory()Select theHTTPConduitFactoryimplementation for this client.Optional<List<String>>inFaultInterceptors()The comma-separated list of InFaultInterceptor classesOptional<List<String>>inInterceptors()The comma-separated list of InInterceptor classesLoggingConfig.PerClientOrServiceLoggingConfiglogging()Logging related configurationintmaxRetransmits()Specifies the maximum amount of retransmits that are allowed for redirects.Optional<String>nonProxyHosts()Specifies the list of hostnames that will not use the proxy configuration.Optional<List<String>>outFaultInterceptors()The comma-separated list of OutFaultInterceptor classesOptional<List<String>>outInterceptors()The comma-separated list of OutInterceptor classesOptional<String>password()The password for HTTP Basic authOptional<String>proxyPassword()Password for the proxy authenticationOptional<String>proxyServer()Specifies the address of proxy server if one is used.Optional<Integer>proxyServerPort()Specifies the port number used by the proxy server.org.apache.cxf.transports.http.configuration.ProxyServerTypeproxyServerType()Specifies the type of the proxy server.Optional<String>proxyUsername()Username for the proxy authenticationlongreceiveTimeout()Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out.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_BINDINGOptional<String>trustStore()The trust store location for this client.Optional<String>trustStorePassword()The trust store passwordStringtrustStoreType()The type of the trust store.Optional<String>username()The username for HTTP Basic authStringversion()HTTP Version used for the connection.Optional<String>wsdlPath()The client WSDL path
-
-
-
Method Detail
-
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
-
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
LoggingFeatureis available through the Logging Feature extension.
-
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.
-
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.
-
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.
-
autoRedirect
@WithDefault("false") boolean autoRedirect()Specifies if the consumer will automatically follow a server issued redirection. (name is not part of standard)
-
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)
-
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.
-
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.
-
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.
-
accept
Optional<String> accept()
Specifies the MIME types the client is prepared to handle (e.g., HTML, JPEG, GIF, etc.)
-
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)
-
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).
-
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.
-
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.
-
cacheControl
Optional<String> cacheControl()
Most commonly used to specify no-cache, however the standard supports a dozen or so caching related directives for requests
-
version
@WithDefault("auto") String version()HTTP Version used for the connection. The "auto" default will use whatever the default is for the HTTPConduit implementation.
-
browserType
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
Optional<String> decoupledEndpoint()
Specifies the URL of a decoupled endpoint for the receipt of responses over a separate provider->consumer connection.
-
proxyServerPort
Optional<Integer> proxyServerPort()
Specifies the port number used by the proxy server.
-
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
-
proxyServerType
@WithDefault("HTTP") org.apache.cxf.transports.http.configuration.ProxyServerType proxyServerType()Specifies the type of the proxy server. Can be either HTTP or SOCKS.
-
httpConduitFactory
Optional<CxfClientConfig.HTTPConduitImpl> httpConduitFactory()
Select theHTTPConduitFactoryimplementation for this client.QuarkusCXFDefault(default): ifio.quarkiverse.cxf:quarkus-cxf-rt-transports-http-hc5is present in class path, then itsHTTPConduitFactoryimplementation will be used; otherwise this value is equivalent withURLConnectionHTTPConduitFactory(this may change, once issue #992 gets resolved in CXF)CXFDefault: the selection ofHTTPConduitFactoryimplementation is left to CXFHttpClientHTTPConduitFactory: theHTTPConduitFactoryfor this client will be set to an implementation always returningorg.apache.cxf.transport.http.HttpClientHTTPConduit. This will usejava.net.http.HttpClientas the underlying HTTP client.URLConnectionHTTPConduitFactory: theHTTPConduitFactoryfor this client will be set to an implementation always returningorg.apache.cxf.transport.http.URLConnectionHTTPConduit. This will usejava.net.HttpURLConnectionas 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.
-
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.HostnameVerifierto look up in the CDI container. - A bean name prefixed with
#that will be looked up in the CDI container; example:#myHostnameVerifier
HostnameVerifieris delegated to CXF, which boils down toorg.apache.cxf.transport.https.httpclient.DefaultHostnameVerifierwith the defaultorg.apache.cxf.transport.https.httpclient.PublicSuffixMatcherLoaderas returned fromPublicSuffixMatcherLoader.getDefault(). - One of the well known values:
-
-