org.apache.camel.component.mllp

Class MllpEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.mllp.MllpEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(scheme="mllp",
             title="MLLP",
             syntax="mllp:hostname:port",
             consumerClass=MllpTcpServerConsumer.class,
             label="mllp")
public class MllpEndpoint
extends org.apache.camel.impl.DefaultEndpoint

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.

Field Summary

Fields

Modifier and Type	Field and Description
static char	END_OF_BLOCK
static char	END_OF_DATA
static int	END_OF_STREAM
static char	MESSAGE_TERMINATOR
static char	SEGMENT_DELIMITER
static char	START_OF_BLOCK

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
MllpEndpoint(String uri, MllpComponent component)

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Exchange	createExchange(org.apache.camel.Exchange exchange)
org.apache.camel.Exchange	createExchange(org.apache.camel.ExchangePattern exchangePattern)
org.apache.camel.Producer	createProducer()
int	getAcceptTimeout()
int	getBacklog()
int	getBindRetryInterval()
int	getBindTimeout()
String	getCharsetName()
int	getConnectTimeout()
org.apache.camel.ExchangePattern	getExchangePattern()
String	getHostname()
int	getMaxReceiveTimeouts()
int	getPort()
int	getReadTimeout()
int	getReceiveBufferSize()
int	getReceiveTimeout()
int	getSendBufferSize()
boolean	isAutoAck()
boolean	isBufferWrites()
boolean	isHl7Headers()
boolean	isKeepAlive()
boolean	isReuseAddress()
boolean	isSingleton()
boolean	isSynchronous()
boolean	isTcpNoDelay()
boolean	isValidatePayload()
void	setAcceptTimeout(int acceptTimeout) Timeout (in milliseconds) while waiting for a TCP connection TCP Server Only
void	setAutoAck(boolean autoAck) Enable/Disable the automatic generation of a MLLP Acknowledgement MLLP Consumers only
void	setBacklog(int backlog) The maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter.
void	setBindRetryInterval(int bindRetryInterval) TCP Server Only - The number of milliseconds to wait between bind attempts
void	setBindTimeout(int bindTimeout) TCP Server Only - The number of milliseconds to retry binding to a server port
void	setBufferWrites(boolean bufferWrites) 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.
void	setCharsetName(String charsetName) Set the CamelCharsetName property on the exchange
void	setConnectTimeout(int connectTimeout) Timeout (in milliseconds) for establishing for a TCP connection TCP Client only
void	setHl7Headers(boolean hl7Headers) Enable/Disable the automatic generation of message headers from the HL7 Message MLLP Consumers only
void	setHostname(String hostname) Hostname or IP for connection for the TCP connection.
void	setKeepAlive(boolean keepAlive) Enable/disable the SO_KEEPALIVE socket option.
void	setMaxReceiveTimeouts(int maxReceiveTimeouts) The maximum number of timeouts (specified by receiveTimeout) allowed before the TCP Connection will be reset.
void	setPort(int port) Port number for the TCP connection
void	setReadTimeout(int readTimeout) The SO_TIMEOUT value (in milliseconds) used after the start of an MLLP frame has been received
void	setReceiveBufferSize(Integer receiveBufferSize) Sets the SO_RCVBUF option to the specified value (in bytes)
void	setReceiveTimeout(int receiveTimeout) The SO_TIMEOUT value (in milliseconds) used when waiting for the start of an MLLP frame
void	setReuseAddress(boolean reuseAddress) Enable/disable the SO_REUSEADDR socket option.
void	setSendBufferSize(Integer sendBufferSize) Sets the SO_SNDBUF option to the specified value (in bytes)
void	setTcpNoDelay(boolean tcpNoDelay) Enable/disable the TCP_NODELAY socket option.
void	setValidatePayload(boolean validatePayload) 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).

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createPollingConsumer, doStart, doStop, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Field Detail

START_OF_BLOCK

public static final char START_OF_BLOCK

See Also:

Constant Field Values

END_OF_BLOCK

public static final char END_OF_BLOCK

See Also:

Constant Field Values

END_OF_DATA

public static final char END_OF_DATA

See Also:

Constant Field Values

END_OF_STREAM

public static final int END_OF_STREAM

See Also:

Constant Field Values

SEGMENT_DELIMITER

public static final char SEGMENT_DELIMITER

See Also:

Constant Field Values

MESSAGE_TERMINATOR

public static final char MESSAGE_TERMINATOR

See Also:

Constant Field Values

Constructor Detail

MllpEndpoint

public MllpEndpoint(String uri,
                    MllpComponent component)

Method Detail

getExchangePattern

public org.apache.camel.ExchangePattern getExchangePattern()

Overrides:

getExchangePattern in class org.apache.camel.impl.DefaultEndpoint

createExchange

public org.apache.camel.Exchange createExchange(org.apache.camel.ExchangePattern exchangePattern)

Specified by:

createExchange in interface org.apache.camel.Endpoint

Overrides:

createExchange in class org.apache.camel.impl.DefaultEndpoint

createExchange

public org.apache.camel.Exchange createExchange(org.apache.camel.Exchange exchange)

Specified by:

createExchange in interface org.apache.camel.Endpoint

