Namespace: Consultingwerk.Framework.Session
Class 
SessionManager Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object

File:SessionManager
Purpose:Static class that manages session and authentication
properties
Description:The method SessionManager:LogSessionManagerProperties
requires the "SessionManager" custom LogEntryType activated
within the LogManager
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Mon Nov 15 22:47:24 CET 2010



Top Method Summary
Options Name Purpose
+ DetermineUserGroupAssignments () Determines the user group assignments of the current user/login company
+ CHARACTER GetSessionId () Return a suitable SessionId from any session
+ LOGICAL Login (IUserCredentials) Performs the application login
+ Login (Form, logical) Performs the application login
+ Login (logical) Performs the application login
+ LogSessionManagerProperties () Writes the current SessionManager properties to the log file
# OnAfterLogin () Raises the AfterLogin event
# OnAfterShowLoginDialog () Raises the AfterShowLoginDialog event
# OnBeforeLogin (BeforeLoginEventArgs) Raises the BeforeShowLoginDialog event
# OnBeforeShowLoginDialog (CancelableEventArgs) Raises the BeforeShowLoginDialog event
# OnLanguageDisplayNameChanged () Raises the LanguageDisplayNameChanged event
# OnLanguageIsoCodeChanged () Raises the LanguageDisplayNameChanged event
# OnLanguageKeyChanged () Raises the LanguageDisplayNameChanged event
# OnLoginCompanyKeyChanged () Raises the LoginCompanyKeyChanged event
# OnLoginCompanyNameChanged () Raises the LoginCompanyNameChanged event
# OnLoginCompleted () Raises the LoginCompleted event
# OnProcessingDateChanged () Raises the ProcessingDateChanged event
# OnUserNameChanged () Raises the UserNameChanged event
+ Reset () Resets all Session Manager Properties to their initial values

Top Constructor Summary
Options Name Purpose
SessionManager () Static constructor for the SessionManager class
- SessionManager () Disallow instance creation

Top Event Summary
Options Name Purpose
+ AfterLogin () Raised after the user credentials are validated
+ AfterShowLoginDialog () Raised after the GUI login Dialog is shown
+ BeforeLogin (BeforeLoginEventArgs) Raised before the user credentials are validated
+ BeforeShowLoginDialog (CancelableEventArgs) Raised before the GUI login Dialog is shown
+ LanguageDisplayNameChanged () Raised when the DisplayLanguage Changes
+ LanguageIsoCodeChanged () Raised when the Language Iso Code Changes
+ LanguageKeyChanged () Raised when the Language Key Changes
+ LoginCompanyKeyChanged () Raised when the LoginCompanyKey has changed
+ LoginCompanyNameChanged () Raised when the LoginCompanyName has changed
+ LoginCompleted () Raised when the Login has completed
+ ProcessingDateChanged () Raised when the ProcessingDate has changed
+ UserNameChanged () Raised when the UserName has changed

Top Property Summary
Options Name Purpose
+ RAW ClientPrincipal
+ HANDLE ContextDataset
+ Consultingwerk.Framework.Session.ContextDatasetOriginEnum ContextDatasetOrigin
+ CHARACTER LanguageDisplayName
+ CHARACTER LanguageIsoCode
+ CHARACTER LanguageKey
+ CHARACTER LoginCompanyImageLarge
+ CHARACTER LoginCompanyImageSmall
+ CHARACTER LoginCompanyKey
+ CHARACTER LoginCompanyName
+ CHARACTER LoginCompanyReferenceChar
+ DECIMAL LoginCompanyReferenceDecimal
+ INTEGER LoginCompanyReferenceInteger
+ CHARACTER LoginCompanyShortName
+ LOGICAL LoginFormAllowStorePassword
+ CHARACTER LoginFormClassName
+ LOGICAL LoginFormShowProcessingDate
+ DATE ProcessingDate
+ CHARACTER RestrictedTokens
+ CHARACTER ServerCustomLogEntries
+ LOGICAL ServerDebugMode
+ CHARACTER ServerLogEntryTypes
- CHARACTER SessionId
+ CHARACTER UserEmail
+ CHARACTER UserFullName
+ CHARACTER UserGroupKeys
+ CHARACTER UserGroupNames
+ CHARACTER UserKey
+ CHARACTER UserName


