Designing Managed Object Format (MOF) Classes
A WMI provider consists of a Managed Object Format (MOF) file and DLL file. The MOF file defines the classes for which the provider implementation supplies data.
The MOF class definitions are compiled by the mofcomp utility and stored in the WMI repository, also known as the Common Information Model (CIM) repository. A less common way to create classes is through the methods of the COM API for WMI.
To ensure that all your WMI class definitions for managed objects are restored to the WMI repository if WMI has a failure and restarts, use the #pragma autorecover preprocessor instruction in your MOF file.
The following sections are discussed in this topic:
- Defining the Objects to Manage
- Defining Properties or Methods
- Relating Objects to Each Other
- Related topics
Defining the Objects to Manage
After you identify the part of your enterprise to manage, define the objects to manage. The definition must include the required data, and allow you to implement the relevant business rules accurately. You can define objects at a granular level, but it is best to decide between the level of detail contained in the definition, and the need to provide enough detail to be useful. Shortcuts early in the process may save time, but may be cause more work in the future.
The CIM Tutorial at the Distributed Management Task Force (DMTF) website contains excellent information about the design process. For more information, see www.dmtf.org.
Consider the following factors when you develop and implement a schema design:
Qualifiers provide information about how to describe classes, objects, properties, methods, and parameters; and they are applied to class and property definitions. In MOF code, qualifiers are enclosed in brackets and may include [key] or [association]. For more information, see Adding a Qualifier and WMI Qualifiers.
A namespace is a logical unit to group classes and objects, and control scope and visibility. Typically, a namespace contains a set of classes and objects that represent managed objects in a specific environment. For more information, see Creating Hierarchies Within WMI.
A modeled object might be a physical or logical element of the schema. For example, you can model a physical disk drive such as a hard disk drive, or a logical disk that can be a partition on a physical disk. A design that uses a class to model a physical disk drive, and then extends that class to model a logical disk is more extensible than one that attempts to create a separate class for each type of disk.
Data may be dynamic or static. If the data is dynamic, you must create a class provider for it.
To enable the user to modify data, you must determine whether or not you want a property to be directly writable or modifiable only by using a method that the user calls.
Defining Properties or Methods
Generally, a WMI class property is similar to a property in a C++ class. If the only actions your code implements for the piece of data is to get the value or set the value, then the data should be defined as a property of the WMI class.
A WMI method generally performs an action that changes the state of a managed object. For example, if the action is to enable or disable the operation of a hardware object, then a method is probably preferable to creating a read/write property. You may decide also to create a property that displays the state of the hardware.
When you create a class or an instance, you can include comments. Use this technique to document your class or explain your programming techniques. For more information, see Creating a Comment. In addition, you can add data to qualify the purpose of a data object. For more information, see Adding a Qualifier.
Relating Objects to Each Other
There are two ways to relate objects to each other: by creating separate objects and an association object that relates them, or by embedding one object in the other. CIM does not support embedded objects, so to be CIM-compliant you must use the first method. However, WMI supports embedded objects so use either method to represent a relationship between objects. You can find examples of embedded objects in the Win32 Classes. For example, Win32_SecurityDescriptor has the embedded object Win32_ACE, which has another embedded object, Win32_Trustee.
Consider the following when deciding how to represent relationships between objects:
- If an instance is useful by itself, then an association works best. For example, Win32_Process and Win32_UserAccount. For more information, see Declaring an Association Class.
- If an instance does not exist outside of the parent object, an embedded object works best. For example, Win32_SecurityDescriptor and Win32_Ace. For more information, see Embedding Objects in a Class.