Package org.gnome.webkit

Class NetworkSession

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.webkit.NetworkSession

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public final class NetworkSession
extends GObject

Manages network configuration.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
NetworkSession(@Nullable String dataDirectory, @Nullable String cacheDirectory)	Creates a new WebKitNetworkSession with a persistent WebKitWebsiteDataManager.
NetworkSession(MemorySegment address)	Create a NetworkSession proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	allowTlsCertificateForHost(TlsCertificate certificate, String host)	Ignore further TLS errors on the host for the certificate present in info.
protected NetworkSession	asParent()	Returns this instance as if it were its parent type.
static NetworkSession.Builder<? extends NetworkSession.Builder>	builder()	A NetworkSession.Builder object constructs a NetworkSession with the specified properties.
Download	downloadUri(String uri)	Requests downloading of the specified URI string.
void	emitDownloadStarted(Download download)	Emits the "download-started" signal.
static NetworkSession	ephemeral()	Creates a new WebKitNetworkSession with an ephemeral WebKitWebsiteDataManager.
CookieManager	getCookieManager()	Get the WebKitCookieManager of this NetworkSession.
static NetworkSession	getDefault()	Get the default network session.
boolean	getItpEnabled()	Get whether Intelligent Tracking Prevention (ITP) is enabled or not.
void	getItpSummary(@Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously get the list of WebKitITPThirdParty seen for this NetworkSession.
List<ITPThirdParty>	getItpSummaryFinish(AsyncResult result)	Finish an asynchronous operation started with webkit_network_session_get_itp_summary().
boolean	getPersistentCredentialStorageEnabled()	Get whether persistent credential storage is enabled or not.
TLSErrorsPolicy	getTlsErrorsPolicy()	Get the TLS errors policy of this NetworkSession.
static Type	getType()	Get the GType of the NetworkSession class
WebsiteDataManager	getWebsiteDataManager()	Get the WebKitWebsiteDataManager of this NetworkSession.
boolean	isEphemeral()	Get whether this NetworkSession is ephemeral.
SignalConnection<NetworkSession.DownloadStartedCallback>	onDownloadStarted(NetworkSession.DownloadStartedCallback handler)	This signal is emitted when a new download request is made.
void	prefetchDns(String hostname)	Resolve the domain name of the given hostname in advance, so that if a URI of hostname is requested the load will be performed more quickly.
void	setItpEnabled(boolean enabled)	Enable or disable Intelligent Tracking Prevention (ITP).
static void	setMemoryPressureSettings(MemoryPressureSettings settings)	Sets settings as the WebKitMemoryPressureSettings.
void	setPersistentCredentialStorageEnabled(boolean enabled)	Enable or disable persistent credential storage.
void	setProxySettings(NetworkProxyMode proxyMode, @Nullable NetworkProxySettings proxySettings)	Set the network proxy settings to be used by connections started in this NetworkSession session.
void	setTlsErrorsPolicy(TLSErrorsPolicy policy)	Set the TLS errors policy of this NetworkSession as policy.

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, getMemoryLayout, 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, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

NetworkSession

public NetworkSession(MemorySegment address)

Create a NetworkSession proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

NetworkSession

public NetworkSession(@Nullable
 @Nullable String dataDirectory,
 @Nullable
 @Nullable String cacheDirectory)
               throws UnsupportedPlatformException

Creates a new WebKitNetworkSession with a persistent WebKitWebsiteDataManager. The parameters dataDirectory and cacheDirectory will be used as construct properties of the WebKitWebsiteDataManager of the network session. Note that if null is passed, the default directory will be passed to WebKitWebsiteDataManager so that webkit_website_data_manager_get_base_data_directory() and webkit_website_data_manager_get_base_cache_directory() always return a value for non ephemeral sessions.

It must be passed as construct parameter of a WebKitWebView.

Parameters:

dataDirectory - a base directory for data, or null

cacheDirectory - a base directory for caches, or null

Throws:

UnsupportedPlatformException - when run on a platform other than linux

Method Details

getType

public static Type getType()

Get the GType of the NetworkSession class

Returns:

the GType

asParent

protected NetworkSession 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

ephemeral

public static NetworkSession ephemeral()

Creates a new WebKitNetworkSession with an ephemeral WebKitWebsiteDataManager.

Returns:

a new ephemeral WebKitNetworkSession.

Throws:

UnsupportedPlatformException - when run on a platform other than linux

getDefault

public static NetworkSession getDefault()
                                 throws UnsupportedPlatformException

Get the default network session. The default network session is created using webkit_network_session_new() and passing null as data and cache directories.

Returns:

a WebKitNetworkSession

Throws:

UnsupportedPlatformException - when run on a platform other than linux

setMemoryPressureSettings

public static void setMemoryPressureSettings(MemoryPressureSettings settings)
                                      throws UnsupportedPlatformException

Sets settings as the WebKitMemoryPressureSettings.

Sets settings as the WebKitMemoryPressureSettings to be used by the network process created by any instance of WebKitNetworkSession after this function is called.

Be sure to call this function before creating any WebKitNetworkSession.

The periodic check for used memory is disabled by default on network processes. This will be enabled only if custom settings have been set using this function. After that, in order to remove the custom settings and disable the periodic check, this function must be called passing null as the value of settings.

Parameters:

settings - a WebKitMemoryPressureSettings.

Throws:

UnsupportedPlatformException - when run on a platform other than linux

allowTlsCertificateForHost

public void allowTlsCertificateForHost(TlsCertificate certificate,
 String host)

Ignore further TLS errors on the host for the certificate present in info.

If host is an IPv6 address, it should not be surrounded by brackets. This expectation matches g_uri_get_host().

Parameters:

certificate - a GTlsCertificate

host - the host for which a certificate is to be allowed

downloadUri

public Download downloadUri(String uri)

Requests downloading of the specified URI string.

The download operation will not be associated to any WebKitWebView, if you are interested in starting a download from a particular WebKitWebView use webkit_web_view_download_uri() instead.

Parameters:

uri - the URI to download

Returns:

a new WebKitDownload representing the download operation.

getCookieManager

public CookieManager getCookieManager()

Get the WebKitCookieManager of this NetworkSession.

Returns:

a WebKitCookieManager

getItpEnabled

public boolean getItpEnabled()

Get whether Intelligent Tracking Prevention (ITP) is enabled or not.

Returns:

true if ITP is enabled, or false otherwise.

getItpSummary

public void getItpSummary(@Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously get the list of WebKitITPThirdParty seen for this NetworkSession.

Every WebKitITPThirdParty contains the list of WebKitITPFirstParty under which it has been seen.

When the operation is finished, callback will be called. You can then call webkit_network_session_get_itp_summary_finish() to get the result of the operation.

Parameters:

cancellable - a GCancellable or null to ignore

callback - a GAsyncReadyCallback to call when the request is satisfied

getItpSummaryFinish

public List<ITPThirdParty> getItpSummaryFinish(AsyncResult result)
                                        throws GErrorException

Finish an asynchronous operation started with webkit_network_session_get_itp_summary().

Parameters:

result - a GAsyncResult

Returns:

a GList of WebKitITPThirdParty. You must free the GList with g_list_free() and unref the WebKitITPThirdParty<!-- -->s with webkit_itp_third_party_unref() when you're done with them.

Throws:

GErrorException - see GError

getPersistentCredentialStorageEnabled

public boolean getPersistentCredentialStorageEnabled()

Get whether persistent credential storage is enabled or not.

See also webkit_network_session_set_persistent_credential_storage_enabled().

Returns:

true if persistent credential storage is enabled, or false otherwise.

getTlsErrorsPolicy

public TLSErrorsPolicy getTlsErrorsPolicy()

Get the TLS errors policy of this NetworkSession.

Returns:

a WebKitTLSErrorsPolicy

getWebsiteDataManager

public WebsiteDataManager getWebsiteDataManager()

Get the WebKitWebsiteDataManager of this NetworkSession.

Returns:

a WebKitWebsiteDataManager

isEphemeral

public boolean isEphemeral()

Get whether this NetworkSession is ephemeral. A WebKitNetworkSession is ephemeral when its WebKitWebsiteDataManager is ephemeral. See WebKitWebsiteDataManager:is-ephemeral for more details.

Returns:

true if this NetworkSession is pehmeral, or false otherwise

prefetchDns

public void prefetchDns(String hostname)

Resolve the domain name of the given hostname in advance, so that if a URI of hostname is requested the load will be performed more quickly.

Parameters:

hostname - a hostname to be resolved

setItpEnabled

public void setItpEnabled(boolean enabled)

Enable or disable Intelligent Tracking Prevention (ITP).

When ITP is enabled resource load statistics are collected and used to decide whether to allow or block third-party cookies and prevent user tracking. Note that while ITP is enabled the accept policy CookieAcceptPolicy.NO_THIRD_PARTY is ignored and CookieAcceptPolicy.ALWAYS is used instead. See also webkit_cookie_session_set_accept_policy().

Parameters:

enabled - value to set

setPersistentCredentialStorageEnabled

public void setPersistentCredentialStorageEnabled(boolean enabled)

Enable or disable persistent credential storage.

When enabled, which is the default for non-ephemeral sessions, the network process will try to read and write HTTP authentiacation credentials from persistent storage.

Parameters:

enabled - value to set

setProxySettings

public void setProxySettings(NetworkProxyMode proxyMode,
 @Nullable
 @Nullable NetworkProxySettings proxySettings)

Set the network proxy settings to be used by connections started in this NetworkSession session.

By default NetworkProxyMode.DEFAULT is used, which means that the system settings will be used (g_proxy_resolver_get_default()). If you want to override the system default settings, you can either use NetworkProxyMode.NO_PROXY to make sure no proxies are used at all, or NetworkProxyMode.CUSTOM to provide your own proxy settings. When proxyMode is NetworkProxyMode.CUSTOM proxySettings must be a valid WebKitNetworkProxySettings; otherwise, proxySettings must be null.

Parameters:

proxyMode - a WebKitNetworkProxyMode

proxySettings - a WebKitNetworkProxySettings, or null

setTlsErrorsPolicy

public void setTlsErrorsPolicy(TLSErrorsPolicy policy)

Set the TLS errors policy of this NetworkSession as policy.

Parameters:

policy - a WebKitTLSErrorsPolicy

onDownloadStarted

public SignalConnection<NetworkSession.DownloadStartedCallback> onDownloadStarted(NetworkSession.DownloadStartedCallback handler)

This signal is emitted when a new download request is made.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• NetworkSession.DownloadStartedCallback.run(org.gnome.webkit.Download)

emitDownloadStarted

public void emitDownloadStarted(Download download)

Emits the "download-started" signal. See onDownloadStarted(org.gnome.webkit.NetworkSession.DownloadStartedCallback).

builder

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

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