Versions Compared

Key

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

Configuring the Undertow Runtime

Overview

This section is for configuring the Undertow runtime used for the CXF standalone model. The Undertow runtime is used by HTTP servers using a decoupled endpoint. The Undertow runtime's thread pool and handlers can be configured. You can also set a number of the security settings for an HTTP service provider through the Undertow runtime.

Namespace

The elements used to configure the Undertow runtime are defined in the namespace http://cxf.apache.org/transports/http-undertow/configuration. It is commonly referred to using the prefix httpu. In order to use the Undertow configuration elements you will need to add the lines shown below to the beans element of your endpoint's configuration file. In addition, you will need to add the configuration elements' namespace to the xsi:schemaLocation attribute.

Code Block
xml
xml
<beans ...
  xmlns:httpu="http://cxf.apache.org/transports/http-undertow/configuration
  ...
  xsi:schemaLocation="...
                      http://cxf.apache.org/transports/http-undertow/configuration
                      http://cxf.apache.org/schemas/configuration/http-undertow.xsd
                      ...>

The engine-factory element

The engine-factory element

The httpu:engine-factory element is the root element used to configure the Undertow runtime used by an application. It has a single required attribute, bus, whose value is the name of the Bus that manages the Undertow instances being configured.

Tip

The value is typically cxf which is the name of the default Bus instance.

The httpu:engine-factory element has three children that contain the information used to configure the HTTP ports instantiated by the Undertow runtime factory. The children are described below.

httpu:engine

Specifies the configuration for a particular Undertow runtime instance.

httpu:identifiedTLSServerParameters

Specifies a reusable set of properties for securing an HTTP server. It has a single attribute, id, that specifies a unique identifier by which the property set can be referred.

httpu:identifiedThreadingParameters

Specifies a reusable set of properties for controlling a Undertow instance's thread & NIO pools. It has a single attribute, id, that specifies a unique identifier by which the property set can be referred.

...