com.contentful.java.cma.interceptor

Class UserAgentHeaderInterceptor

java.lang.Object

com.contentful.java.cma.interceptor.UserAgentHeaderInterceptor

All Implemented Interfaces:

okhttp3.Interceptor

public class UserAgentHeaderInterceptor
extends Object
implements okhttp3.Interceptor

Interceptor to add user agent header to requests

Nested Class Summary

Nested classes/interfaces inherited from interface okhttp3.Interceptor

okhttp3.Interceptor.Chain

Field Summary

Fields

Modifier and Type	Field and Description
static String	HEADER_NAME

Constructor Summary

Constructors

Constructor and Description
UserAgentHeaderInterceptor(String userAgent) Create Header interceptor, saving parameters.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_NAME

public static final String HEADER_NAME

See Also:

Constant Field Values

Constructor Detail

UserAgentHeaderInterceptor

public UserAgentHeaderInterceptor(String userAgent)

Create Header interceptor, saving parameters.

Parameters:

userAgent - user agent header to be send with _every_ request.

Method Detail

intercept

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

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

Specified by:

intercept in interface okhttp3.Interceptor

Parameters:

chain - the execution chain for the request.

Returns:

the response received

Throws:

IOException - if there was an error.