IClient (HAPI - Java HL7 API - HL7 over HTTP 2.3 API)

All Known Subinterfaces:

IClientMultithreaded, IClientSimple

All Known Implementing Classes:

AbstractClient, AbstractRawClient, HohClientMultithreaded, HohClientSimple, HohRawClientMultithreaded, HohRawClientSimple, RelayHttpSender
```
public interface IClient
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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
`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.

- Method Detail
  - getHost
```
String getHost()
```
    Getter for the host (e.g. "10.0.0.111" or "localhost")
  - getPort
```
int getPort()
```
    Getter for the port (e.g. 80 for standard HTTP)
  - getSocketFactory
```
ISocketFactory getSocketFactory()
```
    Returns the socket factory used by this client
  - getUriPath
```
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
  - getUrl
```
URL getUrl()
```
    Getter for the URL to send messages to.
  - setAuthorizationCallback
```
void setAuthorizationCallback(IAuthorizationClientCallback theAuthorizationCallback)
```
    If set, provides a callback which will be used to se the username and password associated with the request
  - setCharset
```
void setCharset(Charset theCharset)
```
    Sets the charset to use for requests from this client. May be changed at any time.
    
    Default is UTF-8
  - setHost
```
void setHost(String theHost)
```
    Setter for the host (e.g. "10.0.0.111" or "localhost")
  - setKeepAlive
```
void setKeepAlive(boolean theKeepAlive)
```
    Configures the TCP KeepAlive flag for new connections
    
    See Also:
    
    Socket.getKeepAlive()
  - isKeepAlive
```
boolean isKeepAlive()
```
    Returns the TCP KeepAlive flag for new connections
    
    See Also:
    
    Socket.getKeepAlive()
  - setSoTimeout
```
void setSoTimeout(int theSoTimeout)
```
    Sets the TCP SO Timeout setting for new connections
    
    See Also:
    
    Socket.getSoTimeout()
  - getSoTimeout
```
int getSoTimeout()
```
    Returns the TCP SO Timeout setting for new connections
    
    See Also:
    
    Socket.getSoTimeout()
  - setUriPath
```
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
  - setPort
```
void setPort(int thePort)
```
    Getter for the port (e.g. 80 for standard HTTP)
  - setResponseTimeout
```
void setResponseTimeout(long theResponseTimeout)
```
    Sets the number of milliseconds before timing out. Default is #DEFAULT_RESPONSE_TIMEOUT
    
    Parameters:
    
    theResponseTimeout - The millis to wait before timeout.
    
    See Also:
    
    #DEFAULT_RESPONSE_TIMEOUT
  - setSigner
```
void setSigner(ISigner theSigner)
```
    Parameters:
    
    theSigner - If provided, sets the Signature Profile signer implementation to use. See http://hl7api.sourceforge.net/hapi-hl7overhttp/specification. html#SIGNATURE_PROFILE
  - setSocketFactory
```
void setSocketFactory(ISocketFactory theSocketFactory)
```
    Sets the socket factory used by this client. Default is StandardSocketFactory.
    
    See Also:
    
    ISocketFactory
  - setUrl
```
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 setHost(String), setPort(int), or setUriPath(String)
  - setUrlString
```
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 setHost(String), setPort(int), or setUriPath(String)
  - getUrlString
```
String getUrlString()
```
    Getter for the URL to send messages to.

Interface IClient

Method Summary

Method Detail

getHost

getPort

getSocketFactory

getUriPath

getUrl

setAuthorizationCallback

setCharset

setHost

setKeepAlive

isKeepAlive

setSoTimeout

getSoTimeout

setUriPath

setPort

setResponseTimeout

setSigner

setSocketFactory

setUrl

setUrlString

getUrlString