org.apache.camel.component.mllp.impl

Class MllpUtil

java.lang.Object

org.apache.camel.component.mllp.impl.MllpUtil

public final class MllpUtil
extends Object

Supplies methods to read and write messages in a MLLP Frame.

Although the methods in the class are intended to handle HL7 v2 formatted messages, the methods do not depend on that format - any byte[]can be written to the Socket. Also, any byte[] can be read from the socket provided it has the proper MLLP Enveloping - payload>.

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. The property is evaluated using Boolean.parseBoolean.

Method Summary

Methods

Modifier and Type	Method and Description
static void	closeConnection(Socket socket)
static byte[]	closeFrame(Socket socket) Close a MLLP frame by reading from the socket until the end of the frame is found.
static boolean	openFrame(Socket socket) Open the MLLP frame by reading from the Socket until the begging of the frame is found.
static void	resetConnection(Socket socket)
static void	writeFramedPayload(Socket socket, byte[] payload) Write a MLLP-Framed payload to the Socket

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

openFrame

public static boolean openFrame(Socket socket)
                         throws SocketTimeoutException,
                                MllpCorruptFrameException,
                                MllpException

Open the MLLP frame by reading from the Socket until the begging of the frame is found.

If any errors occur (including MLLP frame errors) while opening the frame, the socket will be closed and an Exception will be thrown.

Parameters:

socket - the Socket to read

Throws:

SocketTimeoutException - thrown if a timeout occurs while looking for the beginning of the MLLP frame, but nothing is yet available - this is NOT an error condition

MllpCorruptFrameException - if the MLLP Frame is corrupted in some way

MllpException - for other unexpected error conditions

closeFrame

public static byte[] closeFrame(Socket socket)
                         throws MllpTimeoutException,
                                MllpCorruptFrameException,
                                MllpException

Close a MLLP frame by reading from the socket until the end of the frame is found.

The method assumes the MLLP frame has already been opened and the first byte available will be the first byte of the framed message.

The method consumes the END_OF_BLOCK and END_OF_DATA bytes from the stream before returning the payload

If any errors occur (including MLLP frame errors) while opening the frame, the socket will be closed and an Exception will be thrown.

Parameters:

socket - the Socket to be read

Returns:

the payload of the MLLP-Enveloped message as a byte[]

Throws:

MllpTimeoutException - thrown if a timeout occurs while closing the MLLP frame

MllpCorruptFrameException - if the MLLP Frame is corrupted in some way

MllpException - for other unexpected error conditions

writeFramedPayload

public static void writeFramedPayload(Socket socket,
                      byte[] payload)
                               throws MllpException

Write a MLLP-Framed payload to the Socket

Parameters:

socket - the Socket to write the payload

payload - the MLLP payload

Throws:

MllpWriteException - if the write fails

MllpException - for other unexpected error conditions

closeConnection

public static void closeConnection(Socket socket)

resetConnection

public static void resetConnection(Socket socket)