Package org.dellroad.hl7.llp

Class LLPInputStream

java.lang.Object

org.dellroad.hl7.llp.LLPInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, HL7Reader

public class LLPInputStream
extends Object
implements HL7Reader, Closeable

Reads HL7 messages framed in the "lower layer protocol" (LLP).

Instances are not thread safe.

Constructor Summary

Constructors

Constructor	Description
LLPInputStream(InputStream input, int maxLength)	Constructor for when StandardCharsets.ISO_8859_1 character encoding is to be used for all messages.
LLPInputStream(InputStream input, Charset charset, int maxLength)	Constructor for when a fixed character encoding is to be used for all messages.
LLPInputStream(InputStream input, CharsetDecoder charsetDecoder, int maxLength)	Primary constructor.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the underlying stream.
HL7Message	readMessage()	Read next message from the underlying stream.
void	skip()	Advance past the end of the current message.

Methods inherited from class java.lang.Object

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

Constructor Detail

LLPInputStream

public LLPInputStream(InputStream input,
                      int maxLength)

Constructor for when StandardCharsets.ISO_8859_1 character encoding is to be used for all messages.

Equivalent to: LLPInputStream(input, StandardCharsets.ISO_8859_1, maxLength).

Parameters:

input - underlying input stream

maxLength - maximum allowed message length

Throws:

IllegalArgumentException - if input is null

IllegalArgumentException - if maxLength is negative

LLPInputStream

public LLPInputStream(InputStream input,
                      Charset charset,
                      int maxLength)

Constructor for when a fixed character encoding is to be used for all messages.

Parameters:

input - underlying input stream

maxLength - maximum allowed message length

charset - character encoding for messages

Throws:

IllegalArgumentException - if any parameter is null

IllegalArgumentException - if maxLength is negative

LLPInputStream

public LLPInputStream(InputStream input,
                      CharsetDecoder charsetDecoder,
                      int maxLength)

Primary constructor.

Parameters:

input - underlying input stream

maxLength - maximum allowed message length

charsetDecoder - determines the character encoding for each incoming message

Throws:

IllegalArgumentException - if any parameter is null

IllegalArgumentException - if maxLength is negative

Method Detail

readMessage

public HL7Message readMessage()
                       throws IOException,
                              HL7ContentException

Read next message from the underlying stream.

Specified by:

readMessage in interface HL7Reader

Returns:

next message read

Throws:

EOFException - if there is no more input

HL7ContentException - if a malformed message is read

LLPException - if illegal framing byte(s) are read from the underlying stream, or the message is too long

IOException - if an error occurs on the underlying stream

skip

public void skip()
          throws IOException

Advance past the end of the current message. This method can be used (for example) to skip over the remaining portion of a badly framed message that resulted in a LLPException in an attempt to salvage the connection.

This method just reads until the next occurrence of a LLPConstants.TRAILING_BYTE_0 byte followed immediately by a LLPConstants.TRAILING_BYTE_1 byte, then returns.

Throws:

EOFException - if there is no more input

IOException - if an error occurs on the underlying stream

close

public void close()
           throws IOException

Close the underlying stream.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException