TROOlympiaSessionManager

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner

---

(De)activates the instance as TROEventReceiver.

property Active: Boolean read write

---

Uniquely identifies the running instance of the TROOlympiaSessionManager. Create sets its initial value.

property ApplicationID: TGUID read write

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

The channel used to access the Olympia Server.

property Channel: TROTransportChannel read write

---

Validates the session manager properties.

procedure CheckProperties

---

Checks state of given session.

function CheckSessionIsExpired(aSession: TROSession): Boolean

Parameters:

• aSession: Given session.

---

Checks state of given session or not.

function CheckSessionIsExpired(const aSessionID: TGUID): Boolean

Parameters:

• aSessionID: Session ID

---

internal flag that is set when session are clearing

property Clearing: Boolean read

---

Discards all sessions within the session manager, so that any new call from a client will start with a fresh session.

procedure ClearSessions(OnlyExpired: Boolean)

Parameters:

• OnlyExpired: process only expired sessions or not.

---

Creates a new session with provided ID.

function CreateSession(const aSessionID: TGUID): TROSession

Parameters:

• aSessionID: Session ID

---

Creates internal timer.

procedure CreateTimerByRequest

---

Deletes the session with specified ID.

procedure DeleteSession(const aSessionID: TGUID; IsExpired: Boolean)

Parameters:

• aSessionID: Session ID
• IsExpired: current state of session

---

Deletes the temporary session.

procedure DeleteTemporarySession(var Session: TROSession)

Parameters:

• Session: given session.

---

Discards all sessions within the session manager, so that any new call from a client will start with a fresh session.

procedure DoClearSessions(OnlyExpired: Boolean)

Parameters:

• OnlyExpired: process only expired sessions or not.

---

Creates a new session with provided ID.

function DoCreateSession(const aSessionID: TGUID): TROSession

Parameters:

• aSessionID: Session ID

---

Deletes the session with specified ID.

procedure DoDeleteSession(const aSessionID: TGUID; IsExpired: Boolean)

Parameters:

• aSessionID: Session ID
• IsExpired: current state of session

---

Tries to use the IOlympiaSessionManager to retrieve an OlympiaUserSession and, if succeeded, converts it into a TROSession.

function DoFindSession(const aSessionID: TGUID; aUpdateTime: Boolean): TROSession

Parameters:

• aSessionID: Sought session
• aUpdateTime: Ignored

---

Call the IOlympiaSessionManager and returns its result as a TStringList.

procedure DoGetAllSessions(Dest: TStringList)

Parameters:

• Dest: Result list

---

Returns the session count.

function DoGetSessionCount: Integer

---

Notifies attached listeners about changes

procedure DoNotifySessionsChangesListener(const aSessionID: TGUID; aSessionAction: TROSessionsActions; Sender: TObject)

Parameters:

• aSessionID: Session ID
• aSessionAction: action
• Sender: sender

---

Adds aSession into the sessionlist (while the SessionManager.NewSession creates an aSession, but does not add it into sessionlist). Using this method, the user can create a session in the Service.Login and destroy it with the Service.DestroySession in the same method. Sessions will only be created if the Login Method was successful.

procedure DoReleaseSession(aSession: TROSession; NewSession: Boolean)

Parameters:

• aSession: Session to process
• NewSession: If true, the SessionManager.CreateSession will be used, otherwise the SessionManager.

---

Clears expired sessions.

procedure DoTimerTick(CurrentTickCount: Cardinal)

Parameters:

• CurrentTickCount: ignored

---

property EnableLightweightSessions: Boolean read write

---

Read-only access to the EventReceiver component.

property EventReceiver: TROEventReceiver read

---

Finds session with the specified GUID

function FindSession(const aSessionID: TGUID; aUpdateTime: Boolean): TROSession

Parameters:

• aSessionID: Session ID.
• aUpdateTime: Update LastAccess of found session or not

---

function GetAllSessions: TROSessionIDs

---

