ca.uhn.hl7v2.hoh.encoder

Class Hl7OverHttpResponseEncoder

java.lang.Object

ca.uhn.hl7v2.hoh.encoder.AbstractHl7OverHttpEncoder

ca.uhn.hl7v2.hoh.encoder.Hl7OverHttpResponseEncoder

public class Hl7OverHttpResponseEncoder
extends AbstractHl7OverHttpEncoder

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
Hl7OverHttpResponseEncoder()

Method Summary

Modifier and Type	Method and Description
protected void	addSpecificHeaders()
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()
protected void	setActionLineAppropriately()
void	setAddConnectionCloseHeader(boolean theAddConnectionCloseHeader) Adds a header to the HTTP response: "Connection: close".
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	setGzipData(boolean theGzipData) Should response be GZipped?
void	setHeaders(LinkedHashMap<String,String> theHeaders)
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 ca.uhn.hl7v2.hoh.encoder.AbstractHl7OverHttpEncoder

encode, encodeToOutputStream, getActionLine, setActionLine, setDataProvider, setMessage

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

Hl7OverHttpResponseEncoder

public Hl7OverHttpResponseEncoder()

Method Detail

addSpecificHeaders

protected void addSpecificHeaders()

Specified by:

addSpecificHeaders in class AbstractHl7OverHttpEncoder

setActionLineAppropriately

protected void setActionLineAppropriately()

Specified by:

setActionLineAppropriately in class AbstractHl7OverHttpEncoder

setAddConnectionCloseHeader

public void setAddConnectionCloseHeader(boolean theAddConnectionCloseHeader)

Adds a header to the HTTP response: "Connection: close". Note that setting this to true (default is false) will ONLY add the header, it does not actually close the connection. The caller is responsible for that.

setGzipData

public void setGzipData(boolean theGzipData)

Should response be GZipped?

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