Package org.hl7.fhir.r5.utils.client

Class FHIRToolingClient

java.lang.Object

org.hl7.fhir.utilities.FHIRBaseToolingClient

org.hl7.fhir.r5.utils.client.FHIRToolingClient

public class FHIRToolingClient
extends org.hl7.fhir.utilities.FHIRBaseToolingClient

Very Simple RESTful client. This is purely for use in the standalone tools jar packages. It doesn't support many features, only what the tools need.

To use, initialize class and set base service URI as follows:

 FHIRSimpleClient fhirClient = new FHIRSimpleClient();
 fhirClient.initialize("http://my.fhir.domain/myServiceRoot");
 

Default Accept and Content-Type headers are application/fhir+xml and application/fhir+json.

These can be changed by invoking the following setter functions:

 setPreferredResourceFormat()
 setPreferredFeedFormat()
 

TODO Review all sad paths.

Author:

Claude Nanjo

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATE_FORMAT
static final String	DATETIME_FORMAT
static final String	hostKey
static final String	portKey

Fields inherited from class org.hl7.fhir.utilities.FHIRBaseToolingClient

timeoutEntry, timeoutExpand, timeoutLong, timeoutNormal, timeoutOperation, versionInMimeTypes

Constructor Summary

Constructors

Constructor	Description
FHIRToolingClient(String baseServiceUrl, String userAgent)

Method Summary

Modifier and Type	Method	Description
boolean	basicAuthHeaderExists()
ValueSet	expandValueset(ValueSet source, Parameters expParams)
Bundle	fetchFeed(String url)
<T extends Resource> T	fetchResource(Class<T> resourceClass, String id)
String	getAddress()
okhttp3.internal.http2.Header	getAuthorizationHeader()
<T extends Resource> T	getCanonical(Class<T> resourceClass, String canonicalURL)
CapabilityStatement	getCapabilitiesStatement()
CapabilityStatement	getCapabilitiesStatementQuick()
Client	getClient()
org.hl7.fhir.utilities.ToolingClientLogger	getLogger()
int	getMaximumRecordCount()
String	getPassword()
String	getPreferredResourceFormat()
int	getRetryCount()
String	getServerVersion()
TerminologyCapabilities	getTerminologyCapabilities()
long	getTimeout()
int	getUseCount()
String	getUserAgent()
String	getUsername()
protected void	handleException(String message, Exception e)	Helper method to prevent nesting of previously thrown EFhirClientExceptions
void	initialize(String baseServiceUrl)
ConceptMap	initializeClosure(String name)
protected boolean	isJson(String format)	Helper method to determine whether desired resource representation is Json or XML.
Parameters	lookupCode(Map<String,String> params)
Parameters	lookupCode(Parameters p)
<T extends Resource> Parameters	operateType(Class<T> resourceClass, String name, Parameters params)
<T extends Resource> T	read(Class<T> resourceClass, String id)
Resource	read(String resourceClass, String id)
Bundle	search(String type, String criteria)
void	setAcceptLanguage(String lang)
void	setClient(Client client)
void	setClientHeaders(ArrayList<okhttp3.internal.http2.Header> headers)
void	setContentLanguage(String lang)
void	setLogger(org.hl7.fhir.utilities.ToolingClientLogger logger)
void	setMaximumRecordCount(int maxResultSetSize)
void	setPassword(String password)
void	setPreferredResourceFormat(ResourceFormat resourceFormat)
void	setRetryCount(int retryCount)
void	setTimeout(long timeout)
void	setUserAgent(String userAgent)
void	setUsername(String username)
Bundle	transaction(Bundle batch)
Parameters	translate(Parameters p)
<T extends Resource> T	update(Class<T> resourceClass, T resource, String id)
Resource	update(Resource resource)
ConceptMap	updateClosure(String name, Coding coding)
<T extends Resource> OperationOutcome	validate(Class<T> resourceClass, T resource, String id)
<T extends Resource> T	vread(Class<T> resourceClass, String id, String version)

Methods inherited from class org.hl7.fhir.utilities.FHIRBaseToolingClient

