Difference between revisions of "THTTPDocument"

From Ultibo.org
Jump to: navigation, search
 
Line 329: Line 329:
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<pre style="border: 0; padding-bottom:0px;">procedure THTTPDocument.SetFlags(AFlags:LongWord);</pre>
 
<pre style="border: 0; padding-bottom:0px;">procedure THTTPDocument.SetFlags(AFlags:LongWord);</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function THTTPDocument.GetUserAuthenticator:TAuthenticator;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">procedure THTTPDocument.SetUserAuthenticator(AAuthenticator:TAuthenticator);</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function THTTPDocument.GetSessionAuthenticator:TAuthenticator;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">procedure THTTPDocument.SetSessionAuthenticator(AAuthenticator:TAuthenticator);</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
Line 425: Line 473:
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<pre style="border: 0; padding-bottom:0px;">procedure THTTPDocument.SetIsExtension(AIsExtension:Boolean);</pre>
 
<pre style="border: 0; padding-bottom:0px;">procedure THTTPDocument.SetIsExtension(AIsExtension:Boolean);</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function THTTPDocument.GetRequireAuthorization:Boolean;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">procedure THTTPDocument.SetRequireAuthorization(ARequireAuthorization:Boolean);</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function THTTPDocument.GetRequireAuthentication:Boolean;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">procedure THTTPDocument.SetRequireAuthentication(ARequireAuthentication:Boolean);</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
Line 449: Line 545:
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<pre style="border: 0; padding-bottom:0px;">function THTTPDocument.ReleaseLock:Boolean;</pre>
 
<pre style="border: 0; padding-bottom:0px;">function THTTPDocument.ReleaseLock:Boolean;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function THTTPDocument.ParseFormParams(AHost:THTTPHost; ARequest:THTTPServerRequest):THTTPParams;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
Line 497: Line 605:
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<pre style="border: 0; padding-bottom:0px;">function THTTPDocument.DoPut(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse):Boolean;</pre>
 
<pre style="border: 0; padding-bottom:0px;">function THTTPDocument.DoPut(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse):Boolean;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Base PUT Method for an HTTP Document</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function THTTPDocument.DoError(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse):Boolean;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Base PUT Method for an HTTP Document</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function THTTPDocument.DoAuthorize(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse; var AAuthorized:Boolean):Boolean;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Base PUT Method for an HTTP Document</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function THTTPDocument.DoAuthenticate(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse; var AAuthenticated:Boolean):Boolean;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Base PUT Method for an HTTP Document</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function THTTPDocument.DoDeauthenticate(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse; var ADeauthenticated:Boolean):Boolean;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Base PUT Method for an HTTP Document</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Base PUT Method for an HTTP Document</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">

Latest revision as of 03:02, 24 October 2025

Return to Unit HTTP


Description

To be documented

Class definitions


THTTPDocument = class(TListObject)

public
constructor Create;  
destructor Destroy; override;  
private
FLock:TCriticalSectionHandle;  
 
FName:String;  
FHash:LongWord;  
FFlags:LongWord;  
 
FUserAuthenticator:TAuthenticator;  
FSessionAuthenticator:TAuthenticator;  
 
FAliases:TLinkedList;  
 
FOnGet:THTTPDocumentEvent;  
FOnHead:THTTPDocumentEvent;  
FOnPost:THTTPDocumentEvent;  
FOnPut:THTTPDocumentEvent;  
FOnError:THTTPDocumentEvent;  
 
FOnAuthorize:THTTPAuthorizationEvent;  
FOnAuthenticate:THTTPAuthenticationEvent;  
FOnDeauthenticate:THTTPDeauthenticationEvent;  
 
function GetName:String;  
procedure SetName(const AName:String);  
procedure SetFlags(AFlags:LongWord);  
 
function GetUserAuthenticator:TAuthenticator;  
procedure SetUserAuthenticator(AAuthenticator:TAuthenticator);  
function GetSessionAuthenticator:TAuthenticator;  
procedure SetSessionAuthenticator(AAuthenticator:TAuthenticator);  
 
