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

Class AdditionalRequestHeadersInterceptor

java.lang.Object

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

All Implemented Interfaces:

ca.uhn.fhir.rest.client.api.IClientInterceptor

public class AdditionalRequestHeadersInterceptor
extends Object
implements ca.uhn.fhir.rest.client.api.IClientInterceptor

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()
AdditionalRequestHeadersInterceptor(Map<String,List<String>> additionalHttpHeaders)

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.
void	interceptResponse(ca.uhn.fhir.rest.client.api.IHttpResponse theResponse)	Does nothing since this interceptor is not concerned with the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdditionalRequestHeadersInterceptor

public AdditionalRequestHeadersInterceptor()

AdditionalRequestHeadersInterceptor

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

Method Detail

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.

Specified by:

interceptRequest in interface ca.uhn.fhir.rest.client.api.IClientInterceptor

Parameters:

theRequest - the HTTP request

interceptResponse

public void interceptResponse(ca.uhn.fhir.rest.client.api.IHttpResponse theResponse)
                       throws IOException

Does nothing since this interceptor is not concerned with the response.

Specified by:

interceptResponse in interface ca.uhn.fhir.rest.client.api.IClientInterceptor

Parameters:

theResponse - the HTTP response

Throws:

IOException