Package org.gnome.gio

Class TlsInteraction

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.TlsInteraction

All Implemented Interfaces:

Proxy

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

GTlsInteraction provides a mechanism for the TLS connection and database code to interact with the user. It can be used to ask the user for passwords.

To use a GTlsInteraction with a TLS connection use TlsConnection.setInteraction(org.gnome.gio.TlsInteraction).

Callers should instantiate a derived class that implements the various interaction methods to show the required dialogs.

Callers should use the 'invoke' functions like invokeAskPassword(org.gnome.gio.TlsPassword, org.gnome.gio.Cancellable) to run interaction methods. These functions make sure that the interaction is invoked in the main loop and not in the current thread, if the current thread is not running the main loop.

Derived classes can choose to implement whichever interactions methods they’d like to support by overriding those virtual methods in their class initialization function. Any interactions not implemented will return G_TLS_INTERACTION_UNHANDLED. If a derived class implements an async method, it must also implement the corresponding finish method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TlsInteraction.Builder<B extends TlsInteraction.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	TlsInteraction.TlsInteractionClass	The class for GTlsInteraction.

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
TlsInteraction(MemorySegment address)	Create a TlsInteraction proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
TlsInteractionResult	askPassword(TlsPassword password, @Nullable Cancellable cancellable)	Run synchronous interaction to ask the user for a password.
void	askPasswordAsync(TlsPassword password, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Run asynchronous interaction to ask the user for a password.
TlsInteractionResult	askPasswordFinish(AsyncResult result)	Complete an ask password user interaction request.
protected TlsInteraction	asParent()	Returns this instance as if it were its parent type.
static TlsInteraction.Builder<? extends TlsInteraction.Builder>	builder()	A TlsInteraction.Builder object constructs a TlsInteraction with the specified properties.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static Type	getType()	Get the GType of the TlsInteraction class
TlsInteractionResult	invokeAskPassword(TlsPassword password, @Nullable Cancellable cancellable)	Invoke the interaction to ask the user for a password.
TlsInteractionResult	invokeRequestCertificate(TlsConnection connection, TlsCertificateRequestFlags flags, @Nullable Cancellable cancellable)	Invoke the interaction to ask the user to choose a certificate to use with the connection.
TlsInteractionResult	requestCertificate(TlsConnection connection, TlsCertificateRequestFlags flags, @Nullable Cancellable cancellable)	Run synchronous interaction to ask the user to choose a certificate to use with the connection.
void	requestCertificateAsync(TlsConnection connection, TlsCertificateRequestFlags flags, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Run asynchronous interaction to ask the user for a certificate to use with the connection.
TlsInteractionResult	requestCertificateFinish(AsyncResult result)	Complete a request certificate user interaction request.

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, 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

TlsInteraction

public TlsInteraction(MemorySegment address)

Create a TlsInteraction proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the TlsInteraction class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

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

askPassword

public TlsInteractionResult askPassword(TlsPassword password,
 @Nullable
 @Nullable Cancellable cancellable)
                                 throws GErrorException

Run synchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function.

Derived subclasses usually implement a password prompt, although they may also choose to provide a password from elsewhere. The password value will be filled in and then callback will be called. Alternatively the user may abort this password request, which will usually abort the TLS connection.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code. Certain implementations may not support immediate cancellation.

Parameters:

password - a GTlsPassword object

cancellable - an optional GCancellable cancellation object

Returns:

The status of the ask password interaction.

Throws:

GErrorException - see GError

askPasswordAsync

public void askPasswordAsync(TlsPassword password,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Run asynchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function.

Derived subclasses usually implement a password prompt, although they may also choose to provide a password from elsewhere. The password value will be filled in and then callback will be called. Alternatively the user may abort this password request, which will usually abort the TLS connection.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code. Certain implementations may not support immediate cancellation.

Certain implementations may not support immediate cancellation.

Parameters:

password - a GTlsPassword object

cancellable - an optional GCancellable cancellation object

callback - will be called when the interaction completes

askPasswordFinish

public TlsInteractionResult askPasswordFinish(AsyncResult result)
                                       throws GErrorException

Complete an ask password user interaction request. This should be once the g_tls_interaction_ask_password_async() completion callback is called.

If TlsInteractionResult.HANDLED is returned, then the GTlsPassword passed to g_tls_interaction_ask_password() will have its password filled in.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code.

Parameters:

result - the result passed to the callback

Returns:

The status of the ask password interaction.

Throws:

GErrorException - see GError

invokeAskPassword

public TlsInteractionResult invokeAskPassword(TlsPassword password,
 @Nullable
 @Nullable Cancellable cancellable)
                                       throws GErrorException

Invoke the interaction to ask the user for a password. It invokes this interaction in the main loop, specifically the GMainContext returned by g_main_context_get_thread_default() when the interaction is created. This is called by called by GTlsConnection or GTlsDatabase to ask the user for a password.

Derived subclasses usually implement a password prompt, although they may also choose to provide a password from elsewhere. The password value will be filled in and then callback will be called. Alternatively the user may abort this password request, which will usually abort the TLS connection.

The implementation can either be a synchronous (eg: modal dialog) or an asynchronous one (eg: modeless dialog). This function will take care of calling which ever one correctly.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code. Certain implementations may not support immediate cancellation.

Parameters:

password - a GTlsPassword object

cancellable - an optional GCancellable cancellation object

Returns:

The status of the ask password interaction.

Throws:

GErrorException - see GError

invokeRequestCertificate

public TlsInteractionResult invokeRequestCertificate(TlsConnection connection,
 TlsCertificateRequestFlags flags,
 @Nullable
 @Nullable Cancellable cancellable)
                                              throws GErrorException

Invoke the interaction to ask the user to choose a certificate to use with the connection. It invokes this interaction in the main loop, specifically the GMainContext returned by g_main_context_get_thread_default() when the interaction is created. This is called by called by GTlsConnection when the peer requests a certificate during the handshake.

Derived subclasses usually implement a certificate selector, although they may also choose to provide a certificate from elsewhere. Alternatively the user may abort this certificate request, which may or may not abort the TLS connection.

The implementation can either be a synchronous (eg: modal dialog) or an asynchronous one (eg: modeless dialog). This function will take care of calling which ever one correctly.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code. Certain implementations may not support immediate cancellation.

Parameters:

connection - a GTlsConnection object

flags - flags providing more information about the request

cancellable - an optional GCancellable cancellation object

Returns:

The status of the certificate request interaction.

Throws:

GErrorException - see GError

requestCertificate

public TlsInteractionResult requestCertificate(TlsConnection connection,
 TlsCertificateRequestFlags flags,
 @Nullable
 @Nullable Cancellable cancellable)
                                        throws GErrorException

Run synchronous interaction to ask the user to choose a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function.

Derived subclasses usually implement a certificate selector, although they may also choose to provide a certificate from elsewhere. Alternatively the user may abort this certificate request, which will usually abort the TLS connection.

If TlsInteractionResult.HANDLED is returned, then the GTlsConnection passed to g_tls_interaction_request_certificate() will have had its GTlsConnection:certificate filled in.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code. Certain implementations may not support immediate cancellation.

Parameters:

connection - a GTlsConnection object

flags - flags providing more information about the request

cancellable - an optional GCancellable cancellation object

Returns:

The status of the request certificate interaction.

Throws:

GErrorException - see GError

requestCertificateAsync

public void requestCertificateAsync(TlsConnection connection,
 TlsCertificateRequestFlags flags,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Run asynchronous interaction to ask the user for a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function.

Derived subclasses usually implement a certificate selector, although they may also choose to provide a certificate from elsewhere. callback will be called when the operation completes. Alternatively the user may abort this certificate request, which will usually abort the TLS connection.

Parameters:

connection - a GTlsConnection object

flags - flags providing more information about the request

cancellable - an optional GCancellable cancellation object

callback - will be called when the interaction completes

requestCertificateFinish

public TlsInteractionResult requestCertificateFinish(AsyncResult result)
                                              throws GErrorException

Complete a request certificate user interaction request. This should be once the g_tls_interaction_request_certificate_async() completion callback is called.

If TlsInteractionResult.HANDLED is returned, then the GTlsConnection passed to g_tls_interaction_request_certificate_async() will have had its GTlsConnection:certificate filled in.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code.

Parameters:

result - the result passed to the callback

Returns:

The status of the request certificate interaction.

Throws:

GErrorException - see GError

builder

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

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