javax.cim
Class CIMObjectPath

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

public class CIMObjectPath
extends Object
implements Serializable

This class represents the CIM Object Path as 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 namespace, object name and keys (if the object is an instance).

For example, the object path:

http://myserver/interop:My_ComputerSystem.Name=mycomputer, CreationClassName=My_ComputerSystem

has two parts:

Since:
JSR48 1.0.0
See Also:
Serialized Form

Constructor Summary
CIMObjectPath(String objectPath)
          Constructs a CIM Object Path referencing a CIM element.
CIMObjectPath(String objectName, String namespace)
          Constructs a CIM Object Path referencing a CIM element along in the specified namespace.
CIMObjectPath(String objectName, String namespace, CIMProperty<?>[] keys)
          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(String host, String namespace, String objectName, CIMProperty<?>[] keys)
          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 scheme, String host, String port, String namespace, String objectName, CIMProperty<?>[] keys)
          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 scheme, String host, String port, String namespace, String objectName, CIMProperty<?>[] keys, String xmlSchemaName)
          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(Object o)
          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
 String getHost()
          Gets the host.
 CIMProperty<?> getKey(String name)
          Gets a key property by name.
 CIMProperty<?>[] getKeys()
          Gets all key properties.
 String getNamespace()
          Gets the namespace.
 String getObjectName()
          Gets the object name.
 String getPort()
          Gets the the port on the host to which the connection was established.
 String getScheme()
          Get the connection scheme.
 String getXmlSchemaName()
          Get the XML Schema for this object (optional)
 int hashCode()
          Computes the hash code for this object path.
 String toString()
          Returns a String representation of the CIM object path.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CIMObjectPath

public CIMObjectPath(String objectPath)
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.

Parameters:
objectPath - 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(String objectName,
                     String namespace)
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.

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

CIMObjectPath

public CIMObjectPath(String objectName,
                     String namespace,
                     CIMProperty<?>[] keys)
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.

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

CIMObjectPath

public CIMObjectPath(String host,
                     String namespace,
                     String objectName,
                     CIMProperty<?>[] keys)
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.

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

CIMObjectPath

public CIMObjectPath(String scheme,
                     String host,
                     String port,
                     String namespace,
                     String objectName,
                     CIMProperty<?>[] keys)
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.

Parameters:
scheme - The connection scheme to the host (e.g. http, https, ...)
host - The host name or IP Address.
port - The port on the host to which the connection was established.
namespace - The namepace in which the CIM element is defined.
objectName - The name of the CIM element referenced.
keys - CIMProperty[] The keys and their corresponding values that identify an instance of the CIM element.

CIMObjectPath

public CIMObjectPath(String scheme,
                     String host,
                     String port,
                     String namespace,
                     String objectName,
                     CIMProperty<?>[] keys,
                     String xmlSchemaName)
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.

Parameters:
scheme - The connection scheme to the host (e.g. http, https, ...)
host - The host name or IP Address.
port - The port on the host to which the connection was established.
namespace - The namepace in which the CIM element is defined.
objectName - The name of the CIM element referenced.
keys - CIMProperty[] The keys and their corresponding values that identify an instance of the CIM element.
xmlSchemaName - - The name of the XML Schema for this object. This is only needed for protocols that require this information.
Throws:
IllegalArguementException - if the xmlSchemaNamespace is malformed.
Method Detail

equals

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

Overrides:
equals in class Object
Parameters:
o - The object path to compare to this CIM object path.
Returns:
boolean Returns true if the specified path references the same object, otherwise false is returned.

equalsModelPath

public boolean equalsModelPath(CIMObjectPath pModelPath)
Compares this model path with the specified model path for equality

Parameters:
pModelPath - the object to compare
Returns:
boolean true if the specified path references the same object, otherwise false.

getHost

public String getHost()
Gets the host.

Returns:
String The name of the host

getKey

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

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

getKeys

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

Returns:
CIMProperty[] The container of key properties.

getNamespace

public String getNamespace()
Gets the namespace.

Returns:
String The name of the namespace

getObjectName

public 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:
String The name of this CIM element

getPort

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

Returns:
String The port on the host

getScheme

public String getScheme()
Get the connection scheme.

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

getXmlSchemaName

public String getXmlSchemaName()
Get the XML Schema for this object (optional)

Returns:
The XML Schema name

hashCode

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

Overrides:
hashCode in class Object
Returns:
int The integer representing the hash code for this object path.

toString

public 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 Object
Returns:
String A string representation of this CIM object path


Copyright © 2002-2008 WBEM Solutions, Inc. All Rights Reserved.