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

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

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ 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
# 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
# OnUserNameChanged () Raises the UserNameChanged event
+ Reset () Resets all Session Manager Properties to their initial values

Top Constructor Summary
Options Name Purpose
- SessionManager () Disallow instance creation

Top Event Summary
Options Name Purpose
+ 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
+ UserNameChanged () Raised when the UserName has changed

Top Property Summary
Options Name Purpose
+ RAW ClientPrincipal Gets and sets the RAW export of the client-principal
+ HANDLE ContextDataset Gets the reference to the current context dataset
+ CHARACTER LanguageDisplayName Gets and sets the Current Language DisplayName
+ CHARACTER LanguageIsoCode Gets and sets the Current Language Iso Code
+ CHARACTER LanguageKey Gets and sets the Current Language Key
+ CHARACTER LoginCompanyImageLarge Gets and sets the key of the large login company image
+ CHARACTER LoginCompanyImageSmall Gets and sets the key of the small login company image
+ CHARACTER LoginCompanyKey Gets and sets the Key of the current login company
+ CHARACTER LoginCompanyName Gets and sets the name of the current login company
+ CHARACTER LoginCompanyReferenceChar Gets and sets the foreign reference character value of the current login company
+ DECIMAL LoginCompanyReferenceDecimal Gets and sets the foreign reference character value of the current login company
+ INTEGER LoginCompanyReferenceInteger Gets and sets the foreign reference character value of the current login company
+ CHARACTER LoginCompanyShortName Gets and sets the short name of the current login company
+ CHARACTER LoginFormClassName Gets and sets the class name of the LoginForm that should be used
+ CHARACTER ServerCustomLogEntries Allows the client to specify the LogManager:CustomLogEntries for the AppServer
+ LOGICAL ServerDebugMode Allows the client to specify the FrameworkSettings:DebugMode for the AppServer
+ CHARACTER ServerLogEntryTypes Allows the client to specify the LOG-MANAGER:LOG-ENTRY-TYPES for the AppServer
+ CHARACTER UserGroupKeys Gets and sets the keys of the UserGroups
+ CHARACTER UserGroupNames Gets and sets the names of the UserGroups
+ CHARACTER UserKey Gets and sets the current user's key value (e.g. SmartUser.UserGuid)
+ CHARACTER UserName Gets and sets the current user name


Method Detail
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 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 OnUserNameChanged ()
Purpose: Raises the UserNameChanged event
Notes:

Top

PUBLIC Reset ()
Purpose: Resets all Session Manager Properties to their initial values
Notes:



Constructor Detail
Top

PRIVATE SessionManager ()
Purpose: Disallow instance creation
Notes:



Event Detail
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 UserNameChanged ()
Purpose: Raised when the UserName has changed
Notes:



Property Detail
Top

PUBLIC RAW ClientPrincipal
Purpose: Gets and sets the RAW export of the client-principal
Notes:

Returns RAW
Top

PUBLIC HANDLE ContextDataset
Purpose: Gets the reference to the current context dataset
Notes: On the backend this dataset is only expected to exist during a
client request. This property is implemented to support a custom
context management strategy. A ProDataset can be shared between
frontend and backend to carry custom context information.

Returns HANDLE
Top

PUBLIC CHARACTER LanguageDisplayName
Purpose: Gets and sets the Current Language DisplayName
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LanguageIsoCode
Purpose: Gets and sets the Current Language Iso Code
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LanguageKey
Purpose: Gets and sets the Current Language Key
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LoginCompanyImageLarge
Purpose: Gets and sets the key of the large login company image
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LoginCompanyImageSmall
Purpose: Gets and sets the key of the small login company image
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LoginCompanyKey
Purpose: Gets and sets the Key of the current login company
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LoginCompanyName
Purpose: Gets and sets the name of the current login company
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LoginCompanyReferenceChar
Purpose: Gets and sets the foreign reference character value of the current login company
Notes:

Returns CHARACTER
Top

PUBLIC DECIMAL LoginCompanyReferenceDecimal
Purpose: Gets and sets the foreign reference character value of the current login company
Notes:

Returns DECIMAL
Top

PUBLIC INTEGER LoginCompanyReferenceInteger
Purpose: Gets and sets the foreign reference character value of the current login company
Notes:

Returns INTEGER
Top

PUBLIC CHARACTER LoginCompanyShortName
Purpose: Gets and sets the short name of the current login company
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LoginFormClassName
Purpose: Gets and sets the class name of the LoginForm that should be used
Notes: The LoginForm should implement the Consultingwerk.Framework.Session.ILoginForm
Interface

Returns CHARACTER
Top

PUBLIC CHARACTER ServerCustomLogEntries
Purpose: Allows the client to specify the LogManager:CustomLogEntries for
the AppServer
Notes: Typically set on the client

Returns CHARACTER
Top

PUBLIC LOGICAL ServerDebugMode
Purpose: Allows the client to specify the FrameworkSettings:DebugMode for
the AppServer
Notes: Typically set on the client

Returns LOGICAL
Top

PUBLIC CHARACTER ServerLogEntryTypes
Purpose: Allows the client to specify the LOG-MANAGER:LOG-ENTRY-TYPES for
the AppServer
Notes: Typically set on the client

Returns CHARACTER
Top

PUBLIC CHARACTER UserGroupKeys
Purpose: Gets and sets the keys of the UserGroups
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER UserGroupNames
Purpose: Gets and sets the names of the UserGroups
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER UserKey
Purpose: Gets and sets the current user's key value (e.g. SmartUser.UserGuid)
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER UserName
Purpose: Gets and sets the current user name
Notes:

Returns CHARACTER


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:29:04