Click or drag to resize

VaultApplicationBase Methods

The VaultApplicationBase type exposes the following members.

Methods
  NameDescription
Public methodAddVaultExtensionMethod
Adds a vault extension method that does not have a separate event handler proxy.
Protected methodAssertApplicationInStableState
Throws an exception if the application is in a state where it cannot properly handle server events.
Protected methodClearAutomaticallyGeneratedScripts
Clears the automatically generated scripts that are no longer used from the metadata structure (from property definitions and workflow states).
Protected methodCollectUnusedHandlers
Method for collecting extension method names which are unused.
Protected methodConvertToLocalVault
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.
Protected methodCreateAdminConfigurationManager
Overridable factory method to create the admin configuration manager object.
Protected methodCreateConfigurationStorage
Overridable factory method to create the configuration storage object.
Protected methodCreateEventHandlerMethodInfo
Overridable factory method to create the event handler method info.
Protected methodCreateExecutionTracer
Overridable factory method to create the execution tracer object.
Protected methodCreateMetadataStructureCacheEventSink
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. If one does not want to register the event handlers and update the cache then this method should be overridden and it should return null.
Protected methodCreateMetadataStructureValidator
Overridable factory method to create the metadata structure validator component.
Protected methodCreatePropertyMethodInfo
Overridable factory method to create the property method info.
Protected methodCreateStateMethodInfo
Overridable factory method to create the state method info.
Protected methodCreateStateTransitionMethodInfo
Overridable factory method to create the state transition method info.
Protected methodCreateVaultExtensionMethodInfo
Overridable factory method to create the vault extension method info.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEvaluateAutomaticStateTransitionTrigger
Invokes the registered automatic state transition condition handlers.
Public methodEvaluateStatePostConditions
Invokes all the state post-condition evaluation handlers.
Public methodEvaluateStatePreConditions
Invokes all the state precondition evaluation handlers.
Protected methodEventHandlerBelongsToThisVaultApplication
Check if the event handler belongs to this application.
Public methodExecuteVaultExtensionMethod
Executes the defined vault extension method.
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 methodGetApplicationLicenseDetails
Called by platform to request the license details text, either currently loaded or the given license.
Public methodGetApplicationLicenseStatus
Called to request the status information of the application.
Protected methodGetDelegateScriptTemplate
Method for reading the VBScript template from the resources.
Protected methodGetEventHandlerDelegateScript
Method for retrieving the VBScript delegation code for the certain event type.
Protected methodGetEventHandlerEnvironment
Creates the local event handler environment.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetMetadataStructureCache
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.
Public methodGetMethodsByAttributeT
Returns a collection of the methods decorated with the given attribute.
(Inherited from MethodSource.)
Protected methodGetPrivateMethodSources
Gets private method sources
Public methodGetPropertyAutomaticNumber
Invokes the property customized automatic numbering handler.
Public methodGetPropertyCustomValue
Invokes the property custom value calculation handler.
Protected methodGetPropertyEnvironment
Creates the local property environment.
Protected methodGetPropertyHandlerDelegateScript
Method for retrieving the VBScript delegation code for the certain state.
Protected methodGetStateEnvironment
Creates the local state environment.
Protected methodGetStateHandlerDelegateScript
Method for retrieving the VBScript delegation code for the certain state.
Protected methodGetStateTransitionEnvironment
Creates the local state environment.
Protected methodGetStateTransitionHandlerDelegateScript
Method for retrieving the VBScript delegation code for a certain state transition.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodGetVaultExtensionMethodDelegateScript
Method for retrieving the VBScript delegation code for the certain vault extension method.
Public methodGetVaultExtensionMethodEventHandlerProxyName
Returns the name for the vault extension method event handler proxy of this Vault Application.
Public methodInitialize
Initializes the vault application in the specified vault. The method e.g. installs required event delegating scripts in the vault.
Protected methodInitializeApplication
Protected overridable for the child classes to override instead of Initialize. InitializeApplication can be used to make changes to the vault structure.
Protected methodInitializeImpl
Reload clear the internal data structures and loads the modules and their event handlers.
Protected methodInitializeTaskQueueManager
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.
Public methodInstall
Installs the application.
Protected methodInstallApplication
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.
Protected methodInstallEventHandlerAndVaultExtensionMethodDelegateScripts
Generates and installs the VBScript delegate scripts for event handlers defined in the application.
Protected methodInstallHandlerDelegateScripts
Generates and installs the VBScript delegate scripts for all handlers that are defined in the application.
Protected methodInstallPropertyHandlerDelegateScripts
Generates and installs the VBScript delegate scripts for property handlers defined in the application.
Protected methodInstallStateAndStateTransitionHandlerDelegateScripts
Generates and installs the VBScript delegate scripts for state handlers defined in the application.
Protected methodIsGeneratedAutomatically
Checks if the given script is generated automatically. This is decided by the existence of a line with certain content.
Protected methodIsHandlerDefinedForProperty
Checks if the has handler(s) of the given type.
Protected methodIsHandlerDefinedForState
Checks if the state has handler(s) of the given type.
Protected methodIsHandlerDefinedForStateTransition
Checks if the state has handler(s) of the given type.
Protected methodLoadHandlerMethods
Finds and caches all event handler methods and vault extension methods in the assembly. The methods are decorated with specific attributes.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNewEnvironment
Returns a new Event Handler environment, to be populated in the event handler script.
Protected methodPopulateConfigurationObjects(Vault)
Searches the vault application for marked configuration objects (MFConfiguration attribute) and loads and validates them.
Protected methodPopulateConfigurationObjects(Vault, Object)
Populates a configuration objects from single host object.
Protected methodPopulateConfigurationObjectsAndValidate
Populates and validates objects marked with MFConfiguration attribute.
Protected methodRegisterEventHandlers
Registers the specified event handler method.
Protected methodRegisterHandlersT
Generic method for collecting all methods from the given source that are decorated with the specified attribute type.
Protected methodRegisterMethodsFromSource
Registers all methods from the specified source.
Protected methodRegisterPropertyHandler
Registers the specified property handler method.
Protected methodRegisterStateHandler
Registers the specified state handler method.
Protected methodRegisterStateTransitionHandler
Registers the specified state transition handler method.
Protected methodRegisterVaultExtensionMethodHandler
Registers the specified vault extension method.
Public methodReinitializeMetadataStructureCache
Reinitialize the metadata structure cache.
Public methodRemoveVaultExtensionMethod
Removes a vault extension method that does not have a separate event handler proxy.
Protected methodReportMetadataStructureValidationErrors
Handles the validation results. By default only outputs errors to event log.
Public methodRun
Invokes all methods that have the MFEventHandlerAttribute and are applicable to this event.
Public methodRunStateAction
Invokes the state run action handlers.
Public methodSetApplicationLicense
Setting in new license content. Gets called after application instantiation before Initialize(), and also when a new license is applyed from MF-Admin.
Protected methodSetCallingThreadCulture
Sets the current thread culture according to the current user's culture.
Protected methodShouldUpdateScript
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 methodStartApplication
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.
Public methodStartOperations
Starts the vault operations in the specified vault. The method e.g. begins to use the vault in a background job.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUninitialize
Un-initializes the vault application in the specified vault.
Protected methodUninitializeApplication
Protected overridable for the child classes to override instead of Uninitialize. UninitializeApplication can be used make changes in the vault structure.
Protected methodUninitializeImpl
Un-initializes the vault application in the specified vault.
Public methodUninstall
Uninstall the application.
Protected methodUninstallApplication
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.
Protected methodValidateMetadataStructure
Validates the application and all types in the same assembly.
Public methodValidatePropertyValue
Invokes all property validation handlers.
Top
See Also