Skip to main content

How to create an OkHttp interceptor and why do you need one?

An http interceptor can become handy if you need to log all your requests or add a bearer token to every request when calling a protected resource with an access token in OAuth 2.0.

To create an interceptor you basically need to create an OkHttpClient by calling the OkHttpClient Builder and add an interceptor to it.
OkHttpClient okHttpClient = new OkHttpClient.Builder()

You can have access to the current request by calling chain.request(). Once you get the request you can then add or build on top of it by adding an additional header to send your Bearer Token.
Request auth_request = chain.request()

The last step is to return a Response object by calling chain.proceed, passing the new request.
return chain.proceed(auth_request);

And the final code:
OkHttpClient okHttpClient = new OkHttpClient.Builder()
    .addInterceptor(new Interceptor() {
        @Override
        public Response intercept(Chain chain) throws IOException {
            Request auth_request = chain.request()
                    .newBuilder()
                    .addHeader("Authorization", "Bearer " + YOUR_ACCESS_TOKEN)
                    .build();
            return chain.proceed(auth_request);
        }
    }).build();

Retrofit
If you have been using Retrofit as a wrapper on top of OkHttp to make http requests you can easily add your new interceptor to it by calling the client method of the Retrofit Builder like this:
return new Retrofit.Builder()
    .baseUrl(YOUR_BASE_URL)
    .client(okHttpClient)
    .addConverterFactory(GsonConverterFactory.create())
    .build()
    .create(YOUR_RETROFIT_INTERFACE.class);

So now every time you call your Retrofit interface method to make an http request, OkHttp will intercept your call and add a bearer token to your request header.

Comments

Popular posts from this blog

Understanding RabbitMQ

Introduction RabbitMQ is a centralized message broker based on the AMQP (Advanced Message Queuing Protocol) protocol, acting as a Middleware between Producers and Consumers of different systems. In a message system, Publishers sends a message to a message broker where messages are consumed some time later by one or more Subscribers. By introducing a message brokeer between systems we are decoupling the sender application from the receiver. In this case the service that is responsible for sending or publishing the message does not need to know about any other service. All it needs to care about is the message and its format. With a message system you send a message to a message broker first and when the consumers or listeners of it become online they can start consuming from the message queue. This means you can keep sending messages without even care if the other application is online or if they had any failures. RabbitMQ Architecture Exchange, queue and bindings are the ...

A Retrospective board to call your own made with React, GraphQL and MongoDB

Introduction I have been working in a project to enable anyone to fork and run a retrospective board in its own server. I have created 2 (two) projects: one for the UI with React and GraphQL using Apollo client and one for the GraphQL server also using Apollo (Server) and MongoDB for the database. In the following sections I am going to walk you through the steps and explain how to run both projects. Main features The board main features: - History of your past iteractions saved in the Mongo database - Easy url link format to quick access any past iteractions - Automatically add action items as last action items in the new board - Quick move items to Action Items Coming next You can fork the React UI from the following GitHub repo: - Support for multiple teams - Authentication - Subscriptions (pub/sub) Code Repo You can fork the React UI from the following GitHub repo: React Retrospective UI You can fork the GraphQL Server from the following GitHub rep...

Simple, quick and easy steps to run an Oracle Database in your development environment using Docker without overloading your machine

Introduction In our development environment, besides being easy and fast to use, above all, we need a lightweight version of it to run locally, right? I have tested different Oracle images and this was the option that best work for me. In this post i will show you how you can run the Oracle Database Express Edition version on your local machine quickly and easily and also how to connect to it using Oracle SQL Developer IDE and SQL*Plus. How to do it Basically we just need two simple steps to get our Oracle database running on our local environment. First we need to login to the Oracle Container Registry so we can pull the image from it and then we just need to run it in a container. You can find more information by going to the Oracle Container Registry , under the "Browse Containers", click into Database and next click in the express Repository for the Oracle Database Express Edition. I am going to skip the docker pull step, because docker run will do it for us ...