|
User
|
Represents a secured inter-process cache for a DictionaryTKey, TValue of serialized user role information.
Inheritance Hierarchy
Namespace: GSF.Security
Assembly: GSF.Security (in GSF.Security.dll) Version: 2.4.257-beta
Syntaxpublic class UserRoleCache : InterprocessCache
The UserRoleCache type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | UserRoleCache | Creates a new instance of the UserRoleCache with the specified number of maximumConcurrentLocks. |
Properties| Name | Description | |
|---|---|---|
 | AutoSave |
Gets or sets flag that determines if InterprocessCache should automatically initiate a save when FileData has been updated.
(Inherited from InterprocessCache) |
| FileData |
Gets or sets file data for the cache to be saved or that has been loaded.
(Inherited from InterprocessCache) |
| FileName |
Path and file name for the cache needing inter-process synchronization.
(Inherited from InterprocessCache) |
| Item | Gets or sets access roles for given userName. |
| MaximumConcurrentLocks |
Gets the maximum concurrent reader locks allowed.
(Inherited from InterprocessCache) |
| MaximumRetryAttempts |
Maximum retry attempts allowed for loading or saving cache file data.
(Inherited from InterprocessCache) |
| ReloadOnChange |
Gets or sets flag that enables system to monitor for changes in FileName and automatically reload FileData.
(Inherited from InterprocessCache) |
| RetryDelayInterval |
Wait interval, in milliseconds, before retrying load or save of cache file data.
(Inherited from InterprocessCache) |
| UserRoles | Gets a copy of the internal user role dictionary. |
Methods| Name | Description | |
|---|---|---|
| Dispose |
Releases all the resources used by the InterprocessCache object.
(Inherited from InterprocessCache) |
 | Dispose(Boolean) |
Releases the unmanaged resources used by the InterprocessCache object and optionally releases the managed resources.
(Inherited from InterprocessCache) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize |
Releases the unmanaged resources before the InterprocessCache object is reclaimed by GC.
(Inherited from InterprocessCache) |
 | GetCurrentCache | Loads the UserRoleCache for the current local user. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| HashLoginID | Calculates the hash of the userName used as the key for the user roles dictionary. |
| Load |
Initiates inter-process synchronized cache file load.
(Inherited from InterprocessCache) |
| LoadFileData |
Handles deserialization of file from disk; virtual method allows customization (e.g., pre-load decryption and/or data merge).
(Overrides InterprocessCacheLoadFileData(FileStream)) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MergeLeft | Merge user roles from another UserRoleCache, local cache taking precedence. |
| MergeRight | Merge user roles from another UserRoleCache, other cache taking precedence. |
| Save |
Initiates inter-process synchronized save of user role cache.
(Overrides InterprocessCacheSave) |
| SaveFileData |
Handles serialization of file to disk; virtual method allows customization (e.g., pre-save encryption and/or data merge).
(Overrides InterprocessCacheSaveFileData(FileStream, Byte)) |
| SaveUserRole | Serializes the roles for the given userName into the UserRoleCache. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryGetUserRole | Attempts to retrieve access role for given userName. |
| WaitForLoad |
Blocks current thread and waits for any pending load to complete; wait time is RetryDelayInterval * MaximumRetryAttempts.
(Inherited from InterprocessCache) |
| WaitForLoad(Int32) |
Blocks current thread and waits for specified millisecondsTimeout for any pending load to complete.
(Inherited from InterprocessCache) |
| WaitForSave |
Blocks current thread and waits for any pending save to complete; wait time is RetryDelayInterval * MaximumRetryAttempts.
(Inherited from InterprocessCache) |
| WaitForSave(Int32) |
Blocks current thread and waits for specified millisecondsTimeout for any pending save to complete.
(Inherited from InterprocessCache) |
Extension Methods| Name | Description | |
|---|---|---|
 | GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
| GetEnumValueOrDefaultT |
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
Remarks
This is a system cache that contains the role assignments for each user that has logged in successfully. This cache is used
to check for changes in role assignments for a user - that is, a role change in the database that may now be different than
what is in the current cache. Any kind of role changes are logged as security events in the Windows event log for auditing.
Note that this is kept as a separate cache from the AdoSecurityCache since the user role cache is used for
auditing and contains information relative to a user's roles at last login.
See Also