com.enjin.sdk.http

Class SessionCookieJar

java.lang.Object

com.enjin.sdk.http.SessionCookieJar

All Implemented Interfaces:

okhttp3.CookieJar

public class SessionCookieJar
extends java.lang.Object
implements okhttp3.CookieJar

Stores the cookies used during a session. Used internally.

Nested Class Summary

Nested classes/interfaces inherited from interface okhttp3.CookieJar

okhttp3.CookieJar.Companion

Field Summary

Fields inherited from interface okhttp3.CookieJar

Companion, NO_COOKIES

Constructor Summary

Constructors

Constructor and Description
SessionCookieJar()

Method Summary

Modifier and Type	Method and Description
java.util.List<okhttp3.Cookie>	getCookies(@NonNull okhttp3.HttpUrl url) Returns the cookies for the provided URL.
java.util.List<okhttp3.Cookie>	getCookies(@NonNull java.lang.String url) Returns the cookies for the provided URL.
java.util.List<okhttp3.Cookie>	loadForRequest(okhttp3.HttpUrl url) Loads cookies from the jar for an HTTP request to the URL.
void	removeCookie(okhttp3.HttpUrl url, java.lang.String name) Removes a cookie with the provided name from the URL.
void	removeCookie(java.lang.String url, java.lang.String name) Removes a cookie with the provided name from the URL.
void	saveFromResponse(okhttp3.HttpUrl url, java.util.List<okhttp3.Cookie> cookies) Saves cookies from an HTTP response.
void	setCookie(@NonNull okhttp3.HttpUrl url, @NonNull okhttp3.Cookie cookie) Sets a cookie for the provided URL.
void	setCookie(@NonNull okhttp3.HttpUrl url, @NonNull java.lang.String name, @NonNull java.lang.String value) Sets a cookie with the provided name and value for the URL.
void	setCookie(@NonNull java.lang.String url, @NonNull okhttp3.Cookie cookie) Sets a cookie for the provided URL.
void	setCookie(@NonNull java.lang.String url, @NonNull java.lang.String name, @NonNull java.lang.String value) Sets a cookie with the provided name and value for the URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionCookieJar

public SessionCookieJar()

Method Detail

saveFromResponse

public void saveFromResponse(okhttp3.HttpUrl url,
                             java.util.List<okhttp3.Cookie> cookies)

Saves cookies from an HTTP response.

Specified by:

saveFromResponse in interface okhttp3.CookieJar

Parameters:

url - the URL

cookies - the cookies

loadForRequest

public java.util.List<okhttp3.Cookie> loadForRequest(okhttp3.HttpUrl url)

Loads cookies from the jar for an HTTP request to the URL.

Specified by:

loadForRequest in interface okhttp3.CookieJar

Parameters:

url - the URL

Returns:

the cookies

getCookies

public java.util.List<okhttp3.Cookie> getCookies(@NonNull
                                                 @NonNull java.lang.String url)

Returns the cookies for the provided URL.

Parameters:

url - the URL

Returns:

the cookies

getCookies

public java.util.List<okhttp3.Cookie> getCookies(@NonNull
                                                 @NonNull okhttp3.HttpUrl url)

Returns the cookies for the provided URL.

Parameters:

url - the url

Returns:

the cookies

Throws:

java.lang.NullPointerException - if URL is null

setCookie

public void setCookie(@NonNull
                      @NonNull java.lang.String url,
                      @NonNull
                      @NonNull okhttp3.Cookie cookie)

Sets a cookie for the provided URL.

Parameters:

url - the URL

cookie - the cookie

Throws:

java.lang.NullPointerException - if any parameters are null

setCookie

public void setCookie(@NonNull
                      @NonNull okhttp3.HttpUrl url,
                      @NonNull
                      @NonNull okhttp3.Cookie cookie)

Sets a cookie for the provided URL.

Parameters:

url - the URL

cookie - the cookie

Throws:

java.lang.NullPointerException - if any parameters are null

setCookie

public void setCookie(@NonNull
                      @NonNull java.lang.String url,
                      @NonNull
                      @NonNull java.lang.String name,
                      @NonNull
                      @NonNull java.lang.String value)

Sets a cookie with the provided name and value for the URL.

Parameters:

url - the URL

name - the cookie name

value - the cookie value

Throws:

java.lang.NullPointerException - if any parameters are null

setCookie

public void setCookie(@NonNull
                      @NonNull okhttp3.HttpUrl url,
                      @NonNull
                      @NonNull java.lang.String name,
                      @NonNull
                      @NonNull java.lang.String value)

Sets a cookie with the provided name and value for the URL.

Parameters:

url - the url

name - the cookie name

value - the cookie value

Throws:

java.lang.NullPointerException - if any parameters are null

removeCookie

public void removeCookie(java.lang.String url,
                         java.lang.String name)

Removes a cookie with the provided name from the URL.

Parameters:

url - the URL

name - the cookie name

removeCookie

public void removeCookie(okhttp3.HttpUrl url,
                         java.lang.String name)

Removes a cookie with the provided name from the URL.

Parameters:

url - the URL

name - the cookie name