VaultApplicationBase Class

Constructor.

Admin Configuration Manager to handle the wire-up between M-Files Admin and Dashboard Nodes.

The application definition information.

Returns the application running status. Indicates if the application is starting, stopping or running normally.

The optional authentication data for the application.

Multi-server availability group status reporter.

A manager for creating background operations.

The configuration storage object.

Returns the vault application event source identifier that is used when logging to Windows event log.

The execution tracer object.

True after the Initialize() method has been executed.

The optional license of the application. Set this in inherited class constructor to get license.

The results from the metadata structure validation.

The metadata structure validator object.

The permanent vault object, runs as MFServer user.

Task queue manager.

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.

Adds a vault extension method that does not have a separate event handler proxy.

Throws an exception if the application is in a state where it cannot properly handle server events.

Clears the automatically generated scripts that are no longer used from the metadata structure (from property definitions and workflow states).

Method for collecting extension method names which are unused.

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.

Overridable factory method to create the admin configuration manager object.

Overridable factory method to create the configuration storage object.

Overridable factory method to create the event handler method info.

Overridable factory method to create the execution tracer object.

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 );`

Overridable factory method to create the metadata structure validator component.

Overridable factory method to create the property method info.

Overridable factory method to create the state method info.

Overridable factory method to create the state transition method info.

Overridable factory method to create the vault extension method info.

Invokes the registered automatic state transition condition handlers.

Invokes all the state post-condition evaluation handlers.

Invokes all the state precondition evaluation handlers.

Check if the event handler belongs to this application.

Executes the defined vault extension method.

Called by platform to request the license details text, either currently loaded or the given license.

Called to request the status information of the application.

Method for reading the VBScript template from the resources.

Method for retrieving the VBScript delegation code for the certain event type.

Creates the local event handler environment.

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.

Returns a collection of the methods decorated with the given attribute.

Gets private method sources

Invokes the property customized automatic numbering handler.

Invokes the property custom value calculation handler.

Creates the local property environment.

Method for retrieving the VBScript delegation code for the certain state.

Creates the local state environment.

Method for retrieving the VBScript delegation code for the certain state.

Creates the local state environment.

Method for retrieving the VBScript delegation code for a certain state transition.

Method for retrieving the VBScript delegation code for the certain vault extension method.

Returns the name for the vault extension method event handler proxy of this Vault Application.

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.

Protected overridable for the child classes to override instead of Initialize. InitializeApplication can be used to make changes to the vault structure.

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.

Reload clear the internal data structures and loads the modules and their event handlers.

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.

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.

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.

Generates and installs the VBScript delegate scripts for event handlers defined in the application.

Generates and installs the VBScript delegate scripts for all handlers that are defined in the application.

Generates and installs the VBScript delegate scripts for property handlers defined in the application.

Generates and installs the VBScript delegate scripts for state handlers defined in the application.

Checks if the given script is generated automatically. This is decided by the existence of a line with certain content.

Checks if the has handler(s) of the given type.

Checks if the state has handler(s) of the given type.

Checks if the state has handler(s) of the given type.

Finds and caches all event handler methods and vault extension methods in the assembly. The methods are decorated with specific attributes.

Returns a new Event Handler environment, to be populated in the event handler script.

Searches the vault application for marked configuration objects (MFConfiguration attribute) and loads and validates them.

Populates a configuration objects from single host object.

Populates and validates objects marked with MFConfiguration attribute.

Registers the specified event handler method.

Generic method for collecting all methods from the given source that are decorated with the specified attribute type.

Registers all methods from the specified source.

Registers the specified property handler method.

Registers the specified state handler method.

Registers the specified state transition handler method.

Registers the specified vault extension method.

Reinitialize the metadata structure cache.

Removes a vault extension method that does not have a separate event handler proxy.

Handles the validation results. By default only outputs errors to event log.

Invokes all methods that have the MFEventHandlerAttribute and are applicable to this event.

Invokes the state run action handlers.

Setting in new license content. Gets called after application instantiation before Initialize(), and also when a new license is applyed from MF-Admin.

Sets the authentication data for the vault application.

Sets the current thread culture according to the current user's culture.

Overridable method for setting event handlers.

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.

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.

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.

Adds a custom event to the execution tracer.

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.

Protected overridable for the child classes to override instead of Uninitialize. UninitializeApplication can be used make changes in the vault structure.

Un-initializes the vault application in the specified vault.

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.

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.

Overridable method for updating property definition scripts.

Overridable method for updating a workflow scripts.

Validates the application and all types in the same assembly.

Invokes all property validation handlers.

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.

The vault listeners registered to update the metadatastructurecache backing vault instances.

Collections of the event handling methods.

The application event source identifier that is used in conjunction with the Windows event log.

Defines how long the background operations can be waited at uninitialization.

Namespace holds the multi-server mode health status entries (one per host machine).

Collection of property extension methods by property.

Collection of state extension methods by state.

Collection of state transition extension methods by state.

List of vault extension method names which are known but not used.

Collection of vault extension methods by name.