getTimeoutEntry, getTimeoutExpand, getTimeoutLong, getTimeoutNormal, getTimeoutOperation, isVersionInMimeTypes, setTimeoutEntry, setTimeoutExpand, setTimeoutFactor, setTimeoutLong, setTimeoutNormal, setTimeoutOperation, setVersionInMimeTypes, withVer

Methods inherited from class java.lang.Object

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

Field Details

DATETIME_FORMAT

public static final String DATETIME_FORMAT

See Also:

• Constant Field Values

DATE_FORMAT

public static final String DATE_FORMAT

See Also:

• Constant Field Values

hostKey

public static final String hostKey

See Also:

• Constant Field Values

portKey

public static final String portKey

See Also:

• Constant Field Values

Constructor Details

FHIRToolingClient

public FHIRToolingClient(String baseServiceUrl,
 String userAgent)
                  throws URISyntaxException

Throws:

URISyntaxException

Method Details

initialize

public void initialize(String baseServiceUrl)
                throws URISyntaxException

Throws:

URISyntaxException

getClient

public Client getClient()

setClient

public void setClient(Client client)

getPreferredResourceFormat

public String getPreferredResourceFormat()

setPreferredResourceFormat

public void setPreferredResourceFormat(ResourceFormat resourceFormat)

getMaximumRecordCount

public int getMaximumRecordCount()

setMaximumRecordCount

public void setMaximumRecordCount(int maxResultSetSize)

getTerminologyCapabilities

public TerminologyCapabilities getTerminologyCapabilities()

getCapabilitiesStatement

public CapabilityStatement getCapabilitiesStatement()

getCapabilitiesStatementQuick

public CapabilityStatement getCapabilitiesStatementQuick()
                                                  throws EFhirClientException

Throws:

EFhirClientException

read

public Resource read(String resourceClass,
 String id)

read

public <T extends Resource> T read(Class<T> resourceClass,
 String id)

vread

public <T extends Resource> T vread(Class<T> resourceClass,
 String id,
 String version)

getCanonical

public <T extends Resource> T getCanonical(Class<T> resourceClass,
 String canonicalURL)

update

public Resource update(Resource resource)

update

public <T extends Resource> T update(Class<T> resourceClass,
 T resource,
 String id)

operateType

public <T extends Resource> Parameters operateType(Class<T> resourceClass,
 String name,
 Parameters params)

transaction

public Bundle transaction(Bundle batch)

validate

public <T extends Resource> OperationOutcome validate(Class<T> resourceClass,
 T resource,
 String id)

handleException

protected void handleException(String message,
 Exception e)
                        throws EFhirClientException

Helper method to prevent nesting of previously thrown EFhirClientExceptions

Parameters:

e -

Throws:

EFhirClientException

isJson

protected boolean isJson(String format)

Helper method to determine whether desired resource representation is Json or XML.

Parameters:

format -

Returns:

fetchFeed

public Bundle fetchFeed(String url)

expandValueset

public ValueSet expandValueset(ValueSet source,
 Parameters expParams)

lookupCode

public Parameters lookupCode(Map<String,String> params)

lookupCode

public Parameters lookupCode(Parameters p)

translate

public Parameters translate(Parameters p)

getAddress

public String getAddress()

initializeClosure

public ConceptMap initializeClosure(String name)

updateClosure

public ConceptMap updateClosure(String name,
 Coding coding)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

getLogger

public org.hl7.fhir.utilities.ToolingClientLogger getLogger()

setLogger

public void setLogger(org.hl7.fhir.utilities.ToolingClientLogger logger)

getRetryCount

public int getRetryCount()

setRetryCount

public void setRetryCount(int retryCount)

setClientHeaders

public void setClientHeaders(ArrayList<okhttp3.internal.http2.Header> headers)

basicAuthHeaderExists

public boolean basicAuthHeaderExists()

getAuthorizationHeader

public okhttp3.internal.http2.Header getAuthorizationHeader()

getUserAgent

public String getUserAgent()

setUserAgent

public void setUserAgent(String userAgent)

getServerVersion

public String getServerVersion()

setAcceptLanguage

public void setAcceptLanguage(String lang)

setContentLanguage

public void setContentLanguage(String lang)

search

public Bundle search(String type,
 String criteria)

fetchResource

public <T extends Resource> T fetchResource(Class<T> resourceClass,
 String id)

getUseCount

public int getUseCount()