TROHttpApiBaseAuthenticationManager
Overview
Base class for all authentication implementations.
Location
- Unit: uROHttpApiBaseAuthenticationManager.pas
- Ancestry: TComponent | TROComponent | TROHttpApiBaseAuthenticationManager
constructor Create override
constructor Create(AOwner: TComponent)
Parameters:
- AOwner:
Assign override (declared in TROComponent)
Copies the contents of another, similar object.
procedure Assign(Source: TPersistent)
Parameters:
- Source: Instance whose properties will be copied
DoWriteMethodSecurity protected virtual abstract
procedure DoWriteMethodSecurity(aMethodRoot: TROJSONObject; aServiceName: string; aMethodName: string)
Parameters:
- aMethodRoot:
- aServiceName:
- aMethodName:
DoWriteServerSecurity protected virtual abstract
procedure DoWriteServerSecurity(aRoot: TROJSONObject)
Parameters:
- aRoot:
DoWriteServerSecurityDefinitions protected virtual abstract
procedure DoWriteServerSecurityDefinitions(aRoot: TROJSONObject)
Parameters:
- aRoot:
IsNeedSession
function IsNeedSession(aServiceName: string; aMethodName: string; aProtected: Boolean): Boolean
Parameters:
- aServiceName:
- aMethodName:
- aProtected:
Notification protected override (declared in TROComponent)
Forwards notification messages to all owned components.
procedure Notification(aComponent: TComponent; Operation: TOperation)
Parameters:
- aComponent: component
- Operation: operation
OnCanWriteMethodSecurity
property OnCanWriteMethodSecurity: TROHttpApiCanWriteMethodSecurity read write
delegate: procedure OnCanWriteMethodSecurity(aServiceName: string; aMethodName: string; var CanWrite: Boolean)
ReadAuthenticationInfo virtual abstract
function ReadAuthenticationInfo(aRequest: IROHTTPRequest): TROHttpApiSession
Parameters:
- aRequest:
ROFreeNotification (declared in TROComponent)
Forwards notification messages to all owned components.
procedure ROFreeNotification(aComponent: TComponent)
Parameters:
- aComponent: component
RORemoveFreeNotification (declared in TROComponent)
Forwards notification messages to all owned components.
procedure RORemoveFreeNotification(aComponent: TComponent)
Parameters:
- aComponent: component
SecurityMode
property SecurityMode: TROHttpApiSecurityMode read write default smPerMethod
SendRemoveNotification protected (declared in TROComponent)
Forwards notification messages to all owned components.
procedure SendRemoveNotification(aComponent: TComponent)
Parameters:
- aComponent: component
SessionManager
property SessionManager: TROCustomSessionManager read write
WriteAuthenticationInfo virtual abstract
procedure WriteAuthenticationInfo(aResponse: IROHTTPResponse; aSessionInfo: TROHttpApiSession)
Parameters:
- aResponse:
- aSessionInfo:
WriteMethodSecurity (TROJSONObject) overload
procedure WriteMethodSecurity(aMethodRoot: TROJSONObject)
Parameters:
- aMethodRoot:
WriteMethodSecurity (TROJSONObject, string, string, Boolean) overload
procedure WriteMethodSecurity(aMethodRoot: TROJSONObject; aServiceName: string; aMethodName: string; aProtected: Boolean)
Parameters:
- aMethodRoot:
- aServiceName:
- aMethodName:
- aProtected:
WriteServerSecurity
procedure WriteServerSecurity(aRoot: TROJSONObject)
Parameters:
- aRoot:
WriteServerSecurityDefinitions
procedure WriteServerSecurityDefinitions(aRoot: TROJSONObject)
Parameters:
- aRoot:
SecurityMode
property SecurityMode: TROHttpApiSecurityMode read write default smPerMethod
SessionManager
property SessionManager: TROCustomSessionManager read write
constructor Create override
constructor Create(AOwner: TComponent)
Parameters:
- AOwner:
Assign override (declared in TROComponent)
Copies the contents of another, similar object.
procedure Assign(Source: TPersistent)
Parameters:
- Source: Instance whose properties will be copied
DoWriteMethodSecurity protected virtual abstract
procedure DoWriteMethodSecurity(aMethodRoot: TROJSONObject; aServiceName: string; aMethodName: string)
Parameters:
- aMethodRoot:
- aServiceName:
- aMethodName:
DoWriteServerSecurity protected virtual abstract
procedure DoWriteServerSecurity(aRoot: TROJSONObject)
Parameters:
- aRoot:
DoWriteServerSecurityDefinitions protected virtual abstract
procedure DoWriteServerSecurityDefinitions(aRoot: TROJSONObject)
Parameters:
- aRoot:
IsNeedSession
function IsNeedSession(aServiceName: string; aMethodName: string; aProtected: Boolean): Boolean
Parameters:
- aServiceName:
- aMethodName:
- aProtected:
Notification protected override (declared in TROComponent)
Forwards notification messages to all owned components.
procedure Notification(aComponent: TComponent; Operation: TOperation)
Parameters:
- aComponent: component
- Operation: operation
ReadAuthenticationInfo virtual abstract
function ReadAuthenticationInfo(aRequest: IROHTTPRequest): TROHttpApiSession
Parameters:
- aRequest:
ROFreeNotification (declared in TROComponent)
Forwards notification messages to all owned components.
procedure ROFreeNotification(aComponent: TComponent)
Parameters:
- aComponent: component
RORemoveFreeNotification (declared in TROComponent)
Forwards notification messages to all owned components.
procedure RORemoveFreeNotification(aComponent: TComponent)
Parameters:
- aComponent: component
SendRemoveNotification protected (declared in TROComponent)
Forwards notification messages to all owned components.
procedure SendRemoveNotification(aComponent: TComponent)
Parameters:
- aComponent: component
WriteAuthenticationInfo virtual abstract
procedure WriteAuthenticationInfo(aResponse: IROHTTPResponse; aSessionInfo: TROHttpApiSession)
Parameters:
- aResponse:
- aSessionInfo:
WriteMethodSecurity (TROJSONObject) overload
procedure WriteMethodSecurity(aMethodRoot: TROJSONObject)
Parameters:
- aMethodRoot:
WriteMethodSecurity (TROJSONObject, string, string, Boolean) overload
procedure WriteMethodSecurity(aMethodRoot: TROJSONObject; aServiceName: string; aMethodName: string; aProtected: Boolean)
Parameters:
- aMethodRoot:
- aServiceName:
- aMethodName:
- aProtected:
WriteServerSecurity
procedure WriteServerSecurity(aRoot: TROJSONObject)
Parameters:
- aRoot:
WriteServerSecurityDefinitions
procedure WriteServerSecurityDefinitions(aRoot: TROJSONObject)
Parameters:
- aRoot:
OnCanWriteMethodSecurity
property OnCanWriteMethodSecurity: TROHttpApiCanWriteMethodSecurity read write
delegate: procedure OnCanWriteMethodSecurity(aServiceName: string; aMethodName: string; var CanWrite: Boolean)