Overrides:

createExchange in class org.apache.camel.impl.DefaultEndpoint

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Throws:

Exception

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Throws:

Exception

isSynchronous

public boolean isSynchronous()

Overrides:

isSynchronous in class org.apache.camel.impl.DefaultEndpoint

isSingleton

public boolean isSingleton()

getCharsetName

public String getCharsetName()

setCharsetName

public void setCharsetName(String charsetName)

Set the CamelCharsetName property on the exchange

Parameters:

charsetName - the charset

getHostname

public String getHostname()

setHostname

public void setHostname(String hostname)

Hostname or IP for connection for the TCP connection. The default value is null, which means any local IP address

Parameters:

hostname - Hostname or IP

getPort

public int getPort()

setPort

public void setPort(int port)

Port number for the TCP connection

Parameters:

port - TCP port

getBacklog

public int getBacklog()

setBacklog

public void setBacklog(int backlog)

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.

getBindTimeout

public int getBindTimeout()

setBindTimeout

public void setBindTimeout(int bindTimeout)

TCP Server Only - The number of milliseconds to retry binding to a server port

getBindRetryInterval

public int getBindRetryInterval()

setBindRetryInterval

public void setBindRetryInterval(int bindRetryInterval)

TCP Server Only - The number of milliseconds to wait between bind attempts

getAcceptTimeout

public int getAcceptTimeout()

setAcceptTimeout

public void setAcceptTimeout(int acceptTimeout)

Timeout (in milliseconds) while waiting for a TCP connection

TCP Server Only

Parameters:

acceptTimeout - timeout in milliseconds

getConnectTimeout

public int getConnectTimeout()

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

Timeout (in milliseconds) for establishing for a TCP connection

TCP Client only

Parameters:

connectTimeout - timeout in milliseconds

getReceiveTimeout

public int getReceiveTimeout()

setReceiveTimeout

public void setReceiveTimeout(int receiveTimeout)

The SO_TIMEOUT value (in milliseconds) used when waiting for the start of an MLLP frame

Parameters:

receiveTimeout - timeout in milliseconds

getMaxReceiveTimeouts

public int getMaxReceiveTimeouts()

setMaxReceiveTimeouts

public void setMaxReceiveTimeouts(int maxReceiveTimeouts)

The maximum number of timeouts (specified by receiveTimeout) allowed before the TCP Connection will be reset.

Parameters:

maxReceiveTimeouts - maximum number of receiveTimeouts

getReadTimeout

public int getReadTimeout()

setReadTimeout

public void setReadTimeout(int readTimeout)

The SO_TIMEOUT value (in milliseconds) used after the start of an MLLP frame has been received

Parameters:

readTimeout - timeout in milliseconds

isKeepAlive

public boolean isKeepAlive()

setKeepAlive

public void setKeepAlive(boolean keepAlive)

Enable/disable the SO_KEEPALIVE socket option.

Parameters:

keepAlive - enable SO_KEEPALIVE when true; otherwise disable SO_KEEPALIVE

isTcpNoDelay

public boolean isTcpNoDelay()

setTcpNoDelay

public void setTcpNoDelay(boolean tcpNoDelay)

Enable/disable the TCP_NODELAY socket option.

Parameters:

tcpNoDelay - enable TCP_NODELAY when true; otherwise disable TCP_NODELAY

isReuseAddress

public boolean isReuseAddress()

setReuseAddress

public void setReuseAddress(boolean reuseAddress)

Enable/disable the SO_REUSEADDR socket option.

Parameters:

reuseAddress - enable SO_REUSEADDR when true; otherwise disable SO_REUSEADDR

getReceiveBufferSize

public int getReceiveBufferSize()

setReceiveBufferSize

public void setReceiveBufferSize(Integer receiveBufferSize)

Sets the SO_RCVBUF option to the specified value (in bytes)

Parameters:

receiveBufferSize - the SO_RCVBUF option value. If null, the system default is used

getSendBufferSize

public int getSendBufferSize()

setSendBufferSize

public void setSendBufferSize(Integer sendBufferSize)

Sets the SO_SNDBUF option to the specified value (in bytes)

Parameters:

sendBufferSize - the SO_SNDBUF option value. If null, the system default is used

isAutoAck

public boolean isAutoAck()

setAutoAck

public void setAutoAck(boolean autoAck)

Enable/Disable the automatic generation of a MLLP Acknowledgement MLLP Consumers only

Parameters:

autoAck - enabled if true, otherwise disabled

isHl7Headers

public boolean isHl7Headers()

setHl7Headers

public void setHl7Headers(boolean hl7Headers)

Enable/Disable the automatic generation of message headers from the HL7 Message MLLP Consumers only

Parameters:

hl7Headers - enabled if true, otherwise disabled

isValidatePayload

public boolean isValidatePayload()

setValidatePayload

public void setValidatePayload(boolean validatePayload)

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.

Parameters:

validatePayload - enabled if true, otherwise disabled

isBufferWrites

public boolean isBufferWrites()

setBufferWrites

public void setBufferWrites(boolean bufferWrites)

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])}.

Parameters:

bufferWrites - enabled if true, otherwise disabled