AbstractRawClient (HAPI - Java HL7 API

java.lang.Object
- ca.uhn.hl7v2.hoh.raw.client.AbstractRawClient

All Implemented Interfaces:

IClient

Direct Known Subclasses:

HohRawClientMultithreaded, HohRawClientSimple
```
public abstract class AbstractRawClient
extends Object
implements IClient
```

Field Summary

Fields
Modifier and Type	Field and Description
`static Charset`	`DEFAULT_CHARSET` The default charset encoding (UTF-8)
`static int`	`DEFAULT_CONNECTION_TIMEOUT` The default connection timeout in milliseconds: 10000
`static int`	`DEFAULT_RESPONSE_TIMEOUT` The default number of milliseconds to wait before timing out waiting for a response: 60000

Constructor Summary

Constructors
Constructor and Description
`AbstractRawClient()` Constructor
`AbstractRawClient(String theHost, int thePort, String thePath)` Constructor
`AbstractRawClient(URL theUrl)` Constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`closeSocket(Socket theSocket)`
`protected Socket`	`connect()`
`String`	`getHost()` Getter for the host (e.g.
`int`	`getPort()` Getter for the port (e.g.
`ISocketFactory`	`getSocketFactory()` Returns the socket factory used by this client
`int`	`getSoTimeout()` Returns the TCP SO Timeout setting for new connections
`String`	`getUriPath()` Getter for the "Path" portion of the URL.
`URL`	`getUrl()` Getter for the URL to send messages to.
`String`	`getUrlString()` Getter for the URL to send messages to.
`boolean`	`isKeepAlive()` Returns the TCP KeepAlive flag for new connections
`protected abstract Socket`	`provideSocket()` Subclasses must override to provide a connected socket
`protected abstract void`	`returnSocket(Socket theSocket)` Returns the socket provided by `provideSocket()`.
`IReceivable<String>`	`sendAndReceive(ISendable<?> theMessageToSend)` Sends a message, waits for the response, and then returns the response if any
`void`	`setAuthorizationCallback(IAuthorizationClientCallback theAuthorizationCallback)` If set, provides a callback which will be used to se the username and password associated with the request
`void`	`setCharset(Charset theCharset)` Sets the charset to use for requests from this client.
`void`	`setHost(String theHost)` Setter for the host (e.g.
`void`	`setKeepAlive(boolean theKeepAlive)` Configures the TCP KeepAlive flag for new connections
`void`	`setPort(int thePort)` Getter for the port (e.g.
`void`	`setResponseTimeout(long theResponseTimeout)` Sets the number of milliseconds before timing out.
`void`	`setSigner(ISigner theSigner)`
`void`	`setSocketFactory(ISocketFactory theSocketFactory)` Sets the socket factory used by this client.
`void`	`setSoTimeout(int theSoTimeout)` Sets the TCP SO Timeout setting for new connections
`void`	`setUriPath(String thePath)` Setter for the "Path" portion of the URL.
`void`	`setUrl(URL theUrl)` Setter for the URL to send messages to.
`void`	`setUrlString(String theString)` Setter for the URL to send messages to.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_CHARSET
```
public static final Charset DEFAULT_CHARSET
```
    The default charset encoding (UTF-8)
  - DEFAULT_CONNECTION_TIMEOUT
```
public static final int DEFAULT_CONNECTION_TIMEOUT
```
    The default connection timeout in milliseconds: 10000
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RESPONSE_TIMEOUT
```
public static final int DEFAULT_RESPONSE_TIMEOUT
```
    The default number of milliseconds to wait before timing out waiting for a response: 60000
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractRawClient
```
public AbstractRawClient()
```
    Constructor
  - AbstractRawClient
```
public AbstractRawClient(String theHost,
                         int thePort,
                         String thePath)
```
    Constructor
    
    Parameters:
    
    theHost - The HOST (name/address). E.g. "192.168.1.1"
    
    thePort - The PORT. E.g. "8080"
    
    thePath - The path being requested (must either be blank or start with '/' and contain a path). E.g. "/Apps/Receiver.jsp"
  - AbstractRawClient
```
public AbstractRawClient(URL theUrl)
```
    Constructor
    
    Parameters:
    
    theUrl - The URL to connect to. Note that if the URL refers to the "https" protocol, a SocketFactory which uses TLS will be set. If custom certificates are used, a different factory may need to be provided manually.
- Method Detail
  - closeSocket
```
protected void closeSocket(Socket theSocket)
```
  - connect
```
protected Socket connect()
                  throws IOException
```
    Throws:
    
    IOException
  - getHost
```
public String getHost()
```
    Description copied from interface: IClient
    
    Getter for the host (e.g. "10.0.0.111" or "localhost")
    
    Specified by:
    
    getHost in interface IClient
  - getPort
```
public int getPort()
```
    Description copied from interface: IClient
    
    Getter for the port (e.g. 80 for standard HTTP)
    
    Specified by:
    
    getPort in interface IClient
  - getSocketFactory
```
public ISocketFactory getSocketFactory()
```
    Description copied from interface: IClient
    
    Returns the socket factory used by this client
    
    Specified by:
    
    getSocketFactory in interface IClient
  - getSoTimeout
```
public int getSoTimeout()
```
    Description copied from interface: IClient
    
    Returns the TCP SO Timeout setting for new connections
    
    Specified by:
    
    getSoTimeout in interface IClient
    
    See Also:
    
    Socket.getSoTimeout()
  - getUriPath
```
public String getUriPath()
```
    Description copied from interface: IClient
    
    Getter for the "Path" portion of the URL. This is the path portion which comes after the host and port, so for example if this client is being used to send messages to http://somehost.com:8888/messaging/receiver.jsp, the URI path portion would be /messaging/receiver.jsp
    
    Specified by:
    
    getUriPath in interface IClient
  - getUrl
```
public URL getUrl()
```
    Getter for the URL to send messages to.
    
    Specified by:
    
    getUrl in interface IClient
  - getUrlString
```
public String getUrlString()
```
    Getter for the URL to send messages to.
    
    Specified by:
    
    getUrlString in interface IClient
  - isKeepAlive
```
public boolean isKeepAlive()
```
    Description copied from interface: IClient
    
    Returns the TCP KeepAlive flag for new connections
    
    Specified by:
    
    isKeepAlive in interface IClient
    
    See Also:
    
    Socket.getKeepAlive()
  - provideSocket
```
protected abstract Socket provideSocket()
                                 throws IOException
```
    Subclasses must override to provide a connected socket
    
    Throws:
    
    IOException
  - returnSocket
```
protected abstract void returnSocket(Socket theSocket)
```
    Returns the socket provided by provideSocket(). This method will always be called after the request is finished.
  - sendAndReceive
```
public IReceivable<String> sendAndReceive(ISendable<?> theMessageToSend)
                                   throws DecodeException,
                                          IOException,
                                          EncodeException
```
    Sends a message, waits for the response, and then returns the response if any
    
    Parameters:
    
    theMessageToSend - The message to send
    
    Returns:
    
    The returned message, as well as associated metadata
    
    Throws:
    
    DecodeException - If a problem occurs (read error, socket disconnect, etc.) during communication, or the response is invalid in some way. Note that IO errors in trying to connect to the remote host or sending the message are thrown directly (i.e. as IOException), but IO errors in reading the response are thrown as DecodeException
    
    IOException - If the client is unable to connect to the remote host
    
    EncodeException - If a failure occurs while encoding the message into a sendable HTTP request
  - setAuthorizationCallback
```
public void setAuthorizationCallback(IAuthorizationClientCallback theAuthorizationCallback)
```
    Description copied from interface: IClient
    
    If set, provides a callback which will be used to se the username and password associated with the request
    
    Specified by:
    
    setAuthorizationCallback in interface IClient
  - setCharset
```
public void setCharset(Charset theCharset)
```
    Sets the charset to use for requests from this client. May be changed at any time.
    
    Default is UTF-8
    
    Specified by:
    
    setCharset in interface IClient
  - setHost
```
public void setHost(String theHost)
```
    Setter for the host (e.g. "10.0.0.111" or "localhost")
    
    Specified by:
    
    setHost in interface IClient
  - setKeepAlive
```
public void setKeepAlive(boolean theKeepAlive)
```
    Configures the TCP KeepAlive flag for new connections
    
    Specified by:
    
    setKeepAlive in interface IClient
    
    See Also:
    
    Socket.getKeepAlive()
  - setPort
```
public void setPort(int thePort)
```
    Getter for the port (e.g. 80 for standard HTTP)
    
    Specified by:
    
    setPort in interface IClient
  - setResponseTimeout
```
public void setResponseTimeout(long theResponseTimeout)
```
    Sets the number of milliseconds before timing out. Default is #DEFAULT_RESPONSE_TIMEOUT
    
    Specified by:
    
    setResponseTimeout in interface IClient
    
    Parameters:
    
    theResponseTimeout - The millis to wait before timeout.
    
    See Also:
    
    #DEFAULT_RESPONSE_TIMEOUT
  - setSigner
```
public void setSigner(ISigner theSigner)
```
    Specified by:
    
    setSigner in interface IClient
    
    Parameters:
    
    theSigner - If provided, sets the Signature Profile signer implementation to use. See http://hl7api.sourceforge.net/hapi-hl7overhttp/specification. html#SIGNATURE_PROFILE
  - setSocketFactory
```
public void setSocketFactory(ISocketFactory theSocketFactory)
```
    Sets the socket factory used by this client. Default is StandardSocketFactory.
    
    Specified by:
    
    setSocketFactory in interface IClient
    
    See Also:
    
    ISocketFactory
  - setSoTimeout
```
public void setSoTimeout(int theSoTimeout)
```
    Sets the TCP SO Timeout setting for new connections
    
    Specified by:
    
    setSoTimeout in interface IClient
    
    See Also:
    
    Socket.getSoTimeout()
  - setUriPath
```
public void setUriPath(String thePath)
```
    Setter for the "Path" portion of the URL. This is the path portion which comes after the host and port, so for example if this client is being used to send messages to http://somehost.com:8888/messaging/receiver.jsp, the URI path portion would be /messaging/receiver.jsp
    
    Specified by:
    
    setUriPath in interface IClient
  - setUrl
```
public void setUrl(URL theUrl)
```
    Setter for the URL to send messages to. Note that invoking this method replaces any values that have been provided to IClient.setHost(String), IClient.setPort(int), or IClient.setUriPath(String)
    
    Specified by:
    
    setUrl in interface IClient
  - setUrlString
```
public void setUrlString(String theString)
```
    Setter for the URL to send messages to. Note that invoking this method replaces any values that have been provided to IClient.setHost(String), IClient.setPort(int), or IClient.setUriPath(String)
    
    Specified by:
    
    setUrlString in interface IClient

Class AbstractRawClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CHARSET

DEFAULT_CONNECTION_TIMEOUT

DEFAULT_RESPONSE_TIMEOUT

Constructor Detail

AbstractRawClient

AbstractRawClient

AbstractRawClient

Method Detail

closeSocket

connect

getHost

getPort

getSocketFactory

getSoTimeout

getUriPath

getUrl

getUrlString

isKeepAlive

provideSocket

returnSocket

sendAndReceive

setAuthorizationCallback

setCharset

setHost

setKeepAlive

setPort

setResponseTimeout

setSigner

setSocketFactory

setSoTimeout

setUriPath

setUrl

setUrlString