ca.uhn.fhir.rest.client

Class RestfulClientFactory

java.lang.Object

ca.uhn.fhir.rest.client.RestfulClientFactory

All Implemented Interfaces:

IRestfulClientFactory

Direct Known Subclasses:

ApacheRestfulClientFactory

public abstract class RestfulClientFactory
extends Object
implements IRestfulClientFactory

Base class for a REST client factory implementation

Field Summary

Fields inherited from interface ca.uhn.fhir.rest.client.IRestfulClientFactory

DEFAULT_CONNECT_TIMEOUT, DEFAULT_CONNECTION_REQUEST_TIMEOUT, DEFAULT_POOL_MAX, DEFAULT_POOL_MAX_PER_ROUTE, DEFAULT_SERVER_VALIDATION_MODE, DEFAULT_SOCKET_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
RestfulClientFactory() Constructor
RestfulClientFactory(FhirContext theFhirContext) Constructor

Method Summary

Modifier and Type	Method and Description
int	getConnectionRequestTimeout() Gets the connection request timeout, in milliseconds.
int	getConnectTimeout() Gets the connect timeout, in milliseconds.
FhirContext	getFhirContext() Return the fhir context
protected abstract IHttpClient	getHttpClient(String theServerBase) Get the http client for the given server base
int	getPoolMaxPerRoute() Gets the maximum number of connections per route allowed in the pool.
int	getPoolMaxTotal() Gets the maximum number of connections allowed in the pool.
protected String	getProxyPassword() Return the proxy password to authenticate with the HTTP proxy
protected String	getProxyUsername() Return the proxy username to authenticate with the HTTP proxy
ServerValidationModeEnum	getServerValidationMode() Gets the server validation mode for any clients created from this factory.
ServerValidationModeEnum	getServerValidationModeEnum() Deprecated.
int	getSocketTimeout() Gets the socket timeout, in milliseconds.
<T extends IRestfulClient> T	newClient(Class<T> theClientType, String theServerBase) Instantiates a new client instance
IGenericClient	newGenericClient(String theServerBase) Instantiates a new generic client instance
protected abstract void	resetHttpClient() Reset the http client.
void	setConnectionRequestTimeout(int theConnectionRequestTimeout) Sets the connection request timeout, in milliseconds.
void	setConnectTimeout(int theConnectTimeout) Sets the connect timeout, in milliseconds.
void	setFhirContext(FhirContext theContext) Sets the context associated with this client factory.
void	setPoolMaxPerRoute(int thePoolMaxPerRoute) Sets the maximum number of connections per route allowed in the pool.
void	setPoolMaxTotal(int thePoolMaxTotal) Sets the maximum number of connections allowed in the pool.
void	setProxyCredentials(String theUsername, String thePassword) Sets the credentials to use to authenticate with the HTTP proxy, if one is defined.
void	setServerValidationMode(ServerValidationModeEnum theServerValidationMode) Sets the server validation mode for any clients created from this factory.
void	setServerValidationModeEnum(ServerValidationModeEnum theServerValidationMode) Deprecated.
void	setSocketTimeout(int theSocketTimeout) Sets the socket timeout, in milliseconds.
protected void	validateConfigured() Called automatically before the first use of this factory to ensure that the configuration is sane.
void	validateServerBase(String theServerBase, IHttpClient theHttpClient, BaseClient theClient)
void	validateServerBaseIfConfiguredToDoSo(String theServerBase, IHttpClient theHttpClient, BaseClient theClient) This method is internal to HAPI - It may change in future versions, use with caution.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.fhir.rest.client.IRestfulClientFactory

getHttpClient, setHttpClient, setProxy

Constructor Detail

RestfulClientFactory

public RestfulClientFactory()

Constructor

RestfulClientFactory

public RestfulClientFactory(FhirContext theFhirContext)

Constructor

Parameters:

theFhirContext - The context

Method Detail

getConnectionRequestTimeout

public int getConnectionRequestTimeout()

Description copied from interface: IRestfulClientFactory

