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

Class ClientHeaders

java.lang.Object

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

public class ClientHeaders
extends Object

Generic Implementation of Client Headers. Stores a list of headers for HTTP calls to the TX server. Users can implement their own instance if they desire specific, custom behavior.

Constructor Summary

Constructors

Constructor	Description
ClientHeaders()
ClientHeaders(List<org.hl7.fhir.utilities.http.HTTPHeader> headers)

Method Summary

Modifier and Type	Method	Description
ClientHeaders	addHeader(org.hl7.fhir.utilities.http.HTTPHeader header)	Add a header to the list of stored headers for network operations.
ClientHeaders	addHeaders(List<org.hl7.fhir.utilities.http.HTTPHeader> headerList)	Add a header to the list of stored headers for network operations.
ClientHeaders	clearHeaders()	Clears all stored HTTPHeader.
List<org.hl7.fhir.utilities.http.HTTPHeader>	headers()
ClientHeaders	removeHeader(org.hl7.fhir.utilities.http.HTTPHeader header)	Removes the passed in header from the list of stored headers.
ClientHeaders	removeHeaders(List<org.hl7.fhir.utilities.http.HTTPHeader> headerList)	Removes the passed in headers from the list of stored headers.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ClientHeaders

public ClientHeaders()

ClientHeaders

public ClientHeaders(List<org.hl7.fhir.utilities.http.HTTPHeader> headers)

Method Details

headers

public List<org.hl7.fhir.utilities.http.HTTPHeader> headers()

addHeader

public ClientHeaders addHeader(org.hl7.fhir.utilities.http.HTTPHeader header)
                        throws org.hl7.fhir.exceptions.FHIRException

Add a header to the list of stored headers for network operations.

Parameters:

header - HTTPHeader to add to the list.

Throws:

org.hl7.fhir.exceptions.FHIRException - if the header being added is a duplicate.

addHeaders

public ClientHeaders addHeaders(List<org.hl7.fhir.utilities.http.HTTPHeader> headerList)
                         throws org.hl7.fhir.exceptions.FHIRException

Add a header to the list of stored headers for network operations.

Parameters:

headerList - List of HTTPHeader to add.

Throws:

org.hl7.fhir.exceptions.FHIRException - if any of the headers being added is a duplicate.

removeHeader

public ClientHeaders removeHeader(org.hl7.fhir.utilities.http.HTTPHeader header)
                           throws org.hl7.fhir.exceptions.FHIRException

Removes the passed in header from the list of stored headers.

Parameters:

header - HTTPHeader to remove from the list.

Throws:

org.hl7.fhir.exceptions.FHIRException - if the header passed in does not exist within the stored list.

removeHeaders

public ClientHeaders removeHeaders(List<org.hl7.fhir.utilities.http.HTTPHeader> headerList)
                            throws org.hl7.fhir.exceptions.FHIRException

Removes the passed in headers from the list of stored headers.

Parameters:

headerList - List of HTTPHeader to remove.

Throws:

org.hl7.fhir.exceptions.FHIRException - if any of the headers passed in does not exist within the stored list.

clearHeaders

public ClientHeaders clearHeaders()

Clears all stored HTTPHeader.

toString

public String toString()

Overrides:

toString in class Object