Class CIMObjectPath
java.lang.Object
javax.cim.CIMObjectPath
- All Implemented Interfaces:
Serializable
This class represents the CIM Object Path as defined by the Distributed
Management Task Force (DMTF) CIM
Infrastructure Specification (DSP004). In order to uniquely identify a given object, a CIM object path
includes the host, namespace, object name and keys (if the object is an
instance).
For example, the object path:
has two parts:
For example, the object path:
http://myserver/root/cimv2:My_ComputerSystem.Name=mycomputer,
CreationClassName=My_ComputerSystem
has two parts:
- Namespace Path
- Model Path
Name=mycomputer
-
CreationClassName=My_ComputerSystem
http://myserver/root/cimv2
JSR48 defines the namespace path to include the scheme, host, port (optional) and namespace
The example specifies the
"root/cimv2"
namespace on the host
myserver
. My_ComputerSystem.Name=mycomputer,CreationClassName=My_ComputerSystem
DSP0004 defines the model path for a class or qualifier type as the name of the class/qualifier type
DSP0004 defines the model path for an instance as the class name.(key=value),*
The example specifies an instance for the class
My_ComputerSystem
which is uniquely identified by two key
properties and values: - See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionCIMObjectPath
(String pObjectPath) Constructs a CIM Object Path referencing a CIM element.CIMObjectPath
(String pScheme, String pHost, String pPort, String pNamespace, String pObjectName, CIMProperty<?>[] pKeys) Constructs a CIM Object Path referencing an instance of the specified CIM element as defined in the specified namespace on the specified host and identified by the given key properties and their corresponding values.CIMObjectPath
(String pScheme, String pHost, String pPort, String pNamespace, String pObjectName, CIMProperty<?>[] pKeys, String pXmlSchemaName) Constructs a CIM Object Path referencing an instance of the specified CIM element as defined in the specified namespace on the specified host and identified by the given key properties and their corresponding values. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compares this CIM object path with the specified CIM object path for equality.boolean
equalsModelPath
(CIMObjectPath pModelPath) Compares this model path with the specified model path for equality.getHost()
Gets the host.CIMProperty
<?> Gets a key property by name.CIMProperty<?>[]
getKeys()
Gets all key properties.getKeyValue
(String pName) Gets the namespace.Gets the object name.getPort()
Gets the the port on the host to which the connection was established.Get the connection scheme.Get the XML Schema for this object (optional).int
hashCode()
Computes the hash code for this object path.toString()
Returns aString
representation of the CIM object path.
-
Constructor Details
-
CIMObjectPath
Constructs a CIM Object Path referencing a CIM element. The name can refer to a class name or a qualifier type name, depending on the particular CIM element identified. In order to refer to an instance, the key properties and their corresponding values must be set.
Should be able to handle strings, like:
http://myserver.org:5066/root/cimv2:My_ComputerSystem.Name="mycmp",CreationClassName="My_ComputerSystem"
http://myserver.org/root/cimv2:My_ComputerSystem.Name="mycmp",CreationClassName="My_ComputerSystem"
//myserver.org/root/cimv2:My_ComputerSystem
/root/cimv2:My_ComputerSystem- Parameters:
pObjectPath
- The string representation of an object path for a CIM element that will be parsed and used to initialize the object.- Throws:
IllegalArgumentException
- If thepObjectPath
isnull
or an empty string.
-
CIMObjectPath
public CIMObjectPath(String pScheme, String pHost, String pPort, String pNamespace, String pObjectName, CIMProperty<?>[] pKeys) Constructs a CIM Object Path referencing an instance of the specified CIM element as defined in the specified namespace on the specified host and identified by the given key properties and their corresponding values. Note that the connection mechanism and the port number to which a client connection is established are also specified.
NOTE: When using this API against OpenPegasus CIMOM, do not provide the preceding '/' in the namespace parameter. For example, OpenPegasus will accept"root/cimv2"
as a namespace but will not accept"/root/cimv2"
.- Parameters:
pScheme
- The connection scheme to the host (e.g. http, https, ...)pHost
- The host name or IP Address.pPort
- The port on the host to which the connection was established.pNamespace
- The namepace in which the CIM element is defined.pObjectName
- The name of the CIM element referenced.pKeys
- The keys and their corresponding values that identify an instance of the CIM element.
-
CIMObjectPath
public CIMObjectPath(String pScheme, String pHost, String pPort, String pNamespace, String pObjectName, CIMProperty<?>[] pKeys, String pXmlSchemaName) Constructs a CIM Object Path referencing an instance of the specified CIM element as defined in the specified namespace on the specified host and identified by the given key properties and their corresponding values. Note that the connection mechanism and the port number to which a client connection is established are also specified.
NOTE: When using this API against OpenPegasus CIMOM, do not provide the preceding '/' in the namespace parameter. For example, OpenPegasus will accept"root/cimv2"
as a namespace but will not accept"/root/cimv2"
.- Parameters:
pScheme
- The connection scheme to the host (e.g. http, https, ...)pHost
- The host name or IP Address.pPort
- The port on the host to which the connection was established.pNamespace
- The namepace in which the CIM element is defined.pObjectName
- The name of the CIM element referenced.pKeys
- The keys and their corresponding values that identify an instance of the CIM element.pXmlSchemaName
- The name of the XML Schema for this object. This is only needed for protocols that require this information.
-
-
Method Details
-
equals
Compares this CIM object path with the specified CIM object path for equality. -
equalsModelPath
Compares this model path with the specified model path for equality. If the model path includes references, then the references will also be compared for the model path (i.e. the namespace part of the object path will be ignored).- Parameters:
pModelPath
- The object to compare.- Returns:
true
if the specified path references the same object, otherwisefalse
.
-
getHost
-
getKey
Gets a key property by name.- Parameters:
pName
- The name of the key property to retrieve.- Returns:
- The
CIMProperty
with the given name, ornull
if it is not found.
-
getKeys
Gets all key properties.- Returns:
- The container of key properties.
-
getKeyValue
-
getNamespace
-
getObjectName
Gets the object name. Depending on the type of CIM element referenced, this may be either a class name or a qualifier type name.- Returns:
- The name of this CIM element.
-
getPort
Gets the the port on the host to which the connection was established.- Returns:
- The port on the host.
-
getScheme
Get the connection scheme.- Returns:
- The connection scheme (e.g. http, https,...)
-
getXmlSchemaName
Get the XML Schema for this object (optional).- Returns:
- The XML Schema name.
-
hashCode
-
toString
Returns aString
representation of the CIM object path. This method is intended to be used only for debugging purposes. The format of the value returned may vary between implementations. The string returned may be empty but may not benull
.
-