Auth
Object Hierarchy:
Soup.Auth
Soup.Auth
Soup.Auth
GLib.Object
GLib.Object
GLib.Object->Soup.Auth
Description:
[ CCode ( type_id = "soup_auth_get_type ()" ) ]public abstract class Auth : Object
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.
Auth objects store the authentication data associated with a given bit of web space. They are created
automatically by [class@Session].
Content:
Properties:
public string authority { owned get ; set ; }
The authority (host:port) being authenticated to.
public virtual bool is_authenticated { get ; }
Whether or not the auth has been authenticated.
public bool is_cancelled { get ; }
Whether or not the auth has been cancelled.
public bool is_for_proxy { get ; set ; }
Whether or not the auth is for a proxy server.
public string realm { owned get ; set ; }
The authentication realm.
public string scheme_name { get ; }
The authentication scheme name.
Static methods:
Creation methods:
Methods:
public virtual void authenticate (string username, string password)
Call this on an auth to authenticate it.
public virtual bool can_authenticate ()
Tests if this is able to
authenticate by providing credentials to the [method@Auth.
public void cancel ()
Call this on an auth to cancel it.
public unowned string get_authority ()
Returns the authority (host:port) that this
is associated with.
public virtual string get_authorization (Message msg)
Generates an appropriate "Authorization" header for msg
.
public string get_info ()
Gets an opaque identifier for this .
public virtual SList <string > get_protection_space (Uri source_uri)
Returns a list of paths on the server which
this extends over.
public unowned string get_realm ()
Returns this 's realm.
public unowned string get_scheme_name ()
soup_auth_get_scheme_name: (attributes org.
public virtual bool is_ready (Message msg)
Tests if this is ready to make a
request for msg
with.
public virtual bool update (Message msg, HashTable <void *,void *> auth_header)
Updates this with the information
from msg
and auth_header
, possibly un-authenticating it.
Inherited Members:
All known members inherited from class GLib.Object
@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data
get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer
replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref