ca.uhn.fhir.rest.client.impl

Class BaseClient

java.lang.Object

ca.uhn.fhir.rest.client.impl.BaseClient

All Implemented Interfaces:

IRestfulClient

Direct Known Subclasses:

ClientInvocationHandler, GenericClient

public abstract class BaseClient
extends Object
implements IRestfulClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BaseClient.ResourceResponseHandler<T extends IBaseResource>

Field Summary

Fields

Modifier and Type	Field and Description
static String	HAPI_CLIENT_KEEPRESPONSES This property is used by unit tests - do not rely on it in production code as it may change at any time.

Method Summary

Modifier and Type	Method and Description
protected Map<String,List<String>>	createExtraParams()
<T extends IBaseResource> T	fetchResourceFromUrl(Class<T> theResourceType, String theUrl)
EncodingEnum	getEncoding()
IHttpClient	getHttpClient()
List<IClientInterceptor>	getInterceptors()
IHttpResponse	getLastResponse() For now, this is a part of the internal API of HAPI - Use with caution as this method may change!
String	getLastResponseBody() For now, this is a part of the internal API of HAPI - Use with caution as this method may change!
String	getServerBase()
SummaryEnum	getSummary()
String	getUrlBase()
boolean	isKeepResponses() For now, this is a part of the internal API of HAPI - Use with caution as this method may change!
boolean	isPrettyPrint() Returns the pretty print flag, which is a request to the server for it to return "pretty printed" responses.
void	registerInterceptor(IClientInterceptor theInterceptor)
void	setDontValidateConformance(boolean theDontValidateConformance) This method is an internal part of the HAPI API and may change, use with caution.
void	setEncoding(EncodingEnum theEncoding) Sets the encoding that will be used on requests.
void	setKeepResponses(boolean theKeepResponses) For now, this is a part of the internal API of HAPI - Use with caution as this method may change!
void	setPrettyPrint(Boolean thePrettyPrint) Sets the pretty print flag, which is a request to the server for it to return "pretty printed" responses.
void	setSummary(SummaryEnum theSummary)
void	unregisterInterceptor(IClientInterceptor theInterceptor)

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.IRestfulClient

getFhirContext

Field Detail

HAPI_CLIENT_KEEPRESPONSES

public static final String HAPI_CLIENT_KEEPRESPONSES

This property is used by unit tests - do not rely on it in production code as it may change at any time. If you want to capture responses in a reliable way in your own code, just use client interceptors

See Also:

Constant Field Values

Method Detail

createExtraParams

protected Map<String,List<String>> createExtraParams()

fetchResourceFromUrl

public <T extends IBaseResource> T fetchResourceFromUrl(Class<T> theResourceType,
                                                        String theUrl)

Specified by:

fetchResourceFromUrl in interface IRestfulClient

getEncoding

public EncodingEnum getEncoding()

Specified by:

getEncoding in interface IRestfulClient

getHttpClient

public IHttpClient getHttpClient()

Specified by:

getHttpClient in interface IRestfulClient

getInterceptors

public List<IClientInterceptor> getInterceptors()

Specified by:

getInterceptors in interface IRestfulClient

getLastResponse

public IHttpResponse getLastResponse()

For now, this is a part of the internal API of HAPI - Use with caution as this method may change!

getLastResponseBody

public String getLastResponseBody()

For now, this is a part of the internal API of HAPI - Use with caution as this method may change!

getServerBase

public String getServerBase()

Specified by:

getServerBase in interface IRestfulClient

getSummary

public SummaryEnum getSummary()

getUrlBase

public String getUrlBase()

isKeepResponses

public boolean isKeepResponses()

For now, this is a part of the internal API of HAPI - Use with caution as this method may change!

isPrettyPrint

public boolean isPrettyPrint()

Returns the pretty print flag, which is a request to the server for it to return "pretty printed" responses. Note that this is currently a non-standard flag (_pretty) which is supported only by HAPI based servers (and any other servers which might implement it).

registerInterceptor

public void registerInterceptor(IClientInterceptor theInterceptor)

Specified by:

registerInterceptor in interface IRestfulClient

setDontValidateConformance

public void setDontValidateConformance(boolean theDontValidateConformance)

This method is an internal part of the HAPI API and may change, use with caution. If you want to disable the loading of conformance statements, use IRestfulClientFactory.setServerValidationModeEnum(ServerValidationModeEnum)

setEncoding

public void setEncoding(EncodingEnum theEncoding)

Sets the encoding that will be used on requests. Default is null, which means the client will not explicitly request an encoding. (This is perfectly acceptable behaviour according to the FHIR specification. In this case, the server will choose which encoding to return, and the client can handle either XML or JSON)

Specified by:

setEncoding in interface IRestfulClient

setKeepResponses

public void setKeepResponses(boolean theKeepResponses)

For now, this is a part of the internal API of HAPI - Use with caution as this method may change!

setPrettyPrint

public void setPrettyPrint(Boolean thePrettyPrint)

Sets the pretty print flag, which is a request to the server for it to return "pretty printed" responses. Note that this is currently a non-standard flag (_pretty) which is supported only by HAPI based servers (and any other servers which might implement it).

Specified by:

setPrettyPrint in interface IRestfulClient

setSummary

public void setSummary(SummaryEnum theSummary)

Specified by:

setSummary in interface IRestfulClient

unregisterInterceptor

public void unregisterInterceptor(IClientInterceptor theInterceptor)

Specified by:

unregisterInterceptor in interface IRestfulClient