Package dev.voidframework.restclient.retrofit.interceptor

Class ApiKeyAuthenticationInterceptor

java.lang.Object

dev.voidframework.restclient.retrofit.interceptor.ApiKeyAuthenticationInterceptor

All Implemented Interfaces:

okhttp3.Interceptor

public final class ApiKeyAuthenticationInterceptor
extends Object
implements okhttp3.Interceptor

Provides API key authentication mechanism.

Since:

1.10.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ApiKeyAuthenticationInterceptor.AddTo	Available locations where to add API key.

Nested classes/interfaces inherited from interface okhttp3.Interceptor

okhttp3.Interceptor.Chain

Constructor Summary

Constructors

Constructor	Description
ApiKeyAuthenticationInterceptor(String key, String value, ApiKeyAuthenticationInterceptor.AddTo addTo)	Build a new instance.

Method Summary

Modifier and Type	Method	Description
okhttp3.Response	intercept(okhttp3.Interceptor.Chain chain)

Methods inherited from class java.lang.Object

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

Constructor Details

ApiKeyAuthenticationInterceptor

public ApiKeyAuthenticationInterceptor(String key,
 String value,
 ApiKeyAuthenticationInterceptor.AddTo addTo)

Build a new instance.

Parameters:

key - The API key variable name

value - The API key value

addTo - Where to add the API key (ie: HEADERS)

Since:

1.10.0

Method Details

intercept

public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain)
                           throws IOException

Specified by:

intercept in interface okhttp3.Interceptor

Throws:

IOException