MLLP

MLLP

Scheme: mllp
Syntax: mllp:hostname:port
Description: The MLLP component is designed to handle the MLLP protocol and provide the functionality required by Healthcare providers to communicate with other systems using the MLLP protocol.
Deprecated:false
Maven: org.apache.camel/camel-mllp/2.17.0.redhat-630475

The MLLP component is designed to handle the MLLP protocol and provide the functionality required by Healthcare providers to communicate with other systems using the MLLP protocol.

NOTE: MLLP payloads are not logged unless the logging level is set to DEBUG or TRACE to avoid introducing PHI into the log files. Logging of PHI can be globally disabled by setting the org.apache.camel.mllp.logPHI system property to false.

Name Kind Group Required Default Type Enum Description
hostname path common true java.lang.String Hostname or IP for connection for the TCP connection. The default value is null, which means any local IP address @param hostname Hostname or IP
port path common true int Port number for the TCP connection @param port TCP port
autoAck parameter common true boolean Enable/Disable the automatic generation of a MLLP Acknowledgement MLLP Consumers only @param autoAck enabled if true, otherwise disabled
bufferWrites parameter common true boolean Enable/Disable the validation of HL7 Payloads If enabled, MLLP Payloads are buffered and written to the external system in a single write(byte[]) operation. If disabled, the MLLP payload will not be buffered, and three write operations will be used. The first operation will write the MLLP start-of-block character {0x0b (ASCII VT)}, the second operation will write the HL7 payload, and the third operation will writh the MLLP end-of-block character and the MLLP end-of-data character {[0x1c, 0x0d] (ASCII [FS, CR])}. @param bufferWrites enabled if true, otherwise disabled
hl7Headers parameter common true boolean Enable/Disable the automatic generation of message headers from the HL7 Message MLLP Consumers only @param hl7Headers enabled if true, otherwise disabled
keepAlive parameter common true boolean Enable/disable the SO_KEEPALIVE socket option. @param keepAlive enable SO_KEEPALIVE when true; otherwise disable SO_KEEPALIVE
reuseAddress parameter common boolean Enable/disable the SO_REUSEADDR socket option. @param reuseAddress enable SO_REUSEADDR when true; otherwise disable SO_REUSEADDR
tcpNoDelay parameter common true boolean Enable/disable the TCP_NODELAY socket option. @param tcpNoDelay enable TCP_NODELAY when true; otherwise disable TCP_NODELAY
validatePayload parameter common false boolean Enable/Disable the validation of HL7 Payloads If enabled, HL7 Payloads received from external systems will be validated (see Hl7Util.generateInvalidPayloadExceptionMessage for details on the validation). If and invalid payload is detected, a MllpInvalidMessageException (for consumers) or a MllpInvalidAcknowledgementException will be thrown. @param validatePayload enabled if true, otherwise disabled
bridgeErrorHandler parameter consumer boolean Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN/ERROR level and ignored.
exceptionHandler parameter consumer (advanced) org.apache.camel.spi.ExceptionHandler To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored.
backlog parameter advanced 5 int The maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter. If a connection indication arrives when the queue is full, the connection is refused.
exchangePattern parameter advanced InOnly org.apache.camel.ExchangePattern InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange
receiveBufferSize parameter advanced java.lang.Integer Sets the SO_RCVBUF option to the specified value (in bytes) @param receiveBufferSize the SO_RCVBUF option value. If null, the system default is used
sendBufferSize parameter advanced java.lang.Integer Sets the SO_SNDBUF option to the specified value (in bytes) @param sendBufferSize the SO_SNDBUF option value. If null, the system default is used
synchronous parameter advanced false boolean Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
charsetName parameter codec java.lang.String Set the CamelCharsetName property on the exchange @param charsetName the charset
acceptTimeout parameter timeout 60000 int Timeout (in milliseconds) while waiting for a TCP connection

TCP Server Only @param acceptTimeout timeout in milliseconds

bindRetryInterval parameter timeout 5000 int TCP Server Only - The number of milliseconds to wait between bind attempts
bindTimeout parameter timeout 30000 int TCP Server Only - The number of milliseconds to retry binding to a server port
connectTimeout parameter timeout 30000 int Timeout (in milliseconds) for establishing for a TCP connection

TCP Client only @param connectTimeout timeout in milliseconds

maxReceiveTimeouts parameter timeout -1 int The maximum number of timeouts (specified by receiveTimeout) allowed before the TCP Connection will be reset. @param maxReceiveTimeouts maximum number of receiveTimeouts
readTimeout parameter timeout 500 int The SO_TIMEOUT value (in milliseconds) used after the start of an MLLP frame has been received @param readTimeout timeout in milliseconds
receiveTimeout parameter timeout 10000 int The SO_TIMEOUT value (in milliseconds) used when waiting for the start of an MLLP frame @param receiveTimeout timeout in milliseconds

mllp consumer

The MLLP consumer.