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 Details

  • Method Details

    • headers

      public ArrayList<okhttp3.internal.http2.Header> headers()
    • addHeader

      public ClientHeaders addHeader(okhttp3.internal.http2.Header header) throws org.hl7.fhir.exceptions.FHIRException
      Add a header to the list of stored headers for network operations.
      Parameters:
      header - Header to add to the list.
      Throws:
      org.hl7.fhir.exceptions.FHIRException - if the header being added is a duplicate.
    • addHeaders

      public ClientHeaders addHeaders(List<okhttp3.internal.http2.Header> headerList) throws org.hl7.fhir.exceptions.FHIRException
      Add a header to the list of stored headers for network operations.
      Parameters:
      headerList - List of Header to add.
      Throws:
      org.hl7.fhir.exceptions.FHIRException - if any of the headers being added is a duplicate.
    • removeHeader

      public ClientHeaders removeHeader(okhttp3.internal.http2.Header header) throws org.hl7.fhir.exceptions.FHIRException
      Removes the passed in header from the list of stored headers.
      Parameters:
      header - Header 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<okhttp3.internal.http2.Header> headerList) throws org.hl7.fhir.exceptions.FHIRException
      Removes the passed in headers from the list of stored headers.
      Parameters:
      headerList - List of Header to remove.
      Throws:
      org.hl7.fhir.exceptions.FHIRException - if any of the headers passed in does not exist within the stored list.
    • clearHeaders

      Clears all stored Header.
    • toString

      public String toString()
      Overrides:
      toString in class Object