Package ca.uhn.fhir.rest.client.interceptor

Class AdditionalRequestHeadersInterceptor

java.lang.Object

ca.uhn.fhir.rest.client.interceptor.AdditionalRequestHeadersInterceptor

public class AdditionalRequestHeadersInterceptor
extends Object

This interceptor adds arbitrary header values to requests made by the client. This is now also possible directly on the Fluent Client API by calling IClientExecutable.withAdditionalHeader(String, String)

Constructor Summary

Constructors

Constructor	Description
AdditionalRequestHeadersInterceptor()	Constructor
AdditionalRequestHeadersInterceptor(Map<String,List<String>> theHeaders)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addAllHeaderValues(String headerName, List<String> headerValues)	Adds the list of header values for the given header.
void	addHeaderValue(String headerName, String headerValue)	Adds the given header value.
void	interceptRequest(ca.uhn.fhir.rest.client.api.IHttpRequest theRequest)	Adds the additional header values to the HTTP request.

Methods inherited from class java.lang.Object

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

Constructor Details

AdditionalRequestHeadersInterceptor

public AdditionalRequestHeadersInterceptor()

Constructor

AdditionalRequestHeadersInterceptor

public AdditionalRequestHeadersInterceptor(Map<String,List<String>> theHeaders)

Constructor

Parameters:

theHeaders - The additional headers to add to every request

Method Details

addHeaderValue

public void addHeaderValue(String headerName,
 String headerValue)

Adds the given header value. Note that headerName and headerValue cannot be null.

Parameters:

headerName - the name of the header

headerValue - the value to add for the header

Throws:

NullPointerException - if either parameter is null

addAllHeaderValues

public void addAllHeaderValues(String headerName,
 List<String> headerValues)

Adds the list of header values for the given header. Note that headerName and headerValues cannot be null.

Parameters:

headerName - the name of the header

headerValues - the list of values to add for the header

Throws:

NullPointerException - if either parameter is null

interceptRequest

public void interceptRequest(ca.uhn.fhir.rest.client.api.IHttpRequest theRequest)

Adds the additional header values to the HTTP request.

Parameters:

theRequest - the HTTP request