Package org.gnome.webkit

Class AuthenticationRequest

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.webkit.AuthenticationRequest

All Implemented Interfaces:

Proxy

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

Represents an authentication request.

Whenever a client attempts to load a page protected by HTTP authentication, credentials will need to be provided to authorize access. To allow the client to decide how it wishes to handle authentication, WebKit will fire a WebKitWebView::authenticate signal with a WebKitAuthenticationRequest object to provide client side authentication support. Credentials are exposed through the WebKitCredential object.

In case the client application does not wish to handle this signal WebKit will provide a default handler. To handle authentication asynchronously, simply increase the reference count of the WebKitAuthenticationRequest object.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected AuthenticationRequest	asParent()	Returns this instance as if it were its parent type.
void	authenticate(@Nullable Credential credential)	Authenticate the WebKitAuthenticationRequest.
static AuthenticationRequest.Builder<? extends AuthenticationRequest.Builder>	builder()	A AuthenticationRequest.Builder object constructs a AuthenticationRequest with the specified properties.
void	cancel()	Cancel the authentication challenge.
boolean	canSaveCredentials()	Determine whether this WebKitAuthenticationRequest should allow the storage of credentials.
void	emitAuthenticated(Credential credential)	Emits the "authenticated" signal.
void	emitCancelled()	Emits the "cancelled" signal.
Set<TlsPasswordFlags>	getCertificatePinFlags()	Get the GTlsPasswordFlags of the AuthenticationScheme.CLIENT_CERTIFICATE_PIN_REQUESTED authentication challenge.
String	getHost()	Get the host that this authentication challenge is applicable to.
int	getPort()	Get the port that this authentication challenge is applicable to.
Credential	getProposedCredential()	Get the WebKitCredential of the proposed authentication challenge.
String	getRealm()	Get the realm that this authentication challenge is applicable to.
AuthenticationScheme	getScheme()	Get the authentication scheme of the authentication challenge.
SecurityOrigin	getSecurityOrigin()	Get the WebKitSecurityOrigin that this authentication challenge is applicable to.
static Type	getType()	Get the GType of the AuthenticationRequest class
boolean	isForProxy()	Determine whether the authentication challenge is associated with a proxy server.
boolean	isRetry()	Determine whether this this is a first attempt or a retry for this authentication challenge.
SignalConnection<AuthenticationRequest.AuthenticatedCallback>	onAuthenticated(AuthenticationRequest.AuthenticatedCallback handler)	This signal is emitted when the user authentication request succeeded.
SignalConnection<AuthenticationRequest.CancelledCallback>	onCancelled(AuthenticationRequest.CancelledCallback handler)	This signal is emitted when the user authentication request is cancelled.
void	setCanSaveCredentials(boolean enabled)	Set whether the authentication method associated with this AuthenticationRequest should allow the storage of credentials.
void	setProposedCredential(Credential credential)	Set the WebKitCredential of the proposed authentication challenge.

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

AuthenticationRequest

public AuthenticationRequest(MemorySegment address)

Create a AuthenticationRequest 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 AuthenticationRequest class

Returns:

the GType

asParent

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

authenticate

public void authenticate(@Nullable
 @Nullable Credential credential)

Authenticate the WebKitAuthenticationRequest.

Authenticate the WebKitAuthenticationRequest using the WebKitCredential supplied. To continue without credentials, pass null as credential.

Parameters:

credential - A WebKitCredential, or null

canSaveCredentials

public boolean canSaveCredentials()

Determine whether this WebKitAuthenticationRequest should allow the storage of credentials.

Determine whether the authentication method associated with this WebKitAuthenticationRequest should allow the storage of credentials. This will return false if WebKit doesn't support credential storing, if private browsing is enabled, or if persistent credential storage has been disabled in WebKitWebsiteDataManager, unless credentials saving has been explicitly enabled with webkit_authentication_request_set_can_save_credentials().

Returns:

true if WebKit can store credentials or false otherwise.

cancel

public void cancel()

Cancel the authentication challenge.