Method Detail
Top

PUBLIC DetermineUserGroupAssignments ()

Purpose: Determines the user group assignments of the current user/login company
Notes: Assigns SessionManager UserGroupKeys and UserGroupNames properties

Top

PUBLIC CHARACTER GetSessionId ()

Purpose: Return a suitable SessionId from any session
Notes: Typically used for logical application locks

Returns CHARACTER
A session identifier.
Top

PUBLIC LOGICAL Login (IUserCredentials)

Purpose: Performs the application login
Notes: Actual Login routine including

Parameters:
poUserCredentials Consultingwerk.Framework.IUserCredentials
The IUserCredentials with the data for this method
Returns LOGICAL
Logical value indicating the success of the operation
Top

PUBLIC Login (Form, logical)

Purpose: Performs the application login
Notes: Shows the Login Dialog

Parameters:
poParent System.Windows.Forms.Form
The parent Form for the Login Dialog
lOk LOGICAL
OUTPUT Logical value indicating if login was successful
Top

PUBLIC Login (logical)

Purpose: Performs the application login
Notes: Shows the Login Dialog

Parameters:
plOk LOGICAL
OUTPUT Logical value indicating if login was successful
Top

PUBLIC LogSessionManagerProperties ()

Purpose: Writes the current SessionManager properties to the log file
Notes: The method requires the "SessionManager" custom LogEntryType activated
within the LogManager

Top

PROTECTED OnAfterLogin ()

Purpose: Raises the AfterLogin event
Notes:

Top

PROTECTED OnAfterShowLoginDialog ()

Purpose: Raises the AfterShowLoginDialog event
Notes:

Top

PROTECTED OnBeforeLogin (BeforeLoginEventArgs)

Purpose: Raises the BeforeShowLoginDialog event
Notes:

Parameters:
e Consultingwerk.Framework.Session.BeforeLoginEventArgs
The BeforeLoginEventArgs with the data for the event
Top

PROTECTED OnBeforeShowLoginDialog (CancelableEventArgs)

Purpose: Raises the BeforeShowLoginDialog event
Notes:

Parameters:
e Consultingwerk.CancelableEventArgs
The CancelEventArgs with the data for the event
Top

PROTECTED OnLanguageDisplayNameChanged ()

Purpose: Raises the LanguageDisplayNameChanged event
Notes:

Top

PROTECTED OnLanguageIsoCodeChanged ()

Purpose: Raises the LanguageDisplayNameChanged event
Notes:

Top

PROTECTED OnLanguageKeyChanged ()

Purpose: Raises the LanguageDisplayNameChanged event
Notes:

Top

PROTECTED OnLoginCompanyKeyChanged ()

Purpose: Raises the LoginCompanyKeyChanged event
Notes:

Top

PROTECTED OnLoginCompanyNameChanged ()

Purpose: Raises the LoginCompanyNameChanged event
Notes:

Top

PROTECTED OnLoginCompleted ()

Purpose: Raises the LoginCompleted event
Notes:

Top

PROTECTED OnProcessingDateChanged ()

Purpose: Raises the ProcessingDateChanged event
Notes:

Top

PROTECTED OnUserNameChanged ()

Purpose: Raises the UserNameChanged event
Notes:

Top

PUBLIC Reset ()

Purpose: Resets all Session Manager Properties to their initial values
Notes:



Constructor Detail
Top

STATIC SessionManager ()

Purpose: Static constructor for the SessionManager class
Notes:

Top

PRIVATE SessionManager ()

Purpose: Disallow instance creation
Notes:



Event Detail
Top

PUBLIC AfterLogin ()

Purpose: Raised after the user credentials are validated
Notes:

Top

PUBLIC AfterShowLoginDialog ()

Purpose: Raised after the GUI login Dialog is shown
Notes:

Top

PUBLIC BeforeLogin (BeforeLoginEventArgs)

