ca.uhn.hl7v2.hoh.encoder

Class AbstractHl7OverHttpEncoder

java.lang.Object

ca.uhn.hl7v2.hoh.encoder.AbstractHl7OverHttpEncoder

Direct Known Subclasses:

Hl7OverHttpRequestEncoder, Hl7OverHttpResponseEncoder

public abstract class AbstractHl7OverHttpEncoder
extends Object

Base class that creates HL7 over HTTP requests. This class is intended to be single use, so please create a new instance for each message.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTP_HEADER_HL7_SIGNATURE
static String	HTTP_HEADER_HL7_SIGNATURE_LC
protected static Charset	ourDefaultCharset

Constructor Summary

Constructors

Constructor and Description
AbstractHl7OverHttpEncoder() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	addSpecificHeaders()
void	encode()
void	encodeToOutputStream(OutputStream theOutputStream)
String	getActionLine()
Charset	getCharset() Returns the charset associated with this message.
byte[]	getData()
static Charset	getDefaultCharset()
Map<String,String>	getHeaders()
String	getMessage()
String	getPassword()
String	getPath()
String	getPathRaw()
ISigner	getSigner()
String	getUsername()
boolean	isCharsetExplicitlySet()
void	setActionLine(String theActionLine)
protected abstract void	setActionLineAppropriately()
void	setCharset(Charset theCharset) Deprecated. The HL7 over HTTP specification now mandates the use of UTF-8. Using this method to set a value other than UTF-8 will lead to a non-conformant application
protected void	setData(byte[] theData)
void	setDataProvider(ISendable<?> theSendable) Provide the message to send with a ISendable instance.
void	setHeaders(LinkedHashMap<String,String> theHeaders)
void	setMessage(String theData) Provide the message to send with a String.
void	setPassword(String thePassword)
void	setPath(String thePath)
void	setSigner(ISigner theSigner) Optionally may be used to provide a signer implementation which signs HL7 content.
void	setUsername(String theUsername)
protected void	verifyNotUsed() Throws an IllegalStateException if called more than once

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_HEADER_HL7_SIGNATURE

public static final String HTTP_HEADER_HL7_SIGNATURE

See Also:

Constant Field Values

HTTP_HEADER_HL7_SIGNATURE_LC

public static final String HTTP_HEADER_HL7_SIGNATURE_LC

ourDefaultCharset

protected static final Charset ourDefaultCharset

Constructor Detail

AbstractHl7OverHttpEncoder

public AbstractHl7OverHttpEncoder()

Constructor

Method Detail

encode

public void encode()
            throws EncodeException

Throws:

EncodeException

encodeToOutputStream

public void encodeToOutputStream(OutputStream theOutputStream)
                          throws IOException,
                                 EncodeException

Throws:

IOException

EncodeException

getActionLine

public String getActionLine()

Returns:

the actionLine

setActionLine

public void setActionLine(String theActionLine)

Parameters:

theActionLine - the actionLine to set

setDataProvider

public void setDataProvider(ISendable<?> theSendable)

Provide the message to send with a ISendable instance. Either this method OR setMessage(String) must be called, but not both.

setMessage

public void setMessage(String theData)

Provide the message to send with a String. Either this method OR setDataProvider(ISendable) must be called, but not both.

Parameters:

theData - The raw message text

addSpecificHeaders

protected abstract void addSpecificHeaders()

setActionLineAppropriately

protected abstract void setActionLineAppropriately()

getCharset

public Charset getCharset()

Returns the charset associated with this message. Will not return null.

getData

public byte[] getData()

Returns:

the data

getHeaders

public Map<String,String> getHeaders()

Returns:

the headers

getMessage

public String getMessage()

Returns:

the message

getPassword

public String getPassword()

Returns:

the password

getSigner

public ISigner getSigner()

Returns:

the signer

getPath

public String getPath()

Returns:

the path

getPathRaw

public String getPathRaw()

Returns:

the path

getUsername

public String getUsername()

Returns:

the username

isCharsetExplicitlySet

public boolean isCharsetExplicitlySet()

Returns:

Returns true if the charset was explicitly set using setCharset(Charset)

setCharset

@Deprecated
public void setCharset(Charset theCharset)

Deprecated. The HL7 over HTTP specification now mandates the use of UTF-8. Using this method to set a value other than UTF-8 will lead to a non-conformant application

Parameters:

theCharset - The encoding charset to use (default is UTF-8)

setData

protected void setData(byte[] theData)

Parameters:

theData - the data to set

setHeaders

public void setHeaders(LinkedHashMap<String,String> theHeaders)

Parameters:

theHeaders - the headers to set

setPassword

public void setPassword(String thePassword)

Parameters:

thePassword - The authorization password

setSigner

public void setSigner(ISigner theSigner)

Optionally may be used to provide a signer implementation which signs HL7 content.

See Also:

ISigner, StandardMessageSigner

setPath

public void setPath(String thePath)

Parameters:

thePath - the path to set

setUsername

public void setUsername(String theUsername)

Parameters:

theUsername - The authorization username

verifyNotUsed

protected void verifyNotUsed()

Throws an IllegalStateException if called more than once

getDefaultCharset

public static Charset getDefaultCharset()

Returns:

Returns the ISO-8859-1 charset