function GetIsDefault:Boolean;  
procedure SetIsDefault(AIsDefault:Boolean);  
function GetIsFolder:Boolean;  
procedure SetIsFolder(AIsFolder:Boolean);  
function GetIsSubtree:Boolean;  
procedure SetIsSubtree(AIsSubtree:Boolean);  
function GetIsExtension:Boolean;  
procedure SetIsExtension(AIsExtension:Boolean);  
function GetRequireAuthorization:Boolean;  
procedure SetRequireAuthorization(ARequireAuthorization:Boolean);  
function GetRequireAuthentication:Boolean;  
procedure SetRequireAuthentication(ARequireAuthentication:Boolean);  
protected
function AcquireLock:Boolean;  
function ReleaseLock:Boolean;  
 
function ParseFormParams(AHost:THTTPHost; ARequest:THTTPServerRequest):THTTPParams; virtual;  
 
function DoGet(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse):Boolean; virtual;  
function DoHead(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse):Boolean; virtual;  
function DoPost(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse):Boolean; virtual;  
function DoPut(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse):Boolean; virtual;  
function DoError(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse):Boolean; virtual;  
 
function DoAuthorize(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse; var AAuthorized:Boolean):Boolean; virtual;  
function DoAuthenticate(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse; var AAuthenticated:Boolean):Boolean; virtual;  
function DoDeauthenticate(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse; var ADeauthenticated:Boolean):Boolean; virtual;  
public
property Name:String read GetName write SetName;  
property Hash:LongWord read FHash;  
property Flags:LongWord read FFlags write SetFlags;  
 
property IsDefault:Boolean read GetIsDefault write SetIsDefault;  
property IsFolder:Boolean read GetIsFolder write SetIsFolder;  
property IsSubtree:Boolean read GetIsSubtree write SetIsSubtree;  
property IsExtension:Boolean read GetIsExtension write SetIsExtension;  
property RequireAuthorization:Boolean read GetRequireAuthorization write SetRequireAuthorization;  
property RequireAuthentication:Boolean read GetRequireAuthentication write SetRequireAuthentication;  
 
property UserAuthenticator:TAuthenticator read GetUserAuthenticator write SetUserAuthenticator;  
property SessionAuthenticator:TAuthenticator read GetSessionAuthenticator write SetSessionAuthenticator;  
 
property OnGet:THTTPDocumentEvent read FOnGet write FOnGet;  
property OnHead:THTTPDocumentEvent read FOnHead write FOnHead;  
property OnPost:THTTPDocumentEvent read FOnPost write FOnPost;  
property OnPut:THTTPDocumentEvent read FOnPut write FOnPut;  
property OnError:THTTPDocumentEvent read FOnError write FOnError;  
 
property OnAuthorize:THTTPAuthorizationEvent read FOnAuthorize write FOnAuthorize;  
property OnAuthenticate:THTTPAuthenticationEvent read FOnAuthenticate write FOnAuthenticate;  
property OnDeauthenticate:THTTPDeauthenticationEvent read FOnDeauthenticate write FOnDeauthenticate;  
 
function FindAlias(const AName:String):THTTPAlias;  
function MatchAlias(const AName:String):THTTPAlias; virtual;  
 
function RegisterAlias(AAlias:THTTPAlias):Boolean;  
function DeregisterAlias(AAlias:THTTPAlias):Boolean;  


Function declarations


constructor THTTPDocument.Create;
Description: To be documented
Note None documented 


destructor THTTPDocument.Destroy;
Description: To be documented
Note None documented 


function THTTPDocument.GetName:String;
Description: To be documented
Note None documented 


procedure THTTPDocument.SetName(const AName:String);
Description: To be documented
Note None documented 


procedure THTTPDocument.SetFlags(AFlags:LongWord);
Description: To be documented
Note None documented 


