WebSockets Connector Reference - Mule 4

String

Base path to use for all resources served through this config.

/

String

Reference to the http:listener-config used to expose the inbound endpoint

x

Number

Timeout for automatically closing idle WebSockets

15

Enumeration, one of:

Time unit that qualifies the #idleSocketTimeout

MINUTES

String

Host where the requests is sent

Number

Port where the requests is sent. If the protocol attribute is WS (default), then the default value is 80. If the protocol attribute is WSS, then the default value is 443.

String

Base path to use for all outbound sockets that reference this config

/

Enumeration, one of:

Protocol to use for outbound communication. Valid values are WS and WSS. Default value is WS. When using WSS, the HTTP communication is secured using TLS/SSL. If WSS is configured as the protocol, then the user can customize the TLS/SSL configuration by defining the tls:context parameter. If tls:context is not defined, then the default JVM certificates are used to establish communication.

WS

Tls

Reference to a TLS config element that enables WSS for outbound sockets

Array of Header

Default HTTP headers the message should include

Array of Query Param

Default query parameters the request should include

Number

A timeout for idle connections to be closed. If not specified, there is no timeout.

Enumeration, one of:

Timeout unit that qualifies the #connectionIdleTimeout

MINUTES

Boolean

Specifies whether or not to follow redirects.

true

Boolean

By default, header keys are stored internally in lower-case. This is to improve performance of headers handling and is functionally correct as specified in the RFC.

false

Number

The maximum number of outbound connections that will be kept open at the same time. By default the number of connections is unlimited.

-1

One of:

Reusable configuration element for outbound connections through a proxy. A proxy element must define host name and port attributes, and, optionally, can define a username and a password.

HttpRequestAuthentication

Authentication method to use for the HTTP request

String

A comma-separated list of protocols enabled for this context

String

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

Trust Store

Key Store

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 set to true, no certificate validations are performed, which renders connections vulnerable to attacks. Use at your own risk.

String

The location (which will be resolved 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 to use. 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

Verify only 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.

String

x

String

x

String

x

String

x

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

How often in milliseconds to reconnect

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Number

How many reconnection attempts to make.

Number

How often in milliseconds to reconnect

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

String

HTTP version of the request

x

String

Local host address from the server

x

String

Remote host address from the sender

x

Any

Client certificate (if two-way TLS is enabled)

String

The socket ID

x

Enumeration, one of:

The socket type

x

Array of String

The groups on which this socket is subscribed

x

String

Full path where the request was received

x

String

Full URI of the request

x

Enumeration, one of:

HTTP scheme of the request.

x

Object

Query parameters map built from the parsed string

x

Object

Headers map built from the parsed string

x

Object

URI parameters extracted from the request path

x

String

HTTP method of the request

x

String

Query string of the request

x

Number

The amount of memory to allocate 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

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 should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Enumeration, one of:

The unit in which all these attributes are expressed

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content 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 a process-failed-message

String

The secure hashing algorithm to use.

SHA-256

Redelivery Policy Message Identifier

Defines which strategy is used to identify the messages

ObjectStore

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

Boolean

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

String

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

String

The socket ID

x

Enumeration, one of:

The socket type

x

Array of String

The groups to which this socket is subscribed

x

String

Full path where the request was received

x

String

Full URI of the request

x

Enumeration, one of:

HTTP scheme of the request.

x

Object

Query parameters map built from the parsed string

x

Object

Headers map built from the parsed string

x

Object

URI parameters extracted from the request path

x

String

HTTP method of the request

x

String

Query string of the request

x

Enumeration, one of:

The close code

x

String

The phrase with the reason the socket was closed

String

Any

String

Enumeration, one of:

String

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 should not be 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 should not be used