soup/org.gtkkn.bindings.soup/Auth/AuthImpl

AuthImpl

class AuthImpl(pointer: <Error class: unknown class><<Error class: unknown class>>) : Auth(source)

The AuthImpl type represents a native instance of the abstract Auth class.

Constructors

Link copied to clipboard
constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Creates a new instance of Auth for the provided CPointer.

Properties

Link copied to clipboard
open val authority: String

The authority (host:port) being authenticated to.

Link copied to clipboard
open val realm: String

The authentication realm.

Link copied to clipboard
open val schemeName: String

The authentication scheme name.

Link copied to clipboard
val soupAuthPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

Link copied to clipboard
open fun authenticate(username: String, password: String)

Call this on an auth to authenticate it.

Link copied to clipboard
open fun canAuthenticate(): Boolean

Tests if @auth is able to authenticate by providing credentials to the method@Auth.authenticate.

Link copied to clipboard
open fun cancel()

Call this on an auth to cancel it.

Link copied to clipboard
open fun freeProtectionSpace(space: <Error class: unknown class>)

Frees @space.

Link copied to clipboard
open fun getAuthorization(msg: Message): String

Generates an appropriate "Authorization" header for @msg.

Link copied to clipboard
open fun getInfo(): String

Gets an opaque identifier for @auth.

Link copied to clipboard
open fun getProtectionSpace(sourceUri: <Error class: unknown class>): <Error class: unknown class>

Returns a list of paths on the server which @auth extends over.

Link copied to clipboard
open fun isAuthenticated(): Boolean

Tests if @auth has been given a username and password.

Link copied to clipboard
open fun isCancelled(): Boolean

Tests if @auth has been cancelled

Link copied to clipboard
open fun isForProxy(): Boolean

Tests whether or not @auth is associated with a proxy server rather than an "origin" server.

Link copied to clipboard
open fun isReady(msg: Message): Boolean

Tests if @auth is ready to make a request for @msg with.

Link copied to clipboard
open fun update(msg: Message, authHeader: String): Boolean

Updates @auth with the information from @msg and @auth_header, possibly un-authenticating it.