VaultApplicationBase Class

Vault application entry point

Definition

Namespace: MFiles.VAF
Assembly: MFiles.VAF (in MFiles.VAF.dll) Version: 24.1.706.1
C#
public class VaultApplicationBase : MethodSource, 
	IVaultApplication
Inheritance
Object    MethodSource    VaultApplicationBase
Derived
Implements
IVaultApplication

Constructors

VaultApplicationBase Constructor.

Properties

AdminConfigurationsManager Admin Configuration Manager to handle the wire-up between M-Files Admin and Dashboard Nodes.
ApplicationDefinition The application definition information.
ApplicationRunningStatus Returns the application running status. Indicates if the application is starting, stopping or running normally.
AuthenticationData The optional authentication data for the application.
AvailabilityGroupStatusWriter Multi-server availability group status reporter.
BackgroundOperations A manager for creating background operations.
ConfigurationStorage The configuration storage object.
EventSourceIdentifier Returns the vault application event source identifier that is used when logging to Windows event log.
ExecutionTracer The execution tracer object.
InitialLoadComplete True after the Initialize() method has been executed.
KillProcessOnStartOperationsException  
License The optional license of the application. Set this in inherited class constructor to get license.
LogContextHelper  
MetadataStructureValidationResult The results from the metadata structure validation.
MetadataStructureValidator The metadata structure validator object.
PermanentVault The permanent vault object, runs as MFServer user.
TaskManager  
TaskQueueResolver  
ValidationRecursionLimit The number of levels the valdiator is allowed to traverse before throwing an exception. This value protects against infinite recursion loops, but may need to be increased for applications with deeply nested configuration settings. Note: Using some built-in types may significantly increase the configuration depth, like SearchConditionsJA.

Methods