Returns a string list containing the IDs of all currently active sessions. Depending on the session manager and on your application architecture, this list can be huge, especially when using a database based session list that is shared by a large server farm. Obtaining the full list of sessions can be a costly process.

procedure GetAllSessions(Dest: TStringList)

Parameters:

• Dest: destination

---

Returns the session count.

function GetSessionCount: Integer

---

function IsSessionPresent(const aSessionID: TGUID): Boolean

Parameters:

• aSessionID:

---

Kills internal timer

procedure KillTimer

---

procedure LockForReading

---

procedure LockForWriting

---

Specifies the maximum number of sessions that will be allowed. -1 (the default) indicates that no limit on number of sessions will be enforced. Allowing a server to run without enforcing any limit on the number of sessions might pose a security risk, as malicious clients could theoretically start an infinite number of sessions by performing repeated requests with changing Client IDs, until server memory is depleted. You should make sure to either set a limit, or tie session creation to user authentication, so that only valid client users can obtain a session(and possibly only one session per login).

property MaxSessions: Integer read write

---

Forwards notification messages to all owned components.

procedure Notification(AComponent: TComponent; Operation: TOperation)

Parameters:

• AComponent: component
• Operation: operation

---

Fires before deleting session.

property OnBeforeDeleteSession: TDeleteSessionEvent read write
delegate:  procedure OnBeforeDeleteSession(const aSessionID: TGUID; IsExpired: Boolean)

---

Fires before the session is created. It allows to return existing session for given session ID

property OnCustomCreateSession: TROCustomSessionCreationEvent read write
delegate:  procedure OnCustomCreateSession(const aSessionID: TGUID; var Session: TROSession)

---

Fires when an exception is occuring

property OnException: TROSessionExceptionEvent read write
delegate:  procedure OnException(aSessionID: TGUID; anException: Exception; var aRetry: Boolean)

---

Fires when maximum count of allowed sessions is reached

property OnMaxSessionsReached: TROMaxSessionsReachedEvent read write
delegate:  procedure OnMaxSessionsReached(var aFail: Boolean)

---

Gets triggered after a new Session has been created. You can use it to perform initialization functions or fill the session with default values.

property OnSessionCreated: TSessionEvent read write
delegate:  procedure OnSessionCreated(const aSession: TROSession)

---

Hides the TROCustomSessionManager property as protected.

property OnSessionDeleted: TDeleteSessionEvent read write

---

Attaches a new IROSessionsChangesListener listener.

procedure RegisterSessionsChangesListener(aListener: IROSessionsChangesListener)

Parameters:

• aListener: New listener

---

Releases the previously acquired session.

procedure ReleaseSession(var aSession: TROSession; NewSession: Boolean)

Parameters:

• aSession: given session
• NewSession: newly created session or not

---

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Internal for checking session in minutes. default value is 15 minutes.

property SessionCheckInterval: Integer read write

---

The time, in minutes, that sessions will persist before timing out (default is 15 minutes).The timeout for each individual session will be reset every time the session is accessed; after SessionDuration minutes have passed without access to the session, it will be discarded. The exact handling of the timeout processing depends on the implementation of the specific session manager, which might check session timeouts at intervals. Therefore, sessions might live slightly longer then the specified timeout.

property SessionDuration: Integer read write

---

Returns a new instance of the IOlympiaSessionManager.

property SessionManager: IOlympiaSessionManager read

---

Calls DeleteSession to each item of aExpiredSessionIDs.

procedure SessionsExpired(const aExpiredSessionIDs: GuidArray)

Parameters:

• aExpiredSessionIDs: list of expired ID

---

function ShouldNotifySessionsChanges: Boolean

---

function TestLastAccess(const aLastAccess: TDateTime): Boolean

Parameters:

• aLastAccess:

---

procedure UnlockForReading

---

procedure UnlockForWriting

---

Detaches a previously attached aListener.

procedure UnRegisterSessionsChangesListener(aListener: IROSessionsChangesListener)

Parameters:

