Configuring the Jetty Runtime
This section is for configuring the Jetty runtime used for the CXF standalone model. The Jetty runtime is used by HTTP servers and HTTP clients using a decoupled endpoint. The Jetty runtime's thread pool, connector and handlers can be configured. You can also set a number of the security settings for an HTTP service provider through the Jetty runtime.
The elements used to configure the Jetty runtime are defined in the namespace
http://cxf.apache.org/transports/http-jetty/configuration. It is commonly referred to using the prefix
httpj. In order to use the Jetty 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
httpj:engine-factory element is the root element used to configure the Jetty runtime used by an application. It has a single required attribute, bus, whose value is the name of the Bus that manages the Jetty instances being configured.
The value is typically cxf which is the name of the default Bus instance.
httpj:engine-factory element has three children that contain the information used to configure the HTTP ports instantiated by the Jetty runtime factory. The children are described below.
Specifies the configuration for a particular Jetty runtime instance.
Specifies a reusable set of properties for securing an HTTP server. It has a single attribute,
Specifies a reusable set of properties for controlling a Jetty instance's thread pool. It has a single attribute,
httpj:engine element is used to configure specific instances of the Jetty runtime. It has a single attribute,
port, that specifies the number of the port being managed by the Jetty instance.
You can specify a value of 0 for the port attribute. Any threading properties specified in an
httpj:engine element with its port attribute set to 0 are used as the configuration for all Jetty listeners that are not explicitly configured.
httpj:engine element can have two children: one for configuring security properties and one for configuring the Jetty instance's thread pool. For each type of configuration you can either directly provide the configuration information or provide a reference to a set of configuration properties defined in the parent
The child elements used to provide the configuration properties are described below.
Specifies a set of properties for configuring the security used for the specific Jetty instance. See the TLS Configuration page for more information.
Refers to a set of security properties defined by a
Specifies the size of the thread pool used by the specific Jetty instance.
Refers to a set of properties defined by a
You can use spring beans syntax to instantiate a connector and set the connector's properties , this connector will be set to the Jetty server engine
You can use spring beans syntax to instantiate a Jetty handler list and set these handlers' properties , the jetty handlers will be set to the Jetty server engine
If the value is true , the Jetty Engine will set up a session manager for the Jetty server engine to maintain the sessions. The default value of it is false.
The the value is true, the Jetty Engine connector's socket will enable the SO_REUSEADDR flage. The default value of it is true. (This feature is available in CXF 2.0.3)
Configuring the thread pool
You can configure the size of a Jetty instance's thread pool by either:
- Specifying the size of thread pool using a
identifiedThreadingParameterselement in the
engine-factoryelement. You then refer to the element using a
Specify the size of the of thread pool directly using a
threadingParametershas two attributes to specify the size of a thread pool. The attributes are described below.
httpj:identifiedThreadingParameterselement has a single child
Specifies the minimum number of threads available to the Jetty instance for processing requests.
Specifies the maximum number of threads available to the Jetty instance for processing requests.
If HttpServerEngineSupport#ENABLE_HTTP2 bus property is set, Jetty engine will enable the HTTP/2 support as well: HTTP/2 over cleartext (h2c) if TLS is not configured, regular HTTP/2 otherwise. It requires additional dependencies to be bundled by the application.
Additionally, for JDK8 you would need to include:
If you are using JDK9 and above, please use the following dependency instead:
The example below shows a configuration fragment that configures a Jetty instance on port number 9001.