AddVaultExtensionMethod Adds a vault extension method that does not have a separate event handler proxy.
AnonymousExtensionMethodsSupported  
AssertApplicationInStableState Throws an exception if the application is in a state where it cannot properly handle server events.
ClearAutomaticallyGeneratedScripts Clears the automatically generated scripts that are no longer used from the metadata structure (from property definitions and workflow states).
CollectUnusedHandlers Method for collecting extension method names which are unused.
ConvertToLocalVault Overridable factory method for local vault objects. Converts the vault object to locally used and possibly stored vault object. This method allows the implementations to improve the performance by using in-process vault. Overriding functionality may e.g. implement local caching features to the vault.
CreateAdminConfigurationManager Overridable factory method to create the admin configuration manager object.
CreateConfigurationStorage Overridable factory method to create the configuration storage object.
CreateEventHandlerMethodInfo Overridable factory method to create the event handler method info.
CreateExecutionTracer Overridable factory method to create the execution tracer object.
CreateMetadataStructureCacheEventSink Creates the metadata structure cache event sink that can be used to update the cache based on events. Currently only updating the users, user groups and logins is supported. - The default setting is to disable all event driven caches, so we return a null value. - To enable event driven caches, override to return a `new MetadataStructureCacheEventSink( cache );`
CreateMetadataStructureValidator Overridable factory method to create the metadata structure validator component.
CreatePropertyMethodInfo Overridable factory method to create the property method info.
CreateStateMethodInfo Overridable factory method to create the state method info.
CreateStateTransitionMethodInfo Overridable factory method to create the state transition method info.
CreateTaskManager  
CreateVaultAnonymousExtensionMethodInfo  
CreateVaultExtensionMethodInfo Overridable factory method to create the vault extension method info.
EvaluateAutomaticStateTransitionTrigger Invokes the registered automatic state transition condition handlers.
EvaluateStatePostConditions Invokes all the state post-condition evaluation handlers.
EvaluateStatePreConditions Invokes all the state precondition evaluation handlers.
EventHandlerBelongsToThisVaultApplication Check if the event handler belongs to this application.
ExecuteAnonymousVaultExtensionMethod  
ExecuteVaultExtensionMethod Executes the defined vault extension method.
GetApplicationLicenseDetails Called by platform to request the license details text, either currently loaded or the given license.
GetApplicationLicenseStatus Called to request the status information of the application.
GetDelegateScriptTemplate Method for reading the VBScript template from the resources.
GetEventHandlerDelegateScript Method for retrieving the VBScript delegation code for the certain event type.
GetEventHandlerEnvironment Creates the local event handler environment.
GetEventHandlerExecutionOrderPreserver  
GetEventHandlerPrefix  
GetMetadataStructureCache Creates the metadata structure cache for the given vault. If the caching is not desired then this method should be overridden and it should return null.
GetMethodsByAttributeT Returns a collection of the methods decorated with the given attribute.
(Inherited from MethodSource)
GetPrivateMethodSources Gets private method sources
GetPropertyAutomaticNumber Invokes the property customized automatic numbering handler.
GetPropertyCustomValue Invokes the property custom value calculation handler.
GetPropertyEnvironment Creates the local property environment.
GetPropertyHandlerDelegateScript Method for retrieving the VBScript delegation code for the certain state.
GetStateEnvironment Creates the local state environment.
GetStateHandlerDelegateScript Method for retrieving the VBScript delegation code for the certain state.
GetStateTransitionEnvironment Creates the local state environment.
GetStateTransitionHandlerDelegateScript Method for retrieving the VBScript delegation code for a certain state transition.
GetTransactionRunner  
GetVaultExtensionMethodDelegateScript  
GetVaultExtensionMethodEventHandlerProxyName Returns the name for the vault extension method event handler proxy of this Vault Application.
Initialize Initializes the vault application in the specified vault. The method e.g. installs required event delegating scripts in the vault. - NOTE: Once this method releases the vault object will have been disposed. - When overriding this method in classes that extend this one, any logic that - needs to use that vault must be processed before the base.Initialize() method is - called. Alternatively you can place the logic inside an override of the - InitializeImpl() method.
InitializeApplication Protected overridable for the child classes to override instead of Initialize. InitializeApplication can be used to make changes to the vault structure.
InitializeAvailabilityGroupStatusWriter Protected overridable for the child classes to override so they can pass in their own settings. PermanentVault is initialized and should be used as the vault connection.
InitializeImpl Reload clear the internal data structures and loads the modules and their event handlers.
InitializeTaskManager  
InitializeTaskQueueResolver  
Install Installs the application. - NOTE: Once this method releases the vault object will have been disposed. - When overriding this method in classes that extend this one, any logic that - needs to use that vault must be processed before the base.Install() method is - called. Alternatively you can place the logic inside an override of the - InstallApplication() method.
InstallApplication Protected overridable for the child classes to override instead of Install. InstallApplication can be used to prevent installation of the application. InstallApplication should also install any additional required components. InstallApplication cannot make changes to the vault structure.
InstallEventHandlerAndVaultExtensionMethodDelegateScripts Generates and installs the VBScript delegate scripts for event handlers defined in the application.
InstallHandlerDelegateScripts Generates and installs the VBScript delegate scripts for all handlers that are defined in the application.
InstallPropertyHandlerDelegateScripts Generates and installs the VBScript delegate scripts for property handlers defined in the application.
InstallStateAndStateTransitionHandlerDelegateScripts Generates and installs the VBScript delegate scripts for state handlers defined in the application.
IsAnonymousExtensionMethodSupported  
IsGeneratedAutomatically Checks if the given script is generated automatically. This is decided by the existence of a line with certain content.
IsHandlerDefinedForProperty Checks if the has handler(s) of the given type.
IsHandlerDefinedForState Checks if the state has handler(s) of the given type.
IsHandlerDefinedForStateTransition Checks if the state has handler(s) of the given type.
LoadHandlerMethods Finds and caches all event handler methods and vault extension methods in the assembly. The methods are decorated with specific attributes.
NewEnvironment Returns a new Event Handler environment, to be populated in the event handler script.
PopulateConfigurationObjects(Vault) Searches the vault application for marked configuration objects (MFConfiguration attribute) and loads and validates them.
PopulateConfigurationObjects(Vault, Object) Populates a configuration objects from single host object.
PopulateConfigurationObjectsAndValidate Populates and validates objects marked with MFConfiguration attribute.
RegisterEventHandlers Registers the specified event handler method.
RegisterHandlersT Generic method for collecting all methods from the given source that are decorated with the specified attribute type.
RegisterMethodsFromSource Registers all methods from the specified source.
RegisterPropertyHandler Registers the specified property handler method.
RegisterStateHandler Registers the specified state handler method.
RegisterStateTransitionHandler Registers the specified state transition handler method.
RegisterVaultAnonymousExtensionMethodHandler  
RegisterVaultExtensionMethodHandler Registers the specified vault extension method.
ReinitializeMetadataStructureCache Reinitialize the metadata structure cache.
RemoveVaultExtensionMethod Removes a vault extension method that does not have a separate event handler proxy.
ReportMetadataStructureValidationErrors Handles the validation results. By default only outputs errors to event log.
Run Invokes all methods that have the MFEventHandlerAttribute and are applicable to this event.
RunStateAction Invokes the state run action handlers.
SetApplicationLicense Setting in new license content. Gets called after application instantiation before Initialize(), and also when a new license is applyed from MF-Admin.
SetAuthenticationData Sets the authentication data for the vault application.
SetCallingThreadCulture Sets the current thread culture according to the current user's culture.
SetEventHandlers Overridable method for setting event handlers.
ShouldUpdateScript Checks if the script should be updated. The script should be updated only if the old script was automatically generated and the new script differs from the old one.
StartApplication Protected overridable for the child classes to override instead of StartOperations. PermanentVault is initialized and should be used as the vault connection. StartApplication should be used to start recurring background operations.
StartOperations Starts the vault operations in the specified vault. The method e.g. begins to use the vault in a background job. - NOTE: Once this method releases the vault object will have been disposed. - When overriding this method in classes that extend this one, any logic that - needs to use that vault must be processed before the base.StartOperations() method is - called. Alternatively you can place the logic inside an override of the - StartApplication() method or inside the RegisterTaskQueues() method for - Vault applications that implement the IUsesTaskQueue interface. - ADDITIONAL NOTE: The PermanentVault reference will still be available.
StartTaskQueueProcessing  
TraceCustomEvent Adds a custom event to the execution tracer.
Uninitialize Un-initializes the vault application in the specified vault. - NOTE: Once this method releases the vault object will have been disposed. - When overriding this method in classes that extend this one, any logic that - needs to use that vault must be processed before the base.Uninitialize() method is - called. Alternatively you can place the logic inside an override of the - UninitializeApplication() method.
UninitializeApplication Protected overridable for the child classes to override instead of Uninitialize. UninitializeApplication can be used make changes in the vault structure.
UninitializeImpl Un-initializes the vault application in the specified vault.
Uninstall Uninstall the application. - NOTE: Once this method releases the vault object will have been disposed. - When overriding this method in classes that extend this one, any logic that - needs to use that vault must be processed before the base.Uninstall() method is - called. Alternatively you can place the logic inside an override of the - UninstallApplication() method.
UninstallApplication Protected overridable for the child classes to override instead of Uninitialize. UninstallApplication can be used to prevent uninstallation of the application. UninstallApplication should also uninstall any additional required components, that were installed by the InstallApplication-method. UninstallApplication cannot make changes to the vault structure.
UpdatePropertyDefScripts Overridable method for updating property definition scripts.
UpdateWorkflowScripts Overridable method for updating a workflow scripts.
ValidateMetadataStructure Validates the application and all types in the same assembly.
ValidatePropertyValue Invokes all property validation handlers.
VaultActionNotification  

Fields

anonymousMethods  
applicationRunningStatus Indicates the application running status. This is volatile because the value can be accessed from multiple threads to avoid caching delays -- the enumeration read and write itself is atomic.
cacheEventSink The vault listeners registered to update the metadatastructurecache backing vault instances.
eventHandlerMethods Collections of the event handling methods.
eventSourceIdentifier The application event source identifier that is used in conjunction with the Windows event log.
MaxTimeToWaitBackgroundOperationsAtUninitialization Defines how long the background operations can be waited at uninitialization.
MultiserverHealthStatusNamespace Namespace holds the multi-server mode health status entries (one per host machine).
propertyMethods Collection of property extension methods by property.
stateMethods Collection of state extension methods by state.
stateTransitionMethods Collection of state transition extension methods by state.
unusedAnonymousMethodNames  
unusedVaultExtensionNames List of vault extension method names which are known but not used.
vaultExtensionMethods Collection of vault extension methods by name.

See Also