Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Configuring the Undertow Runtime

...

The child elements used to provide the configuration properties are described below.

ElementDescription

httpu:tlsServerParameters

Specifies a set of properties for configuring the security used for the specific Undertow instance. See the TLS Configuration page for more information.

httpu:tlsServerParametersRef

Refers to a set of security properties defined by a identifiedTLSServerParameters element. The id attribute provides the id of the referred identifiedTLSServerParameters element.

httpu:threadingParameters

Specifies the size of the thread & IO pools used by the specific Undertow instance.

httpu:threadingParametersRef

Refers to a set of properties defined by a identifiedThreadingParameters element. The id attribute provides the id of the referred identifiedThreadingParameters element.

httpu:handlers

You can use Spring Beans syntax to instantiate a Undertow handler list and set these handlers' properties , the Undertow's handlers will be set to the Undertow server engine

Configuring the thread & IO pools

...

  • Specifying the size of thread pool using a identifiedThreadingParameters element in the engine-factory element. You then refer to the element using a threadingParametersRef element.
  • Specify the size of the of thread pool directly using a threadingParameters element.
    The threadingParameters has four attributes to specify the size of a thread & IO worker pools. The attributes are described below. 

    Warning

    The httpu:identifiedThreadingParameters element has a single child threadingParameters element


AttributeDescription

minThreads

Specifies the minimum number of threads available to the Undertow instance for processing requests.

maxThreads

Specifies the maximum number of threads available to the Undertow instance for processing requests.

workerIOThreadsSpecifies the number of worker threads available to the Undertow instance for I/O processing.
workerIONameSpecifies the name of the Undertow instance worker thread pool.

Anchor
undertow_http2
undertow_http2
HTTP/2 support

If HttpServerEngineSupport#ENABLE_HTTP2  bus property is set, Undertow engine will enable the HTTP/2 support as well: HTTP/2 over cleartext (h2c) if TLS is not configured, regular HTTP/2 otherwise.

Example: https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/basic_http2_undertow

Example

The example below shows a configuration fragment that configures a Jetty instance on port number 9001.

Code Block
xml
xml
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:sec="http://cxf.apache.org/configuration/security"
    xmlns:http="http://cxf.apache.org/transports/http/configuration"
    xmlns:httpu="http://cxf.apache.org/transports/http-undertow/configuration"
    xsi:schemaLocation="http://cxf.apache.org/configuration/security 
        http://cxf.apache.org/schemas/configuration/security.xsd 
        http://cxf.apache.org/transports/http/configuration 
        http://cxf.apache.org/schemas/configuration/http-conf.xsd 
        http://cxf.apache.org/transports/http-undertow/configuration 
        http://cxf.apache.org/schemas/configuration/http-undertow.xsd 
        http://www.springframework.org/schema/beans 
        http://www.springframework.org/schema/beans/spring-beans.xsd">
    <httpu:engine-factory bus="cxf">
        <httpu:engine port="9001">
            <httpu:tlsServerParameters>
                <sec:keyManagers keyPassword="skpass">
                    <sec:keyStore file="src/main/config/serviceKeystore.jks" password="sspass" type="JKS"/>
                </sec:keyManagers>
                <sec:trustManagers>
                    <sec:keyStore file="src/main/config/serviceKeystore.jks" password="sspass" type="JKS"/>
                </sec:trustManagers>
            </httpu:tlsServerParameters>
        </httpu:engine>
    </httpu:engine-factory>
</beans>