com.contentful.java.cma.interceptor

Class HeaderInterceptor

java.lang.Object

com.contentful.java.cma.interceptor.HeaderInterceptor

All Implemented Interfaces:

okhttp3.Interceptor

Direct Known Subclasses:

AuthorizationHeaderInterceptor, ContentfulUserAgentHeaderInterceptor, UserAgentHeaderInterceptor

public class HeaderInterceptor
extends Object
implements okhttp3.Interceptor

This class adds custom headers to all requests it intercepts.

Nested Class Summary

Nested classes/interfaces inherited from interface okhttp3.Interceptor

okhttp3.Interceptor.Chain, okhttp3.Interceptor.Companion

Field Summary

Fields inherited from interface okhttp3.Interceptor

Companion

Constructor Summary

Constructors

Constructor and Description
HeaderInterceptor(String name, String value) Create an arbitrary header adding interceptor.

Method Summary

Modifier and Type	Method and Description
String	getName()
String	getValue()
okhttp3.Response	intercept(okhttp3.Interceptor.Chain chain) Method called by framework, to enrich current request chain with requested header information.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderInterceptor

public HeaderInterceptor(String name,
                         String value)

Create an arbitrary header adding interceptor.

Parameters:

name - of the header to be used.

value - value of the new header.

Method Detail

intercept

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

Method called by framework, to enrich current request chain with requested header information.

Specified by:

intercept in interface okhttp3.Interceptor

Parameters:

chain - the execution chain for the request.

Returns:

the response received.

Throws:

IOException - in case of failure down the line.

getName

public String getName()

Returns:

the name of this header.

getValue

public String getValue()

Returns:

the value of this header.