• aListener: Known listener

 

(De)activates the instance as TROEventReceiver.

property Active: Boolean read write

---

Uniquely identifies the running instance of the TROOlympiaSessionManager. Create sets its initial value.

property ApplicationID: TGUID read write

---

The channel used to access the Olympia Server.

property Channel: TROTransportChannel read write

---

internal flag that is set when session are clearing

property Clearing: Boolean read

---

property EnableLightweightSessions: Boolean read write

---

Read-only access to the EventReceiver component.

property EventReceiver: TROEventReceiver read

---

Specifies the maximum number of sessions that will be allowed. -1 (the default) indicates that no limit on number of sessions will be enforced. Allowing a server to run without enforcing any limit on the number of sessions might pose a security risk, as malicious clients could theoretically start an infinite number of sessions by performing repeated requests with changing Client IDs, until server memory is depleted. You should make sure to either set a limit, or tie session creation to user authentication, so that only valid client users can obtain a session(and possibly only one session per login).

property MaxSessions: Integer read write

---

Hides the TROCustomSessionManager property as protected.

property OnSessionDeleted: TDeleteSessionEvent read write

---

Internal for checking session in minutes. default value is 15 minutes.

property SessionCheckInterval: Integer read write

---

The time, in minutes, that sessions will persist before timing out (default is 15 minutes).The timeout for each individual session will be reset every time the session is accessed; after SessionDuration minutes have passed without access to the session, it will be discarded. The exact handling of the timeout processing depends on the implementation of the specific session manager, which might check session timeouts at intervals. Therefore, sessions might live slightly longer then the specified timeout.

property SessionDuration: Integer read write

---

Returns a new instance of the IOlympiaSessionManager.

property SessionManager: IOlympiaSessionManager read

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Validates the session manager properties.

procedure CheckProperties

---

Checks state of given session.

function CheckSessionIsExpired(aSession: TROSession): Boolean

Parameters:

• aSession: Given session.

---

Checks state of given session or not.

function CheckSessionIsExpired(const aSessionID: TGUID): Boolean

Parameters:

• aSessionID: Session ID

---

Discards all sessions within the session manager, so that any new call from a client will start with a fresh session.

procedure ClearSessions(OnlyExpired: Boolean)

Parameters:

• OnlyExpired: process only expired sessions or not.

---

Creates a new session with provided ID.

function CreateSession(const aSessionID: TGUID): TROSession

Parameters:

• aSessionID: Session ID

---

Creates internal timer.

procedure CreateTimerByRequest

---

Deletes the session with specified ID.

procedure DeleteSession(const aSessionID: TGUID; IsExpired: Boolean)

Parameters:

• aSessionID: Session ID
• IsExpired: current state of session

---

Deletes the temporary session.

procedure DeleteTemporarySession(var Session: TROSession)

Parameters:

• Session: given session.

---

Discards all sessions within the session manager, so that any new call from a client will start with a fresh session.

procedure DoClearSessions(OnlyExpired: Boolean)

Parameters:

• OnlyExpired: process only expired sessions or not.

---

Creates a new session with provided ID.

function DoCreateSession(const aSessionID: TGUID): TROSession

Parameters:

• aSessionID: Session ID

---

Deletes the session with specified ID.

procedure DoDeleteSession(const aSessionID: TGUID; IsExpired: Boolean)

Parameters:

• aSessionID: Session ID
• IsExpired: current state of session

---

Tries to use the IOlympiaSessionManager to retrieve an OlympiaUserSession and, if succeeded, converts it into a TROSession.

function DoFindSession(const aSessionID: TGUID; aUpdateTime: Boolean): TROSession

Parameters:

• aSessionID: Sought session
• aUpdateTime: Ignored

---

Call the IOlympiaSessionManager and returns its result as a TStringList.

procedure DoGetAllSessions(Dest: TStringList)

Parameters:

• Dest: Result list

---

Returns the session count.

function DoGetSessionCount: Integer

---

