Package org.gnome.soup

Class CookieJar

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.soup.CookieJar

All Implemented Interfaces:

SessionFeature, Proxy

Direct Known Subclasses:

CookieJarDB, CookieJarText

@Generated("io.github.jwharm.JavaGI")
public class CookieJar
extends GObject
implements SessionFeature

Automatic cookie handling for SoupSession.

A SoupCookieJar stores Cookies and arrange for them to be sent with the appropriate Messages. SoupCookieJar implements SessionFeature, so you can add a cookie jar to a session with Session.addFeature(org.gnome.soup.SessionFeature) or Session.addFeatureByType(org.gnome.glib.Type).

Note that the base SoupCookieJar class does not support any form of long-term cookie persistence.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CookieJar.Builder<B extends CookieJar.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	CookieJar.ChangedCallback	Functional interface declaration of the ChangedCallback callback.
static class	CookieJar.CookieJarClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.soup.SessionFeature

SessionFeature.SessionFeature$Impl, SessionFeature.SessionFeatureInterface

Constructor Summary

Constructors

Constructor	Description
CookieJar()	Creates a new CookieJar.
CookieJar(MemorySegment address)	Create a CookieJar proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	addCookie(Cookie cookie)	Adds cookie to jar.
void	addCookieFull(Cookie cookie, @Nullable Uri uri, @Nullable Uri firstParty)	Adds cookie to jar.
void	addCookieWithFirstParty(Uri firstParty, Cookie cookie)	Adds cookie to jar.
SList<Cookie>	allCookies()	Constructs a GLib.List with every cookie inside the jar.
protected CookieJar	asParent()	Returns this instance as if it were its parent type.
static CookieJar.Builder<? extends CookieJar.Builder>	builder()	A CookieJar.Builder object constructs a CookieJar with the specified properties.
protected void	changed(Cookie oldCookie, Cookie newCookie)
void	deleteCookie(Cookie cookie)	Deletes cookie from jar.
void	emitChanged(@Nullable Cookie oldCookie, @Nullable Cookie newCookie)	Emits the "changed" signal.
CookieJarAcceptPolicy	getAcceptPolicy()	Gets jar's CookieJarAcceptPolicy.
SList<Cookie>	getCookieList(Uri uri, boolean forHttp)	Retrieves the list of cookies that would be sent with a request to uri as a GLib.List of SoupCookie objects.
SList<Cookie>	getCookieListWithSameSiteInfo(Uri uri, @Nullable Uri topLevel, @Nullable Uri siteForCookies, boolean forHttp, boolean isSafeMethod, boolean isTopLevelNavigation)	This is an extended version of getCookieList(org.gnome.glib.Uri, boolean) that provides more information required to use SameSite cookies.
@Nullable String	getCookies(Uri uri, boolean forHttp)	Retrieves (in Cookie-header form) the list of cookies that would be sent with a request to uri.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the CookieJar class
boolean	isPersistent()	Gets whether this CookieJar stores cookies persistenly.
SignalConnection<CookieJar.ChangedCallback>	onChanged(CookieJar.ChangedCallback handler)	Emitted when jar changes.
protected void	save()
void	setAcceptPolicy(CookieJarAcceptPolicy policy)	Sets policy as the cookie acceptance policy for jar.
void	setCookie(Uri uri, String cookie)	Adds cookie to jar, exactly as though it had appeared in a Set-Cookie header returned from a request to uri.
void	setCookieWithFirstParty(Uri uri, Uri firstParty, String cookie)	Adds cookie to jar, exactly as though it had appeared in a Set-Cookie header returned from a request to uri.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

CookieJar

public CookieJar(MemorySegment address)

Create a CookieJar proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

CookieJar

public CookieJar()

Creates a new CookieJar.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the CookieJar class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected CookieJar asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

addCookie

public void addCookie(Cookie cookie)

Adds cookie to jar.

