Click or drag to resize

AdminConfigurationManagerBase Class

Base implementation of best practices for managing ConfigurationDomains and interacting with MFAdmin's configurator. This base implementation can register/unregister root nodes at a given configuration extension point, corresponding to one of the ConfigurationDomainDefaultNamespaces. Implementations of this class are responsible for: - Creating and resolving references for nodes anywhere in the hierarchy so base methods know how to refer to nodes, and can resolve them easily using ResolveNodeReference(IConfigurationRequestContext, String) and GetNodeReference(DomainNodeLocation)). - Generating the correct SourceDefinitions and MethodSourceDefinitions for MFAdmin to communicate back with the M-Files server using CreateSourceDefinition(DomainNodeLocation, BuiltInDomainCommand, String), CreateReadWriteConfigurationSourceDefinition(DomainNodeLocation), and CreateCommandMethodSource(DomainNodeLocation, String). - Ensuring requests from MFAdmin are received and routed back to this manager's ExecuteBuiltInCommand(IConfigurationRequestContext, DomainNodeLocation, BuiltInDomainCommand, String) and ExecuteCustomCommand(IConfigurationRequestContext, DomainNodeLocation, String, String) methods as appropriate.
Inheritance Hierarchy

Namespace:  MFiles.VAF.Configuration.AdminConfigurations
Assembly:  MFiles.VAF.Configuration (in MFiles.VAF.Configuration.dll) Version: 2.1.0.1 (2.1.0.1)
Syntax
C#
public abstract class AdminConfigurationManagerBase

The AdminConfigurationManagerBase type exposes the following members.

Constructors
  NameDescription
Public methodAdminConfigurationManagerBase
Constructor.
Top
Properties
  NameDescription
Public propertyRegisteredRootNodes
List of nodes that have been registered through this admin configuration manager.
Public propertyRegistrationNamespace
The namespace where the root nodes are registered. Should be one of the values specified in ConfigurationDomainDefaultNamespaces.
Protected propertyRootNodes
Currently registered root nodes.
Public propertyRootParentId
The id of the domain to which root nodes are anchored. Depends on where the root nodes are registered.
Public propertyVault
The vault for which the configurations are being managed.
Top
Methods
  NameDescription
Public methodAddRootNode
Registers the root node and all of its subnodes to M-Files Admin.
Public methodCreateCommandDefinition
Converts a CustomDomainCommand into a serializable ConfigurationDomainCommand understood by MFAdmin.
Public methodCreateCommandMethodSource
Creates a method source MFAdmin can use to trigger a custom command.
Public methodCreateDomainDefinition
Converts a IConfigurationDomainNode into a serializable ConfigurationDomain understood by MFAdmin.
Public methodCreateReadWriteConfigurationSourceDefinition
Creates a read-write source definition that MFAdmin can use to read and write a node's configuration.
Public methodCreateSourceDefinition
Creates a standard read-only source definition that MFAdmin can use to request specific information from the server.
Public methodDispose
Disposes of the manager and unregistered all domains that has been registered by it.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExecuteBuiltInCommand
Executes a built-in node command.
Public methodExecuteCustomCommand
Executes a custom node command.
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 methodGetCommands
Delegates the GetCommands command to the node.
Public methodGetConfiguration
Delegates the GetConfiguration command to the node.
Public methodGetDashboard
Delegates the GetDashboard command to the node.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetNodeReference
Gets a reference for a node that can be used in a directive. Typically this is the node id, or some form of path or both.
Public methodGetSchema
Delegates the GetSchema command to the node.
Public methodGetStatus
Delegates the GetStatus command to the node.
Public methodGetSubDomains
Delegates the GetSubDomains command to the node.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodProcessRequest(IConfigurationRequestContext, DomainNodeLocation, String, String)
Executes a command for a node and returns the serialized results.
Public methodProcessRequest(IConfigurationRequestContext, String, String, String)
Executes a command for a node and returns the serialized results.
Public methodResolveNodeReference
Resolves a node and its location from a reference.
Public methodSaveConfiguration
Delegates the SaveConfiguration command to the node.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnRegisterRootNode
Removes the registration of the given domain.
Public methodValidate
Delegates the Validate command to the node.
Top
See Also