AbstractHl7OverHttpDecoder (HAPI - Java HL7 API

java.lang.Object
- ca.uhn.hl7v2.hoh.encoder.AbstractHl7OverHttpDecoder

Direct Known Subclasses:

Hl7OverHttpRequestDecoder, Hl7OverHttpResponseDecoder
```
public abstract class AbstractHl7OverHttpDecoder
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_READ_TIMEOUT` Default amount of time that the decoder will attempt to read before timing out and throwing an IOException (30000ms)
`static String`	`HTTP_HEADER_HL7_SIGNATURE`
`static String`	`HTTP_HEADER_HL7_SIGNATURE_LC`
`protected static Charset`	`ourDefaultCharset`

Constructor Summary

Constructors
Constructor and Description

AbstractHl7OverHttpDecoder()

Constructors
Constructor and Description
`AbstractHl7OverHttpDecoder()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected abstract void`	`authorize()`
`void`	`decode()`
`Charset`	`getCharset()` Returns the charset associated with this message.
`List<String>`	`getConformanceProblems()`
`String`	`getContentType()`
`byte[]`	`getData()`
`static Charset`	`getDefaultCharset()`
`EncodingStyle`	`getEncodingStyle()` Returns the `EncodingStyle` associated with the incoming message, or `null`.
`Map<String,String>`	`getHeaders()`
`String`	`getMessage()`
`String`	`getPassword()`
`String`	`getPath()`
`String`	`getPathRaw()`
`String`	`getResponseName()`
`Integer`	`getResponseStatus()`
`ISigner`	`getSigner()`
`String`	`getUsername()`
`boolean`	`isCharsetExplicitlySet()`
`protected boolean`	`isConnectionCloseHeaderPresent()` Protected because this doesn't make sense for a sender
`protected abstract String`	`readActionLineAndDecode(InputStream theInputStream)`
`void`	`readContentsFromInputStreamAndDecode(InputStream theInputStream)` Read in the contents of the raw message from the input stream and decode entire the message.
`protected String`	`readFirstLine(InputStream theInputStream)`
`void`	`readHeadersAndContentsFromInputStreamAndDecode(InputStream theInputStream)` Note that if `setPath(String)` is called, this method will assume that the first line of the HTTP request has already been read from the input stream.
`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`	`setHeaders(LinkedHashMap<String,String> theHeaders)`
`void`	`setMessage(String theMessage)`
`void`	`setPassword(String thePassword)`
`void`	`setPath(String thePath)`
`void`	`setReadTimeout(long theReadTimeout)` Sets the number of milliseconds that the decoder will attempt to read from an InputStream before timing out and throwing an exception
`void`	`setResponseName(String theResponseName)`
`void`	`setResponseStatus(Integer theResponseStatus)`
`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
  - DEFAULT_READ_TIMEOUT
```
public static final int DEFAULT_READ_TIMEOUT
```
    Default amount of time that the decoder will attempt to read before timing out and throwing an IOException (30000ms)
    
    See Also:
    
    setReadTimeout(long), Constant Field Values
  - 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
  - AbstractHl7OverHttpDecoder
```
public AbstractHl7OverHttpDecoder()
```
- Method Detail
  - authorize
```
protected abstract void authorize()
                           throws AuthorizationFailureException
```
    Throws:
    
    AuthorizationFailureException
  - decode
```
public void decode()
            throws DecodeException,
                   SignatureVerificationException
```
    Throws:
    
    DecodeException
    
    SignatureVerificationException
  - isConnectionCloseHeaderPresent
```
protected boolean isConnectionCloseHeaderPresent()
```
    Protected because this doesn't make sense for a sender
  - getEncodingStyle
```
public EncodingStyle getEncodingStyle()
```
    Returns the EncodingStyle associated with the incoming message, or null. This will be set automatically based on the value of the Content-Type header, and will be set to null if the content type is not provided, or if the content type does not correspond to an HL7 type.
    
    See Also:
    
    EncodingStyle} for a list of appropriate content types
  - getConformanceProblems
```
public List<String> getConformanceProblems()
```
  - getContentType
```
public String getContentType()
```
    Returns:
    
    Returns the content type associated with the message (e.g. application/hl7-v2)
  - getResponseName
```
public String getResponseName()
```
    Returns:
    
    the responseName
  - getResponseStatus
```
public Integer getResponseStatus()
```
    Returns:
    
    the responseStatus
  - readActionLineAndDecode
```
protected abstract String readActionLineAndDecode(InputStream theInputStream)
                                           throws IOException,
                                                  NoMessageReceivedException,
                                                  DecodeException
```
    Throws:
    
    IOException
    
    NoMessageReceivedException
    
    DecodeException
  - readContentsFromInputStreamAndDecode
```
public void readContentsFromInputStreamAndDecode(InputStream theInputStream)
                                          throws AuthorizationFailureException,
                                                 DecodeException,
                                                 IOException,
                                                 SignatureVerificationException
```
    Read in the contents of the raw message from the input stream and decode entire the message. This method assumes that the headers have been provided using setHeaders(LinkedHashMap)
    
    Parameters:
    
    theInputStream - The inputstream to read the raw message from
    
    Throws:
    
    AuthorizationFailureException - If the authorization check fails. This will only be thrown if this decoder is decoding a request message, and an authorization callback has been provided, and the authorization fails.
    
    DecodeException - If the message can not be decoded for any reason
    
    IOException - If there is a failure while reading from the inputstream
    
    SignatureVerificationException - If the signature verification fails. This will only occur if a signer has been provided.
  - readFirstLine
```
protected String readFirstLine(InputStream theInputStream)
                        throws IOException,
                               NoMessageReceivedException
```
    Throws:
    
    IOException
    
    NoMessageReceivedException
  - readHeadersAndContentsFromInputStreamAndDecode
```
public void readHeadersAndContentsFromInputStreamAndDecode(InputStream theInputStream)
                                                    throws IOException,
                                                           DecodeException,
                                                           NoMessageReceivedException,
                                                           SignatureVerificationException
```
    Note that if setPath(String) is called, this method will assume that the first line of the HTTP request has already been read from the input stream. If setHeaders(java.util.LinkedHashMap) has been called, this method will assume that the HTTP headers have already been read from the input stream as well as the double-LF (ASCII-10) that proceeds the headers.
    
    Parameters:
    
    theInputStream - The inputstream to read the raw message from
    
    Throws:
    
    AuthorizationFailureException - If the authorization check fails. This will only be thrown if this decoder is decoding a request message, and an authorization callback has been provided, and the authorization fails.
    
    DecodeException - If the message can not be decoded for any reason
    
    IOException - If there is a failure while reading from the inputstream
    
    SignatureVerificationException - If the signature verification fails. This will only occur if a signer has been provided.
    
    NoMessageReceivedException
  - setReadTimeout
```
public void setReadTimeout(long theReadTimeout)
```
    Sets the number of milliseconds that the decoder will attempt to read from an InputStream before timing out and throwing an exception
  - setResponseName
```
public void setResponseName(String theResponseName)
```
    Parameters:
    
    theResponseName - the responseName to set
  - setResponseStatus
```
public void setResponseStatus(Integer theResponseStatus)
```
    Parameters:
    
    theResponseStatus - the responseStatus to set
  - 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
  - setMessage
```
public void setMessage(String theMessage)
```
    Parameters:
    
    theMessage - The raw message text
  - 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

Class AbstractHl7OverHttpDecoder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_READ_TIMEOUT

HTTP_HEADER_HL7_SIGNATURE

HTTP_HEADER_HL7_SIGNATURE_LC

ourDefaultCharset

Constructor Detail

AbstractHl7OverHttpDecoder

Method Detail

authorize

decode

isConnectionCloseHeaderPresent

getEncodingStyle

getConformanceProblems

getContentType

getResponseName

getResponseStatus

readActionLineAndDecode

readContentsFromInputStreamAndDecode

readFirstLine

readHeadersAndContentsFromInputStreamAndDecode

setReadTimeout

setResponseName

setResponseStatus

getCharset

getData

getHeaders

getMessage

getPassword

getSigner

getPath

getPathRaw

getUsername

isCharsetExplicitlySet

setCharset

setData

setHeaders

setMessage

setPassword

setSigner

setPath

setUsername

verifyNotUsed

getDefaultCharset