Package org.gnome.gio

Class ProxyAddress

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.SocketAddress

org.gnome.gio.InetSocketAddress

org.gnome.gio.ProxyAddress

All Implemented Interfaces:

SocketConnectable, Proxy

@Generated("io.github.jwharm.JavaGI")
public class ProxyAddress
extends InetSocketAddress
implements SocketConnectable

A InetSocketAddress representing a connection via a proxy server.

Since:

2.26

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProxyAddress.Builder<B extends ProxyAddress.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	ProxyAddress.ProxyAddressClass	Class structure for GProxyAddress.

Nested classes/interfaces inherited from class org.gnome.gio.InetSocketAddress

InetSocketAddress.InetSocketAddressClass

Nested classes/interfaces inherited from class org.gnome.gio.SocketAddress

SocketAddress.SocketAddress$Impl, SocketAddress.SocketAddressClass

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

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gio.SocketConnectable

SocketConnectable.SocketConnectable$Impl, SocketConnectable.SocketConnectableIface

Constructor Summary

Constructors

Constructor	Description
ProxyAddress()	Creates a new ProxyAddress.
ProxyAddress(MemorySegment address)	Create a ProxyAddress proxy instance for the provided memory address.
ProxyAddress(InetAddress inetaddr, short port, String protocol, String destHostname, short destPort, @Nullable String username, @Nullable String password)	Creates a new GProxyAddress for inetaddr with protocol that should tunnel through destHostname and destPort.

Method Summary

Modifier and Type	Method	Description
protected ProxyAddress	asParent()	Returns this instance as if it were its parent type.
static ProxyAddress.Builder<? extends ProxyAddress.Builder>	builder()	A ProxyAddress.Builder object constructs a ProxyAddress with the specified properties.
String	getDestinationHostname()	Gets proxy's destination hostname; that is, the name of the host that will be connected to via the proxy, not the name of the proxy itself.
short	getDestinationPort()	Gets proxy's destination port; that is, the port on the destination host that will be connected to via the proxy, not the port number of the proxy itself.
String	getDestinationProtocol()	Gets the protocol that is being spoken to the destination server; eg, "http" or "ftp".
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
@Nullable String	getPassword()	Gets proxy's password.
String	getProtocol()	Gets proxy's protocol.
static @Nullable Type	getType()	Get the GType of the ProxyAddress class
@Nullable String	getUri()	Gets the proxy URI that this ProxyAddress was constructed from.
@Nullable String	getUsername()	Gets proxy's username.

Methods inherited from class org.gnome.gio.InetSocketAddress

fromString, getAddress, getFlowinfo, getPort, getScopeId

Methods inherited from class org.gnome.gio.SocketAddress

fromNative, getFamily, getNativeSize, toNative

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

Methods inherited from interface org.gnome.gio.SocketConnectable

enumerate, formatAsString, proxyEnumerate

Constructor Details

ProxyAddress

public ProxyAddress(MemorySegment address)

Create a ProxyAddress proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ProxyAddress

public ProxyAddress(InetAddress inetaddr,
 short port,
 String protocol,
 String destHostname,
 short destPort,
 @Nullable String username,
 @Nullable String password)

Creates a new GProxyAddress for inetaddr with protocol that should tunnel through destHostname and destPort.

(Note that this method doesn't set the GProxyAddress:uri or GProxyAddress:destination-protocol fields; use g_object_new() directly if you want to set those.)

Parameters:

inetaddr - The proxy server GInetAddress.

port - The proxy server port.

protocol - The proxy protocol to support, in lower case (e.g. socks, http).

destHostname - The destination hostname the proxy should tunnel to.

destPort - The destination port to tunnel to.

username - The username to authenticate to the proxy server (or null).

password - The password to authenticate to the proxy server (or null).

Since:

2.26

ProxyAddress

public ProxyAddress()

Creates a new ProxyAddress.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the ProxyAddress class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected ProxyAddress 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 InetSocketAddress

getDestinationHostname

public String getDestinationHostname()

Gets proxy's destination hostname; that is, the name of the host that will be connected to via the proxy, not the name of the proxy itself.

Returns:

the proxy's destination hostname

Since:

2.26

getDestinationPort

public short getDestinationPort()

Gets proxy's destination port; that is, the port on the destination host that will be connected to via the proxy, not the port number of the proxy itself.

Returns:

the proxy's destination port

Since:

2.26

getDestinationProtocol

public String getDestinationProtocol()

Gets the protocol that is being spoken to the destination server; eg, "http" or "ftp".

Returns:

the proxy's destination protocol

Since:

2.34

getPassword

public @Nullable String getPassword()

Gets proxy's password.

Returns:

the proxy's password

Since:

2.26

getProtocol

public String getProtocol()

Gets proxy's protocol. eg, "socks" or "http"

Returns:

the proxy's protocol

Since:

2.26

getUri

public @Nullable String getUri()

Gets the proxy URI that this ProxyAddress was constructed from.

Returns:

the proxy's URI, or null if unknown

Since:

2.34

getUsername

public @Nullable String getUsername()

Gets proxy's username.

Returns:

the proxy's username

Since:

2.26

builder

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

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

Returns:

the builder object