Click or drag to resize

MetadataStructureCache Class

A class that provides thread-safe caching features for the metadata structure items. The cache lifetime and validity is controlled from outside of the class.
Inheritance Hierarchy
SystemObject
  MFiles.VAF.MetadataCacheMetadataStructureCache

Namespace:  MFiles.VAF.MetadataCache
Assembly:  MFiles.VAF (in MFiles.VAF.dll) Version: 2.1.0.1 (2.1.0.1)
Syntax
C#
public class MetadataStructureCache : IMetadataStructureCache, 
	IMetadataStructureCacheUpdate

The MetadataStructureCache type exposes the following members.

Constructors
  NameDescription
Public methodMetadataStructureCache
Initializes new metadata structure cache.
Top
Properties
  NameDescription
Public propertyOptions
Flags indicating how the cache should behave.
Top
Methods
  NameDescription
Public methodAddOrUpdateLoginAccount
Adds or updates a user account in the cache.
Public methodAddOrUpdateUserAccount
Adds or updates a user account in the cache.
Public methodAddOrUpdateUserGroupAdmin
Adds or updates a user group in the cache.
Protected methodClearEventDrivenCaches
Clears all event driven caches.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetClassIdByAlias
Fetches the class id from the cache. Populates the cache if necessary.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLogin
Gets the specified login account from the cache.
Public methodGetNamedACLIdByAlias
Fetches the workflow state id from the cache. Populates the cache if necessary.
Public methodGetObjectClassAdmin
Gets the full (admin) object class from the metadata structure cache.
Public methodGetObjectTypeAdmin
Gets the full (admin) object type from the metadata structure cache.
Public methodGetObjectTypeIdByAlias
Fetches the object type id from the cache. Populates the cache if necessary.
Public methodGetObjIDByGuid
Fetches the value list item or object id by guid.
Public methodGetPropertyDefAdmin
Gets the full (admin) property definition from the metadata structure cache.
Public methodGetPropertyDefIdByAlias
Fetches the property def id from the cache. Populates the cache if necessary.
Public methodGetStateAdmin
Gets the full (admin) state data struct.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUser
Gets the user account of the specified user from the cache.
Public methodGetUserGroupAdmin
Gets the specified user group from the cache.
Public methodGetUserGroupIdByAlias
Fetches the user group id from the cache. Populates the cache if necessary.
Public methodGetUserGroupIdByGuid
Gets user group id by guid.
Public methodGetUserIdByGuid
Gets the user id by guid.
Public methodStatic memberGetVaultCache
Gets a new or existing metadata structure cache instance for a specific vault.
Public methodGetWorkflowAdmin
Gets the full (admin) workflow data struct.
Public methodGetWorkflowIdByAlias
Fetches the workflow id from the cache. Populates the cache if necessary.
Public methodGetWorkflowStateIdByAlias
Fetches the workflow state id from the cache. Populates the cache if necessary.
Protected methodInitialize
The initialization method which is called only from the constructor. Rebuilds the cache.
Protected methodInitializeEventDrivenCaches
(Re)Builds caches that are kept up-to-date by vault events. Includes: Users, Groups and Logins
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemoveLoginAccount
Removes the specified login account from the cache.
Public methodRemoveUserAccount
Removes the specified user account from the cache.
Public methodRemoveUserGroup
Removes the specified user group from the cache.
Public methodSetOptions
Change the options that control cache behavior.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Protected fieldclassIdByAlias
Container for cached class aliases.
Protected fieldloginsCache
Container for cached login accounts.
Protected fieldStatic membermetadataStructureCollectionLock
The lock for protecting the metadata structure cache creation.
Protected fieldnamedACLIdByAlias
Container for cached NACL aliases.
Protected fieldobjectClassAdminCache
Container for cached full( admin) object class definitions.
Protected fieldobjectTypeAdminCache
Container for cached full (admin) object type definitions.
Protected fieldobjectTypeIdByAlias
Container for cached object type aliases.
Protected fieldpropertyDefAdminCache
Container for cached full (admin) property definitions.
Protected fieldpropertyDefIdByAlias
Container for cached property definition aliases.
Protected fieldstateAdminCache
Container for cached states.
Protected fielduserGroupAdminCache
Container for cached user groups.
Protected fielduserGroupIdByAlias
Container for cached user group aliases.
Protected fielduserGroupIdByGuid
Maps user group guid to user group id.
Protected fielduserIdByGuid
Maps user guid to user id.
Protected fieldusersCache
Container for cached user accounts.
Protected fieldvalueListItemIDByGuid
Value list items (or objects) by guid.
Protected fieldStatic membervaultCachesByVaultGuid
Collection of the metadata structure caches.
Protected fieldworkflowAdminCache
Container for cached workflows.
Protected fieldworkflowIdByAlias
Container for cached workflow aliases.
Protected fieldworkflowStateIdByAlias
Container for cached state aliases.
Top
See Also