ca.uhn.hl7v2.hoh.hapi.client

Class AbstractClient<T extends AbstractRawClient>

java.lang.Object

ca.uhn.hl7v2.hoh.hapi.client.AbstractClient<T>

All Implemented Interfaces:

IClient

Direct Known Subclasses:

HohClientMultithreaded, HohClientSimple

public abstract class AbstractClient<T extends AbstractRawClient>
extends Object
implements IClient

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractClient(T theRawClient) Constructor
protected	AbstractClient(T theRawClient, Parser theParser) Constructor

Method Summary

Modifier and Type	Method and Description
String	getHost() Getter for the host (e.g.
Parser	getParser() Returns the Parser to use to parsing and encoding messages within this client (may return null)
int	getPort() Getter for the port (e.g.
protected T	getRawClient()
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
IReceivable<Message>	sendAndReceiveMessage(ISendable<Message> theMessageToSend) Sends a message, waits for the response, and then returns the response if any
IReceivable<Message>	sendAndReceiveMessage(Message theMessageToSend) Sends a message, waits for the response, and then returns the response if any (this method is a convenience method for sendAndReceiveMessage(ISendable)
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	setParser(Parser theParser) Sets the Parser to use to parsing and encoding messages within this client
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

Constructor Detail

AbstractClient

public AbstractClient(T theRawClient)

Constructor

Parameters:

theRawClient - The Raw client to wrap (may not be null)

AbstractClient

protected AbstractClient(T theRawClient,
                         Parser theParser)

Constructor

Parameters:

theRawClient - The Raw client to wrap (may not be null)

theParser - The parser to use (may be null, in which case the parser contained within the sent message will be used

Method Detail

setKeepAlive

public void setKeepAlive(boolean theKeepAlive)

Configures the TCP KeepAlive flag for new connections

Specified by:

setKeepAlive in interface IClient

See Also:

Socket.getKeepAlive()

isKeepAlive

public boolean isKeepAlive()

Returns the TCP KeepAlive flag for new connections

Specified by:

isKeepAlive in interface IClient

See Also:

Socket.getKeepAlive()

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

getSoTimeout

public int getSoTimeout()

Returns the TCP SO Timeout setting for new connections

Specified by:

getSoTimeout in interface IClient

See Also:

Socket.getSoTimeout()

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

getParser

public Parser getParser()

Returns the Parser to use to parsing and encoding messages within this client (may return null)

getPort

public int getPort()

Getter for the port (e.g. 80 for standard HTTP)

Specified by:

getPort in interface IClient

getRawClient

protected T getRawClient()

getSocketFactory

public ISocketFactory getSocketFactory()

Returns the socket factory used by this client

Specified by:

getSocketFactory in interface IClient

getUriPath

public String getUriPath()

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

sendAndReceiveMessage

public IReceivable<Message> sendAndReceiveMessage(ISendable<Message> theMessageToSend)
                                           throws DecodeException,
                                                  IOException,
                                                  EncodeException,
                                                  EncodingNotSupportedException,
                                                  HL7Exception

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

HL7Exception - If the response can not be parsed

EncodingNotSupportedException - If the encoding is not supported

sendAndReceiveMessage

public IReceivable<Message> sendAndReceiveMessage(Message theMessageToSend)
                                           throws DecodeException,
                                                  IOException,
                                                  EncodeException,
                                                  EncodingNotSupportedException,
                                                  HL7Exception

Sends a message, waits for the response, and then returns the response if any (this method is a convenience method for sendAndReceiveMessage(ISendable)

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

HL7Exception - If the response can not be parsed

EncodingNotSupportedException - If the encoding is not supported

setAuthorizationCallback

public void setAuthorizationCallback(IAuthorizationClientCallback theAuthorizationCallback)

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

setParser

public void setParser(Parser theParser)

Sets the Parser to use to parsing and encoding messages within this client

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

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

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