Namespace: Consultingwerk.SmartFramework.Authorization
Class 
AuthorizationClient Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.SmartFramework.Authorization.AuthorizationClient

Inherits: Progress.Lang.Object
Implements: Consultingwerk.SmartFramework.Authorization.IObjectTokenSecurityService, Consultingwerk.SmartFramework.Authorization.IProductSecurityService, Consultingwerk.SmartFramework.Authorization.ITokenSecurityService, Consultingwerk.SmartFramework.Authorization.IToolbarItemSecurityService

File:AuthorizationClient
Purpose:Provides authorization information about tokens etc.
Service for Client and AppServer and Client/Server
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Fri Apr 18 21:36:27 CEST 2014
Notes:Caches information when used on the client

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



Top Method Summary
Options Name Purpose
+ ClearCache () Clears the cache of the SecurityServiceClient
# DetermineUserGuid () Determines the Guid of the current user
+ LONGCHAR GetRestrictedTokens () Returns the comma-delimited list of restricted tokens for the current user
+ Progress.Json.ObjectModel.JsonArray GetRestrictedTokensAsJsonArray () Returns the JsonArray of restricted tokens for the current user
+ LOGICAL IsObjectTokenRestricted (character, character) Returns if the given security token is restricted
+ LOGICAL IsProductRestricted (character) Returns if the given product is restricted
+ LOGICAL IsTokenRestricted (character) Returns if the given security token is restricted
+ LOGICAL IsToolbarItemRestricted (character, character) Returns if the given toolbar item is restricted
# LoginCompanyKeyChangedHandler () Event handler for the LoginCompanyKeyChanged event of the SessionManager class
# UserNameChangedHandler () Event handler for the UserNameChanged event of the SessionManager class

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


Method Detail
Top

PUBLIC ClearCache ()
Purpose: Clears the cache of the SecurityServiceClient
Notes:

Top

PROTECTED DetermineUserGuid ()
Purpose: Determines the Guid of the current user
Notes: Based on the SessionManager:UserName and SessionManager:LoginCompanyKey

Top

PUBLIC LONGCHAR GetRestrictedTokens ()
Purpose: Returns the comma-delimited list of restricted tokens for the current
user
Notes:

Returns LONGCHAR
Comma-delimited list of restricted tokens
Top

PUBLIC Progress.Json.ObjectModel.JsonArray GetRestrictedTokensAsJsonArray ()
Purpose: Returns the JsonArray of restricted tokens for the current
user
Notes:

Returns Progress.Json.ObjectModel.JsonArray
JsonArray with the list of restricted tokens
Top

PUBLIC LOGICAL IsObjectTokenRestricted (character, character)
Purpose: Returns if the given security token is restricted
Notes: When the token is unknown on the current system, the ? is returned
When the object is not known, of the token not assigned to that object,
the ITokenSecurityService:IsTokenRestricted API will be used instead

Parameters:
pcSecurityObjectName CHARACTER
The name of the security object
pcSecurityTokenCode CHARACTER
The code of the security token
Returns LOGICAL
Logical value indicating if the given token is restricted for the current user, TRUE means the user does not have access to the token
Top

PUBLIC LOGICAL IsProductRestricted (character)
Purpose: Returns if the given product is restricted
Notes: When the product is unknown on the current system, the ? is returned

Parameters:
pcProductCode CHARACTER
The code of the product
Returns LOGICAL
Logical value indicating if the given token is restricted for the current user, TRUE means the user does not have access to the product
Top

PUBLIC LOGICAL IsTokenRestricted (character)
Purpose: Returns if the given security token is restricted
Notes: When the token is unknown on the current system, the ? is returned

Parameters:
pcSecurityTokenCode CHARACTER
The code of the security token
Returns LOGICAL
Logical value indicating if the given token is restricted for the current user, TRUE means the user does not have access to the token
Top

PUBLIC LOGICAL IsToolbarItemRestricted (character, character)
Purpose: Returns if the given toolbar item is restricted
Notes: When the toolbar item is unknown on the current system, the security realm default will be returned

Parameters:
pcObjectName CHARACTER
The name of the container or SmartTableIOTarget
pcToolbarItemKey CHARACTER
The name of the toolbar item
Returns LOGICAL
Logical value indicating if the given toolbar item is restricted for the current user, TRUE means the user does not have access to the toolbar item
Top

PROTECTED LoginCompanyKeyChangedHandler ()
Purpose: Event handler for the LoginCompanyKeyChanged event of the SessionManager class
Notes:

Top

PROTECTED UserNameChangedHandler ()
Purpose: Event handler for the UserNameChanged event of the SessionManager class
Notes:



Constructor Detail
Top

PUBLIC AuthorizationClient ()
Purpose: Constructor for the AuthorizationClient class
Notes:



Temp-Table Detail


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 05:56:12