Class AuthDomainBasic

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.soup.AuthDomain

org.gnome.soup.AuthDomainBasic

All Implemented Interfaces:

Proxy

@Generated("org.javagi.JavaGI")
public final class AuthDomainBasic
extends AuthDomain

Server-side "Basic" authentication.

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

AuthDomain.AuthDomain$Impl, AuthDomain.AuthDomainClass

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected AuthDomainBasic	asParent()	Return 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 MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the AuthDomainBasic class.
void	setAuthCallback(@Nullable AuthDomainBasicAuthCallback callback)	Sets the callback that this AuthDomainBasic will use to authenticate incoming requests.

Methods inherited from class AuthDomain

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

Methods inherited from class 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 TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AuthDomainBasic

public AuthDomainBasic(MemorySegment address)

Create a AuthDomainBasic instance for the provided memory address.

Parameters:

address - the memory address of the native object

AuthDomainBasic

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

Creates a AuthDomainBasic.

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

AuthDomainBasic

public AuthDomainBasic()

Create a new AuthDomainBasic.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the AuthDomainBasic class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected AuthDomainBasic asParent()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class AuthDomain

Returns:

the instance as if it were its parent type

setAuthCallback

public void setAuthCallback(@Nullable 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().

Returns:

the builder object