UnboundID Metrics Engine - HTTP Connection Handler

Metrics Engine Documentation Index
Configuration Reference Home

HTTP Connection Handler

The HTTP Connection Handler may be used to interact with clients using the HyperText Transport Protocol, used by Web clients and services.

↓Parent Component
↓Relations To this Component
↓Properties
↓dsconfig Usage

Parent Component

The HTTP Connection Handler component inherits from the Connection Handler

Relations from This Component

The following components have a direct aggregation relation from HTTP Connection Handlers:

HTTP Operation Log Publisher

HTTP Servlet Extension

Key Manager Provider

Trust Manager Provider

Web Application Extension

Properties

The properties supported by this managed object are as follows:

Basic Properties:	Advanced Properties:
↓ description	↓ keep-stats
↓ enabled	↓ accept-backlog
↓ listen-address	↓ allow-tcp-reuse-address
↓ listen-port	↓ disable-tls-renegotiation
↓ use-ssl
↓ http-servlet-extension
↓ web-application-extension
↓ http-operation-log-publisher
↓ key-manager-provider
↓ trust-manager-provider
↓ num-request-handlers

Basic Properties

description

Description	A description for this Connection Handler
Default Value	None
Allowed Values	A string
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

enabled

Description	Indicates whether the Connection Handler is enabled.
Default Value	None
Allowed Values	true false
Multi-Valued	No
Required	Yes
Admin Action Required	None. Modification requires no further action

listen-address

Description	Specifies the address on which to listen for connections from HTTP clients. If no value is defined, the server will listen on all addresses on all interfaces.
Default Value	The server will listen on all addresses on all interfaces.
Allowed Values	An IP address
Multi-Valued	No
Required	No
Admin Action Required	The HTTP Connection Handler must be disabled and re-enabled for changes to this setting to take effect. Modification requires that this component be disabled and then re-enabled

listen-port

Description	Specifies the port number on which the HTTP Connection Handler will listen for connections from clients. Only a single port number may be provided.
Default Value	None
Allowed Values	An integer value. Lower limit is 1. Upper limit is 65535 .
Multi-Valued	No
Required	Yes
Admin Action Required	The HTTP Connection Handler must be disabled and re-enabled for changes to this setting to take effect. Modification requires that this component be disabled and then re-enabled

use-ssl

Description	Indicates whether the HTTP Connection Handler should use SSL. If enabled, the HTTP Connection Handler will use SSL to encrypt communication with the clients.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	The HTTP Connection Handler must be disabled and re-enabled for changes to this setting to take effect. Modification requires that this component be disabled and then re-enabled

http-servlet-extension

Description	Specifies information about servlets that will be provided via this connection handler.
Default Value	None
Allowed Values	The DN of any HTTP Servlet Extension.
Multi-Valued	Yes
Required	No
Admin Action Required	The HTTP Connection Handler must be disabled and re-enabled for changes to this setting to take effect. Modification requires that this component be disabled and then re-enabled

web-application-extension

Description	Specifies information about web applications that will be provided via this connection handler.
Default Value	None
Allowed Values	The DN of any Web Application Extension.
Multi-Valued	Yes
Required	No
Admin Action Required	The HTTP Connection Handler must be disabled and re-enabled for changes to this setting to take effect. Modification requires that this component be disabled and then re-enabled

http-operation-log-publisher

Description	Specifies the set of HTTP operation loggers that should be used to log information about requests and responses for operations processed through this HTTP Connection Handler.
Default Value	None
Allowed Values	The DN of any HTTP Operation Log Publisher. The associated HTTP operation logger must be enabled.
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

key-manager-provider

Description	Specifies the key manager provider that will be used to obtain the certificate to present to HTTPS clients. This must be provided if use-ssl is set to true.
Default Value	None
Allowed Values	The DN of any Key Manager Provider. The referenced key manager provider must be enabled if SSL is to be used.
Multi-Valued	No
Required	No
Admin Action Required	The HTTP Connection Handler must be disabled and re-enabled for changes to this setting to take effect. Modification requires that this component be disabled and then re-enabled

trust-manager-provider

Description	Specifies the trust manager provider that will be used to validate any certificates presented by HTTPS clients. This must be provided if use-ssl is set to true.
Default Value	None
Allowed Values	The DN of any Trust Manager Provider. The referenced trust manager provider must be enabled if SSL is to be used.
Multi-Valued	No
Required	No
Admin Action Required	The HTTP Connection Handler must be disabled and re-enabled for changes to this setting to take effect. Modification requires that this component be disabled and then re-enabled

num-request-handlers

Description	Specifies the number of threads that will be used for accepting connections and reading requests from clients. A value of zero will cause the number of request handlers to be based on the number of available CPUs.
Default Value	0
Allowed Values	An integer value. Lower limit is 0.
Multi-Valued	No
Required	No
Admin Action Required	The HTTP Connection Handler must be disabled and re-enabled for changes to this setting to take effect. Modification requires that this component be disabled and then re-enabled

Advanced Properties

keep-stats (Advanced Property)

Description	Indicates whether to enable statistics collection for this connection handler.
Default Value	true
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

accept-backlog (Advanced Property)

Description	Specifies the number of concurrent outstanding connection attempts that the connection handler should allow. The default value should be acceptable in most cases, but it may need to be increased in environments that may attempt to establish large numbers of connections simultaneously.
Default Value	128
Allowed Values	An integer value. Lower limit is 1.
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

allow-tcp-reuse-address (Advanced Property)

Description	Indicates whether the server should attempt to reuse socket descriptors. This may be useful in environments with a high rate of connection establishment and termination.
Default Value	true
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

disable-tls-renegotiation (Advanced Property)

Description	Indicates whether to disable TLS renegotiation, which is rarely used by legitimate clients but has been used by malicious clients to exploit a vulnerability in some TLS implementations that could allow arbitrary content to be injected at the beginning of an encrypted message.
Default Value	true
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

dsconfig Usage

To list the configured Connection Handlers:

dsconfig list-connection-handlers
     [--property {propertyName}] ...

To view the configuration for an existing Connection Handler:

dsconfig get-connection-handler-prop
     --handler-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Connection Handler:

dsconfig set-connection-handler-prop
     --handler-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new HTTP Connection Handler:

dsconfig create-connection-handler
     --handler-name {name}
     --type http
     --set enabled:{propertyValue}
     --set listen-port:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Connection Handler:

dsconfig delete-connection-handler
     --handler-name {name}