ca.uhn.fhir.rest.client.interceptor

Class BearerTokenAuthInterceptor

java.lang.Object

ca.uhn.fhir.rest.client.interceptor.BearerTokenAuthInterceptor

All Implemented Interfaces:

IClientInterceptor

public class BearerTokenAuthInterceptor
extends Object
implements IClientInterceptor

HTTP interceptor to be used for adding HTTP Authorization using "bearer tokens" to requests. Bearer tokens are used for protocols such as OAUTH2 (see the RFC 6750 specification on bearer token usage for more information).

This interceptor adds a header resembling the following:
Authorization: Bearer dsfu9sd90fwp34.erw0-reu
where the token portion (at the end of the header) is supplied by the invoking code.

See the HAPI Documentation for information on how to use this class.

Constructor Summary

Constructors

Constructor and Description
BearerTokenAuthInterceptor() Constructor.
BearerTokenAuthInterceptor(String theToken) Constructor

Method Summary

Modifier and Type	Method and Description
String	getToken() Returns the bearer token to use
void	interceptRequest(org.apache.http.client.methods.HttpRequestBase theRequest) Fired by the client just before invoking the HTTP client request
void	interceptResponse(org.apache.http.HttpResponse theResponse) Fired by the client upon receiving an HTTP response, prior to processing that response
void	setToken(String theToken) Sets the bearer token to use

Methods inherited from class java.lang.Object

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

Constructor Detail

BearerTokenAuthInterceptor

public BearerTokenAuthInterceptor()

Constructor. If this constructor is used, a token must be supplied later

BearerTokenAuthInterceptor

public BearerTokenAuthInterceptor(String theToken)

Constructor

Parameters:

theToken - The bearer token to use (must not be null)

Method Detail

getToken

public String getToken()

Returns the bearer token to use

interceptRequest

public void interceptRequest(org.apache.http.client.methods.HttpRequestBase theRequest)

Description copied from interface: IClientInterceptor

Fired by the client just before invoking the HTTP client request

Specified by:

interceptRequest in interface IClientInterceptor

interceptResponse

public void interceptResponse(org.apache.http.HttpResponse theResponse)

Description copied from interface: IClientInterceptor

Fired by the client upon receiving an HTTP response, prior to processing that response

Specified by:

interceptResponse in interface IClientInterceptor

setToken

public void setToken(String theToken)

Sets the bearer token to use