HTTP Connector 1.11 Reference

String

A comma separated list of protocols enabled for this context.

String

A comma separated list of cipher suites enabled for this context.

Truststore

Configures the TLS truststore.

Keystore

Configures the TLS keystore.

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

String

Password used to protect the truststore.

String

Type of store.

String

Encryption algorithm that the truststore uses.

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

String

The path to the keystore. Mule resolves the path relative to the current classpath and file system.

String

The type of store.

String

The alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

String

The password used to protect the private key.

String

The password used to protect the keystore.

String

The encryption algorithm that the keystore uses.

Boolean

Which elements to verify in the certificate chain:

Verify only the last element in the certificate chain.

Verify all elements in the certificate chain.

Boolean

How to check certificate validity:

Check the Certification Revocation List (CRL) for certificate validity.

Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

Boolean

Whether to use the secondary method to check certificate validity:

Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

Don’t use the secondary method to check certificate validity.

Boolean

What to do if the revocation server can’t be reached or is busy:

Avoid verification failure.

Allow the verification to fail.

String

The URL of the OCSP responder.

String

The alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

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.

Number

Frequency of reconnection attempts, in milliseconds.

Number

How many reconnection attempts the Mule app can make.

Number

Frequency of reconnection attempts, in milliseconds.

Boolean

Enables or disables HTTP/1.

true

Boolean

Enables or disables HTTP/2.

true

Number

Allows the sender to inform the remote endpoint of the maximum size of the header compression table used to decode header blocks, in octets. The encoder can select any size equal to or less than this value by using signaling specific to the header compression format inside a header block. The initial value is 4,096 octets.

4096

Number

Indicates the maximum number of concurrent streams that the sender allows. This limit is directional: it applies to the number of streams that the sender permits the receiver to create. Initially, there is no limit to this value. Set this value to 100 or higher to avoid reducing parallelism. Don’t treat a value of 0 for SETTINGS_MAX_CONCURRENT_STREAMS as special by endpoints. A zero value does prevent the creation of new streams; however, this can also happen for any limit that is exhausted with active streams. Servers set a zero value only for short durations. If a server doesn’t want to accept requests, closing the connection is more appropriate.

Number

Indicates the sender’s initial window size (in octets) for stream-level flow control. The initial value is 2^16-1 (65,535) octets.

65535

Number

Indicates the size of the largest frame payload that the sender is willing to receive, in octets. The initial value is 2^14 (16,384) octets. The value advertised by an endpoint must be between this initial value and the maximum allowed frame size (2^24-1 or 16,777,215 octets), inclusive.

16384

Number

This advisory setting informs a peer of the maximum size of header list that the sender is prepared to accept, in octets. The value is based on the uncompressed size of header fields, including the length of the name and value in octets plus an overhead of 32 octets for each header field. For any given request, a lower limit than what is advertised can be enforced. The initial value of this setting is unlimited.

8192

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. Former http.listener.path.

x

String

Full path requested, encoded as received.

x

String

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

x

String

Path computed from masking the listenerPath and taking the difference. This is only calculated when the listenerPath isn’t null.

x

String

HTTP version of the request. Former http.version.

x

String

HTTP scheme of the request. Former http.scheme.

x

String

HTTP method of the request. Former http.method.

x

String

Full URI of the request. Former http.request.uri.

x

String

Full URI of the request, encoded as received.

x

String

Query string of the request. Former http.query.string.

x

String

Local host address from the server.

x

String

Remote host address from the sender. Former http.remote.address.

x

Certificate Data

Client certificate (if 2 way TLS is enabled). Former http.client.cert.

Object

Query parameters map built from the parsed string. Former http.query.params.

x

Object

URI parameters extracted from the request path. Former http.uri.params.

x

String

Full path requested. Former http.request.path.

x

Object

Map of HTTP headers in the message. Former properties.

x

Number

Array of String

Binary

Array of String

Array of Certificate Extension

Array of Alternative Name Data

Principal Data

Array of Boolean

X500 Principal Data

Array of Boolean

String

Array of String

Date

Date

Public Key Data

Number

Serial Number Data

String

String

Binary

Binary

Array of Alternative Name Data

Principal Data

X500 Principal Data

String

Number

Boolean

String

Binary

String

Number

String

String

String

String

Binary

Number

Number

String

Number

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer doesn’t expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Number

Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit.

Enumeration, one of:

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

Number

Maximum amount of memory that the stream uses for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

Enumeration, one of:

Unit for the In Memory Size field.

Number

Maximum number of times that a redelivered request is processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Boolean

If true, Mule uses a secure hash algorithm to identify a redelivered message.

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

String

One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is false.

Object Store

Configures the object store that stores the redelivery counter for each message.

String

Path used in the connectivity test request URI.

x

String

HTTP Method for the connectivity test request.

GET

Boolean

Specifies whether to follow redirects or not.

true

Number

Maximum time that the request element blocks the execution of the flow waiting for the HTTP response.

10000

Enumeration, one of:

Response timeout time unit.

MILLISECONDS

String

The body in the connectivity test request. It can be an expression, but it doesn’t have any binding.

Array of Request Header

HTTP headers the connectivity test request includes. It allows multiple headers with the same key.

Array of Query Parameter

Query parameters the connectivity test request includes. It allows multiple query params with the same key.

Array of URI Parameter

URI parameters the connectivity test request includes.

One of:

Validation applied to the connectivity test response.

String

Key for this type.

x

String

Value for this type.

x

String

Key for this type.

x

String

Value for this type.

x

String

Key for this type.

x

String

Value for this type.

x

Number

30000

Boolean

true

Number

Boolean

false

Boolean

true

Number

Number

Number

Boolean

true

Number

Maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Enumeration, one of:

Time unit for the Max Idle Time field.

String

Key for this type.

x

String

Value for this type.

x

String

The key name for default query parameter.

x

String

The value for default query parameter.

x

Number

The HTTP status code of the response. Former http.status.

x

String

The HTTP reason phrase of the response. Former http.reason.

x

Object

The map of HTTP headers in the message. Former properties.

x

String

The key name for the HTTP header.

x

String

The value for the HTTP header. It can be an expression depending on a watermarking value that is resolved

x

String

The key name for the HTTP URI parameter.

x

String

The value for the HTTP URI parameter. It can be an expression depending on a watermarking value that is resolved

x

String

The key name for the HTTP query parameter.

x

String

The value for the HTTP query parameter. It can be an expression depending on a watermarking value that is resolved

x

String

The username to authenticate.

x

String

The password to authenticate.

x

Boolean

Configures if authentication is preemptive or not. Preemptive authentication sends 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 is preemptive or not. Preemptive authentication sends 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 is preemptive or not. Preemptive authentication sends 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 is sent.

x

Number

Port where the proxy requests is 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 isn’t used

String

The domain to authenticate against the proxy.

x

String

Host where the proxy requests is sent.

x

Number

Port where the proxy requests is 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 isn’t used

String

Status codes that are considered.

x

String

Status codes that are considered.

x

String

DataWeave expression.

x

String

x

Number

x

Array of Method

Array of Header

Array of Header

String

HTTP method name.

x

String

HTTP header name.

x