Gets the connection request timeout, in milliseconds. This is the amount of time that the HTTPClient connection pool may wait for an available connection before failing. This setting typically does not need to be adjusted.

The default value for this setting is defined by IRestfulClientFactory.DEFAULT_CONNECTION_REQUEST_TIMEOUT

Specified by:

getConnectionRequestTimeout in interface IRestfulClientFactory

getConnectTimeout

public int getConnectTimeout()

Description copied from interface: IRestfulClientFactory

Gets the connect timeout, in milliseconds. This is the amount of time that the initial connection attempt network operation may block without failing.

The default value for this setting is defined by IRestfulClientFactory.DEFAULT_CONNECT_TIMEOUT

Specified by:

getConnectTimeout in interface IRestfulClientFactory

getProxyUsername

protected String getProxyUsername()

Return the proxy username to authenticate with the HTTP proxy

Parameters:

The - proxy username

getProxyPassword

protected String getProxyPassword()

Return the proxy password to authenticate with the HTTP proxy

Parameters:

The - proxy password

setProxyCredentials

public void setProxyCredentials(String theUsername,
                                String thePassword)

Description copied from interface: IRestfulClientFactory

Sets the credentials to use to authenticate with the HTTP proxy, if one is defined. Set to null to use no authentication with the proxy.

Specified by:

setProxyCredentials in interface IRestfulClientFactory

Parameters:

theUsername - The username

thePassword - The password

getServerValidationMode

public ServerValidationModeEnum getServerValidationMode()

Description copied from interface: IRestfulClientFactory

Gets the server validation mode for any clients created from this factory. Server validation involves the client requesting the server's conformance statement to determine whether the server is appropriate for the given client.

The default value for this setting is defined by IRestfulClientFactory.DEFAULT_SERVER_VALIDATION_MODE

Specified by:

getServerValidationMode in interface IRestfulClientFactory

getSocketTimeout

public int getSocketTimeout()

Description copied from interface: IRestfulClientFactory

Gets the socket timeout, in milliseconds. This is the SO_TIMEOUT time, which is the amount of time that a read/write network operation may block without failing.

The default value for this setting is defined by IRestfulClientFactory.DEFAULT_SOCKET_TIMEOUT

Specified by:

getSocketTimeout in interface IRestfulClientFactory

getPoolMaxTotal

public int getPoolMaxTotal()

Description copied from interface: IRestfulClientFactory

Gets the maximum number of connections allowed in the pool.

The default value for this setting is defined by IRestfulClientFactory.DEFAULT_POOL_MAX

Specified by:

getPoolMaxTotal in interface IRestfulClientFactory

getPoolMaxPerRoute

public int getPoolMaxPerRoute()

Description copied from interface: IRestfulClientFactory

Gets the maximum number of connections per route allowed in the pool.

The default value for this setting is defined by IRestfulClientFactory.DEFAULT_POOL_MAX_PER_ROUTE

Specified by:

getPoolMaxPerRoute in interface IRestfulClientFactory

newClient

public <T extends IRestfulClient> T newClient(Class<T> theClientType,
                                              String theServerBase)

Instantiates a new client instance

Specified by:

newClient in interface IRestfulClientFactory

Parameters:

theClientType - The client type, which is an interface type to be instantiated

theServerBase - The URL of the base for the restful FHIR server to connect to

Returns:

A newly created client

Throws:

ConfigurationException - If the interface type is not an interface

validateConfigured

protected void validateConfigured()

Called automatically before the first use of this factory to ensure that the configuration is sane. Subclasses may override, but should also call super.validateConfigured()

newGenericClient

public IGenericClient newGenericClient(String theServerBase)

Description copied from interface: IRestfulClientFactory

Instantiates a new generic client instance

Specified by:

newGenericClient in interface IRestfulClientFactory

Parameters:

theServerBase - The URL of the base for the restful FHIR server to connect to

Returns:

A newly created client

validateServerBaseIfConfiguredToDoSo

public void validateServerBaseIfConfiguredToDoSo(String theServerBase,
                                                 IHttpClient theHttpClient,
                                                 BaseClient theClient)