Emits the CookieJar::changed signal if we are modifying an existing cookie or adding a valid new cookie ('valid' means that the cookie's expire date is not in the past).

cookie will be 'stolen' by the jar, so don't free it afterwards.

Parameters:

cookie - a SoupCookie

addCookieFull

public void addCookieFull(Cookie cookie,
 @Nullable Uri uri,
 @Nullable Uri firstParty)

Adds cookie to jar.

Emits the CookieJar::changed signal if we are modifying an existing cookie or adding a valid new cookie ('valid' means that the cookie's expire date is not in the past).

firstParty will be used to reject cookies coming from third party resources in case such a security policy is set in the jar.

uri will be used to reject setting or overwriting secure cookies from insecure origins. null is treated as secure.

cookie will be 'stolen' by the jar, so don't free it afterwards.

Parameters:

cookie - a SoupCookie

uri - the URI setting the cookie

firstParty - the URI for the main document

addCookieWithFirstParty

public void addCookieWithFirstParty(Uri firstParty,
 Cookie cookie)

Adds cookie to jar.

Emits the CookieJar::changed signal if we are modifying an existing cookie or adding a valid new cookie ('valid' means that the cookie's expire date is not in the past).

firstParty will be used to reject cookies coming from third party resources in case such a security policy is set in the jar.

cookie will be 'stolen' by the jar, so don't free it afterwards.

For secure cookies to work properly you may want to use addCookieFull(org.gnome.soup.Cookie, org.gnome.glib.Uri, org.gnome.glib.Uri).

Parameters:

firstParty - the URI for the main document

cookie - a SoupCookie

allCookies

public SList<Cookie> allCookies()

Constructs a GLib.List with every cookie inside the jar.

The cookies in the list are a copy of the original, so you have to free them when you are done with them.

For historical reasons this list is in reverse order.

Returns:

a GSList with all the cookies in the jar.

deleteCookie

public void deleteCookie(Cookie cookie)

Deletes cookie from jar.

Emits the CookieJar::changed signal.

Parameters:

cookie - a SoupCookie

getAcceptPolicy

public CookieJarAcceptPolicy getAcceptPolicy()

Gets jar's CookieJarAcceptPolicy.

Returns:

the SoupCookieJarAcceptPolicy set in the this CookieJar

getCookieList

public SList<Cookie> getCookieList(Uri uri,
 boolean forHttp)

Retrieves the list of cookies that would be sent with a request to uri as a GLib.List of SoupCookie objects.

If forHttp is true, the return value will include cookies marked "HttpOnly" (that is, cookies that the server wishes to keep hidden from client-side scripting operations such as the JavaScript document.cookies property). Since SoupCookieJar sets the Cookie header itself when making the actual HTTP request, you should almost certainly be setting forHttp to false if you are calling this.

Parameters:

uri - a GUri

forHttp - whether or not the return value is being passed directly to an HTTP operation

Returns:

a GSList with the cookies in the this CookieJar that would be sent with a request to uri.

getCookieListWithSameSiteInfo

public SList<Cookie> getCookieListWithSameSiteInfo(Uri uri,
 @Nullable Uri topLevel,
 @Nullable Uri siteForCookies,
 boolean forHttp,
 boolean isSafeMethod,
 boolean isTopLevelNavigation)

This is an extended version of getCookieList(org.gnome.glib.Uri, boolean) that provides more information required to use SameSite cookies.

See the SameSite cookies spec for more detailed information.

Parameters:

uri - a GUri

topLevel - a GUri for the top level document

siteForCookies - a GUri indicating the origin to get cookies for

forHttp - whether or not the return value is being passed directly to an HTTP operation

isSafeMethod - if the HTTP method is safe, as defined by RFC 7231, ignored when forHttp is false

isTopLevelNavigation - whether or not the HTTP request is part of top level navigation

Returns:

a GSList with the cookies in the this CookieJar that would be sent with a request to uri.

getCookies

public @Nullable String getCookies(Uri uri,
 boolean forHttp)

Retrieves (in Cookie-header form) the list of cookies that would be sent with a request to uri.

If forHttp is true, the return value will include cookies marked "HttpOnly" (that is, cookies that the server wishes to keep hidden from client-side scripting operations such as the JavaScript document.cookies property). Since SoupCookieJar sets the Cookie header itself when making the actual HTTP request, you should almost certainly be setting forHttp to false if you are calling this.

Parameters:

uri - a GUri

forHttp - whether or not the return value is being passed directly to an HTTP operation

Returns:

the cookies, in string form, or null if there are no cookies for uri.

isPersistent

public boolean isPersistent()

Gets whether this CookieJar stores cookies persistenly.

Returns:

true if this CookieJar storage is persistent or false otherwise.

setAcceptPolicy

public void setAcceptPolicy(CookieJarAcceptPolicy policy)

Sets policy as the cookie acceptance policy for jar.

Parameters:

policy - a SoupCookieJarAcceptPolicy

setCookie

public void setCookie(Uri uri,
 String cookie)

Adds cookie to jar, exactly as though it had appeared in a Set-Cookie header returned from a request to uri.

Keep in mind that if the CookieJarAcceptPolicy set is either CookieJarAcceptPolicy.NO_THIRD_PARTY or CookieJarAcceptPolicy.GRANDFATHERED_THIRD_PARTY you'll need to use setCookieWithFirstParty(org.gnome.glib.Uri, org.gnome.glib.Uri, java.lang.String), otherwise the jar will have no way of knowing if the cookie is being set by a third party or not.

Parameters:

uri - the URI setting the cookie

cookie - the stringified cookie to set

setCookieWithFirstParty

public void setCookieWithFirstParty(Uri uri,
 Uri firstParty,
 String cookie)

Adds cookie to jar, exactly as though it had appeared in a Set-Cookie header returned from a request to uri.

firstParty will be used to reject cookies coming from third party resources in case such a security policy is set in the jar.

Parameters:

uri - the URI setting the cookie

firstParty - the URI for the main document

cookie - the stringified cookie to set

changed

protected void changed(Cookie oldCookie,
 Cookie newCookie)

save

protected void save()

onChanged

public SignalConnection<CookieJar.ChangedCallback> onChanged(CookieJar.ChangedCallback handler)

Emitted when jar changes.

If a cookie has been added, newCookie will contain the newly-added cookie and oldCookie will be null. If a cookie has been deleted, oldCookie will contain the to-be-deleted cookie and newCookie will be null. If a cookie has been changed, oldCookie will contain its old value, and newCookie its new value.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• CookieJar.ChangedCallback.run(org.gnome.soup.Cookie, org.gnome.soup.Cookie)

emitChanged

public void emitChanged(@Nullable Cookie oldCookie,
 @Nullable Cookie newCookie)

Emits the "changed" signal. See onChanged(org.gnome.soup.CookieJar.ChangedCallback).

builder

public static CookieJar.Builder<? extends CookieJar.Builder> builder()

A CookieJar.Builder object constructs a CookieJar with the specified properties. Use the various set...() methods to set properties, and finish construction with CookieJar.Builder.build().

Returns:

the builder object