Auth

open class Auth(pointer: <Error class: unknown class><<Error class: unknown class>>)

The abstract base class for handling authentication.

Specific HTTP Authentication mechanisms are implemented by its subclasses, but applications never need to be aware of the specific subclasses being used.

#SoupAuth objects store the authentication data associated with a given bit of web space. They are created automatically by class@Session.

Skipped during bindings generation

method is-authenticated: Property has no getter nor setter
method is-cancelled: Property has no getter nor setter
method is-for-proxy: Property has no getter nor setter

Constructors

Auth

constructor(type: <Error class: unknown class>, msg: Message, authHeader: String)

Creates a new #SoupAuth of type @type with the information from

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

authority

open val authority: String

The authority (host:port) being authenticated to.

realm

open val realm: String

The authentication realm.

schemeName

open val schemeName: String

The authentication scheme name.

soupAuthPointer

val soupAuthPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

authenticate

open fun authenticate(username: String, password: String)

Call this on an auth to authenticate it.

canAuthenticate

open fun canAuthenticate(): Boolean

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

cancel

open fun cancel()

Call this on an auth to cancel it.

freeProtectionSpace

open fun freeProtectionSpace(space: <Error class: unknown class>)

Frees @space.

getAuthorization

open fun getAuthorization(msg: Message): String

Generates an appropriate "Authorization" header for @msg.

getInfo

open fun getInfo(): String

Gets an opaque identifier for @auth.

getProtectionSpace

open fun getProtectionSpace(sourceUri: <Error class: unknown class>): <Error class: unknown class>

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

isAuthenticated

open fun isAuthenticated(): Boolean

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

isCancelled

open fun isCancelled(): Boolean

Tests if @auth has been cancelled

isForProxy

open fun isForProxy(): Boolean

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

isReady

open fun isReady(msg: Message): Boolean

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

update

open fun update(msg: Message, authHeader: String): Boolean

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