TBaseLoginService

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner.

---

Toggles whether the service can automatically acquire a connection when needed (true, default) or not (false).

property AcquireConnection: Boolean read write

---

Allows clients to use custom variables of Macro Processor.

property AllowCustomSqlMacros: Boolean read write

---

Obsolete, replaced by the LegacyEvents property.

function AllowRemoteEventsRegistration: Boolean

---

Copies data from a given source.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Validates ServiceSchema.ConnectionManager property.

procedure CheckForConnectionManager

---

The unique identifier for the client connected to the service. It is equal to the session ID if the session already exists. When the service method is called, this property is already initialized with a proper value. Do not change it unless you know what you are doing!

property ClientID: TGUID read write

---

Returns a live connection to the back-end database based on the configured ConnectionName value. If a connection was previously requested, the same instance will be returned, if a fresh connection to the database couldn't be obtained from the connection manager. Once a connection is acquired, it will be held on until the service gets deactivated, or ReleaseConnection is called.

property Connection: IDAConnection read write

---

Defines the name of the connection that this service will use to connect to the back-end database. If set, all data access done by the service will use the specified connection; if not set, the default connection as defined in connection manager will be used. A typical use case for this property would be to set the connection name in the OnActivate or BeforeAcquireConnection event to match a specific connection, which, for example, could have been stored in the Sessions. The default code provided by the MultiDb Server template uses this approach. When setting ConnectionName and a connection is already acquired, make sure to call the ReleaseConnection method, so that a new connection will be obtained when needed.

property ConnectionName: string read write

---

Creates a new session object and makes it available via the Session property. As a rule, there is no need to call this method because the session is created automatically when required.

procedure CreateSession

---

Internal use only, don't override.

function CustomRequireSession(const aMessage: IROMessage): Boolean

Parameters:

• aMessage: Message

---

Destroys the current session object. This method is primarily used to destroy the session in case of unsuccessful client authentication.

procedure DestroySession

---

Destroys default connection.

procedure DoOnDeactivate(aClientID: TGUID)

Parameters:

• aClientID: Client ID

---

Points to the event repository (TROEventRepository instance) for the service. The value must be set to use the events feature.

property EventRepository: TROEventRepository read write

---

Allows to grab the input parameters to get all information about the upcoming call including the remote method parameters and the calling client transport object.

procedure GetDispatchInfo(const aTransport: IROTransport; const aMessage: IROMessage)

Parameters:

• aTransport: Points to the transport object containing connection-specific information
• aMessage: Message that needs to be processed

---

Collects events data to the memory stream. For internal use only, don't call or override.

function GetEventsData(const ClientID: string; out EventsData: Binary): Integer

Parameters:

• ClientID: Client ID
• EventsData: Binary stream that holds the event data

---

Returns true if anObject is retained by Self.

function IsRetained(const anObject: TObject): Boolean

Parameters:

• anObject: Object to check

---

Checks if session is present

function IsSessionPresent: Boolean

---

Enables or disables the legacy events mode for the service. The default value is true. The legacy mode is less secure and it is recommended to set this property to false for new projects. Note that refusing to use the legacy mode will break compatibility with legacy Delphi clients.

property LegacyEvents: Boolean read write

---

Provides the actual login procedure.

function LoginEx(const aLoginString: ROUTF8String): Boolean

Parameters:

• aLoginString: String that contains the connection name, user name and password

---

This method performs the log out.

procedure Logout

---

Indicates that the client's session was just created, i.e. this indicates the first connection of a so far unknown client.

property NewSession: Boolean read

---

Fired when acquiring a connection failed.

property OnAcquireConnectionFailure: TDAAcquireConnectionFailureEvent read write
delegate:  procedure OnAcquireConnectionFailure(aSender: TObject; const aConnectionName: string; aError: Exception)

---

Called just after the service is created and before any service method is called. Handle this event for everything you need to do when the service instance is created.

property OnActivate: TActivateEvent read write
delegate:  procedure OnActivate(const aClientID: TGUID; aSession: TROSession; const aMessage: IROMessage)

---

Fires right after a new connection is acquired through the Connection property. Use this event to make perform initializations on the new connection, such as opening a transaction, or setting connection options.

property OnAfterAcquireConnection: TDAConnectionAcquiredEvent read write
delegate:  procedure OnAfterAcquireConnection(aSender: TObject; const aConnectionName: string; const aAcquiredConnection: IDAConnection)

---

Fires right after a connection is released.

property OnAfterReleaseConnection: TDAConnectionReleasedEvent read write
delegate:  procedure OnAfterReleaseConnection(aSender: TObject; const aConnectionName: string)

---

Fires just before a new connection is acquired through the Connection property. Use this event to make last-minute configurations before the connection will be acquired, such as changing the ConnectionName.

property OnBeforeAcquireConnection: TDAAcquireConnectionEvent read write
delegate:  procedure OnBeforeAcquireConnection(aSender: TObject; var aConnectionName: string)

---

Called when the new client is being registered to receive events. Deprecated now, since remote event (un-)registration is forbidden (LegacyEvents = false).

property OnBeforeRegisterEventClient: TRegisterEventClientEvent read write
delegate:  procedure OnBeforeRegisterEventClient(const aClientID: TGUID; const EventTypes: string)

---

Fires just before the connection is released. Use this event to perform any finalization tasks on the new connection, such as closing a transaction, or setting connection options.

property OnBeforeReleaseConnection: TDAConnectionAcquiredEvent read write
delegate:  procedure OnBeforeReleaseConnection(aSender: TObject; const aConnectionName: string; const aAcquiredConnection: IDAConnection)

---

Called when the client is being unsubscribed from events. Deprecated now, since remote event (un-)registration is forbidden (LegacyEvents = false).

property OnBeforeUnregisterEventClient: TRegisterEventClientEvent read write
delegate:  procedure OnBeforeUnregisterEventClient(const aClientID: TGUID; const EventTypes: string)

---

Called after the service method completes and before the service instance is freed. Handle this event to perform actions on service destruction, such as disposing of resources.

property OnDeactivate: TDeactivateEvent read write
delegate:  procedure OnDeactivate(const aClientID: TGUID; aSession: TROSession)

---

This event is fired before the invoker executes the service method. Handle this event to preview remote methods about to be executed; the input parameters allow to get all information about the upcoming call including the remote method parameters and the calling client transport object.

property OnGetDispatchInfo: TGetDispatchInfoEvent read write
delegate:  procedure OnGetDispatchInfo(const aTransport: IROTransport; const aMessage: IROMessage)

---

Implement this event handler to provide the actual logout procedure.

property OnLogout: TNotifyEvent read write

---

Fires when unknown macro variable is found. it can be usable when user-defined variables are used inside sql or Dynamic Where expression.

property OnUnknownSqlMacroIdentifier: TOnUnknownIdentifier read write
delegate:  function OnUnknownSqlMacroIdentifier(Sender: TObject; const Name: string; const OrgName: string; var Value: string): Boolean

---

Validates roles.

property OnValidateRoles: TValidateRolesEvent read write
delegate:  procedure OnValidateRoles(aRoles: array of string; var aAllow: Boolean)

---

Reference counter - this class is the interfaced object.

property RefCount: Integer read

---

Registers the client to receive server callback events of the specified type.

procedure RegisterEventClient(const aSession: TROSession; const EventTypes: string)

Parameters:

• aSession: Client session
• EventTypes: Identifier (GUID) of the event sink containing the events to subscribe the client to.

---

Registers the client to receive server callback events of the specified type.

procedure RegisterEventClient(const ClientID: string; const EventTypes: string)

Parameters:

• ClientID: Client identifier to subscribe
• EventTypes: Identifier (GUID) of the event sink containing the events to subscribe the client to.

---

Registers the client to receive server callback events of the specified type.

procedure RegisterEventClient(const ClientID: TGUID; const EventTypes: string)

Parameters:

• ClientID: Client identifier to subscribe
• EventTypes: Identifier (GUID) of the event sink containing the events to subscribe the client to.

---

Releases any connection currently acquired in the Connection property.

procedure ReleaseConnection

---

Takes away the hold of anObject set by RetainObject.

procedure ReleaseObject(const anObject: TObject)

Parameters:

• anObject: Object to release

---

This property should be set to true (perhaps with the designer) to make the service protected and to disallow unauthenticated clients to call its methods. Read more.

property RequiresSession: Boolean read write

---

Sets the hold of anObject.

procedure RetainObject(const anObject: TObject)

Parameters:

• anObject: Object to hold

---

This property points to the TDASchema component defining the schema that will be published by this service. This can be a schema component located on the service data module or (more typically) on a separate global data module in the server application. Data Abstract uses a 1:1 mapping of services and schemas, where every service publishes one schema. Depending on your application design and the scope of your server, you might only use one schema for the entire data access, or logically partition your data tables across different schemas (and services). Locating the schema on a global data module rather than the service module itself might provide a slight performance benefit, as the schema structure only has to be loaded into memory once (on application startup), not every time a new service instance is created. Also note that the TDAConnectionManager (referenced from the schema) must be located off the service module and in a global location for connection pooling to work properly across service instances.

property ServiceSchema: TDASchema read write

---

Validates roles.

procedure ServiceValidateRoles(aRequiredRoles: array of string)

Parameters:

• aRequiredRoles: Roles

---

Provides access to the session object of the current connection. If the session does not exist, it is created at the moment of property access.

property Session: TROSession read

---

Points to the session manager to use. It is necessary to assign the session manager if the protected service is being developed and/or it is necessary to use the events feature.

property SessionManager: TROCustomSessionManager read write

---

procedure Synchronize(aMethod: TThreadMethod)

Parameters:

• aMethod:

---

Provides access to the transport object that processes the current network (or other) connection to the server. Various information, such as client IP address, can be available via the transport objects.

property Transport: IROTransport read

---

procedure UnregisterEventClient(const aSession: TROSession; const EventTypes: string)

Parameters:

• aSession:
• EventTypes:

---

The action is opposite to RegisterEventClient, it cancels the subscription. Unregistration is not absolutely necessary as the client session dies after some time of inactivity but allows to conserve some system resources.

procedure UnregisterEventClient(const ClientID: string; const EventTypes: string)

Parameters:

• ClientID: Client identifier to unsubscribe
• EventTypes: Identifier (GUID) of the event sink containing the events to unsubscribe the client from.

---

procedure UnregisterEventClient(const ClientID: TGUID; const EventTypes: string)

Parameters:

• ClientID:
• EventTypes:

 

Toggles whether the service can automatically acquire a connection when needed (true, default) or not (false).

property AcquireConnection: Boolean read write

---

Allows clients to use custom variables of Macro Processor.

property AllowCustomSqlMacros: Boolean read write

---

The unique identifier for the client connected to the service. It is equal to the session ID if the session already exists. When the service method is called, this property is already initialized with a proper value. Do not change it unless you know what you are doing!

property ClientID: TGUID read write

---

Returns a live connection to the back-end database based on the configured ConnectionName value. If a connection was previously requested, the same instance will be returned, if a fresh connection to the database couldn't be obtained from the connection manager. Once a connection is acquired, it will be held on until the service gets deactivated, or ReleaseConnection is called.

property Connection: IDAConnection read write

---

Defines the name of the connection that this service will use to connect to the back-end database. If set, all data access done by the service will use the specified connection; if not set, the default connection as defined in connection manager will be used. A typical use case for this property would be to set the connection name in the OnActivate or BeforeAcquireConnection event to match a specific connection, which, for example, could have been stored in the Sessions. The default code provided by the MultiDb Server template uses this approach. When setting ConnectionName and a connection is already acquired, make sure to call the ReleaseConnection method, so that a new connection will be obtained when needed.

property ConnectionName: string read write

---

Points to the event repository (TROEventRepository instance) for the service. The value must be set to use the events feature.

property EventRepository: TROEventRepository read write

---

Enables or disables the legacy events mode for the service. The default value is true. The legacy mode is less secure and it is recommended to set this property to false for new projects. Note that refusing to use the legacy mode will break compatibility with legacy Delphi clients.

property LegacyEvents: Boolean read write

---

Indicates that the client's session was just created, i.e. this indicates the first connection of a so far unknown client.

property NewSession: Boolean read

---

Reference counter - this class is the interfaced object.

property RefCount: Integer read

---

This property should be set to true (perhaps with the designer) to make the service protected and to disallow unauthenticated clients to call its methods. Read more.

property RequiresSession: Boolean read write

---

This property points to the TDASchema component defining the schema that will be published by this service. This can be a schema component located on the service data module or (more typically) on a separate global data module in the server application. Data Abstract uses a 1:1 mapping of services and schemas, where every service publishes one schema. Depending on your application design and the scope of your server, you might only use one schema for the entire data access, or logically partition your data tables across different schemas (and services). Locating the schema on a global data module rather than the service module itself might provide a slight performance benefit, as the schema structure only has to be loaded into memory once (on application startup), not every time a new service instance is created. Also note that the TDAConnectionManager (referenced from the schema) must be located off the service module and in a global location for connection pooling to work properly across service instances.

property ServiceSchema: TDASchema read write

---

Provides access to the session object of the current connection. If the session does not exist, it is created at the moment of property access.

property Session: TROSession read

---

Points to the session manager to use. It is necessary to assign the session manager if the protected service is being developed and/or it is necessary to use the events feature.

property SessionManager: TROCustomSessionManager read write

---

Provides access to the transport object that processes the current network (or other) connection to the server. Various information, such as client IP address, can be available via the transport objects.

property Transport: IROTransport read

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner.

---

Obsolete, replaced by the LegacyEvents property.

function AllowRemoteEventsRegistration: Boolean

---

Copies data from a given source.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Validates ServiceSchema.ConnectionManager property.

procedure CheckForConnectionManager

---

Creates a new session object and makes it available via the Session property. As a rule, there is no need to call this method because the session is created automatically when required.

procedure CreateSession

---

Internal use only, don't override.

function CustomRequireSession(const aMessage: IROMessage): Boolean

Parameters:

• aMessage: Message

---

Destroys the current session object. This method is primarily used to destroy the session in case of unsuccessful client authentication.

procedure DestroySession

---

Destroys default connection.

procedure DoOnDeactivate(aClientID: TGUID)

Parameters:

• aClientID: Client ID

---

Allows to grab the input parameters to get all information about the upcoming call including the remote method parameters and the calling client transport object.

procedure GetDispatchInfo(const aTransport: IROTransport; const aMessage: IROMessage)

Parameters:

• aTransport: Points to the transport object containing connection-specific information
• aMessage: Message that needs to be processed

---

Collects events data to the memory stream. For internal use only, don't call or override.

function GetEventsData(const ClientID: string; out EventsData: Binary): Integer

Parameters:

• ClientID: Client ID
• EventsData: Binary stream that holds the event data

---

Returns true if anObject is retained by Self.

function IsRetained(const anObject: TObject): Boolean

Parameters:

• anObject: Object to check

---

Checks if session is present

function IsSessionPresent: Boolean

---

Provides the actual login procedure.

function LoginEx(const aLoginString: ROUTF8String): Boolean

Parameters:

• aLoginString: String that contains the connection name, user name and password

---

This method performs the log out.

procedure Logout

---

Registers the client to receive server callback events of the specified type.

procedure RegisterEventClient(const aSession: TROSession; const EventTypes: string)

Parameters:

• aSession: Client session
• EventTypes: Identifier (GUID) of the event sink containing the events to subscribe the client to.

---

Registers the client to receive server callback events of the specified type.

procedure RegisterEventClient(const ClientID: string; const EventTypes: string)

Parameters:

• ClientID: Client identifier to subscribe
• EventTypes: Identifier (GUID) of the event sink containing the events to subscribe the client to.

---

Registers the client to receive server callback events of the specified type.

procedure RegisterEventClient(const ClientID: TGUID; const EventTypes: string)

Parameters:

• ClientID: Client identifier to subscribe
• EventTypes: Identifier (GUID) of the event sink containing the events to subscribe the client to.

---

Releases any connection currently acquired in the Connection property.

procedure ReleaseConnection

---

Takes away the hold of anObject set by RetainObject.

procedure ReleaseObject(const anObject: TObject)

Parameters:

• anObject: Object to release

---

Sets the hold of anObject.

procedure RetainObject(const anObject: TObject)

Parameters:

• anObject: Object to hold

---

Validates roles.

procedure ServiceValidateRoles(aRequiredRoles: array of string)

Parameters:

• aRequiredRoles: Roles

---

procedure Synchronize(aMethod: TThreadMethod)

Parameters:

• aMethod:

---

procedure UnregisterEventClient(const aSession: TROSession; const EventTypes: string)

Parameters:

• aSession:
• EventTypes:

---

The action is opposite to RegisterEventClient, it cancels the subscription. Unregistration is not absolutely necessary as the client session dies after some time of inactivity but allows to conserve some system resources.

procedure UnregisterEventClient(const ClientID: string; const EventTypes: string)

Parameters:

• ClientID: Client identifier to unsubscribe
• EventTypes: Identifier (GUID) of the event sink containing the events to unsubscribe the client from.

---

procedure UnregisterEventClient(const ClientID: TGUID; const EventTypes: string)

Parameters:

• ClientID:
• EventTypes:

 

Fired when acquiring a connection failed.

property OnAcquireConnectionFailure: TDAAcquireConnectionFailureEvent read write
delegate:  procedure OnAcquireConnectionFailure(aSender: TObject; const aConnectionName: string; aError: Exception)

---

Called just after the service is created and before any service method is called. Handle this event for everything you need to do when the service instance is created.

property OnActivate: TActivateEvent read write
delegate:  procedure OnActivate(const aClientID: TGUID; aSession: TROSession; const aMessage: IROMessage)

---

Fires right after a new connection is acquired through the Connection property. Use this event to make perform initializations on the new connection, such as opening a transaction, or setting connection options.

property OnAfterAcquireConnection: TDAConnectionAcquiredEvent read write
delegate:  procedure OnAfterAcquireConnection(aSender: TObject; const aConnectionName: string; const aAcquiredConnection: IDAConnection)

---

Fires right after a connection is released.

property OnAfterReleaseConnection: TDAConnectionReleasedEvent read write
delegate:  procedure OnAfterReleaseConnection(aSender: TObject; const aConnectionName: string)

---

Fires just before a new connection is acquired through the Connection property. Use this event to make last-minute configurations before the connection will be acquired, such as changing the ConnectionName.

property OnBeforeAcquireConnection: TDAAcquireConnectionEvent read write
delegate:  procedure OnBeforeAcquireConnection(aSender: TObject; var aConnectionName: string)

---

Called when the new client is being registered to receive events. Deprecated now, since remote event (un-)registration is forbidden (LegacyEvents = false).

property OnBeforeRegisterEventClient: TRegisterEventClientEvent read write
delegate:  procedure OnBeforeRegisterEventClient(const aClientID: TGUID; const EventTypes: string)

---

Fires just before the connection is released. Use this event to perform any finalization tasks on the new connection, such as closing a transaction, or setting connection options.

property OnBeforeReleaseConnection: TDAConnectionAcquiredEvent read write
delegate:  procedure OnBeforeReleaseConnection(aSender: TObject; const aConnectionName: string; const aAcquiredConnection: IDAConnection)

---

Called when the client is being unsubscribed from events. Deprecated now, since remote event (un-)registration is forbidden (LegacyEvents = false).

property OnBeforeUnregisterEventClient: TRegisterEventClientEvent read write
delegate:  procedure OnBeforeUnregisterEventClient(const aClientID: TGUID; const EventTypes: string)

---

Called after the service method completes and before the service instance is freed. Handle this event to perform actions on service destruction, such as disposing of resources.

property OnDeactivate: TDeactivateEvent read write
delegate:  procedure OnDeactivate(const aClientID: TGUID; aSession: TROSession)

---

This event is fired before the invoker executes the service method. Handle this event to preview remote methods about to be executed; the input parameters allow to get all information about the upcoming call including the remote method parameters and the calling client transport object.

property OnGetDispatchInfo: TGetDispatchInfoEvent read write
delegate:  procedure OnGetDispatchInfo(const aTransport: IROTransport; const aMessage: IROMessage)

---

Implement this event handler to provide the actual logout procedure.

property OnLogout: TNotifyEvent read write

---

Fires when unknown macro variable is found. it can be usable when user-defined variables are used inside sql or Dynamic Where expression.

property OnUnknownSqlMacroIdentifier: TOnUnknownIdentifier read write
delegate:  function OnUnknownSqlMacroIdentifier(Sender: TObject; const Name: string; const OrgName: string; var Value: string): Boolean

---

Validates roles.

property OnValidateRoles: TValidateRolesEvent read write
delegate:  procedure OnValidateRoles(aRoles: array of string; var aAllow: Boolean)