How to add headers to OkHttp request interceptor

Question

I have this interceptor that i add to my OkHttp client   public class RequestTokenInterceptor implements Interceptor    Override public Response intercept Chain chain  throws IOException     Request request   chain request         Here where we ll try to refresh token       with an retrofit call      After we succeed we ll proceed our request   Response response   chain proceed request     return response        How can i add headers to request in my interceptor   I tried this but i am making mistake and i lose my request when creating new request       public class RequestTokenInterceptor implements Interceptor        Override     public Response intercept Interceptor Chain chain  throws IOException           Request request   chain request            Request newRequest           try               Log d  addHeader    Before                String token   TokenProvider getInstance mContext  getToken                newRequest   request newBuilder                        addHeader HeadersContract HEADER AUTHONRIZATION  O AUTH AUTHENTICATION   token                       addHeader HeadersContract HEADER CLIENT ID  CLIENT ID                       build              catch  Exception e                Log d  addHeader    Error                e printStackTrace                return chain proceed request                      Log d  addHeader    after            return chain proceed newRequest             Note that  i know i can add header when creating request like this   Request request   new Request Builder        url  https   api github com repos square okhttp issues        header  User-Agent    OkHttp Headers java        addHeader  Accept    application json  q 0 5        addHeader  Accept    application vnd github v3 json        build      But it doesn t fit my needs  I need it in interceptor

User · Answer

If you are using Retrofit library then you can directly pass header to api request using @Header annotation without use of Interceptor. Here is example that shows how to add header to Retrofit api request.

@POST(apiURL)
void methodName(
        @Header(HeadersContract.HEADER_AUTHONRIZATION) String token,
        @Header(HeadersContract.HEADER_CLIENT_ID) String token,
        @Body TypedInput body,
        Callback<String> callback);

Hope it helps!

User · Answer

here is a useful gist from lfmingo  OkHttpClient Builder httpClient   new OkHttpClient Builder     httpClient addInterceptor new Interceptor           Override     public Response intercept Interceptor Chain chain  throws IOException           Request original   chain request             Request request   original newBuilder                header  User-Agent    Your-App-Name                header  Accept    application vnd yourapi v1 full json                method original method    original body                 build             return chain proceed request            OkHttpClient client   httpClient build     Retrofit retrofit   new Retrofit Builder          baseUrl API BASE URL       addConverterFactory GsonConverterFactory create         client client       build

User · Answer

This worked for me  class JSONHeaderInterceptor   Interceptor       override fun intercept chain  Interceptor Chain    Response           val request   chain request   newBuilder                header  quot Content-Type quot    quot application json quot                build           return chain proceed request           fun provideHttpClient    OkHttpClient       val okHttpClientBuilder   OkHttpClient Builder       okHttpClientBuilder addInterceptor JSONHeaderInterceptor        return okHttpClientBuilder build

User · Answer

Finally  I added the headers this way    Override     public Response intercept Interceptor Chain chain  throws IOException           Request request   chain request            Request newRequest           newRequest   request newBuilder                    addHeader HeadersContract HEADER AUTHONRIZATION  O AUTH AUTHENTICATION                   addHeader HeadersContract HEADER X CLIENT ID  CLIENT ID                   build            return chain proceed newRequest

User · Answer

Faced similar issue with other samples  this Kotlin class worked for me  import okhttp3 Interceptor import okhttp3 Response  class CustomInterceptor   Interceptor       override fun intercept chain  Interceptor Chain    Response                          val request   chain request   newBuilder                header  x-custom-header    my-value                build           return chain proceed request

User · Answer

you can do it this way  private String GET String url  Map lt String  String gt  header  throws IOException           Headers headerbuild   Headers of header           Request request   new Request Builder   url url  headers headerbuild                           build             Response response   client newCall request  execute            return response body   string

User · Answer

Kotlin version  fun okHttpClientFactory    OkHttpClient       return OkHttpClient   newBuilder            addInterceptor   chain - gt              chain request   newBuilder                    addHeader HEADER AUTHONRIZATION  O AUTH AUTHENTICATION                   build                    let chain  proceed                     build

User · Answer

There is yet an another way to add interceptors in your OkHttp3  latest version as of now    that is you add the interceptors to your Okhttp builder  okhttpBuilder networkInterceptors   add chain - gt       todo add headers etc to your AuthorisedRequest    return chain proceed yourAuthorisedRequest         and finally build your okHttpClient from this builder  OkHttpClient client   builder build

User · Answer

client   new OkHttpClient             Request request   new Request Builder   header  authorization   token  url url  build            MyWebSocketListener wsListener   new MyWebSocketListener LudoRoomActivity this           client newWebSocket request  wsListener           client dispatcher   executorService   shutdown

User · Answer

package com example network interceptors   import androidx annotation NonNull   import java io IOException  import java util Map   import okhttp3 Interceptor  import okhttp3 Request  import okhttp3 Response   public class RequestHeadersNetworkInterceptor implements Interceptor        private final Map lt String  String gt  headers       public RequestHeadersNetworkInterceptor  NonNull Map lt String  String gt  headers            this headers   headers              NonNull      Override     public Response intercept Chain chain  throws IOException           Request Builder builder   chain request   newBuilder            for  Map Entry lt String  String gt  header   headers entrySet                  if  header getKey      null    header getKey   trim   isEmpty                      continue                            if  header getValue      null    header getValue   trim   isEmpty                      builder removeHeader header getKey                   else                   builder header header getKey    header getValue                                     return chain proceed builder build                Example of usage   httpClientBuilder networkInterceptors   add new RequestHeadersNetworkInterceptor new HashMap lt String  String gt                    put  User-Agent   getUserAgent             put  Accept    application json

[java] How to add headers to OkHttp request interceptor?

Examples related to java

Examples related to android

Examples related to http-headers

Examples related to retrofit

Examples related to okhttp