Add cookie to client request OkHttp

Question

So i started using Okhttp 3 and most of the examples on the web talk about older versions

I need to add a cookie to the OkHttp client requests, how is it done with OkHttp 3?

In my case i simply want to statically add it to client calls without receiving it from the server

You need to be more precise on what you're trying to do. Maybe some code? — Tudor Luca, Mar 02 '16 at 09:41
@TudorLuca I need to send http (get post put) while attaching cookie to the request. in Java for example its done like this: URL url = new URL("http://www.google.com:80"); URLConnection conn = url.openConnection(); conn.setRequestProperty("Cookie", "name1=value1; name2=value2"); conn.connect(); — Michael A, Mar 02 '16 at 09:45

score 39 · Accepted Answer · edited Jul 22 '21 at 20:06

39

There are 2 ways you can do this:

OkHttpClient client = new OkHttpClient().newBuilder()
    .cookieJar(new CookieJar() {
        @Override
        public void saveFromResponse(HttpUrl url, List<Cookie> cookies) {
        }

        @Override
        public List<Cookie> loadForRequest(HttpUrl url) {
            Arrays.asList(createNonPersistentCookie());
        }
    })
    .build();

// ...
    
public static Cookie createNonPersistentCookie() {
    return new Cookie.Builder()
        .domain("publicobject.com")
        .path("/")
        .name("cookie-name")
        .value("cookie-value")
        .httpOnly()
        .secure()
        .build();
}

or simply

OkHttpClient client = new OkHttpClient().newBuilder()
    .addInterceptor(chain -> {
        final Request original = chain.request();
        final Request authorized = original.newBuilder()
            .addHeader("Cookie", "cookie-name=cookie-value")
            .build();
        return chain.proceed(authorized);
    })
    .build();

I have a feeling that the second suggestion is what you need.

You can find here a working example.

edited Jul 22 '21 at 20:06

blacktide

10,654
8
33
53

answered Mar 02 '16 at 09:52

Tudor Luca

6,259
2
29
44

thanks for the help, can you tell me how to construct a okhttp3.Cookie? – Michael A Mar 02 '16 at 09:57
Thanks! do you have an example for using the Cookie builder? also, if i want to set cookie on the domain level and not a specific full url? – Michael A Mar 02 '16 at 10:22
@MichaelA the second solution, with the interceptor, will work regardless of your url. – Tudor Luca Mar 02 '16 at 12:39
1

Double brace initialization is a bad idea for stack overflow code samples! No reason to show clever code when you can show simple code. – Jesse Wilson Mar 02 '16 at 13:33
How can I log the cookie for testing purposes @TudorLuca – TheLearner Aug 25 '17 at 19:05
line 9: `Arrays.asList(createNonPersistentCookie());` needs a return statement in method `loadForRequest` – ATutorMe Oct 21 '21 at 02:18

score 16 · Answer 2 · answered Mar 02 '16 at 10:22

16

If you need to set a cookie for a single request you can just add the header:

Request request = new Request.Builder()
        .addHeader("Cookie", "yourcookie")
        .url("http://yoursite.com")
        .build();

Otherwise, if you want to read cookies returned by the server and attach them to other requests you will need a CookieJar. For Android you can use the PersistentCookieJar library which handles cookies properly and also saves them in the shared preferences:

ClearableCookieJar cookieJar = new PersistentCookieJar(new SetCookieCache(), new SharedPrefsCookiePersistor(context));

OkHttpClient okHttpClient = new OkHttpClient.Builder()
                .cookieJar(cookieJar)
                .build();

answered Mar 02 '16 at 10:22

rciovati

27,603
6
82
101

Tried setting the header but it dont seem to work, on the server side no cookie is received – Michael A Mar 02 '16 at 10:29
2

Try using addHeader("Cookie", "key=value") ? – Jesse Wilson Mar 02 '16 at 13:31
Just tested it and it doesn't work, the server doesn't receive the cookie – furiel Jul 29 '16 at 19:31
@furiel this is the correct method, your problem should be somewhere else. :) – rciovati Jul 29 '16 at 22:19
@RiccardoCiovati I use this block with PersistentCookieJar but I can not add to Header or different interceptor to. When I add just PCJ its ok but when added new interceptor for headers (Accept, Envoirement etc) CookieJar not working. do you have any suggestion? – Kaloglu Oct 26 '16 at 11:16
1

@Kaloglu I don't, sorry. Perhaps it'd be better to post your own question with a code example so that people could reproduce your problem. – rciovati Oct 26 '16 at 14:03
How can I log the cookie for testing purposes? @rciovati – TheLearner Aug 25 '17 at 19:04
it works. try .addHeader("Cookie", "cookie-name=cookie-value") – ChaturaM Mar 27 '19 at 06:15

score 7 · Answer 3 · answered Mar 25 '17 at 09:58

I had the same needs, I made my own library. You can force set cookies like this with OkHttp3CookieHelper on https://github.com/riversun/okhttp3-cookie-helper .

    String url = "https://example.com/webapi";

    OkHttp3CookieHelper cookieHelper = new OkHttp3CookieHelper();
    cookieHelper.setCookie(url, "cookie_name", "cookie_value");

    OkHttpClient client = new OkHttpClient.Builder()
            .cookieJar(cookieHelper.cookieJar())
            .build();

    Request request = new Request.Builder()
            .url(url)
            .build();

Gradle

compile 'org.riversun:okhttp3-cookie-helper:1.0.0'

Maven

<dependency>
<groupId>org.riversun</groupId>
<artifactId>okhttp3-cookie-helper</artifactId>
<version>1.0.0</version>
</dependency>

how to add this cookie to .addHeader() – JASIM CHOUHAN May 05 '21 at 07:21 — JASIM CHOUHAN, May 05 '21 at 07:21

score 0 · Answer 4 · answered Feb 03 '17 at 08:21

I think a better way to do this is by adding the cookie to the cookieJar. OkHttp will then automatically add the cookies to the request with an interceptor: https://github.com/square/okhttp/blob/master/okhttp/src/main/java/okhttp3/internal/http/BridgeInterceptor.java

cookieManager = new CookieManager();
cookieManager.setCookiePolicy(CookiePolicy.ACCEPT_ALL);
JavaNetCookieJar cookieJar = new JavaNetCookieJar(cookieManager);
// add cookies to cookiejar
cookieJar.saveFromResponse("Cookie", listOfCookiesToAdd);

OkHttpClient.Builder builder = new OkHttpClient.Builder();
builder.cookieJar(cookieJar)

I didn't actually try this code, but it should work.

Add cookie to client request OkHttp

4 Answers4

Linked