Notifies attached listeners about changes

procedure DoNotifySessionsChangesListener(const aSessionID: TGUID; aSessionAction: TROSessionsActions; Sender: TObject)

Parameters:

• aSessionID: Session ID
• aSessionAction: action
• Sender: sender

---

Adds aSession into the sessionlist (while the SessionManager.NewSession creates an aSession, but does not add it into sessionlist). Using this method, the user can create a session in the Service.Login and destroy it with the Service.DestroySession in the same method. Sessions will only be created if the Login Method was successful.

procedure DoReleaseSession(aSession: TROSession; NewSession: Boolean)

Parameters:

• aSession: Session to process
• NewSession: If true, the SessionManager.CreateSession will be used, otherwise the SessionManager.

---

Clears expired sessions.

procedure DoTimerTick(CurrentTickCount: Cardinal)

Parameters:

• CurrentTickCount: ignored

---

Finds session with the specified GUID

function FindSession(const aSessionID: TGUID; aUpdateTime: Boolean): TROSession

Parameters:

• aSessionID: Session ID.
• aUpdateTime: Update LastAccess of found session or not

---

function GetAllSessions: TROSessionIDs

---

Returns a string list containing the IDs of all currently active sessions. Depending on the session manager and on your application architecture, this list can be huge, especially when using a database based session list that is shared by a large server farm. Obtaining the full list of sessions can be a costly process.

procedure GetAllSessions(Dest: TStringList)

Parameters:

• Dest: destination

---

Returns the session count.

function GetSessionCount: Integer

---

function IsSessionPresent(const aSessionID: TGUID): Boolean

Parameters:

• aSessionID:

---

Kills internal timer

procedure KillTimer

---

procedure LockForReading

---

procedure LockForWriting

---

Forwards notification messages to all owned components.

procedure Notification(AComponent: TComponent; Operation: TOperation)

Parameters:

• AComponent: component
• Operation: operation

---

Attaches a new IROSessionsChangesListener listener.

procedure RegisterSessionsChangesListener(aListener: IROSessionsChangesListener)

Parameters:

• aListener: New listener

---

Releases the previously acquired session.

procedure ReleaseSession(var aSession: TROSession; NewSession: Boolean)

Parameters:

• aSession: given session
• NewSession: newly created session or not

---

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Calls DeleteSession to each item of aExpiredSessionIDs.

procedure SessionsExpired(const aExpiredSessionIDs: GuidArray)

Parameters:

• aExpiredSessionIDs: list of expired ID

---

function ShouldNotifySessionsChanges: Boolean

---

function TestLastAccess(const aLastAccess: TDateTime): Boolean

Parameters:

• aLastAccess:

---

procedure UnlockForReading

---

procedure UnlockForWriting

---

Detaches a previously attached aListener.

procedure UnRegisterSessionsChangesListener(aListener: IROSessionsChangesListener)

Parameters:

• aListener: Known listener

 

Fires before deleting session.

property OnBeforeDeleteSession: TDeleteSessionEvent read write
delegate:  procedure OnBeforeDeleteSession(const aSessionID: TGUID; IsExpired: Boolean)

---

Fires before the session is created. It allows to return existing session for given session ID

property OnCustomCreateSession: TROCustomSessionCreationEvent read write
delegate:  procedure OnCustomCreateSession(const aSessionID: TGUID; var Session: TROSession)

---

Fires when an exception is occuring

property OnException: TROSessionExceptionEvent read write
delegate:  procedure OnException(aSessionID: TGUID; anException: Exception; var aRetry: Boolean)

---

Fires when maximum count of allowed sessions is reached

property OnMaxSessionsReached: TROMaxSessionsReachedEvent read write
delegate:  procedure OnMaxSessionsReached(var aFail: Boolean)

---

Gets triggered after a new Session has been created. You can use it to perform initialization functions or fill the session with default values.

property OnSessionCreated: TSessionEvent read write
delegate:  procedure OnSessionCreated(const aSession: TROSession)