HTTP Connector 1.10 Reference

String

A comma separated list of protocols enabled for this context.

String

A comma separated list of cipher suites enabled for this context. Use IANA (Internet Assigned Numbers Authority) naming convention for the cipher suites. Check the OpenSSL - IANA mapping for reference. Additionally, review TLS Configuration Examples.

Trust Store

Configures the truststore for TLS.

Key Store

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Configures a revocation check for TLS.

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

String

The password used to protect the trust store.

String

The type of store used.

String

The algorithm used by the trust store.

Boolean

If true, no certificate validations are performed, rendering connections vulnerable to attacks. Use at your own risk.

String

The location (which resolves relative to the current classpath and file system, if possible) of the key store.

String

The type of store used.

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file is used by default.

String

The password used to protect the private key.

String

The password used to protect the key store.

String

The algorithm used by the key store.

Boolean

Only verify the last element of the certificate chain.

Boolean

Try CRL instead of OCSP first.

Boolean

Do not use the secondary checking method (the one not selected before).

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

String

The URL of the OCSP responder.

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

String

The path to the CRL file.

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy

The reconnection strategy to use

CORS Listener Interceptor

Interceptor which validates that requests match CORS specification and acts on responses accordingly.

x

Boolean

false

Array of One of:

x

String

Full path where the request was received.

x

String

Full path requested, encoded as received. @since 1.5.0

x

String

Path where the request was received, without considering the base path.

x

String

Path computed from masking the listenerPath and taking the difference. Note that this is only calculated when the null otherwise.

x

String

HTTP version of the request.

x

String

HTTP scheme of the request.

x

String

HTTP method of the request.

x

String

Full URI of the request.

x

String

Full URI of the request, encoded as received. @since 1.5.0

x

String

Query string of the request.

x

String

Local host address from the server.

x

String

Remote host address from the sender.

x

Any

Client certificate (if 2 way TLS is enabled).

Object

Query parameters map built from the parsed string.

x

Object

URI parameters extracted from the request path.

x

String

Full path requested.

x

Object

Map of HTTP headers in the message.

x

Number

This is the amount of memory allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Number

How much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Number

This is the maximum amount of memory that the buffer can use. If the buffer uses more than that, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means there’s no limit.

Enumeration, one of:

The unit in which all these attributes are expressed

Number

Defines the maximum memory that the stream can use to keep data in memory. If more than that is consumed, the content is buffered on disk.

Enumeration, one of:

The unit in which maxInMemorySize is expressed

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Boolean

Whether to use a secure hash algorithm to identify a redelivered message

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

ObjectStore

The object store where the redelivery counter for each message is stored.

Number

Time to wait during a connection to a remote server before failing with a timeout. If the configured requester host resolves to multiple IP addresses, the host tries to connect to every single IP address. Therefore, if every connection times out, the number of resolved IP addresses multiplies the global connection timeout.

30000

Boolean

Indicates whether or not to collect the transmitted data for greater efficiency and send the data immediately.

true

Number

How long, in milliseconds, the socket takes to close, so any remaining data is transmitted correctly.

Boolean

Indicates whether the open socket connections unused for a long period and with an unavailable connection can be closed.

false

Boolean

Indicates whether the socket fails during its creation if the host set on the endpoint cannot be resolved.

true

Number

Size of the buffer, in bytes, when sending data.

Number

Size of the buffer, in bytes, when receiving data.

Number

Time, in milliseconds, that the socket waits in a blocking operation before failing.

Boolean

When trying to bind the port, indicates whether to reuse (true) or fail (false) the configured port.

true

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Enumeration, one of:

A time unit that qualifies the maxIdleTime attribute

String

Key for default HTTP headers.

x

String

Value for default HTTP headers.

x

String

Key name for default query parameter.

x

String

Value for default query parameter.

x

Number

HTTP status code of the response.

x

String

HTTP reason phrase of the response.

x

Object

Map of HTTP headers in the message.

x

String

The username to authenticate.

x

String

The password to authenticate.

x

Boolean

Configures if authentication should be preemptive or not. Preemptive authentication will send the authentication header in the first request, instead of waiting for a 401 response code to send it.

true

String

The username to authenticate.

x

String

The password to authenticate.

x

Boolean

Configures if authentication should be preemptive or not. Preemptive authentication will send the authentication header in the first request, instead of waiting for a 401 response code to send it.

true

String

The domain to authenticate.

String

The workstation to authenticate.

String

The username to authenticate.

x

String

The password to authenticate.

x

Boolean

Configures if authentication should be preemptive or not. Preemptive authentication will send the authentication header in the first request, instead of waiting for a 401 response code to send it.

true

String

Host where the proxy requests will be sent.

x

Number

Port where the proxy requests will be sent.

x

String

The username to authenticate against the proxy.

String

The password to authenticate against the proxy.

String

A list of comma separated hosts against which the proxy is not used

String

The domain to authenticate against the proxy.

x

String

Host where the proxy requests will be sent.

x

Number

Port where the proxy requests will be sent.

x

String

The username to authenticate against the proxy.

String

The password to authenticate against the proxy.

String

A list of comma separated hosts against which the proxy is not used

String

Status codes that are considered.

x

String

Status codes that are considered.

x

String

URL of the Origins, from which the browser can load resources.

x

Number

The amount of time, in seconds, to cache the results of a preflight request.

x

Array of Method

Indicates which HTTP methods are permitted while accessing the resources from the origin.

Array of Header

In preflight requests, indicates the HTTP headers to use during the actual request.

Array of Header

Response headers exposed in the request.

String

HTTP method name.

x

String

HTTP header name.

x