Purpose: Raised before the user credentials are validated
Notes:

Parameters:
e Consultingwerk.Framework.Session.BeforeLoginEventArgs
The BeforeLoginEventArgs with the data for the event
Top

PUBLIC BeforeShowLoginDialog (CancelableEventArgs)

Purpose: Raised before the GUI login Dialog is shown
Notes:

Parameters:
e Consultingwerk.CancelableEventArgs
The CancelEventArgs with the data for the event
Top

PUBLIC LanguageDisplayNameChanged ()

Purpose: Raised when the DisplayLanguage Changes
Notes:

Top

PUBLIC LanguageIsoCodeChanged ()

Purpose: Raised when the Language Iso Code Changes
Notes:

Top

PUBLIC LanguageKeyChanged ()

Purpose: Raised when the Language Key Changes
Notes:

Top

PUBLIC LoginCompanyKeyChanged ()

Purpose: Raised when the LoginCompanyKey has changed
Notes:

Top

PUBLIC LoginCompanyNameChanged ()

Purpose: Raised when the LoginCompanyName has changed
Notes:

Top

PUBLIC LoginCompleted ()

Purpose: Raised when the Login has completed
Notes:

Top

PUBLIC ProcessingDateChanged ()

Purpose: Raised when the ProcessingDate has changed
Notes:

Top

PUBLIC UserNameChanged ()

Purpose: Raised when the UserName has changed
Notes:



Property Detail
Top

PUBLIC RAW ClientPrincipal


Returns RAW
Top

PUBLIC HANDLE ContextDataset


Returns HANDLE
Top

PUBLIC Consultingwerk.Framework.Session.ContextDatasetOriginEnum ContextDatasetOrigin


Returns Consultingwerk.Framework.Session.ContextDatasetOriginEnum
Top

PUBLIC CHARACTER LanguageDisplayName


Returns CHARACTER
Top

PUBLIC CHARACTER LanguageIsoCode


Returns CHARACTER
Top

PUBLIC CHARACTER LanguageKey


Returns CHARACTER
Top

PUBLIC CHARACTER LoginCompanyImageLarge


Returns CHARACTER
Top

PUBLIC CHARACTER LoginCompanyImageSmall


Returns CHARACTER
Top

PUBLIC CHARACTER LoginCompanyKey


Returns CHARACTER
Top

PUBLIC CHARACTER LoginCompanyName


Returns CHARACTER
Top

PUBLIC CHARACTER LoginCompanyReferenceChar


Returns CHARACTER
Top

PUBLIC DECIMAL LoginCompanyReferenceDecimal


Returns DECIMAL
Top

PUBLIC INTEGER LoginCompanyReferenceInteger


Returns INTEGER
Top

PUBLIC CHARACTER LoginCompanyShortName


Returns CHARACTER
Top

PUBLIC LOGICAL LoginFormAllowStorePassword


Returns LOGICAL
Top

PUBLIC CHARACTER LoginFormClassName


Returns CHARACTER
Top

PUBLIC LOGICAL LoginFormShowProcessingDate


Returns LOGICAL
Top

PUBLIC DATE ProcessingDate


Returns DATE
Top

PUBLIC CHARACTER RestrictedTokens


Returns CHARACTER
Top

PUBLIC CHARACTER ServerCustomLogEntries


Returns CHARACTER
Top

PUBLIC LOGICAL ServerDebugMode


Returns LOGICAL
Top

PUBLIC CHARACTER ServerLogEntryTypes


Returns CHARACTER
Top

PRIVATE CHARACTER SessionId


Returns CHARACTER
Top

PUBLIC CHARACTER UserEmail


Returns CHARACTER
Top

PUBLIC CHARACTER UserFullName


Returns CHARACTER
Top

PUBLIC CHARACTER UserGroupKeys


Returns CHARACTER
Top

PUBLIC CHARACTER UserGroupNames


Returns CHARACTER
Top

PUBLIC CHARACTER UserKey


Returns CHARACTER
Top

PUBLIC CHARACTER UserName


Returns CHARACTER


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       24.05.2022 19:15:05