Package org.gnome.soup

Class AuthDomainBasic

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.soup.AuthDomain

org.gnome.soup.AuthDomainBasic

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public final class AuthDomainBasic
extends AuthDomain

Server-side "Basic" authentication.

SoupAuthDomainBasic handles the server side of HTTP "Basic" (ie, cleartext password) authentication.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthDomainBasic.AuthDomainBasicClass
static class	AuthDomainBasic.Builder<B extends AuthDomainBasic.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.

Nested classes/interfaces inherited from class org.gnome.soup.AuthDomain

AuthDomain.AuthDomainClass, AuthDomain.AuthDomainImpl

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
AuthDomainBasic(MemorySegment address)	Create a AuthDomainBasic proxy instance for the provided memory address.
AuthDomainBasic(String optname1, Object... varargs)	Creates a SoupAuthDomainBasic.

Method Summary

Modifier and Type	Method	Description
protected AuthDomainBasic	asParent()	Returns this instance as if it were its parent type.
static AuthDomainBasic.Builder<? extends AuthDomainBasic.Builder>	builder()	A AuthDomainBasic.Builder object constructs a AuthDomainBasic with the specified properties.
static Type	getType()	Get the GType of the AuthDomainBasic class
void	setAuthCallback(AuthDomainBasicAuthCallback callback)	Sets the callback that this AuthDomainBasic will use to authenticate incoming requests.

Methods inherited from class org.gnome.soup.AuthDomain

accepts, accepts, addPath, challenge, checkPassword, covers, getMemoryLayout, getRealm, removePath, setFilter, setGenericAuthCallback

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

AuthDomainBasic

public AuthDomainBasic(MemorySegment address)

Create a AuthDomainBasic proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

AuthDomainBasic

public AuthDomainBasic(String optname1,
 Object... varargs)
                throws UnsupportedPlatformException

Creates a SoupAuthDomainBasic.

You must set the AuthDomain:realm property, to indicate the realm name to be returned with the authentication challenge to the client. Other parameters are optional.

Parameters:

optname1 - name of first option, or null

varargs - option name/value pairs

Throws:

UnsupportedPlatformException - when run on a platform other than linux

Method Details

getType

public static Type getType()

Get the GType of the AuthDomainBasic class

Returns:

the GType

asParent

protected AuthDomainBasic 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 AuthDomain

setAuthCallback

public void setAuthCallback(AuthDomainBasicAuthCallback callback)

Sets the callback that this AuthDomainBasic will use to authenticate incoming requests.

For each request containing authorization, this AuthDomainBasic will invoke the callback, and then either accept or reject the request based on callback's return value.

You can also set the auth callback by setting the AuthDomainBasic:auth-callback and AuthDomainBasic:auth-data properties, which can also be used to set the callback at construct time.

Parameters:

callback - the callback

builder

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

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