This will also cancel the page loading and result in a WebKitWebView::load-failed signal with a WebKitNetworkError of type NetworkError.CANCELLED being emitted.

getCertificatePinFlags

public Set<TlsPasswordFlags> getCertificatePinFlags()

Get the GTlsPasswordFlags of the AuthenticationScheme.CLIENT_CERTIFICATE_PIN_REQUESTED authentication challenge.

Returns:

a GTlsPasswordFlags

getHost

public String getHost()

Get the host that this authentication challenge is applicable to.

Returns:

The host of this AuthenticationRequest.

getPort

public int getPort()

Get the port that this authentication challenge is applicable to.

Returns:

The port of this AuthenticationRequest.

getProposedCredential

public Credential getProposedCredential()

Get the WebKitCredential of the proposed authentication challenge.

Get the WebKitCredential of the proposed authentication challenge that was stored from a previous session. The client can use this directly for authentication or construct their own WebKitCredential.

Returns:

A WebKitCredential encapsulating credential details or null if there is no stored credential.

getRealm

public String getRealm()

Get the realm that this authentication challenge is applicable to.

Returns:

The realm of this AuthenticationRequest.

getScheme

public AuthenticationScheme getScheme()

Get the authentication scheme of the authentication challenge.

Returns:

The WebKitAuthenticationScheme of this AuthenticationRequest.

getSecurityOrigin

public SecurityOrigin getSecurityOrigin()

Get the WebKitSecurityOrigin that this authentication challenge is applicable to.

Returns:

a newly created WebKitSecurityOrigin.

isForProxy

public boolean isForProxy()

Determine whether the authentication challenge is associated with a proxy server.

Determine whether the authentication challenge is associated with a proxy server rather than an "origin" server.

Returns:

true if authentication is for a proxy or false otherwise.

isRetry

public boolean isRetry()

Determine whether this this is a first attempt or a retry for this authentication challenge.

Returns:

true if authentication attempt is a retry or false otherwise.

setCanSaveCredentials

public void setCanSaveCredentials(boolean enabled)

Set whether the authentication method associated with this AuthenticationRequest should allow the storage of credentials.

Set whether the authentication method associated with this AuthenticationRequest should allow the storage of credentials. This should be used by applications handling their own credentials storage to indicate that it should be supported even when internal credential storage is disabled or unsupported. Note that storing of credentials will not be allowed on ephemeral sessions in any case.

Parameters:

enabled - value to set

setProposedCredential

public void setProposedCredential(Credential credential)

Set the WebKitCredential of the proposed authentication challenge.

Set the WebKitCredential of the proposed authentication challenge that was stored from a previous session. This should only be used by applications handling their own credential storage. (When using the default WebKit credential storage, webkit_authentication_request_get_proposed_credential() already contains previously-stored credentials.) Passing a null credential will clear the proposed credential.

Parameters:

credential - a WebKitCredential, or null

onAuthenticated

public SignalConnection<AuthenticationRequest.AuthenticatedCallback> onAuthenticated(AuthenticationRequest.AuthenticatedCallback handler)

This signal is emitted when the user authentication request succeeded. Applications handling their own credential storage should connect to this signal to save the credentials.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• AuthenticationRequest.AuthenticatedCallback.run(org.gnome.webkit.Credential)

emitAuthenticated

public void emitAuthenticated(Credential credential)

Emits the "authenticated" signal. See onAuthenticated(org.gnome.webkit.AuthenticationRequest.AuthenticatedCallback).

onCancelled

public SignalConnection<AuthenticationRequest.CancelledCallback> onCancelled(AuthenticationRequest.CancelledCallback handler)

This signal is emitted when the user authentication request is cancelled. It allows the application to dismiss its authentication dialog in case of page load failure for example.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• AuthenticationRequest.CancelledCallback.run()

emitCancelled

public void emitCancelled()

Emits the "cancelled" signal. See onCancelled(org.gnome.webkit.AuthenticationRequest.CancelledCallback).

builder

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

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