ca.uhn.hl7v2.hoh.raw.client

Class HohRawClientMultithreaded

java.lang.Object

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

ca.uhn.hl7v2.hoh.raw.client.HohRawClientMultithreaded

All Implemented Interfaces:

IClient, IClientMultithreaded

public class HohRawClientMultithreaded
extends AbstractRawClient
implements IClientMultithreaded

Raw message sender using the HL7 over HTTP specification which uses a ScheduledExecutorService to provide advanced functionality such as persistent connections which time out and close automatically.

This connector uses an executor service which can start worker threads, so use caution if embedding within a J2EE container.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_SOCKET_TIMEOUT Default Socket Timeout, 10000ms

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
HohRawClientMultithreaded() Constructor
HohRawClientMultithreaded(String theHost, int thePort, String thePath) Constructor
HohRawClientMultithreaded(String theHost, int thePort, String theUriPath, ScheduledExecutorService theExecutorService) Constructor
HohRawClientMultithreaded(URL theUrl) Constructor
HohRawClientMultithreaded(URL theUrl, ScheduledExecutorService theExecutorService) Constructor

Method Summary

Modifier and Type	Method and Description
long	getSocketTimeout() Returns the number of millis to keep an idle socket open before closing it.
protected Socket	provideSocket() Subclasses must override to provide a connected socket
protected void	returnSocket(Socket theSocket) Returns a socket to the pool.
void	setSocketTimeout(long theSocketTimeout) Sets the number of millis to keep an idle socket open before closing it.

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

closeSocket, connect, getHost, getPort, getSocketFactory, getSoTimeout, getUriPath, getUrl, getUrlString, isKeepAlive, sendAndReceive, 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

Field Detail

DEFAULT_SOCKET_TIMEOUT

public static final long DEFAULT_SOCKET_TIMEOUT

Default Socket Timeout, 10000ms

See Also:

Constant Field Values

Constructor Detail

HohRawClientMultithreaded

public HohRawClientMultithreaded()

Constructor

HohRawClientMultithreaded

public HohRawClientMultithreaded(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"

HohRawClientMultithreaded

public HohRawClientMultithreaded(String theHost,
                                 int thePort,
                                 String theUriPath,
                                 ScheduledExecutorService theExecutorService)

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"

theExecutorService - The executor service to use for detecting stale sockets

HohRawClientMultithreaded

public HohRawClientMultithreaded(URL theUrl)

Constructor

Parameters:

theUrl - The URL to connect to

theExecutorService - The executor service to use for detecting stale sockets

HohRawClientMultithreaded

public HohRawClientMultithreaded(URL theUrl,
                                 ScheduledExecutorService theExecutorService)

Constructor

Parameters:

theUrl - The URL to connect to

theExecutorService - The executor service to use for detecting stale sockets

Method Detail

provideSocket

protected Socket provideSocket()
                        throws IOException

Description copied from class: AbstractRawClient

Subclasses must override to provide a connected socket

Specified by:

provideSocket in class AbstractRawClient

Throws:

IOException

returnSocket

protected void returnSocket(Socket theSocket)

Returns a socket to the pool. If the socket is closed, it will not be returned.

Specified by:

returnSocket in class AbstractRawClient

getSocketTimeout

public long getSocketTimeout()

Returns the number of millis to keep an idle socket open before closing it.

Specified by:

getSocketTimeout in interface IClientMultithreaded

setSocketTimeout

public void setSocketTimeout(long theSocketTimeout)

Sets the number of millis to keep an idle socket open before closing it. This value may be changed at any time. Default is DEFAULT_SOCKET_TIMEOUT

A value of -1 indicates that connections do not time out (use with caution).

Note that this parameter is respected on a best-effort basis, timeouts may be different, especially under heavy load

Specified by:

setSocketTimeout in interface IClientMultithreaded