Indy 9 | Content | Index | Reference

TIdAuthenticationManager
Hierarchy, Properties, Methods, See Also, Unit: IdAuthenticationManager
Maintains authentication mechanisms used for a HTTP client connection.

    TIdAuthenticationManager = class(TIdBaseComponent)

Unit
IdAuthenticationManager
Description
TIdAuthenticationManager is a TIdBaseComponent descendant that maintains a collection of authentication mechanisms used by a HTTP client. TIdAuthenticationManager is the types used to represent the TIdCustomHTTP.AuthenticationManager property, and is used when a HTTP request requires a specific TIdAuthentication mechanism.

TIdAuthenticationManager.Authentications
TIdAuthenticationManager, See Also
Authentication class instances maintained by the manager component.

    property Authentications: TIdAuthenticationCollection;

Description
Authentications is a read-only TIdAuthenticationCollection property that represents the TIdAuthenticationItem instances maintained by the authentication manager component.

Authentications is initialized in the Create constructor, and released in the Destroy destructor. Authentications is updated when AddAuthentications is called.

Use methods in the TOwnedCollection ancestor class, like Clear, Delete, Items, to access members of the collection.

TIdAuthenticationManager.AddAuthentication
TIdAuthenticationManager, See Also
Adds a new authentication mechanism to the collection for the component,

    procedure AddAuthentication(AAuthtetication: TIdAuthentication; AURL: TIdURI);

Parameters
AAuthtetication: TIdAuthentication
Authentication mechanism to add.
AURL: TIdURI
Resource locator for the authentication.
Description
AddAuthentication is a convenience procedure that creates a new authentication class instance in the Authentications collection maintained by the component. AddAuthentication calls the Add method for the Authentications collection, and sets the URL and Params values maintained in the new collection item based on values in the AAuthtetication and AURL parameters.

TIdAuthenticationManager.Create
TIdAuthenticationManager, See Also
Constructor for the object instance.

    constructor Create(AOwner: TComponent); override;

Parameters
AOwner: TComponent
Owner of the object instance.
Description
Create is the constructor for the object instance. Create calls the inherited Create method using AOwner as the owner of the object instance for notification messages. Create allocates resources need for the Authentication property prior to exiting from the method.

TIdAuthenticationManager.Destroy
TIdAuthenticationManager, See Also
Frees the object instance.

    destructor Destroy; override;

Description
Destroy is the destructor for the object instance. Destroy frees resource allocated in the Create method for the Authentications property. Destroy calls the inherited Destroy method prior to exiting.

Created with Doc-O-Matic 2 donated to Project JEDI. Commercial license available from the Doc-O-Matic site.