AdminConfigurationManager Class

Manages the setting up the communication between M-Files Admin and the Dashboard Nodes for VaultApplications.

Definition

Namespace: MFiles.VAF.AdminConfigurations
Assembly: MFiles.VAF (in MFiles.VAF.dll) Version: 24.1.706.1
C#
public class AdminConfigurationManager : ExtensionMethodAdminConfigurationManager, 
	IAdminConfigurations
Inheritance
Object    AdminConfigurationManagerBase    ExtensionMethodAdminConfigurationManager    AdminConfigurationManager
Implements
IAdminConfigurations

Constructors

Properties

ExtensionMethod The name of the VaultExtensionMethod to use in sources.
(Inherited from ExtensionMethodAdminConfigurationManager)
FileUploadMethod  
ProxyMethod The name of the private VaultExtensionMethod that is created to route configuration requests from the extension method to this object.
RegisteredRootNodes List of nodes that have been registered through this admin configuration manager.
(Inherited from AdminConfigurationManagerBase)
RegistrationNamespace The namespace where the root nodes are registered. Should be one of the values specified in ConfigurationDomainDefaultNamespaces.
(Inherited from AdminConfigurationManagerBase)
RootNamespace The base namespace to prepend to fully qualified node references.
(Inherited from ExtensionMethodAdminConfigurationManager)
RootNodes Currently registered root nodes.
(Inherited from AdminConfigurationManagerBase)
RootParentId The id of the domain to which root nodes are anchored. Depends on where the root nodes are registered.
(Inherited from AdminConfigurationManagerBase)
Vault The vault for which the configurations are being managed.
(Inherited from AdminConfigurationManagerBase)
VaultApplication The vault application for which configurations are being managed.

Methods

AddRootNode Registers the root node and all of its subnodes to M-Files Admin.
(Inherited from AdminConfigurationManagerBase)
AddSimpleConfigurationNodeT Adds a simple configuration node to M-Files Admin.
AddSimpleDashboardNode Adds a simple dashboard node to M-Files Admin.
CreateCommandDefinition Converts a CustomDomainCommand into a serializable ConfigurationDomainCommand understood by MFAdmin.
(Inherited from AdminConfigurationManagerBase)
CreateCommandMethodSource Creates a method source MFAdmin can use to trigger a custom command.
(Inherited from ExtensionMethodAdminConfigurationManager)
CreateDomainDefinition Converts a IConfigurationDomainNode into a serializable ConfigurationDomain understood by MFAdmin.
(Inherited from AdminConfigurationManagerBase)
CreateReadWriteConfigurationSourceDefinition Creates a read-write source definition that MFAdmin can use to read and write a node's configuration.
(Inherited from ExtensionMethodAdminConfigurationManager)
CreateSource(DomainNodeLocation, BuiltInDomainCommand, String) Creates a VaultExtensionMethodSource for use in SourceDefinitions.
(Inherited from ExtensionMethodAdminConfigurationManager)
CreateSource(DomainNodeLocation, String, String) Creates a VaultExtensionMethodSource for use in SourceDefinitions.
(Inherited from ExtensionMethodAdminConfigurationManager)
CreateSourceDefinition Creates a standard read-only source definition that MFAdmin can use to request specific information from the server.
(Inherited from ExtensionMethodAdminConfigurationManager)
CreateVaultExtensionMethodCall(DomainNodeLocation, String, String) Creates a VaultExtensionMethodCall for use in SourceDefinitions.
(Overrides ExtensionMethodAdminConfigurationManagerCreateVaultExtensionMethodCall(DomainNodeLocation, String, String))
CreateVaultExtensionMethodCall(DomainNodeLocation, BuiltInDomainCommand, String) Creates a VaultExtensionMethodCall for use in SourceDefinitions.
(Inherited from ExtensionMethodAdminConfigurationManager)
Dispose Disposes of the manager and unregistered all domains that has been registered by it.
(Inherited from AdminConfigurationManagerBase)
Dispose(Boolean)
(Inherited from AdminConfigurationManagerBase)
ExecuteBuiltInCommand Executes a built-in node command.
(Inherited from AdminConfigurationManagerBase)
ExecuteCustomCommand Executes a custom node command.
(Inherited from AdminConfigurationManagerBase)
GetCommands Delegates the GetCommands command to the node.
(Inherited from AdminConfigurationManagerBase)
GetConfiguration Delegates the GetConfiguration command to the node.
(Inherited from AdminConfigurationManagerBase)
GetDashboard Delegates the GetDashboard command to the node.
(Inherited from AdminConfigurationManagerBase)
GetDefaultNamedValueSource Returns the default named value source for the given node name. Default named value source should only be used at the root level to avoid name collision.
GetFileUploadSource  
GetNodeReference Gets a nodes fully qualified node id, which is namespaced with the root and ancestor ids.
(Inherited from ExtensionMethodAdminConfigurationManager)
GetPlugins
(Inherited from AdminConfigurationManagerBase)
GetSchema Delegates the GetSchema command to the node.
(Inherited from AdminConfigurationManagerBase)
GetStatus Delegates the GetStatus command to the node.
(Inherited from AdminConfigurationManagerBase)
GetSubDomains Delegates the GetSubDomains command to the node.
(Inherited from AdminConfigurationManagerBase)
ProcessFileUploadRequest  
ProcessRequest(IConfigurationRequestContext, DomainNodeLocation, String, String) Executes a command for a node and returns the serialized results.
(Inherited from AdminConfigurationManagerBase)
ProcessRequest(IConfigurationRequestContext, String, String, String) Executes a command for a node and returns the serialized results.
(Inherited from AdminConfigurationManagerBase)
RebroadcastVaultExtMethod Broadcasts a Vault Extension method call to others servers.
RegisterProxy Registers a hidden vault extension method with the vault application. This will instruct the vault application to route a VaultExtensionMethod called like below to this instance's RouteRequest(EventHandlerEnvironment) method. VaultExtensionMethodOperations.ExecuteVaultExtensionMethod( "<VaultAppExtMethod>, "[ \"<this.ProxyMethod>\", "<command>", ... ]" )
ResolveNodeReference Resolves a node and its location from a reference.
(Inherited from ExtensionMethodAdminConfigurationManager)
RouteRequest Handles the routing of configurator requests from the client. All external requests should be passed to this method.
SaveConfiguration Delegates the SaveConfiguration command to the node.
(Inherited from AdminConfigurationManagerBase)
UnRegisterRootNode(IConfigurationDomainNode) Removes the registration of the given domain.
(Inherited from AdminConfigurationManagerBase)
UnRegisterRootNode(String) Removes the registration of the given dn
(Inherited from ExtensionMethodAdminConfigurationManager)
Validate Delegates the Validate command to the node.
(Inherited from AdminConfigurationManagerBase)

See Also