HL7 MLLP Connector Reference

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types that can be provided to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires an instance at the exact moment it becomes eligible. The runtime purges instances only when it sees fit.

Delimiter

Character code that separates MLLP messages. By default MLLP uses 001C.

x

TLS Configuration

Specifies the use of SSLServerSocket instead of plain TCP ServerSocket for accepting new SSL connections.

Port

Connection’s port number.

x

Host

Connection’s host name.

x

Reconnection

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.

Send Buffer Size

Size of the buffer in bytes used when sending data, set on the socket itself.

Receive Buffer Size

Size of the buffer in bytes used when receiving data, set on the socket itself.

Client Timeout

Sets the SO_TIMEOUT value on sockets. Indicates the amount of time in milliseconds that the socket waits in a blocking operation before failing. A value of 0 (the default) means waiting indefinitely.

Reuse Address

If set (the default), SO_REUSEADDRESS is set on the sockets before binding. This helps reduce "address already in use" errors when a socket is re-used.

true

Send TCP With No Delay

If set, transmitted data is not collected together for greater efficiency but sent immediately. Defaults to true even though Socket default is false because optimizing to reduce amount of network traffic over latency is hardly ever a concern today.

true

Linger

This sets the SO_LINGER value. This is related to how long in milliseconds the socket takes to close so that any remaining data is transmitted correctly.

Keep Alive

Enables SO_KEEPALIVE behavior on open sockets. This automatically checks socket connections that are open but unused for long periods and closes them if the connection becomes unavailable. This is a property on the socket itself and is used by a server socket to control whether connections to the server are kept alive before they are recycled.

false

Fail On Unresolved Host

Whether the socket should fail during its creation if the host set on the endpoint cannot be resolved. However, it can be set to false to allow unresolved hosts (useful when connecting through a proxy).

true

Server Timeout

This sets the SO_TIMEOUT value when the socket is used as a server. This is the timeout that applies to the "accept" operation. A value of 0 (the ServerSocket default) causes the accept to wait indefinitely (if no connection arrives).

Receive Backlog

The maximum queue length for incoming connections.

50

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types that can be provided to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires an instance at the exact moment it becomes eligible. The runtime purges instances only when it sees fit.

Local Address Settings

This configuration parameter refers to the address that a socket should bind to.

TLS Configuration

Configuration for TLS, which can be used from both the client and server sides.

Port

Connection’s port number.

x

Host

Connection’s host name.

x

Reconnection

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.

Pooling Profile

Characteristics of the connection pool.

Send Buffer Size

The size of the buffer in bytes used when sending data, set on the socket itself.

Receive Buffer Size

The size of the buffer in bytes used when receiving data, set on the socket itself.

Client Timeout

This sets the SO_TIMEOUT value on sockets. Indicates the amount of time in milliseconds that the socket waits in a blocking operation before failing. A value of 0 (the default) means waiting indefinitely.

Reuse Address

If set (the default), SO_REUSEADDRESS is set on the sockets before binding. This helps reduce "address already in use" errors when a socket is re-used.

true

Send TCP With No Delay

If set, transmitted data is not collected together for greater efficiency but sent immediately. Defaults to true even though Socket default is false because optimizing to reduce amount of network traffic over latency is hardly ever a concern today.

true

Linger

This sets the SO_LINGER value. This is related to how long in milliseconds the socket takes to close so that any remaining data is transmitted correctly.

Keep Alive

Enables SO_KEEPALIVE behavior on open sockets. This automatically checks socket connections that are open but unused for long periods and closes them if the connection becomes unavailable. This is a property on the socket itself and is used by a server socket to control whether connections to the server are kept alive before they are recycled.

false

Fail On Unresolved Host

Whether the socket should fail during its creation if the host set on the endpoint cannot be resolved. However, it can be set to false to allow unresolved hosts (useful when connecting through a proxy).

true

Connection Timeout

Number of milliseconds to wait until an outbound connection to a remote server is successfully created. Defaults to 30 seconds.

30000

Configuration

String

The name of the configuration to use.

x

Content

Data to serialize and send through the socket.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

x

Output Mime Type

The MIME type of the payload that this operation outputs.

Output Encoding

The encoding of the payload that this operation outputs.

Primary Node Only

Whether this source should only execute on the primary node when running in a cluster.

Streaming Strategy

Configure if repeatable streams should be used and their behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Type

Binary

Attributes Type

Enabled Protocols

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

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

Trust Store

Key Store

Revocation Check

Path

The location that resolves relative to the current classpath and file system, if possible of the trust store.

Password

The password used to protect the trust store.

Type

The type of store used.

Algorithm

The algorithm used by the trust store.

Insecure

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

Path

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

Type

The type of store used.

Alias

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.

Key Password

The password used to protect the private key.

Password

The password used to protect the key store.

Algorithm

The algorithm used by the key store.

Only End Entities

Only verify the last element of the certificate chain.

Prefer Crls

Try CRL instead of OCSP first.

No Fallback

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

Soft Fail

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

Url

The URL of the OCSP responder.

Cert Alias

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

Path

The path to the CRL file.

Fails Deployment

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.

Reconnection Strategy

The reconnection strategy to use.

Frequency

How often in milliseconds to reconnect.

Count

How many reconnection attempts to make.

Frequency

How often in milliseconds to reconnect.

Max Idle Time

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.

Time Unit

A time unit that qualifies the maxIdleTime attribute.

Host Address

Host Name

Local Certificates

Peer Certificates

Port

Initial Buffer Size

This is 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, the buffer expands by maxInMemorySize.

Buffer Size Increment

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.

Max Buffer Size

This is 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 or equal to zero means no limit.

Buffer Unit

The unit in which all these attributes are expressed.

Max In Memory Size

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it starts to buffer the content on disk.

Buffer Unit

The unit in which maxInMemorySize is expressed.

Max Redelivery Count

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

Use Secure Hash

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

Message Digest Algorithm

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

Id Expression

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.

Object Store

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

Port

Connection’s port number.

x

Host

Connection’s host name.

x

Max Active

Controls the maximum number of Mule components that can be borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that may be active at one time. When maxActive is exceeded, the pool is said to be exhausted.

Max Idle

Controls the maximum number of Mule components that can sit idle in the pool at any time. When set to a negative value, there is no limit to the number of Mule components that may be idle at one time.

Max Wait

Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the exhaustedAction is set to WHEN_EXHAUSTED_WAIT.

Min Eviction Millis

Determines the minimum amount of time an object may sit idle in the pool before it is eligible for eviction. When non-positive, no objects are evicted from the pool due to idle time alone.

Eviction Check Interval Millis

Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed.

Exhausted Action

Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are: "WHEN_EXHAUSTED_FAIL", which throws a NoSuchElementException, "WHEN_EXHAUSTED_WAIT", which blocks by invoking Object.wait(long) until a new or idle object is available, or WHEN_EXHAUSTED_GROW, which creates a new Mule instance and returns it, essentially making maxActive meaningless. If a positive maxWait value is supplied, it blocks for at most that many milliseconds, after which a NoSuchElementException is thrown. If maxThreadWait is a negative value, it blocks indefinitely.

Initialization Policy

Determines how components in a pool should be initialized. The possible values are: INITIALISE_NONE (does not load any components into the pool on startup), INITIALISE_ONE (loads one initial component into the pool on startup), or INITIALISE_ALL (loads all components in the pool on startup).

Disabled

Whether pooling should be disabled.