function THTTPDocument.GetUserAuthenticator:TAuthenticator;
Description: To be documented
Note None documented 


procedure THTTPDocument.SetUserAuthenticator(AAuthenticator:TAuthenticator);
Description: To be documented
Note None documented 


function THTTPDocument.GetSessionAuthenticator:TAuthenticator;
Description: To be documented
Note None documented 


procedure THTTPDocument.SetSessionAuthenticator(AAuthenticator:TAuthenticator);
Description: To be documented
Note None documented 


function THTTPDocument.GetIsDefault:Boolean;
Description: To be documented
Note None documented 


procedure THTTPDocument.SetIsDefault(AIsDefault:Boolean);
Description: To be documented
Note None documented 


function THTTPDocument.GetIsFolder:Boolean;
Description: To be documented
Note None documented 


procedure THTTPDocument.SetIsFolder(AIsFolder:Boolean);
Description: To be documented
Note None documented 


function THTTPDocument.GetIsSubtree:Boolean;
Description: To be documented
Note None documented 


procedure THTTPDocument.SetIsSubtree(AIsSubtree:Boolean);
Description: To be documented
Note None documented 


function THTTPDocument.GetIsExtension:Boolean;
Description: To be documented
Note None documented 


procedure THTTPDocument.SetIsExtension(AIsExtension:Boolean);
Description: To be documented
Note None documented 


function THTTPDocument.GetRequireAuthorization:Boolean;
Description: To be documented
Note None documented 


procedure THTTPDocument.SetRequireAuthorization(ARequireAuthorization:Boolean);
Description: To be documented
Note None documented 


function THTTPDocument.GetRequireAuthentication:Boolean;
Description: To be documented
Note None documented 


procedure THTTPDocument.SetRequireAuthentication(ARequireAuthentication:Boolean);
Description: To be documented
Note None documented 


function THTTPDocument.AcquireLock:Boolean;
Description: To be documented
Note None documented 


function THTTPDocument.ReleaseLock:Boolean;
Description: To be documented
Note None documented 


function THTTPDocument.ParseFormParams(AHost:THTTPHost; ARequest:THTTPServerRequest):THTTPParams;
Description: To be documented
Note None documented 


function THTTPDocument.DoGet(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse):Boolean;
Description: Base GET Method for an HTTP Document
Note None documented 


function THTTPDocument.DoHead(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse):Boolean;
Description: Base HEAD Method for an HTTP Document
Note None documented 


function THTTPDocument.DoPost(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse):Boolean;
Description: Base POST Method for an HTTP Document
Note None documented 


function THTTPDocument.DoPut(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse):Boolean;
Description: Base PUT Method for an HTTP Document
Note None documented 


function THTTPDocument.DoError(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse):Boolean;
Description: Base PUT Method for an HTTP Document
Note None documented 


function THTTPDocument.DoAuthorize(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse; var AAuthorized:Boolean):Boolean;
Description: Base PUT Method for an HTTP Document
Note None documented 


function THTTPDocument.DoAuthenticate(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse; var AAuthenticated:Boolean):Boolean;
Description: Base PUT Method for an HTTP Document
Note None documented 


function THTTPDocument.DoDeauthenticate(AHost:THTTPHost; ARequest:THTTPServerRequest; AResponse:THTTPServerResponse; var ADeauthenticated:Boolean):Boolean;
Description: Base PUT Method for an HTTP Document
Note None documented 


function THTTPDocument.FindAlias(const AName:String):THTTPAlias;
Description: To be documented
Note None documented 


function THTTPDocument.MatchAlias(const AName:String):THTTPAlias;
Description: To be documented
Note None documented 


function THTTPDocument.RegisterAlias(AAlias:THTTPAlias):Boolean;
Description: To be documented
Note None documented 


function THTTPDocument.DeregisterAlias(AAlias:THTTPAlias):Boolean;
Description: To be documented
Note None documented


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=THTTPDocument&oldid=6089"