javax.cim
Class CIMObjectPath

java.lang.Object
  extended by javax.cim.CIMObjectPath
All Implemented Interfaces:
java.io.Serializable

public class CIMObjectPath
extends java.lang.Object
implements java.io.Serializable

A CIMObjectPath is a reference to a specified CIM class, CIM instance or CIM qualifier. It is only valid in context of an active connection to a CIM object manager on a host. In order to uniquely identify a given object on a host, a CIM object path includes the namespace, object name and keys (if the object is an instance). The namespace is relative to the namespace to which the CIMClient is currently connected. One or more Key properties are used to uniquely identify an instance of a class. Key properties are marked with the KEY qualifier.

For example, the object path:

http://myserver/root/cimv2:My_ComputerSystem.Name=mycomputer, CreationClassName=My_ComputerSystem

has two parts:

See Also:
Serialized Form

Constructor Summary
CIMObjectPath(java.lang.String pObjectPath)
          Constructs a CIM Object Path referencing a CIM element.
CIMObjectPath(java.lang.String pElementName, java.lang.String pNamespace)
          Constructs a CIM Object Path referencing a CIM element along in the specified namespace.
CIMObjectPath(java.lang.String pObjectName, java.lang.String pNamespace, CIMProperty<?>[] pKeys)
          Constructs a CIM Object Path referencing an instance of the specified CIM element as defined in the specified namespace and identified by the given key properties and their corresponding values.
CIMObjectPath(java.lang.String pHost, java.lang.String pNamespace, java.lang.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(java.lang.String pScheme, java.lang.String pHost, java.lang.String pPort, java.lang.String pNamespace, java.lang.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(java.lang.String pScheme, java.lang.String pHost, java.lang.String pPort, java.lang.String pNamespace, java.lang.String pObjectName, CIMProperty<?>[] pKeys, java.lang.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
 boolean equals(java.lang.Object pObj)
          Compares this CIM object path with the specified CIM object path for equality.
 boolean equalsModelPath(CIMObjectPath pModelPath)
           
 java.lang.String getHost()
          Gets the host.
 CIMProperty<?> getKey(java.lang.String pName)
          Gets a key property by name.
 CIMProperty<?>[] getKeys()
          Gets all key properties.
 java.lang.String getNamespace()
          Gets the namespace.
 java.lang.String getObjectName()
          Gets the object name.
 java.lang.String getPort()
          Gets the the port on the host to which the connection was established.
 java.lang.String getScheme()
          Get the connection scheme.
 int hashCode()
          Computes the hash code for this object path.
 java.lang.String toString()
          Returns a String representation of the CIM object path.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CIMObjectPath

public CIMObjectPath(java.lang.String pObjectPath)
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 which will be parsed and used to initialize the object.


CIMObjectPath

public CIMObjectPath(java.lang.String pElementName,
                     java.lang.String pNamespace)
Constructs a CIM Object Path referencing a CIM element along in the specified namespace. 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, key properties and their corresponding values must be set. (Note: When using this API against Pegasus CIMOMs, do not provide the preceding '/' to the namespace parameter. For example, Pegasus will accept "root/cimv2" as a namespace but will not accept "/root/cimv2").

Parameters:
pElementName - - The name of a CIM element.
pNamespace - - The namespace relative to the current namespace.

CIMObjectPath

public CIMObjectPath(java.lang.String pObjectName,
                     java.lang.String pNamespace,
                     CIMProperty<?>[] pKeys)
Constructs a CIM Object Path referencing an instance of the specified CIM element as defined in the specified namespace and identified by the given key properties and their corresponding values. (Note: When using this API against Pegasus CIMOMs, do not provide the preceding '/' to the namespace parameter. For example, Pegasus will accept "root/cimv2" as a namespace but will not accept "/root/cimv2").

Parameters:
pObjectName - - The name of the CIM element referenced.
pNamespace - - The namespace in which the CIM element is defined.
pKeys - - CIMProperty[] The keys and their corresponding values that identify an instance of the CIM element.

CIMObjectPath

public CIMObjectPath(java.lang.String pHost,
                     java.lang.String pNamespace,
                     java.lang.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: When using this API against Pegasus CIMOMs, do not provide the preceding '/' to the namespace parameter. For example, Pegasus will accept "root/cimv2" as a namespace but will not accept "/root/cimv2").

Parameters:
pHost - - The host name or IP Address.
pNamespace - - The namepace in which the CIM element is defined.
pObjectName - - The name of the CIM element referenced.
pKeys - - CIMProperty[] The keys and their corresponding values that identify an instance of the CIM element.

CIMObjectPath

public CIMObjectPath(java.lang.String pScheme,
                     java.lang.String pHost,
                     java.lang.String pPort,
                     java.lang.String pNamespace,
                     java.lang.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 Pegasus CIMOMs, do not provide the preceding '/' to the namespace parameter. For example, Pegasus 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 - - CIMProperty[] The keys and their corresponding values that identify an instance of the CIM element.

CIMObjectPath

public CIMObjectPath(java.lang.String pScheme,
                     java.lang.String pHost,
                     java.lang.String pPort,
                     java.lang.String pNamespace,
                     java.lang.String pObjectName,
                     CIMProperty<?>[] pKeys,
                     java.lang.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 Pegasus CIMOMs, do not provide the preceding '/' to the namespace parameter. For example, Pegasus 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 - CIMProperty[] 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 Detail

equals

public boolean equals(java.lang.Object pObj)
Compares this CIM object path with the specified CIM object path for equality.

Overrides:
equals in class java.lang.Object
Parameters:
pObj - - The object to compare to this CIM object path. Only the model paths are compared.
Returns:
true if the specified path references the same object, otherwise false is returned.
See Also:
Object.equals(java.lang.Object)

equalsModelPath

public boolean equalsModelPath(CIMObjectPath pModelPath)
Parameters:
pModelPath -
Returns:
boolean

getHost

public java.lang.String getHost()
Gets the host.

Returns:
The name of the host.

getKey

public CIMProperty<?> getKey(java.lang.String pName)
Gets a key property by name.

Parameters:
pName - - The name of the key property to retrieve.
Returns:
The CIMProperty with the given name, or null if it is not found.

getKeys

public CIMProperty<?>[] getKeys()
Gets all key properties.

Returns:
The container of key properties.

getNamespace

public java.lang.String getNamespace()
Gets the namespace.

Returns:
The name of the namespace.

getObjectName

public java.lang.String 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

public java.lang.String getPort()
Gets the the port on the host to which the connection was established.

Returns:
The port on the host.

getScheme

public java.lang.String getScheme()
Get the connection scheme.

Returns:
The connection scheme (e.g. http, https,...)

hashCode

public int hashCode()
Computes the hash code for this object path.

Overrides:
hashCode in class java.lang.Object
Returns:
The integer representing the hash code for this object path.
See Also:
Object.hashCode()

toString

public java.lang.String toString()
Returns a String 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 be null.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this CIM object path.
See Also:
Object.toString()


Copyright © 2005, 2009 IBM Corporation. All Rights Reserved.