ca.uhn.fhir.rest.client.interceptor

Class SimpleRequestHeaderInterceptor

java.lang.Object

ca.uhn.fhir.rest.client.interceptor.SimpleRequestHeaderInterceptor

All Implemented Interfaces:

IClientInterceptor

public class SimpleRequestHeaderInterceptor
extends Object
implements IClientInterceptor

This interceptor adds an arbitrary header to requests made by this client. Both the header name and the header value are specified by the calling code.

See Also:

for a more advanced version of this interceptor which can add multiple headers

Constructor Summary

Constructors

Constructor and Description
SimpleRequestHeaderInterceptor() Constructor
SimpleRequestHeaderInterceptor(String theCompleteHeader) Constructor which takes a complete header including name and value
SimpleRequestHeaderInterceptor(String theHeaderName, String theHeaderValue) Constructor

Method Summary

Modifier and Type	Method and Description
String	getHeaderName()
String	getHeaderValue()
void	interceptRequest(IHttpRequest theRequest)
void	interceptResponse(IHttpResponse theResponse)
void	setHeaderName(String theHeaderName)
void	setHeaderValue(String theHeaderValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleRequestHeaderInterceptor

public SimpleRequestHeaderInterceptor()

Constructor

SimpleRequestHeaderInterceptor

public SimpleRequestHeaderInterceptor(String theHeaderName,
                                      String theHeaderValue)

Constructor

Parameters:

theHeaderName - The header name, e.g. "Authorization"

theHeaderValue - The header value, e.g. "Bearer 09uer90uw9yh"

SimpleRequestHeaderInterceptor

public SimpleRequestHeaderInterceptor(String theCompleteHeader)

Constructor which takes a complete header including name and value

Parameters:

theCompleteHeader - The complete header, e.g. "Authorization: Bearer af09ufe90efh". Must not be null or empty.

Method Detail

getHeaderName

public String getHeaderName()

getHeaderValue

public String getHeaderValue()

interceptRequest

public void interceptRequest(IHttpRequest theRequest)

Specified by:

interceptRequest in interface IClientInterceptor

interceptResponse

public void interceptResponse(IHttpResponse theResponse)
                       throws IOException

Specified by:

interceptResponse in interface IClientInterceptor

Throws:

IOException

setHeaderName

public void setHeaderName(String theHeaderName)

setHeaderValue

public void setHeaderValue(String theHeaderValue)