Brook Tardigrade

Class TBrookHTTPAuthentication

Description
Hierarchy
Fields
Methods
Properties

Unit

BrookHTTPAuthentication

Declaration

type TBrookHTTPAuthentication = class(TBrookHandledPersistent)

Description

Management class to grant, deny, cancel an authentication.

Hierarchy

Overview

Methods

Public constructor Create(AHandle: Pointer); virtual;
Public destructor Destroy; override;
Public procedure Deny(const AReason, AContentType: string; AStatus: Word); overload; virtual;
Public procedure Deny(const AFmt: string; const AArgs: array of const; const AContentType: string; AStatus: Word); overload; virtual;
Public procedure Deny(const AReason, AContentType: string); overload; virtual;
Public procedure Deny(const AFmt: string; const AArgs: array of const; const AContentType: string); overload; virtual;
Public procedure Cancel; virtual;

Properties

Public property Credentials: TBrookHTTPCredentials read FCredentials;

Description

Methods

Public constructor Create(AHandle: Pointer); virtual;

Creates an instance of TBrookHTTPAuthentication.

Parameters
AHandle[in]
Authentication handle.
Public destructor Destroy; override;

Destroys an instance of TBrookHTTPAuthentication.

Public procedure Deny(const AReason, AContentType: string; AStatus: Word); overload; virtual;

Deny the authentication sending the reason to the user.

Parameters
AReason[in]
Denial reason.
AContentType[in]
Content type.
AStatus[in]
HTTP status code.
Public procedure Deny(const AFmt: string; const AArgs: array of const; const AContentType: string; AStatus: Word); overload; virtual;

Deny the authentication sending the formatted reason to the user.

Parameters
AFmt[in]
Formatted string.
AArgs[in]
Arguments to compose the formatted reason.
AContentType[in]
Content type.
AStatus[in]
HTTP status code.
Public procedure Deny(const AReason, AContentType: string); overload; virtual;

Deny the authentication sending the reason to the user.

Parameters
AReason[in]
Denial reason.
AContentType[in]
Content type.
Public procedure Deny(const AFmt: string; const AArgs: array of const; const AContentType: string); overload; virtual;

Deny the authentication sending the formatted reason to the user.

Parameters
AFmt[in]
Formatted string.
AArgs[in]
Arguments to compose the formatted reason.
AContentType[in]
Content type.
Public procedure Cancel; virtual;

Cancels the authentication loop while the user is trying to access the server.

Properties

Public property Credentials: TBrookHTTPCredentials read FCredentials;

Credentials holder.

Generated by PasDoc 0.16.0.