com.microsoft.rest.interceptors

Class CustomHeadersInterceptor

java.lang.Object

com.microsoft.rest.interceptors.CustomHeadersInterceptor

All Implemented Interfaces:

okhttp3.Interceptor

public final class CustomHeadersInterceptor
extends Object
implements okhttp3.Interceptor

An instance of this class enables adding custom headers in client requests when added to the OkHttpClient interceptors.

Nested Class Summary

Nested classes/interfaces inherited from interface okhttp3.Interceptor

okhttp3.Interceptor.Chain

Constructor Summary

Constructors

Constructor and Description
CustomHeadersInterceptor() Initialize an instance of CustomHeadersInterceptor class.
CustomHeadersInterceptor(String key, String value) Initialize an instance of CustomHeadersInterceptor class.

Method Summary

Modifier and Type	Method and Description
CustomHeadersInterceptor	addHeader(String name, String value) Add a single header key-value pair.
CustomHeadersInterceptor	addHeaderMap(Map<String,String> headers) Add all headers in a header map.
CustomHeadersInterceptor	addHeaderMultimap(Map<String,List<String>> headers) Add all headers in a header multimap.
CustomHeadersInterceptor	addHeaders(okhttp3.Headers headers) Add all headers in a Headers object.
Map<String,List<String>>	headers()
okhttp3.Response	intercept(okhttp3.Interceptor.Chain chain)
CustomHeadersInterceptor	removeHeader(String name) Remove a header.
CustomHeadersInterceptor	replaceHeader(String name, String value) Add a single header key-value pair.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomHeadersInterceptor

public CustomHeadersInterceptor()

Initialize an instance of CustomHeadersInterceptor class.

CustomHeadersInterceptor

public CustomHeadersInterceptor(String key,
                                String value)

Initialize an instance of CustomHeadersInterceptor class.

Parameters:

key - the key for the header

value - the value of the header

Method Detail

headers

public Map<String,List<String>> headers()

Returns:

the currently stored custom headers

replaceHeader

public CustomHeadersInterceptor replaceHeader(String name,
                                              String value)

Add a single header key-value pair. If one with the name already exists, it gets replaced.

Parameters:

name - the name of the header.

value - the value of the header.

Returns:

the interceptor instance itself.

addHeader

public CustomHeadersInterceptor addHeader(String name,
                                          String value)

Add a single header key-value pair. If one with the name already exists, both stay in the header map.

Parameters:

name - the name of the header.

value - the value of the header.

Returns:

the interceptor instance itself.

addHeaders

public CustomHeadersInterceptor addHeaders(okhttp3.Headers headers)

Add all headers in a Headers object.

Parameters:

headers - an OkHttp Headers object.

Returns:

the interceptor instance itself.

addHeaderMap

public CustomHeadersInterceptor addHeaderMap(Map<String,String> headers)

Add all headers in a header map.

Parameters:

headers - a map of headers.

Returns:

the interceptor instance itself.

addHeaderMultimap

public CustomHeadersInterceptor addHeaderMultimap(Map<String,List<String>> headers)

Add all headers in a header multimap.

Parameters:

headers - a multimap of headers.

Returns:

the interceptor instance itself.

removeHeader

public CustomHeadersInterceptor removeHeader(String name)

Remove a header.

Parameters:

name - the name of the header to remove.

Returns:

the interceptor instance itself.

intercept

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

Specified by:

intercept in interface okhttp3.Interceptor

Throws:

IOException