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	LOCATION_HEADER

Constructor Summary

Constructors

Constructor	Description
FhirRequestBuilder(org.hl7.fhir.utilities.http.HTTPRequest httpRequest, String source)

Method Summary

Modifier and Type	Method	Description
<T extends Resource> ResourceRequest<T>	execute()
Bundle	executeAsBatch()
protected static org.hl7.fhir.utilities.http.HTTPRequest	formatHeaders(org.hl7.fhir.utilities.http.HTTPRequest request, String format, Iterable<org.hl7.fhir.utilities.http.HTTPHeader> headers)	Adds necessary default headers, formatting headers, and any passed in HTTPHeaders to the passed in HTTPRequest
protected static String	getLocationHeader(Iterable<org.hl7.fhir.utilities.http.HTTPHeader> headers)	Extracts the 'location' header from the passed Iterable<org.hl7.fhir.utilities.http.HTTPHeader>.
protected org.hl7.fhir.utilities.http.ManagedFhirWebAccessor	getManagedWebAccessor()
protected IParser	getParser(String format)	Returns the appropriate parser based on the format type passed in.
protected static Iterable<org.hl7.fhir.utilities.http.HTTPHeader>	getResourceFormatHeaders(org.hl7.fhir.utilities.http.HTTPRequest httpRequest, String format)	Adds necessary headers for the given resource format provided.
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(org.hl7.fhir.utilities.http.HTTPResult response, String format)	Unmarshalls Bundle from response stream.
protected <T extends Resource> T	unmarshalReference(org.hl7.fhir.utilities.http.HTTPResult response, String format, String resourceType)	Unmarshalls a resource from the response stream.
FhirRequestBuilder	withHeaders(Iterable<org.hl7.fhir.utilities.http.HTTPHeader> headers)
FhirRequestBuilder	withLogger(org.hl7.fhir.utilities.ToolingClientLogger 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

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(org.hl7.fhir.utilities.http.HTTPRequest httpRequest,
 String source)

Method Details

formatHeaders

protected static org.hl7.fhir.utilities.http.HTTPRequest formatHeaders(org.hl7.fhir.utilities.http.HTTPRequest request,
 String format,
 Iterable<org.hl7.fhir.utilities.http.HTTPHeader> headers)

Adds necessary default headers, formatting headers, and any passed in HTTPHeaders to the passed in HTTPRequest

Parameters:

request - HTTPRequest to add headers to.

format - Expected Resource format.

headers - Any additional HTTPHeaders to add to the request.

getResourceFormatHeaders

protected static Iterable<org.hl7.fhir.utilities.http.HTTPHeader> getResourceFormatHeaders(org.hl7.fhir.utilities.http.HTTPRequest httpRequest,
 String format)

Adds necessary headers for the given resource format provided.

Parameters:

httpRequest - HTTPRequest to add default headers to.

format - Expected Resource format.

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(Iterable<org.hl7.fhir.utilities.http.HTTPHeader> headers)

Extracts the 'location' header from the passed Iterable<org.hl7.fhir.utilities.http.HTTPHeader>. If no value for 'location' exists, the value for 'content-location' is returned. If neither header exists, we return null.

Parameters:

headers - HTTPHeader to evaluate

Returns:

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

getManagedWebAccessor

protected org.hl7.fhir.utilities.http.ManagedFhirWebAccessor getManagedWebAccessor()

withResourceFormat

public FhirRequestBuilder withResourceFormat(String resourceFormat)

withHeaders

public FhirRequestBuilder withHeaders(Iterable<org.hl7.fhir.utilities.http.HTTPHeader> headers)

withMessage

public FhirRequestBuilder withMessage(String message)

withRetryCount

public FhirRequestBuilder withRetryCount(int retryCount)

withLogger

public FhirRequestBuilder withLogger(org.hl7.fhir.utilities.ToolingClientLogger logger)

withTimeout

public FhirRequestBuilder withTimeout(long timeout,
 TimeUnit unit)

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(org.hl7.fhir.utilities.http.HTTPResult response,
 String format,
 String resourceType)

Unmarshalls a resource from the response stream.

unmarshalFeed

protected Bundle unmarshalFeed(org.hl7.fhir.utilities.http.HTTPResult 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