Description copied from interface: IRestfulClientFactory

This method is internal to HAPI - It may change in future versions, use with caution.

Specified by:

validateServerBaseIfConfiguredToDoSo in interface IRestfulClientFactory

setConnectionRequestTimeout

public void setConnectionRequestTimeout(int theConnectionRequestTimeout)

Description copied from interface: IRestfulClientFactory

Sets the connection request timeout, in milliseconds. This is the amount of time that the HTTPClient connection pool may wait for an available connection before failing. This setting typically does not need to be adjusted.

The default value for this setting is defined by IRestfulClientFactory.DEFAULT_CONNECTION_REQUEST_TIMEOUT

Specified by:

setConnectionRequestTimeout in interface IRestfulClientFactory

setConnectTimeout

public void setConnectTimeout(int theConnectTimeout)

Description copied from interface: IRestfulClientFactory

Sets the connect timeout, in milliseconds. This is the amount of time that the initial connection attempt network operation may block without failing.

The default value for this setting is defined by IRestfulClientFactory.DEFAULT_CONNECT_TIMEOUT

Specified by:

setConnectTimeout in interface IRestfulClientFactory

setFhirContext

public void setFhirContext(FhirContext theContext)

Sets the context associated with this client factory. Must not be called more than once.

getFhirContext

public FhirContext getFhirContext()

Return the fhir context

Returns:

the fhir context

setServerValidationMode

public void setServerValidationMode(ServerValidationModeEnum theServerValidationMode)

Description copied from interface: IRestfulClientFactory

Sets the server validation mode for any clients created from this factory. Server validation involves the client requesting the server's conformance statement to determine whether the server is appropriate for the given client.

This check is primarily to validate that the server supports an appropriate version of FHIR

The default value for this setting is defined by IRestfulClientFactory.DEFAULT_SERVER_VALIDATION_MODE

Specified by:

setServerValidationMode in interface IRestfulClientFactory

setSocketTimeout

public void setSocketTimeout(int theSocketTimeout)

Description copied from interface: IRestfulClientFactory

Sets the socket timeout, in milliseconds. This is the SO_TIMEOUT time, which is the amount of time that a read/write network operation may block without failing.

The default value for this setting is defined by IRestfulClientFactory.DEFAULT_SOCKET_TIMEOUT

Specified by:

setSocketTimeout in interface IRestfulClientFactory

setPoolMaxTotal

public void setPoolMaxTotal(int thePoolMaxTotal)

Description copied from interface: IRestfulClientFactory

Sets the maximum number of connections allowed in the pool.

The default value for this setting is defined by IRestfulClientFactory.DEFAULT_POOL_MAX

Specified by:

setPoolMaxTotal in interface IRestfulClientFactory

setPoolMaxPerRoute

public void setPoolMaxPerRoute(int thePoolMaxPerRoute)

Description copied from interface: IRestfulClientFactory

Sets the maximum number of connections per route allowed in the pool.

The default value for this setting is defined by IRestfulClientFactory.DEFAULT_POOL_MAX_PER_ROUTE

Specified by:

setPoolMaxPerRoute in interface IRestfulClientFactory

validateServerBase

public void validateServerBase(String theServerBase,
                               IHttpClient theHttpClient,
                               BaseClient theClient)

Specified by:

validateServerBase in interface IRestfulClientFactory

getServerValidationModeEnum

@Deprecated
public ServerValidationModeEnum getServerValidationModeEnum()

Deprecated.

Specified by:

getServerValidationModeEnum in interface IRestfulClientFactory

setServerValidationModeEnum

@Deprecated
public void setServerValidationModeEnum(ServerValidationModeEnum theServerValidationMode)

Deprecated.

Specified by:

setServerValidationModeEnum in interface IRestfulClientFactory

getHttpClient

protected abstract IHttpClient getHttpClient(String theServerBase)

Get the http client for the given server base

Parameters:

theServerBase - the server base

Returns:

the http client

resetHttpClient

protected abstract void resetHttpClient()

Reset the http client. This method is used when parameters have been set and a new http client needs to be created