ca.uhn.fhir.rest.client.impl

Class RestfulClientFactory

java.lang.Object

ca.uhn.fhir.rest.client.impl.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.api.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()
int	getConnectTimeout()
FhirContext	getFhirContext() Return the fhir context
protected abstract IHttpClient	getHttpClient(String theServerBase) Get the http client for the given server base
int	getPoolMaxPerRoute()
int	getPoolMaxTotal()
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()
ServerValidationModeEnum	getServerValidationModeEnum() Deprecated.
int	getSocketTimeout()
<T extends IRestfulClient> T	newClient(Class<T> theClientType, String theServerBase) Instantiates a new client instance
IGenericClient	newGenericClient(String theServerBase)
protected abstract void	resetHttpClient() Reset the http client.
void	setConnectionRequestTimeout(int theConnectionRequestTimeout)
void	setConnectTimeout(int theConnectTimeout)
void	setFhirContext(FhirContext theContext) Sets the context associated with this client factory.
void	setPoolMaxPerRoute(int thePoolMaxPerRoute)
void	setPoolMaxTotal(int thePoolMaxTotal)
void	setProxyCredentials(String theUsername, String thePassword)
void	setServerValidationMode(ServerValidationModeEnum theServerValidationMode)
void	setServerValidationModeEnum(ServerValidationModeEnum theServerValidationMode) Deprecated.
void	setSocketTimeout(int theSocketTimeout)
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, IRestfulClient theClient)
void	validateServerBaseIfConfiguredToDoSo(String theServerBase, IHttpClient theHttpClient, IRestfulClient theClient)

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

Specified by:

getConnectionRequestTimeout in interface IRestfulClientFactory

getConnectTimeout

public int getConnectTimeout()

Specified by:

getConnectTimeout in interface IRestfulClientFactory

getProxyUsername

protected String getProxyUsername()

Return the proxy username to authenticate with the HTTP proxy

getProxyPassword

protected String getProxyPassword()

Return the proxy password to authenticate with the HTTP proxy

setProxyCredentials

public void setProxyCredentials(String theUsername,
                                String thePassword)

Specified by:

setProxyCredentials in interface IRestfulClientFactory

getServerValidationMode

public ServerValidationModeEnum getServerValidationMode()

Specified by:

getServerValidationMode in interface IRestfulClientFactory

getSocketTimeout

public int getSocketTimeout()

Specified by:

getSocketTimeout in interface IRestfulClientFactory

getPoolMaxTotal

public int getPoolMaxTotal()

Specified by:

getPoolMaxTotal in interface IRestfulClientFactory

getPoolMaxPerRoute

public int getPoolMaxPerRoute()

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)

Specified by:

newGenericClient in interface IRestfulClientFactory

setConnectionRequestTimeout

public void setConnectionRequestTimeout(int theConnectionRequestTimeout)

Specified by:

setConnectionRequestTimeout in interface IRestfulClientFactory

setConnectTimeout

public void setConnectTimeout(int theConnectTimeout)

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)

Specified by:

setServerValidationMode in interface IRestfulClientFactory

setSocketTimeout

public void setSocketTimeout(int theSocketTimeout)

Specified by:

setSocketTimeout in interface IRestfulClientFactory

setPoolMaxTotal

public void setPoolMaxTotal(int thePoolMaxTotal)

Specified by:

setPoolMaxTotal in interface IRestfulClientFactory

setPoolMaxPerRoute

public void setPoolMaxPerRoute(int thePoolMaxPerRoute)

Specified by:

setPoolMaxPerRoute 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

validateServerBaseIfConfiguredToDoSo

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

Specified by:

validateServerBaseIfConfiguredToDoSo in interface IRestfulClientFactory

validateServerBase

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

Specified by:

validateServerBase 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