The CIMObjectPath class represents the DMTF standard CIM object name or
reference. A reference is a property type that is used in an association.
Consider this MOF example:
[Association]
class MyAssociations
{
MyClass ref from;
MyClass ref to;
};
The value of the "from" and "to" properties are represented using a
CIMObjectPath.
A CIM reference is used to uniquely identify a CIM class or CIM instance
object. A CIMObjectPath consists of:
- Host - name of host that contains the object
- NameSpace - the namespace which contains the object
- ClassName - name of objects class
- KeyBindings key/value pairs which uniquely identify an instance
CIM references may also be expressed as simple strings (as opposed to
being represented by the CIMObjectPath class). This string is known as
the "Object Name". An object name has the following form:
<namespace-path>:<model-path>
As for the model-path mentioned above, its form is defined by the CIM
Standard (more is defined by the "XML Mapping Specification v2.0.0"
specification) as follows:
<Qualifyingclass>.<key-1>=<value-1>[,<key-n>=
<value-n>]*
For example:
TennisPlayer.first="Patrick",last="Rafter"
This presupposes the existence of a class called "TennisPlayer"
that has key properties named "first" and "last". For example, here is what
the MOF might look like:
class TennisPlayer : Person
{
[key] string first;
[key] string last;
};
All keys must be present in the model path.
Now the namespace-type and model-path are combined in the following
string object name.
//atp:9999/root/cimv25:TennisPlayer.first="Patrick",last="Rafter"
Now suppose we wish to create a CIMObjectPath from this above string. There
are two constructors provided: one which takes the above string and the
other that takes the constituent elements. Here are the signature of the
two constructors:
CIMObjectPath(const String& objectName);
CIMObjectPath(
const String& host,
const CIMNamespaceName& nameSpace,
const CIMName& className,
const Array& keyBindings);
Following our example, the above object name may be used to initialize
a CIMObjectPath like this:
CIMObjectPath ref =
"//atp:9999/root/cimv25:TennisPlayer.first="Patrick",last="Rafter";
A CIMObjectPath may also be initialized using the constituent elements
of the object name (sometimes the object name is not available as a string:
this is the case with CIM XML encodings). The arguments shown in that
constructor above correspond elements of the object name in the following
way:
- host = "atp:9999"
- nameSpace = "root/cimv25"
- className = "TennisPlayer"
- keyBindings = "first=\"Patrick\",last=\"Rafter\""
Note that the host and nameSpace argument may be empty since object names
need not necessarily include a namespace path according to the standard.
The key bindings must be built up by appending CIMKeyBinding objects
to an Array of CIMKeyBindings like this:
Array keyBindings;
keyBindings.append(
CIMKeyBinding("first", "Patrick", CIMKeyBinding::STRING));
keyBindings.append(CIMKeyBinding("last", "Rafter", CIMKeyBinding::STRING));
Notice that the keys in the object name may appear in any order.
That is the following object names refer to the same object:
TennisPlayer.first="Patrick",last="Rafter"
TennisPlayer.last="Rafter",first="Patrick"
And since CIM is not case sensitive, the following refer to the same
object:
TennisPlayer.first="Patrick",last="Rafter"
tennisplayer.FIRST="Patrick",Last="Rafter"
Therefore, the CIMObjectPaths::operator==() would return true for the last
two examples.
The CIM standard leaves it an open question whether model paths may have
spaces around delimiters (like '.', '=', and ','). We assume they cannot.
So the following is an invalid model path:
TennisPlayer . first = "Patrick", last="Rafter"
We require that the '.', '=', and ',' have no spaces around them.
For reasons of efficiency, the key bindings are internally sorted
during initialization. This allows the key bindings to be compared
more easily. This means that when the string is converted back to
string (by calling toString()) that the keys may have been rearranged.
There are two forms an object name can take:
<namespace-path>:<model-path>
<model-path>
In other words, the namespace-path is optional. Here is an example of
each:
//atp:9999/root/cimv25:TennisPlayer.first="Patrick",last="Rafter"
TennisPlayer.first="Patrick",last="Rafter"
If it begins with "//" then we assume the namespace-path is present and
process it that way.
It should also be noted that an object name may refer to an instance or
a class. Here is an example of each:
TennisPlayer.first="Patrick",last="Rafter"
TennisPlayer
In the second case--when it refers to a class--the key bindings are
omitted.
CIMObjectPath()