ca.uhn.hl7v2.hoh.raw.client

Class HohRawClientSimple

java.lang.Object

ca.uhn.hl7v2.hoh.raw.client.AbstractRawClient

ca.uhn.hl7v2.hoh.raw.client.HohRawClientSimple

All Implemented Interfaces:

IClient, IClientSimple

public class HohRawClientSimple
extends AbstractRawClient
implements IClientSimple

Simple raw message sender using the HL7 over HTTP specification. This implementation makes use of a single connection so it is simple, but may only be used to send one message at time (per instance).

This client uses no external threads, so it is suitable for use within J2EE containers.

Field Summary

Fields inherited from class ca.uhn.hl7v2.hoh.raw.client.AbstractRawClient

DEFAULT_CHARSET, DEFAULT_CONNECTION_TIMEOUT, DEFAULT_RESPONSE_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
HohRawClientSimple(String theHost, int thePort, String theUriPath) Constructor
HohRawClientSimple(URL theUrl) Constructor

Method Summary

Modifier and Type	Method and Description
void	close() If a socket exists and it is connected, closes the socket.
boolean	isAutoClose()
boolean	isConnected()
static void	main(String[] args)
protected Socket	provideSocket() Subclasses must override to provide a connected socket
protected void	returnSocket(Socket theSocket) Returns the socket provided by AbstractRawClient.provideSocket().
IReceivable<String>	sendAndReceive(ISendable<?> theMessageToSend) Sends a message, waits for the response, and then returns the response if any
void	setAutoClose(boolean theAutoClose) Sets the auto-close property.

Methods inherited from class ca.uhn.hl7v2.hoh.raw.client.AbstractRawClient

closeSocket, connect, getHost, getPort, getSocketFactory, getSoTimeout, getUriPath, getUrl, getUrlString, isKeepAlive, setAuthorizationCallback, setCharset, setHost, setKeepAlive, setPort, setResponseTimeout, setSigner, setSocketFactory, setSoTimeout, setUriPath, setUrl, setUrlString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.hl7v2.hoh.api.IClient

getHost, getPort, getSocketFactory, getSoTimeout, getUriPath, getUrl, getUrlString, isKeepAlive, setAuthorizationCallback, setCharset, setHost, setKeepAlive, setPort, setResponseTimeout, setSigner, setSocketFactory, setSoTimeout, setUriPath, setUrl, setUrlString

Constructor Detail

HohRawClientSimple

public HohRawClientSimple(String theHost,
                          int thePort,
                          String theUriPath)

Constructor

Parameters:

theHost - The HOST (name/address). E.g. "192.168.1.1"

thePort - The PORT. E.g. "8080"

theUriPath - The URI path being requested (must either be blank or start with '/' and contain a path). E.g. "/Apps/Receiver.jsp"

HohRawClientSimple

public HohRawClientSimple(URL theUrl)

Constructor

Parameters:

theUrl - The URL to connect to

Method Detail

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

Overrides:

sendAndReceive in class AbstractRawClient

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

close

public void close()

If a socket exists and it is connected, closes the socket. Only required if auto close mode is false

Specified by:

close in interface IClientSimple

isAutoClose

public boolean isAutoClose()

Specified by:

isAutoClose in interface IClientSimple

Returns:

Should the socket auto-close

See Also:

IClientSimple.setAutoClose(boolean)

isConnected

public boolean isConnected()

Specified by:

isConnected in interface IClientSimple

Returns:

Returns true if there is a socket, and it appears to be connected and not shut down

provideSocket

protected Socket provideSocket()
                        throws IOException

Subclasses must override to provide a connected socket

Specified by:

provideSocket in class AbstractRawClient

Throws:

IOException

returnSocket

protected void returnSocket(Socket theSocket)

Returns the socket provided by AbstractRawClient.provideSocket(). This method will always be called after the request is finished.

Specified by:

returnSocket in class AbstractRawClient

setAutoClose

public void setAutoClose(boolean theAutoClose)

Sets the auto-close property. If set to true (which is the default), the client will close the socket between each request. If set to false, the client will keep the socket open between requests.

If auto-close is disabled, sockets will never automatically disconnect, which some servers may not like. The socket can still be closed by calling IClientSimple.close().

Specified by:

setAutoClose in interface IClientSimple

main

public static void main(String[] args)