Namespace: Consultingwerk.Framework.Server
Class 
RestServerSessionActivator Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Framework.Server.RestServerSessionActivator

Inherits: Progress.Lang.Object

File:RestServerSessionActivator
Purpose:Performs session activation for REST requests
Description:Requires SmartFramework
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Jan 16 11:32:03 CET 2016
Notes:Although in our default setup this class is loaded as a
service using services.xml there is no need to implement
an interface. This class subscribes itself to events of
the service interface and does not have any public methods
Supports the VALIDATE-SEAL custom logging entry with the
logging level 2 for status messages only and 4 for detailed
debug output

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
# ActivateServerSession (EventArgs) Activates a server session
# DeactivateServerSession (EventArgs) Deactivates a server session
# HANDLE GetClientPrincipal () Returns the current client-principal object
# CHARACTER GetDomainName (handle) Returns the Domain Name of the client-principal
# CHARACTER GetSessionId (handle) Returns the Session ID of the client-principal
# CHARACTER GetUserId (handle) Returns the User ID of the client-principal

Top Constructor Summary
Options Name Purpose
+ RestServerSessionActivator () Constructor for the ServerSessionActivator class

Top Property Summary
Options Name Purpose
+ LOGICAL SetDbClient


Method Detail
Top

PROTECTED ActivateServerSession (EventArgs)
Purpose: Activates a server session
Notes:

Parameters:
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for this event
Top

PROTECTED DeactivateServerSession (EventArgs)
Purpose: Deactivates a server session
Notes:

Parameters:
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for this event
Top

PROTECTED HANDLE GetClientPrincipal ()
Purpose: Returns the current client-principal object
Notes: Method may be overridden to return a client-principal object
from a custom source. This implementation returns
SESSION:CURRENT-REQUEST-INFO:GetClientPrincipal() CURRENT-REQUEST-INFO:GetClientPrincipal()

Returns HANDLE
The handle of the client-principal object
Top

PROTECTED CHARACTER GetDomainName (handle)
Purpose: Returns the Domain Name of the client-principal
Notes: Allows overriding of the retrieval of the Domain Name

Parameters:
phPrincipal HANDLE
The current client-principal instance
Returns CHARACTER
The Domain Name Value
Top

PROTECTED CHARACTER GetSessionId (handle)
Purpose: Returns the Session ID of the client-principal
Notes: Allows overriding of the retrieval of the SessionId

Parameters:
phPrincipal HANDLE
The current client-principal instance
Returns CHARACTER
The Session ID Value
Top

PROTECTED CHARACTER GetUserId (handle)
Purpose: Returns the User ID of the client-principal
Notes: Allows overriding of the retrieval of the User ID

Parameters:
phPrincipal HANDLE
The current client-principal instance
Returns CHARACTER
The User ID Value


Constructor Detail
Top

PUBLIC RestServerSessionActivator ()
Purpose: Constructor for the ServerSessionActivator class
Notes:



Property Detail
Top

PUBLIC LOGICAL SetDbClient

Returns LOGICAL


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2024 18:37:20