Package org.gnome.gio

Interface ProxyResolver

All Superinterfaces:

Proxy

All Known Implementing Classes:

ProxyResolver.ProxyResolver$Impl, SimpleProxyResolver

@Generated("io.github.jwharm.JavaGI")
public interface ProxyResolver
extends Proxy

GProxyResolver provides synchronous and asynchronous network proxy resolution. GProxyResolver is used within SocketClient through the method SocketConnectable.proxyEnumerate().

Implementations of GProxyResolver based on libproxy and GNOME settings can be found in glib-networking. GIO comes with an implementation for use inside Flatpak portals.

Since:

2.26

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProxyResolver.ProxyResolver$Impl	The ProxyResolver$Impl type represents a native instance of the ProxyResolver interface.
static class	ProxyResolver.ProxyResolverInterface	The virtual function table for GProxyResolver.

Method Summary

Modifier and Type	Method	Description
static ProxyResolver	getDefault()	Gets the default GProxyResolver for the system.
static @Nullable Type	getType()	Get the GType of the ProxyResolver class
default boolean	isSupported()	Checks if this ProxyResolver can be used on this system.
default String[]	lookup(String uri, @Nullable Cancellable cancellable)	Looks into the system proxy configuration to determine what proxy, if any, to use to connect to uri. The returned proxy URIs are of the form <protocol>://[user[:password]&#64;]host[:port] or direct://, where <protocol> could be http, rtsp, socks or other proxying protocol.
default void	lookupAsync(String uri, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronous lookup of proxy.
default String[]	lookupFinish(AsyncResult result)	Call this function to obtain the array of proxy URIs when g_proxy_resolver_lookup_async() is complete.

Methods inherited from interface org.javagi.base.Proxy

handle

Method Details

getType

static @Nullable Type getType()

Get the GType of the ProxyResolver class

Returns:

the GType

getDefault

static ProxyResolver getDefault()

Gets the default GProxyResolver for the system.

Returns:

the default GProxyResolver, which will be a dummy object if no proxy resolver is available

Since:

2.26

isSupported

default boolean isSupported()

Checks if this ProxyResolver can be used on this system. (This is used internally; g_proxy_resolver_get_default() will only return a proxy resolver that returns true for this method.)

Returns:

true if this ProxyResolver is supported.

Since:

2.26

lookup

default String[] lookup(String uri,
 @Nullable Cancellable cancellable)
                 throws GErrorException

Looks into the system proxy configuration to determine what proxy, if any, to use to connect to uri. The returned proxy URIs are of the form <protocol>://[user[:password]&#64;]host[:port] or direct://, where <protocol> could be http, rtsp, socks or other proxying protocol.

If you don't know what network protocol is being used on the socket, you should use none as the URI protocol. In this case, the resolver might still return a generic proxy type (such as SOCKS), but would not return protocol-specific proxy types (such as http).

direct:// is used when no proxy is needed. Direct connection should not be attempted unless it is part of the returned array of proxies.

Parameters:

uri - a URI representing the destination to connect to

cancellable - a GCancellable, or null

Returns:

A NULL-terminated array of proxy URIs. Must be freed with g_strfreev().

Throws:

GErrorException - see GError

Since:

2.26

lookupAsync

default void lookupAsync(String uri,
 @Nullable Cancellable cancellable,
 @Nullable AsyncReadyCallback callback)

Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more details.

Parameters:

uri - a URI representing the destination to connect to

cancellable - a GCancellable, or null

callback - callback to call after resolution completes

Since:

2.26

lookupFinish

default String[] lookupFinish(AsyncResult result)
                       throws GErrorException

Call this function to obtain the array of proxy URIs when g_proxy_resolver_lookup_async() is complete. See g_proxy_resolver_lookup() for more details.

Parameters:

result - the result passed to your GAsyncReadyCallback

Returns:

A NULL-terminated array of proxy URIs. Must be freed with g_strfreev().

Throws:

GErrorException - see GError

Since:

2.26