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

Class FhirRequestBuilder

java.lang.Object

org.hl7.fhir.r5.utils.client.network.FhirRequestBuilder

public class FhirRequestBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CONTENT_LOCATION_HEADER
protected static final String	DEFAULT_CHARSET
protected static final String	HEADER_PROXY_AUTH
protected static final String	HTTP_PROXY_PASS
protected static final String	HTTP_PROXY_USER
protected static final String	LOCATION_HEADER

Constructor Summary

Constructors

Constructor	Description
FhirRequestBuilder(okhttp3.Request.Builder httpRequest)

Method Summary

Modifier and Type	Method	Description
protected static void	addDefaultHeaders(okhttp3.Request.Builder request, okhttp3.Headers headers)	Adds necessary headers for all REST requests.
protected static void	addHeaders(okhttp3.Request.Builder request, okhttp3.Headers headers)	Iterates through the passed in Headers and adds them to the provided Request.Builder.
protected static void	addResourceFormatHeaders(okhttp3.Request.Builder request, String format)	Adds necessary headers for the given resource format provided.
protected okhttp3.Request	buildRequest()
<T extends Resource> ResourceRequest<T>	execute()
Bundle	executeAsBatch()
protected static void	formatHeaders(okhttp3.Request.Builder request, String format, okhttp3.Headers headers)	Adds necessary default headers, formatting headers, and any passed in Headers to the passed in Request.Builder
protected okhttp3.OkHttpClient	getHttpClient()	We only ever want to have one copy of the HttpClient kicking around at any given time.
protected static String	getLocationHeader(okhttp3.Headers headers)	Extracts the 'location' header from the passes in Headers.
protected IParser	getParser(String format)	Returns the appropriate parser based on the format type passed in.
protected static boolean	hasError(OperationOutcome oo)	Returns true if any of the OperationOutcome.OperationOutcomeIssueComponent within the provided OperationOutcome have an OperationOutcome.IssueSeverity of OperationOutcome.IssueSeverity.ERROR or OperationOutcome.IssueSeverity.FATAL
protected Bundle	unmarshalFeed(okhttp3.Response response, String format)	Unmarshalls Bundle from response stream.
protected <T extends Resource> T	unmarshalReference(okhttp3.Response response, String format)	Unmarshalls a resource from the response stream.
FhirRequestBuilder	withHeaders(okhttp3.Headers headers)
FhirRequestBuilder	withLogger(FhirLoggingInterceptor logger)
FhirRequestBuilder	withMessage(String message)
FhirRequestBuilder	withResourceFormat(String resourceFormat)
FhirRequestBuilder	withRetryCount(int retryCount)
FhirRequestBuilder	withTimeout(long timeout, TimeUnit unit)

Methods inherited from class java.lang.Object

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

Field Details

HTTP_PROXY_USER

protected static final String HTTP_PROXY_USER

See Also:

• Constant Field Values

HTTP_PROXY_PASS

protected static final String HTTP_PROXY_PASS

See Also:

• Constant Field Values

HEADER_PROXY_AUTH

protected static final String HEADER_PROXY_AUTH

See Also:

• Constant Field Values

LOCATION_HEADER

protected static final String LOCATION_HEADER

See Also:

• Constant Field Values

CONTENT_LOCATION_HEADER

protected static final String CONTENT_LOCATION_HEADER

See Also:

• Constant Field Values

DEFAULT_CHARSET

protected static final String DEFAULT_CHARSET

See Also:

• Constant Field Values

Constructor Details

FhirRequestBuilder

public FhirRequestBuilder(okhttp3.Request.Builder httpRequest)

Method Details

formatHeaders

protected static void formatHeaders(okhttp3.Request.Builder request,
 String format,
 okhttp3.Headers headers)

Adds necessary default headers, formatting headers, and any passed in Headers to the passed in Request.Builder

Parameters:

request - Request.Builder to add headers to.

format - Expected Resource format.

headers - Any additional Headers to add to the request.

addDefaultHeaders

protected static void addDefaultHeaders(okhttp3.Request.Builder request,
 okhttp3.Headers headers)

Adds necessary headers for all REST requests.

User-Agent : hapi-fhir-tooling-client

Accept-Charset : DEFAULT_CHARSET

Parameters:

request - Request.Builder to add default headers to.

addResourceFormatHeaders

protected static void addResourceFormatHeaders(okhttp3.Request.Builder request,
 String format)

Adds necessary headers for the given resource format provided.

Parameters:

request - Request.Builder to add default headers to.

addHeaders

protected static void addHeaders(okhttp3.Request.Builder request,
 okhttp3.Headers headers)

Iterates through the passed in Headers and adds them to the provided Request.Builder.

Parameters:

request - Request.Builder to add headers to.

headers - Headers to add to request.

hasError

protected static boolean hasError(OperationOutcome oo)

Returns true if any of the OperationOutcome.OperationOutcomeIssueComponent within the provided OperationOutcome have an OperationOutcome.IssueSeverity of OperationOutcome.IssueSeverity.ERROR or OperationOutcome.IssueSeverity.FATAL

Parameters:

oo - OperationOutcome to evaluate.

Returns:

Boolean.TRUE if an error exists.

getLocationHeader

protected static String getLocationHeader(okhttp3.Headers headers)

Extracts the 'location' header from the passes in Headers. If no value for 'location' exists, the value for 'content-location' is returned. If neither header exists, we return null.

Parameters:

headers - Headers to evaluate

Returns:

String header value, or null if no location headers are set.

getHttpClient

protected okhttp3.OkHttpClient getHttpClient()

We only ever want to have one copy of the HttpClient kicking around at any given time. If we need to make changes to any configuration, such as proxy settings, timeout, caches, etc, we can do a per-call configuration through the OkHttpClient.newBuilder() method. That will return a builder that shares the same connection pool, dispatcher, and configuration with the original client.

The OkHttpClient uses the proxy auth properties set in the current system properties. The reason we don't set the proxy address and authentication explicitly, is due to the fact that this class is often used in conjunction with other http client tools which rely on the system.properties settings to determine proxy settings. It's easier to keep the method consistent across the board. ...for now.

Returns:

OkHttpClient instance

withResourceFormat

public FhirRequestBuilder withResourceFormat(String resourceFormat)

withHeaders

public FhirRequestBuilder withHeaders(okhttp3.Headers headers)

withMessage

public FhirRequestBuilder withMessage(String message)

withRetryCount

public FhirRequestBuilder withRetryCount(int retryCount)

withLogger

public FhirRequestBuilder withLogger(FhirLoggingInterceptor logger)

withTimeout

public FhirRequestBuilder withTimeout(long timeout,
 TimeUnit unit)

buildRequest

protected okhttp3.Request buildRequest()

execute

public <T extends Resource> ResourceRequest<T> execute()
                                                throws IOException

Throws:

IOException

executeAsBatch

public Bundle executeAsBatch()
                      throws IOException

Throws:

IOException

unmarshalReference

protected <T extends Resource> T unmarshalReference(okhttp3.Response response,
 String format)

Unmarshalls a resource from the response stream.

unmarshalFeed

protected Bundle unmarshalFeed(okhttp3.Response response,
 String format)

Unmarshalls Bundle from response stream.

getParser

protected IParser getParser(String format)

Returns the appropriate parser based on the format type passed in. Defaults to XML parser if a blank format is provided...because reasons.

Currently supports only "json" and "xml" formats.

Parameters:

format - One of "json" or "xml".

Returns:

JsonParser or XmlParser