javax.wbem.client
Class CIMClient

java.lang.Object
  |
  +--javax.wbem.client.CIMClient

All Implemented Interfaces:

CIMOMHandle

public class CIMClient

extends java.lang.Object

implements CIMOMHandle

Constructs a CIM client on the local host (default) or the specified host. This class invokes the CIM object manager for this client session to perform a WBEM operation, such as, adding, modifying, or deleting a CIM class, CIM instance, and CIM qualifier type in a namespace.

A WBEM client application connects to a CIM Object Manager to establish an initial connection when it needs to perform WBEM operations.

Since:

WBEM 1.0

Field Summary

static java.lang.String	CIM_RMI Constant identifying the CIM operations over RMI protocol.
static java.lang.String	CIM_XML Constant identifying the CIM operations over XML protocol.
static java.lang.String	WQL WBEM Query Language level 1 is currently supported

Constructor Summary

CIMClient(CIMNameSpace name, java.security.Principal principal, java.lang.Object credential)
Creates a new client connection to the CIM Object Manager on the host and namespace specified in the namespace object, using the specified principal and credential to authenticate the client user identity to the CIM Object Manager.

CIMClient(CIMNameSpace name, java.security.Principal principal, java.lang.Object credential, java.lang.String protocol)
Creates a new client connection to the CIM Object Manager on the host and namespace specified in the namespace object, using the specified principal and credential to authenticate the client user identity to the CIM Object Manager.

Method Summary

void	addCIMListener(CIMListener l) Adds the specified listener which receives indications from the CIM Object Manager.
java.util.Enumeration	associatorNames(CIMObjectPath objectName, java.lang.String assocClass, java.lang.String resultClass, java.lang.String role, java.lang.String resultRole) Enumerates the object paths to CIM Objects that are associated to a particular source CIM Object.
java.util.Enumeration	associators(CIMObjectPath objectName, java.lang.String assocClass, java.lang.String resultClass, java.lang.String role, java.lang.String resultRole, boolean includeQualifiers, boolean includeClassOrigin, java.lang.String[] propertyList) Enumerate CIM Objects that are associated to a particular source CIM Object.
void	close() Closes the client connection to the CIM Object Manager.
void	createClass(CIMObjectPath name, CIMClass cc) Adds the CIM class to the specified namespace.
CIMObjectPath	createInstance(CIMObjectPath name, CIMInstance ci) Adds the specified CIM Instance to the specified namespace
void	createNameSpace(CIMNameSpace ns) Creates a CIM namespace, a directory containing CIM classes and CIM instances.
void	createQualifierType(CIMObjectPath name, CIMQualifierType qt) Adds the specified CIM qualifier type to the specified namespace.
void	deleteClass(CIMObjectPath path) Deletes the CIM class to the specified namespace.
void	deleteInstance(CIMObjectPath path) Deletes the CIM instance specified by the CIM object path, a name that uniquely identifies a CIM object.
void	deleteNameSpace(CIMNameSpace ns) Deletes the specified namespace on the current host.
void	deleteQualifierType(CIMObjectPath path) Deletes the CIM qualfier to the specified namespace.
java.lang.String	encryptData(java.lang.String clearData) Encrypts a limited sized string value using the current authentication exchange session key.
java.util.Enumeration	enumerateClasses(CIMObjectPath path) Enumerates the first level children of the class specified in the path.
java.util.Enumeration	enumerateClasses(CIMObjectPath path, boolean deep) Enumerates the class specified in the path.
java.util.Enumeration	enumerateClasses(CIMObjectPath path, boolean deep, boolean localOnly) Enumerates the class specified in the path.
java.util.Enumeration	enumerateClasses(CIMObjectPath path, boolean deep, boolean localOnly, boolean includeQualifiers) Enumerates the class specified in the path.
java.util.Enumeration	enumerateClasses(CIMObjectPath path, boolean deep, boolean localOnly, boolean includeQualifiers, boolean includeClassOrigin) Enumerates the class specified in the path.
java.util.Enumeration	enumerateClassNames(CIMObjectPath path) Enumerates the class specified in the path.
java.util.Enumeration	enumerateClassNames(CIMObjectPath path, boolean deep) Enumerates the class specified in the path.
java.util.Enumeration	enumerateInstanceNames(CIMObjectPath path) Returns the object paths to all instances belonging to the class specified in the path.
java.util.Enumeration	enumerateInstances(CIMObjectPath path) Returns all instances of the class specified in the path.
java.util.Enumeration	enumerateInstances(CIMObjectPath path, boolean deep) Returns all instances of the class specified in the path.
java.util.Enumeration	enumerateInstances(CIMObjectPath path, boolean deep, boolean localOnly) Returns all instances of the class specified in the path.
java.util.Enumeration	enumerateInstances(CIMObjectPath path, boolean deep, boolean localOnly, boolean includeQualifiers) Returns all instances of the class specified in the path.
java.util.Enumeration	enumerateInstances(CIMObjectPath path, boolean deep, boolean localOnly, boolean includeQualifiers, boolean includeClassOrigin) Returns all instances of the class specified in the path.
java.util.Enumeration	enumerateInstances(CIMObjectPath path, boolean deep, boolean localOnly, boolean includeQualifiers, boolean includeClassOrigin, java.lang.String[] propertyList) Returns all instances of the class specified in the path.
java.util.Enumeration	enumNameSpace(CIMObjectPath path, boolean deep) Gets a list of the namespaces within the namespace specified by the CIM object path.
java.util.Enumeration	enumQualifierTypes(CIMObjectPath path) Enumerates the qualifiers defined in a namespace.
java.util.Enumeration	execQuery(CIMObjectPath name, java.lang.String query, java.lang.String ql) Executes a query to retrieve objects.
CIMClass	getClass(CIMObjectPath name) Gets the CIM class for the specified CIM object path.
CIMClass	getClass(CIMObjectPath name, boolean localOnly) Gets the CIM class for the specified CIM object path.
CIMClass	getClass(CIMObjectPath name, boolean localOnly, boolean includeQualifiers) Gets the CIM class for the specified CIM object path.
CIMClass	getClass(CIMObjectPath name, boolean localOnly, boolean includeQualifiers, boolean includeClassOrigin) Gets the CIM class for the specified CIM object path.
CIMClass	getClass(CIMObjectPath name, boolean localOnly, boolean includeQualifiers, boolean includeClassOrigin, java.lang.String[] propertyList) Gets the CIM class for the specified CIM object path.
CIMInstance	getInstance(CIMObjectPath name) Gets the CIM instance for the specified CIM object path.
CIMInstance	getInstance(CIMObjectPath name, boolean localOnly) Gets the CIM instance for the specified CIM object path.
CIMInstance	getInstance(CIMObjectPath name, boolean localOnly, boolean includeQualifiers) Gets the CIM instance for the specified CIM object path.
CIMInstance	getInstance(CIMObjectPath name, boolean localOnly, boolean includeQualifiers, boolean includeClassOrigin) Gets the CIM instance for the specified CIM object path.
CIMInstance	getInstance(CIMObjectPath name, boolean localOnly, boolean includeQualifiers, boolean includeClassOrigin, java.lang.String[] propertyList) Gets the CIM instance for the specified CIM object path.
CIMValue	getProperty(CIMObjectPath name, java.lang.String propertyName) Gets the value of the specified property for the instance specified in the object path.
CIMQualifierType	getQualifierType(CIMObjectPath name) Gets the CIM qualifier type specified in the CIM object path.
CIMValue	invokeMethod(CIMObjectPath name, java.lang.String methodName, java.util.Vector inParams, java.util.Vector outParams) Executes the specified method on the specified object.
BatchResult	performBatchOperations(BatchHandle bc)
java.util.Enumeration	referenceNames(CIMObjectPath objectName, java.lang.String resultClass, java.lang.String role) Enumerates the object paths to association objects that refer to a particular target CIM Object.
java.util.Enumeration	references(CIMObjectPath objectName, java.lang.String resultClass, java.lang.String role, boolean includeQualifiers, boolean includeClassOrigin, java.lang.String[] propertyList) Enumerates the association objects that refer to a particular target CIM Object.
void	removeCIMListener(CIMListener l) Removes the specified listener which receives indications from the CIM Object Manager.
void	setClass(CIMObjectPath name, CIMClass cc) Modifies the CIM class in the specified namespace.
void	setInstance(CIMObjectPath name, CIMInstance ci) Modifies the specified CIM instance in the specified namespace.
void	setProperty(CIMObjectPath name, java.lang.String propertyName, CIMValue newValue) Modifies the value of the specified property for the instance specified in the object path.
void	setQualifierType(CIMObjectPath name, CIMQualifierType qt) Adds the specified CIM qualifier type to the specified namespace if it does not already exist.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WQL

public static final java.lang.String WQL

WBEM Query Language level 1 is currently supported

See Also:

execQuery(javax.wbem.cim.CIMObjectPath, java.lang.String, java.lang.String)

CIM_XML

public static final java.lang.String CIM_XML

Constant identifying the CIM operations over XML protocol.

CIM_RMI

public static final java.lang.String CIM_RMI

Constant identifying the CIM operations over RMI protocol.

Constructor Detail

CIMClient

public CIMClient(CIMNameSpace name,
                 java.security.Principal principal,
                 java.lang.Object credential)
          throws CIMException

Creates a new client connection to the CIM Object Manager on the host and namespace specified in the namespace object, using the specified principal and credential to authenticate the client user identity to the CIM Object Manager. This connection uses the RMI protocol to send messages to the CIM Object Manager.

Parameters:

name - The namespace in which operations will be performed

principal - The client user principal identity

credential - The client user credential for authentication

Throws:

CIMException - Throws a CIM exception if the namespace already exists, the client connection fails due to a network error, the user account does not exist, or the password is not the correct password for the specified user account.

CIMClient

public CIMClient(CIMNameSpace name,
                 java.security.Principal principal,
                 java.lang.Object credential,
                 java.lang.String protocol)
          throws CIMException

Creates a new client connection to the CIM Object Manager on the host and namespace specified in the namespace object, using the specified principal and credential to authenticate the client user identity to the CIM Object Manager. This connection uses the specified protocol to send messages to the CIM Object Manager.

Parameters:

name - The namespace in which operations will be performed

principal - The client user principal identity

credential - The client user credential for authentication

protocol - The protocol to use for sending messages; e.g. CIM_XML

Throws:

CIMException - Throws a CIM exception if the namespace already exists, the client connection fails due to a network error, the user account does not exist, or the password is not the correct password for the specified user account.

Method Detail

createNameSpace

public void createNameSpace(CIMNameSpace ns)
                     throws CIMException

Creates a CIM namespace, a directory containing CIM classes and CIM instances. When a client application connects to the CIM Object Manager, it specifies a namespace. All subsequent operations occur within that namespace on the CIM Object Manager host.

Specified by:

createNameSpace in interface CIMOMHandle

Parameters:

ns - The CIMNameSpace object that specifies a string for the host and a string for the namespace

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_ALREADY_EXISTS (if namespace already exists),
   CIM_ERR_FAILED (some other unspecified error occurred)

close

public void close()
           throws CIMException

Closes the client connection to the CIM Object Manager. This interface frees resources used for the client session.

Example:

The following sample code closes the client connection (cc).

cc.close();

Specified by:

close in interface CIMOMHandle

Throws:

CIMException - Throws a CIM Exception if the client session does not exist

deleteNameSpace

public void deleteNameSpace(CIMNameSpace ns)
                     throws CIMException

Deletes the specified namespace on the current host.

Specified by:

deleteNameSpace in interface CIMOMHandle

Parameters:

ns - The CIMNameSpace object that identifies the namespace to be deleted

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_NOT_FOUND (if namespace does not exist),
   CIM_ERR_FAILED (some other unspecified error occurred)

deleteClass

public void deleteClass(CIMObjectPath path)
                 throws CIMException

Deletes the CIM class to the specified namespace. The CIM object path consists of two parts: namespace + model path. The namespace portion of the CIM object path identifies the host running the CIM Object Manager and the namespace. A namespace is a directory-like structure that contains CIM classes, instances, and qualifier types.

The model path portion of the CIM object path uniquely identifies a CIM object within the namespace on the host. The model path for a class is the class name.

Specified by:

deleteClass in interface CIMOMHandle

Parameters:

path - The CIMObjectPath identifying the class to delete

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_NOT_FOUND (the CIM Class to be deleted does not exisT),
   CIM_ERR_CLASS_HAS_CHILDREN (the CIM Class has one or more subclasses
   which cannot be deleted),
   CIM_ERR_CLASS_HAS_INSTANCES (the CIM Class has one or more instances
   which cannot be deleted),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

deleteInstance

public void deleteInstance(CIMObjectPath path)
                    throws CIMException

Deletes the CIM instance specified by the CIM object path, a name that uniquely identifies a CIM object. A CIM object path consists of two parts: namespace + model path. The model path is created by concatenating the properties of a class that are qualified with the KEY qualifier.

Specified by:

deleteInstance in interface CIMOMHandle

Parameters:

path - The CIMObjectPath identifying the CIM instance to delete

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_NOT_FOUND (if instance does not exist),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

deleteQualifierType

public void deleteQualifierType(CIMObjectPath path)
                         throws CIMException

Deletes the CIM qualfier to the specified namespace.

Specified by:

deleteQualifierType in interface CIMOMHandle

Parameters:

path - the CIMObjectPath identifying the CIM qualifier to delete

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_NOT_FOUND (the requested Qualifier declaration did not exist),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

enumNameSpace

public java.util.Enumeration enumNameSpace(CIMObjectPath path,
                                           boolean deep)
                                    throws CIMException

Gets a list of the namespaces within the namespace specified by the CIM object path.

Specified by:

enumNameSpace in interface CIMOMHandle

Parameters:

path - The CIMObjectPath identifying the namespace to be enumerated.

deep - If set to true, the enumeration returned will contain the entire hierarchy of namespaces present under the enumerated namespace. If set to false the enumeration will return only the first level children of the enumerated namespace.

Returns:

Enumeration of namespace names as CIMObjectPath.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerateClasses

public java.util.Enumeration enumerateClasses(CIMObjectPath path)
                                       throws CIMException

Enumerates the first level children of the class specified in the path. The entire class contents (and not just the class names) are returned. The returned classes will include only the non-inherited elements. The returned classes will include all the qualifiers. The class origin information will not be included. Class origin is the name of the class where the property is locally defined.

Parameters:

path - The CIMObjectPath identifying the class to be enumerated.

Returns:

Enumeration of CIMClass.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_INVALID_CLASS (the CIM Class that is the basis for this
   enumeration does not exist),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerateClasses

public java.util.Enumeration enumerateClasses(CIMObjectPath path,
                                              boolean deep)
                                       throws CIMException

Enumerates the class specified in the path. The entire class contents (and not just the class names) are returned. The returned classes will include only the non-inherited elements. The returned classes will include all the qualifiers. The class origin information will not be included. Class origin is the name of the class where the property is locally defined.

Parameters:

path - The CIMObjectPath identifying the class to be enumerated.

deep - If true, the enumeration returned will contain the contents of the specified class and the contents of all classes derived from the specified class. If false, the enumeration will return only the contents of the first level children of the specified class.

Returns:

Enumeration of CIMClass.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_INVALID_CLASS (the CIM Class that is the basis for this
   enumeration does not exist),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerateClasses

public java.util.Enumeration enumerateClasses(CIMObjectPath path,
                                              boolean deep,
                                              boolean localOnly)
                                       throws CIMException

Enumerates the class specified in the path. The entire class contents (and not just the class names) are returned. The returned classes will include all the qualifiers. The class origin information will not be included. Class origin is the name of the class where the property is locally defined.

Parameters:

path - The CIMObjectPath identifying the class to be enumerated.

deep - If true, the enumeration returned will contain the contents of the specified class and the contents of all classes derived from the specified class. If false, the enumeration will return only the contents of the first level children of the specified class.

localOnly - If true, only the non-inherited properties and methods of each class are returned. If false, all properties and methods of each class are returned.

Returns:

Enumeration of CIMClass.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_INVALID_CLASS (the CIM Class that is the basis for this
   enumeration does not exist),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerateClasses

public java.util.Enumeration enumerateClasses(CIMObjectPath path,
                                              boolean deep,
                                              boolean localOnly,
                                              boolean includeQualifiers)
                                       throws CIMException

Enumerates the class specified in the path. The entire class contents (and not just the class names) are returned. The class origin information will not be included. Class origin is the name of the class where the property is locally defined.

Parameters:

path - The CIMObjectPath identifying the class to be enumerated.

deep - If true, the enumeration returned will contain the contents of the specified class and the contents of all classes derived from the specified class. If false, the enumeration will return only the contents of the first level children of the specified class.

localOnly - If true, only the non-inherited properties and methods of each class are returned. If false, all properties and methods of each class are returned.

includeQualifiers - If the IncludeQualifiers input parameter is true this specifies that all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included. If false no Qualifiers are present in the returned Object.

Returns:

Enumeration of CIMClass.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_INVALID_CLASS (the CIM Class that is the basis for this
   enumeration does not exist),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerateClasses

public java.util.Enumeration enumerateClasses(CIMObjectPath path,
                                              boolean deep,
                                              boolean localOnly,
                                              boolean includeQualifiers,
                                              boolean includeClassOrigin)
                                       throws CIMException

Enumerates the class specified in the path. The entire class contents (and not just the class names) are returned.

Specified by:

enumerateClasses in interface CIMOMHandle

Parameters:

path - The CIMObjectPath identifying the class to be enumerated.

deep - If true, the enumeration returned will contain the contents of the specified class and the contents of all classes derived from the specified class. If false, the enumeration will return only the contents of the first level children of the specified class.

localOnly - If true, only the non-inherited properties and methods of each class are returned. If false, all properties and methods of each class are returned.

includeQualifiers - If the IncludeQualifiers input parameter is true this specifies that all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included. If false no Qualifiers are present in the returned Object.

includeClassOrigin - If the IncludeClassOrigin input parameter is true, this specifies that the CLASSORIGIN attribute MUST be present on all appropriate elements in each returned Object. If false, no CLASSORIGIN attributes are present in each returned Object.

Returns:

Enumeration of CIMClass.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_INVALID_CLASS (the CIM Class that is the basis for this
   enumeration does not exist),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

See Also:

enumerateClassNames(javax.wbem.cim.CIMObjectPath), enumerateClasses(javax.wbem.cim.CIMObjectPath)

enumerateClassNames

public java.util.Enumeration enumerateClassNames(CIMObjectPath path)
                                          throws CIMException

Enumerates the class specified in the path. The class NAMES are returned as an enumeration of CIMObjectPaths.

Parameters:

path - The CIMObjectPath identifying the class to be enumerated. If the class name component of the object path is NULL, then the names of all base classes in the target namespace are returned. If the class name component of the object path is non-NULL, then the names of all classes derived from the specified class are returned.

Returns:

Enumeration of class names as CIMObjectPaths.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_INVALID_CLASS (the CIM Class that is the basis for this
   enumeration does not exist),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerateClassNames

public java.util.Enumeration enumerateClassNames(CIMObjectPath path,
                                                 boolean deep)
                                          throws CIMException

Enumerates the class specified in the path. The class NAMES are returned as an enumeration of CIMObjectPaths.

Specified by:

enumerateClassNames in interface CIMOMHandle

Parameters:

path - The CIMObjectPath identifying the class to be enumerated.

deep - If true, the enumeration returned will contain the names of all classes derived from the specified class. If false, the enumeration will return only the names of the first level children of the specified class.

Returns:

Enumeration of class names as CIMObjectPaths.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_INVALID_CLASS (the CIM Class that is the basis for this
   enumeration does not exist),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerateInstanceNames

public java.util.Enumeration enumerateInstanceNames(CIMObjectPath path)
                                             throws CIMException

Returns the object paths to all instances belonging to the class specified in the path. The objectpaths of all derived classes in the specified class heirarchy will also be returned.

Specified by:

enumerateInstanceNames in interface CIMOMHandle

Parameters:

path - The CIMObjectPath identifying the class whose instances are to be enumerated. Only the name space and class name components are used. Any other information (e.g. keys) is ignored.

Returns:

Enumeration of instance names as CIMObjectPaths.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerateInstances

public java.util.Enumeration enumerateInstances(CIMObjectPath path)
                                         throws CIMException

Returns all instances of the class specified in the path. Instances of all derived classes in the specified class heirarchy will be returned. Only the local (non-inherited) properties and methods of each instance will be returned. Qualifiers will not be present in each returned instance. The CLASSORIGIN attribute will not be present on each returned instance.

Parameters:

path - The CIMObjectPath identifying the class whose instances are to be enumerated. Only the name space and class name components are used. Any other information (e.g. keys) is ignored.

Returns:

Enumeration of CIMInstance.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerateInstances

public java.util.Enumeration enumerateInstances(CIMObjectPath path,
                                                boolean deep)
                                         throws CIMException

Returns all instances of the class specified in the path. The method also returns all instances of classes derived from the specified class. Qualifiers will not be present in each returned instance. The CLASSORIGIN attribute will not be present on each returned instance.

Parameters:

path - The CIMObjectPath identifying the class whose instances are to be enumerated.

deep - If false, each returned instance will only contain inherited and local properties and methods of the specified class. If true, each returned instance will also contain any additional properties and methods defined in all classes derived from the specified class.

Returns:

Enumeration of CIMInstance.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerateInstances

public java.util.Enumeration enumerateInstances(CIMObjectPath path,
                                                boolean deep,
                                                boolean localOnly)
                                         throws CIMException

Returns all instances of the class specified in the path. The method also returns all instances of classes derived from the specified class. Qualifiers will not be present in each returned instance. The CLASSORIGIN attribute will not be present on each returned instance.

Parameters:

path - The CIMObjectPath identifying the class whose instances are to be enumerated. Only the name space and class name components are used. Any other information (e.g. keys) is ignored.

deep - If false, each returned instance will only contain inherited and local properties and methods of the specified class. If true, each returned instance will also contain any additional properties and methods defined in all classes derived from the specified class.

localOnly - if true, only the non-inherited properties and methods are returned, otherwise all properties and methods are returned.

Returns:

Enumeration of CIMInstance.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerateInstances

public java.util.Enumeration enumerateInstances(CIMObjectPath path,
                                                boolean deep,
                                                boolean localOnly,
                                                boolean includeQualifiers)
                                         throws CIMException

Returns all instances of the class specified in the path. The method also returns all instances of classes derived from the specified class. The CLASSORIGIN attribute will not be present on each returned instance.

Parameters:

path - The CIMObjectPath identifying the class whose instances are to be enumerated. Only the name space and class name components are used. Any other information (e.g. keys) is ignored.

deep - If false, each returned instance will only contain inherited and local properties and methods of the specified class. If true, each returned instance will also contain any additional properties and methods defined in all classes derived from the specified class.

localOnly - If true, only the non-inherited properties and methods are returned. If fals, all properties and methods are returned.

includeQualifiers - If the IncludeQualifiers input parameter is true this specifies that all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included. If false no Qualifiers are present in the returned Object.

Returns:

Enumeration of CIMInstance.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerateInstances

public java.util.Enumeration enumerateInstances(CIMObjectPath path,
                                                boolean deep,
                                                boolean localOnly,
                                                boolean includeQualifiers,
                                                boolean includeClassOrigin)
                                         throws CIMException

Returns all instances of the class specified in the path. The method also returns all instances of classes derived from the specified class.

Parameters:

path - The CIMObjectPath identifying the class whose instances are to be enumerated.

deep - If false, each returned instance will only contain inherited and local properties and methods of the specified class. If true, each returned instance will also contain any additional properties and methods defined in all classes derived from the specified class.

localOnly - If true, only the non-inherited properties and methods are returned. If fals, all properties and methods are returned.

includeQualifiers - If the IncludeQualifiers input parameter is true this specifies that all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included. If false no Qualifiers are present in the returned Object.

includeClassOrigin - If the IncludeClassOrigin input parameter is true, this specifies that the CLASSORIGIN attribute MUST be present on all appropriate elements in each returned Object. If false, no CLASSORIGIN attributes are present in each returned Object.

Returns:

Enumeration of CIMInstance.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerateInstances

public java.util.Enumeration enumerateInstances(CIMObjectPath path,
                                                boolean deep,
                                                boolean localOnly,
                                                boolean includeQualifiers,
                                                boolean includeClassOrigin,
                                                java.lang.String[] propertyList)
                                         throws CIMException

Returns all instances of the class specified in the path. The method also returns all instances of classes derived from the specified class.

Specified by:

enumerateInstances in interface CIMOMHandle

Parameters:

path - The CIMObjectPath identifying the class whose instances are to be enumerated. Only the name space and class name components are used. Any other information (e.g. keys) is ignored.

deep - If false, each returned instance will only contain inherited and local properties and methods of the specified class. If true, each returned instance will also contain any additional properties and methods defined in all classes derived from the specified class.

localOnly - If true, only the non-inherited properties and methods are returned. If fals, all properties and methods are returned.

includeQualifiers - If the IncludeQualifiers input parameter is true this specifies that all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included. If false no Qualifiers are present in the returned Object.

includeClassOrigin - If the IncludeClassOrigin input parameter is true, this specifies that the CLASSORIGIN attribute MUST be present on all appropriate elements in each returned Object. If false, no CLASSORIGIN attributes are present in each returned Object.

propertyList - If the PropertyList input parameter is not NULL, the members of the array define one or more Property names. Each returned Object MUST NOT include elements for any Properties missing from this list. Note that if LocalOnly is specified as true (or DeepInheritance is specified as false) this acts as an additional filter on the set of Properties returned (for example, if Property A is included in the PropertyList but LocalOnly is set to true and A is not local to a returned Instance, then it will not be included in that Instance). If the PropertyList input parameter is an empty array this signifies that no Properties are included in each returned Object. If the PropertyList input parameter is NULL this specifies that all Properties (subject to the conditions expressed by the other parameters) are included in each returned Object. If the PropertyList contains duplicate elements, the Server ignores the duplicates but otherwise process the request normally. If the PropertyList contains elements which are invalid Property names for any target Object, the Server ignores such entries but otherwise process the request normally.

Returns:

Enumeration of CIMInstance.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

enumQualifierTypes

public java.util.Enumeration enumQualifierTypes(CIMObjectPath path)
                                         throws CIMException

Enumerates the qualifiers defined in a namespace.

Specified by:

enumQualifierTypes in interface CIMOMHandle

Parameters:

path - The CIMObjectPath identifying the namespace whose qualifier definitions are to be enumerated.

Returns:

Enumeration of qualifierType objects

Throws:

CIMException - TIf unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

getClass

public CIMClass getClass(CIMObjectPath name)
                  throws CIMException

Gets the CIM class for the specified CIM object path. The entire class contents (and not just the class names) are returned. The returned class will include only the non-inherited elements. The returned class will include all the qualifiers. The class origin information will not be included. Class origin is the name of the class where the element is locally defined.

Parameters:

name - the CIMObjectPath that identifies the CIM class

Returns:

The CIM class identified by the CIMObjectPath

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_NOT_FOUND (the request CIM Class does not exist in the
   specified namespace) 
   CIM_ERR_FAILED (some other unspecified error occurred)
 

See Also:

enumerateClasses(javax.wbem.cim.CIMObjectPath), enumerateClassNames(javax.wbem.cim.CIMObjectPath)

getClass

public CIMClass getClass(CIMObjectPath name,
                         boolean localOnly)
                  throws CIMException

Gets the CIM class for the specified CIM object path. The entire class contents (and not just the class names) are returned. The returned class will include all the qualifiers. The class origin information will not be included. Class origin is the name of the class where the element is locally defined.

Parameters:

name - the CIMObjectPath that identifies the CIM class

localOnly - if true, only the non-inherited properties and methods are returned, otherwise all properties and methods are returned.

Returns:

The CIM class identified by the CIMObjectPath

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_NOT_FOUND (the request CIM Class does not exist in the
   specified namespace) 
   CIM_ERR_FAILED (some other unspecified error occurred)
 

See Also:

enumerateClasses(javax.wbem.cim.CIMObjectPath), enumerateClassNames(javax.wbem.cim.CIMObjectPath)

getClass

public CIMClass getClass(CIMObjectPath name,
                         boolean localOnly,
                         boolean includeQualifiers)
                  throws CIMException

Gets the CIM class for the specified CIM object path. The entire class contents (and not just the class names) are returned. The class origin information will not be included. Class origin is the name of the class where the element is locally defined.

Parameters:

name - the CIMObjectPath that identifies the CIM class

localOnly - If true, only the non-inherited properties and methods are returned. If false, all properties and methods are returned.

includeQualifiers - If the IncludeQualifiers input parameter is true this specifies that all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included. If false no Qualifiers are present in the returned Object.

Returns:

The CIM class identified by the CIMObjectPath

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_NOT_FOUND (the request CIM Class does not exist in the
   specified namespace) 
   CIM_ERR_FAILED (some other unspecified error occurred)
 

See Also:

enumerateClasses(javax.wbem.cim.CIMObjectPath), enumerateClassNames(javax.wbem.cim.CIMObjectPath)

getClass

public CIMClass getClass(CIMObjectPath name,
                         boolean localOnly,
                         boolean includeQualifiers,
                         boolean includeClassOrigin)
                  throws CIMException

Gets the CIM class for the specified CIM object path. The entire class contents (and not just the class names) are returned.

Parameters:

name - the CIMObjectPath that identifies the CIM class

localOnly - iIf true, only the non-inherited properties and methods are returned. If false, all properties and methods are returned.

includeQualifiers - If the IncludeQualifiers input parameter is true this specifies that all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included. If false no Qualifiers are present in the returned Object.

includeClassOrigin - If the IncludeClassOrigin input parameter is true, this specifies that the CLASSORIGIN attribute MUST be present on all appropriate elements in each returned Object. If false, no CLASSORIGIN attributes are present in each returned Object.

Returns:

The CIM class identified by the CIMObjectPath

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_NOT_FOUND (the request CIM Class does not exist in the
   specified namespace) 
   CIM_ERR_FAILED (some other unspecified error occurred)
 

See Also:

enumerateClasses(javax.wbem.cim.CIMObjectPath), enumerateClassNames(javax.wbem.cim.CIMObjectPath)

getClass

public CIMClass getClass(CIMObjectPath name,
                         boolean localOnly,
                         boolean includeQualifiers,
                         boolean includeClassOrigin,
                         java.lang.String[] propertyList)
                  throws CIMException

Gets the CIM class for the specified CIM object path. The entire class contents (and not just the class names) are returned.

Specified by:

getClass in interface CIMOMHandle

Parameters:

name - the CIMObjectPath that identifies the CIM class

localOnly - If true, only the non-inherited properties and methods are returned. If false, all properties and methods are returned.

includeQualifiers - If the IncludeQualifiers input parameter is true this specifies that all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included. If false no Qualifiers are present in the returned Object.

includeClassOrigin - If the IncludeClassOrigin input parameter is true, this specifies that the CLASSORIGIN attribute MUST be present on all appropriate elements in each returned Object. If false, no CLASSORIGIN attributes are present in each returned Object.

propertyList - If the PropertyList input parameter is not NULL, the members of the array define one or more Property names. Each returned Object MUST NOT include elements for any Properties missing from this list. Note that if LocalOnly is specified as true (or DeepInheritance is specified as false) this acts as an additional filter on the set of Properties returned (for example, if Property A is included in the PropertyList but LocalOnly is set to true and A is not local to a returned Instance, then it will not be included in that Instance). If the PropertyList input parameter is an empty array this signifies that no Properties are included in each returned Object. If the PropertyList input parameter is NULL this specifies that all Properties (subject to the conditions expressed by the other parameters) are included in each returned Object. If the PropertyList contains duplicate elements, the Server ignores the duplicates but otherwise process the request normally. If the PropertyList contains elements which are invalid Property names for any target Object, the Server ignores such entries but otherwise process the request normally.

Returns:

The CIM class identified by the CIMObjectPath

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_NOT_FOUND (the request CIM Class does not exist in the
   specified namespace) 
   CIM_ERR_FAILED (some other unspecified error occurred)
 

See Also:

enumerateClasses(javax.wbem.cim.CIMObjectPath), enumerateClassNames(javax.wbem.cim.CIMObjectPath)

getInstance

public CIMInstance getInstance(CIMObjectPath name)
                        throws CIMException

Gets the CIM instance for the specified CIM object path. Only the local (non-inherited) properties and methods will be returned. Qualifiers will not be present in the returned instance. The CLASSORIGIN attribute will not be present on the returned instance.

Parameters:

name - CIM Object Path that identifies this CIM instance. This must include all of the keys.

Returns:

The CIM instance identified by the CIMObjectPath

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_NOT_FOUND (if instance does not exist),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

See Also:

enumerateInstances(javax.wbem.cim.CIMObjectPath), enumerateInstanceNames(javax.wbem.cim.CIMObjectPath)

getInstance

public CIMInstance getInstance(CIMObjectPath name,
                               boolean localOnly)
                        throws CIMException

Gets the CIM instance for the specified CIM object path. Qualifiers will not be present in the returned instance. The CLASSORIGIN attribute will not be present in the returned instance.

Parameters:

name - CIM Object Path that identifies this CIM instance. This must include all of the keys.

localOnly - If true, only the non-inherited properties and methods are returned. If false, all properties and methods are returned.

Returns:

The CIM instance identified by the CIMObjectPath

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_NOT_FOUND (if instance does not exist),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

See Also:

enumerateInstances(javax.wbem.cim.CIMObjectPath), enumerateInstanceNames(javax.wbem.cim.CIMObjectPath)

getInstance

public CIMInstance getInstance(CIMObjectPath name,
                               boolean localOnly,
                               boolean includeQualifiers)
                        throws CIMException

Gets the CIM instance for the specified CIM object path. The CLASSORIGIN attribute will not be present in the returned instance.

Parameters:

name - CIM Object Path that identifies this CIM instance. This must include all of the keys.

localOnly - If true, only the non-inherited properties and methods are returned. If false, all properties and methods are returned.

includeQualifiers - If the IncludeQualifiers input parameter is true this specifies that all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included. If false no Qualifiers are present in the returned instance.

Returns:

The CIM instance identified by the CIMObjectPath

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_NOT_FOUND (if instance does not exist),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

See Also:

enumerateInstances(javax.wbem.cim.CIMObjectPath), enumerateInstanceNames(javax.wbem.cim.CIMObjectPath)

getInstance

public CIMInstance getInstance(CIMObjectPath name,
                               boolean localOnly,
                               boolean includeQualifiers,
                               boolean includeClassOrigin)
                        throws CIMException

Gets the CIM instance for the specified CIM object path.

Parameters:

name - CIM Object Path that identifies this CIM instance. This must include all of the keys.

localOnly - iIf true, only the non-inherited properties and methods are returned. If false, all properties and methods are returned.

includeQualifiers - If the IncludeQualifiers input parameter is true this specifies that all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included. If false no Qualifiers are present in the returned instance.

includeClassOrigin - If the IncludeClassOrigin input parameter is true, this specifies that the CLASSORIGIN attribute MUST be present on all appropriate elements in each returned Object. If false, no CLASSORIGIN attributes are present in each returned Object.

Returns:

The CIM instance identified by the CIMObjectPath

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_NOT_FOUND (if instance does not exist),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

See Also:

enumerateInstances(javax.wbem.cim.CIMObjectPath), enumerateInstanceNames(javax.wbem.cim.CIMObjectPath)

getInstance

public CIMInstance getInstance(CIMObjectPath name,
                               boolean localOnly,
                               boolean includeQualifiers,
                               boolean includeClassOrigin,
                               java.lang.String[] propertyList)
                        throws CIMException

Gets the CIM instance for the specified CIM object path.

Specified by:

getInstance in interface CIMOMHandle

Parameters:

name - CIM Object Path that identifies this CIM instance. This must include all of the keys.

localOnly - If true, only the non-inherited properties and methods are returned. If false, all properties and methods are returned.

includeQualifiers - If the IncludeQualifiers input parameter is true this specifies that all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included. If false no Qualifiers are present in the returned Object.

includeClassOrigin - If the IncludeClassOrigin input parameter is true, this specifies that the CLASSORIGIN attribute MUST be present on all appropriate elements in each returned Object. If false, no CLASSORIGIN attributes are present in each returned Object.

propertyList - If the PropertyList input parameter is not NULL, the members of the array define one or more Property names. Each returned Object MUST NOT include elements for any Properties missing from this list. Note that if LocalOnly is specified as true (or DeepInheritance is specified as false) this acts as an additional filter on the set of Properties returned (for example, if Property A is included in the PropertyList but LocalOnly is set to true and A is not local to a returned Instance, then it will not be included in that Instance). If the PropertyList input parameter is an empty array this signifies that no Properties are included in each returned Object. If the PropertyList input parameter is NULL this specifies that all Properties (subject to the conditions expressed by the other parameters) are included in each returned Object. If the PropertyList contains duplicate elements, the Server ignores the duplicates but otherwise process the request normally. If the PropertyList contains elements which are invalid Property names for any target Object, the Server ignores such entries but otherwise process the request normally.

Returns:

The CIM instance identified by the CIMObjectPath

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_NOT_FOUND (if instance does not exist),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

See Also:

enumerateInstances(javax.wbem.cim.CIMObjectPath), enumerateInstanceNames(javax.wbem.cim.CIMObjectPath)

invokeMethod

public CIMValue invokeMethod(CIMObjectPath name,
                             java.lang.String methodName,
                             java.util.Vector inParams,
                             java.util.Vector outParams)
                      throws CIMException

Executes the specified method on the specified object.

Specified by:

invokeMethod in interface CIMOMHandle

Parameters:

name - CIM object path of the object whose method must be invoked. It must include all of the keys.

methodName - the string name of the method to be invoked

inParams - the input parameters specified as a vector of CIMValue.

outParams - The output parameters, the CIMValue of these parameters will be appended to the outParams vector.

Returns:

CIMValue The return value of the method. If the method returns nothing, the return value will be null.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

 
   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_NOT_FOUND (if instance does not exist),
   CIM_ERR_METHOD_NOT_FOUND,
   CIM_ERR_METHOD_NOT_AVAILABLE,
   CIM_ERR_FAILED (some other unspecified error occurred)
 

getQualifierType

public CIMQualifierType getQualifierType(CIMObjectPath name)
                                  throws CIMException

Gets the CIM qualifier type specified in the CIM object path.

Specified by:

getQualifierType in interface CIMOMHandle

Parameters:

name - CIM object path that identifies the CIM qualifier type

Returns:

CIMQualifierType the CIM qualifier type

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_NOT_FOUND (the requested Qualifier declaration did not exist),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

createQualifierType

public void createQualifierType(CIMObjectPath name,
                                CIMQualifierType qt)
                         throws CIMException

Adds the specified CIM qualifier type to the specified namespace.

Specified by:

createQualifierType in interface CIMOMHandle

Parameters:

name - CIM object path that identifies the CIM qualifier type

qt - the CIM qualifier type to be adds

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_FAILED (some other unspecified error occurred)
   

setQualifierType

public void setQualifierType(CIMObjectPath name,
                             CIMQualifierType qt)
                      throws CIMException

Adds the specified CIM qualifier type to the specified namespace if it does not already exist. Otherwise, it sets the value qualifier type to the one passed in.

Specified by:

setQualifierType in interface CIMOMHandle

Parameters:

name - CIM object path that identifies the CIM qualifier type

qt - the CIM qualifier type to be added

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

createClass

public void createClass(CIMObjectPath name,
                        CIMClass cc)
                 throws CIMException

Adds the CIM class to the specified namespace.

Specified by:

createClass in interface CIMOMHandle

Parameters:

name - CIM object path that identifies the CIM class to be added

cc - CIMClass to be added

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_ALREADY_EXISTS (the CIM Class already exists)
   CIM_ERR_INVALID_SUPERCLASS (the putative CIM Class declares a
   non-existent superclass),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

setClass

public void setClass(CIMObjectPath name,
                     CIMClass cc)
              throws CIMException

Modifies the CIM class in the specified namespace.

Specified by:

setClass in interface CIMOMHandle

Parameters:

name - CIM object path that identifies the CIM class to be modified

cc - CIMClass to be modified

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_INVALID_SUPERCLASS (the putative CIM Class declares a
   non-existent superclass),
   CIM_ERR_CLASS_HAS_CHILDREN (the modification could not be performed
   because it was not possible to update the subclasses of the Class
   in a consistent fashion),
   CIM_ERR_CLASS_HAS_INSTANCES (the modification could not be performed
   because it was not possible to update the instances of the Class in
   a consistent fashion)  
   CIM_ERR_FAILED (some other unspecified error occurred)
 

createInstance

public CIMObjectPath createInstance(CIMObjectPath name,
                                    CIMInstance ci)
                             throws CIMException

Adds the specified CIM Instance to the specified namespace

Specified by:

createInstance in interface CIMOMHandle

Parameters:

name - CIM object path that identifies the CIM instance to be added. Only the name space component is used. Any other information (e.g. keys) is ignored.

ci - CIM instance to be added. Its keys and properties may be initialized by either the client or server.

Returns:

CIMObjectPath of the created instance. This will be non-null only if one or more of the keys have changed.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_ALREADY_EXISTS,
   CIM_ERR_FAILED (some other unspecified error occurred)
 

setInstance

public void setInstance(CIMObjectPath name,
                        CIMInstance ci)
                 throws CIMException

Modifies the specified CIM instance in the specified namespace.

Specified by:

setInstance in interface CIMOMHandle

Parameters:

name - CIM object path that identifies the CIM instance to be modified. It must include all of the keys.

ci - CIM instance to be modified. Its properties may be initialized by either the client or server.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_NOT_FOUND (if instance does not exist),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

Example:

The following code sample gets instances for each element in a vector, updates the property value of b to 10 in each instance, and passes the updated instance to the CIM Object Manager.

For (int i=0; i(v.size(); i++) {
 		CIMInstance ci = cc.getInstance(v.elementAt(i));
		ci.setProperty("b",new CIMValue(10)); 
          // sets the instance in the current namespace.
 		cc.setInstance(new CIMObjectPath(),ci); 
		}

getProperty

public CIMValue getProperty(CIMObjectPath name,
                            java.lang.String propertyName)
                     throws CIMException

Gets the value of the specified property for the instance specified in the object path.

Specified by:

getProperty in interface CIMOMHandle

Parameters:

name - CIM object path that identifies the CIM instance to be accessed. It must include all of the keys.

propertyName - Property whose value is required.

Returns:

CIMValue The value for property propertyName.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_NOT_FOUND (if instance does not exist),
   CIM_ERR_NO_SUCH_PROPERTY (in this instance),
   CIM_ERR_TYPE_MISMATCH (for this property),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

setProperty

public void setProperty(CIMObjectPath name,
                        java.lang.String propertyName,
                        CIMValue newValue)
                 throws CIMException

Modifies the value of the specified property for the instance specified in the object path.

Specified by:

setProperty in interface CIMOMHandle

Parameters:

name - CIM object path that identifies the CIM instance to be accessed. It must include all of the keys.

propertyName - Property whose value is to be set.

newValue - The value for property propertyName.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_INVALID_CLASS (in this namespace),
   CIM_ERR_NOT_FOUND (if instance does not exist),
   CIM_ERR_NO_SUCH_PROPERTY (in this instance),
   CIM_ERR_TYPE_MISMATCH (for this property),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

encryptData

public java.lang.String encryptData(java.lang.String clearData)
                             throws CIMException

Encrypts a limited sized string value using the current authentication exchange session key. It returns the encrypted value as a string of hexadecimal characters enclosed in brackets <>. The enclosing brackets can be used to determine that such a string value has been encrypted. The size of the string to be encrypted must be less than or equal to 16 characters. It is assumed the string is unlocalized; that is, only ASCII characters will be encrypted correctly. It the string value is too long, or there is no authentication exchange session key, a CIMException is thrown.

Specified by:

encryptData in interface CIMOMHandle

Parameters:

clearData - The string to be encrypted

Returns:

The bracketed encrypted string in hexadecimal form

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED,
   CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or
   otherwise incorrect parameters),
   CIM_ERR_FAILED (some other unspecified error occurred)
 

execQuery

public java.util.Enumeration execQuery(CIMObjectPath name,
                                       java.lang.String query,
                                       java.lang.String ql)
                                throws CIMException

Executes a query to retrieve objects. The WBEM Query Language is a subset of standard American National Standards Institute Structured Query Language (ANSI SQL) with semantic changes to support WBEM. Unlike SQL, in this release, it is a retrieval-only language. You cannot use the WBEM Query Language to modify, insert, or delete information.

Only queries on class instances are supported.

Specified by:

execQuery in interface CIMOMHandle

Parameters:

name - CIMObjectPath that identifies the class in which to query. Only the name space and class name components are used. Any other information (e.g. keys) is ignored.

query - A string containing the text of the query. This parameter cannot be null.

ql - String that identifies the query language to use for parsing the query string (e.g. WQL). WQL level 1 is the only currently supported query language.

Returns:

Enumeration A deep enumeration of all instances of the specified class and all classes derived from the specified class, that match the query string.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

    CIM_ERR_ACCESS_DENIED,
    CIM_ERR_NOT_SUPPORTED (provider does not support this method),
    CIM_ERR_INVALID_NAMESPACE,
    CIM_ERR_INVALID_PARAMETER (for this method),
    CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED,
    CIM_ERR_INVALID_QUERY,
    CIM_ERR_FAILED (some other unspecified error occurred)
 

Example:

The following API call returns an enumeration of all instances of the device_class.

cc.execQuery(new CIMObjectPath(), SELECT * FROM device_class, cc.WQL)

associators

public java.util.Enumeration associators(CIMObjectPath objectName,
                                         java.lang.String assocClass,
                                         java.lang.String resultClass,
                                         java.lang.String role,
                                         java.lang.String resultRole,
                                         boolean includeQualifiers,
                                         boolean includeClassOrigin,
                                         java.lang.String[] propertyList)
                                  throws CIMException

Enumerate CIM Objects that are associated to a particular source CIM Object. If the source CIM object is a class, then associated class names are returned. If the target CIM object is an instance, then entire instances of associated classes are returned.

Specified by:

associators in interface CIMOMHandle

Parameters:

objectName - - Defines the source CIM Object whose associated Objects are to be returned. This may be either a Class name or Instance name (modelpath).

assocClass - The AssocClass input parameter, if not NULL, MUST be a valid CIM Association Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Instance of this Class or one of its subclasses.

resultClass - The ResultClass input parameter, if not NULL, MUST be a valid CIM Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be either an Instance of this Class (or one of its subclasses) or be this Class (or one of its subclasses).

role - The Role input parameter, if not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter).

resultRole - The ResultRole input parameter, if not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the returned Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the returned Object MUST match the value of this parameter).

includeQualifiers - If the IncludeQualifiers input parameter is true this specifies that all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included as elements in the response. If false no elements are present in each returned Object.

includeClassOrigin - If the IncludeClassOrigin input parameter is true, this specifies that the CLASSORIGIN attribute MUST be present on all appropriate elements in each returned Object. If false, no CLASSORIGIN attributes are present in each returned Object.

propertyList - If the PropertyList input parameter is not NULL, the members of the array define one or more Property names. Each returned Object MUST NOT include elements for any Properties missing from this list. Note that if LocalOnly is specified as true (or DeepInheritance is specified as false) this acts as an additional filter on the set of Properties returned (for example, if Property A is included in the PropertyList but LocalOnly is set to true and A is not local to a returned Instance, then it will not be included in that Instance). If the PropertyList input parameter is an empty array this signifies that no Properties are included in each returned Object. If the PropertyList input parameter is NULL this specifies that all Properties (subject to the conditions expressed by the other parameters) are included in each returned Object. If the PropertyList contains duplicate elements, the Server ignores the duplicates but otherwise process the request normally. If the PropertyList contains elements which are invalid Property names for any target Object, the Server ignores such entries but otherwise process the request normally. Clients SHOULD NOT explicitly specify properties in the PropertyList parameter unless they have specified a non-NULL value for the ResultClass parameter.

Returns:

If successful, the method returns zero or more CIM Classes or Instances meeting the requested criteria.

Throws:

CIMException. - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

 CIM_ERR_ACCESS_DENIED
 CIM_ERR_NOT_SUPPORTED
 CIM_ERR_INVALID_NAMESPACE
 CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized 
 or otherwise incorrect parameters)
 CIM_ERR_FAILED (some other unspecified error occurred)
 

associatorNames

public java.util.Enumeration associatorNames(CIMObjectPath objectName,
                                             java.lang.String assocClass,
                                             java.lang.String resultClass,
                                             java.lang.String role,
                                             java.lang.String resultRole)
                                      throws CIMException

Enumerates the object paths to CIM Objects that are associated to a particular source CIM Object. If the source CIM object is a class, then associated class names are returned. If the target CIM object is an instance, then object paths to the instances of associated classes are returned.

Specified by:

associatorNames in interface CIMOMHandle

Parameters:

objectName - - Defines the source CIM Object whose associated Objects are to be returned. This may be either a Class name or Instance name (modelpath).

assocClass - The AssocClass input parameter, if not NULL, MUST be a valid CIM Association Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Instance of this Class or one of its subclasses.

resultClass - The ResultClass input parameter, if not NULL, MUST be a valid CIM Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be either an Instance of this Class (or one of its subclasses) or be this Class (or one of its subclasses).

role - The Role input parameter, if not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter).

resultRole - The ResultRole input parameter, if not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the returned Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the returned Object MUST match the value of this parameter).

Returns:

If successful, the method returns zero or more full CIM Class paths or Instance paths of Objects meeting the requested criteria.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

 CIM_ERR_ACCESS_DENIED
 CIM_ERR_NOT_SUPPORTED
 CIM_ERR_INVALID_NAMESPACE
 CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized 
 or otherwise incorrect parameters)
 CIM_ERR_FAILED (some other unspecified error occurred)
 

references

public java.util.Enumeration references(CIMObjectPath objectName,
                                        java.lang.String resultClass,
                                        java.lang.String role,
                                        boolean includeQualifiers,
                                        boolean includeClassOrigin,
                                        java.lang.String[] propertyList)
                                 throws CIMException

Enumerates the association objects that refer to a particular target CIM Object. If the target CIM object is a class, association class names are returned. If the target CIM object is an instance, then association instances are returned.

Specified by:

references in interface CIMOMHandle

Parameters:

objectName - The ObjectName input parameter defines the target CIM Object whose referring Objects are to be returned. This is either a Class name or Instance name (model path).

ResultClass - The ResultClass input parameter, if not NULL, MUST be a valid CIM Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be an Instance of this Class (or one of its subclasses), or this Class (or one of its subclasses).

role - The Role input parameter, if not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Objects MUST refer to the target Object via a Property whose name matches the value of this parameter.

includeQualifiers - If the IncludeQualifiers input parameter is true this specifies that all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included as elements in the response. If false no elements are present in each returned Object.

includeClassOrigin - If the IncludeClassOrigin input parameter is true, this specifies that the CLASSORIGIN attribute MUST be present on all appropriate elements in each returned Object. If false, no CLASSORIGIN attributes are present in each returned Object.

propertyList - If the PropertyList input parameter is not NULL, the members of the array define one or more Property names. Each returned Object MUST NOT include elements for any Properties missing from this list. Note that if LocalOnly is specified as true (or DeepInheritance is specified as false) this acts as an additional filter on the set of Properties returned (for example, if Property A is included in the PropertyList but LocalOnly is set to true and A is not local to a returned Instance, then it will not be included in that Instance). If the PropertyList input parameter is an empty array this signifies that no Properties are included in each returned Object. If the PropertyList input parameter is NULL this specifies that all Properties (subject to the conditions expressed by the other parameters) are included in each returned Object. If the PropertyList contains duplicate elements, the Server ignores the duplicates but otherwise process the request normally. If the PropertyList contains elements which are invalid Property names for any target Object, the Server ignores such entries but otherwise process the request normally. Clients SHOULD NOT explicitly specify properties in the PropertyList parameter unless they have specified a non-NULL value for the ResultClass parameter.

Returns:

If successful, the method returns zero or more CIM Classes or Instances meeting the requested criteria.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

 CIM_ERR_ACCESS_DENIED
 CIM_ERR_NOT_SUPPORTED
 CIM_ERR_INVALID_NAMESPACE
 CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized 
 or otherwise incorrect parameters)
 CIM_ERR_FAILED (some other unspecified error occurred)
 

referenceNames

public java.util.Enumeration referenceNames(CIMObjectPath objectName,
                                            java.lang.String resultClass,
                                            java.lang.String role)
                                     throws CIMException

Enumerates the object paths to association objects that refer to a particular target CIM Object. If the target CIM object is a class, association class names are returned. If the target CIM object is an instance, then object paths to the association instances are returned.

Specified by:

referenceNames in interface CIMOMHandle

Parameters:

objectName - The ObjectName input parameter defines the target CIM Object whose referring Objects are to be returned. This is either a Class name or Instance name (model path).

ResultClass - The ResultClass input parameter, if not NULL, MUST be a valid CIM Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be an Instance of this Class (or one of its subclasses), or this Class (or one of its subclasses).

role - The Role input parameter, if not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Objects MUST refer to the target Object via a Property whose name matches the value of this parameter.

Returns:

If successful, the method returns the names of zero or more full CIM Class paths or Instance paths of Objects meeting the requested criteria.

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

 CIM_ERR_ACCESS_DENIED
 CIM_ERR_NOT_SUPPORTED
 CIM_ERR_INVALID_NAMESPACE
 CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized 
 or otherwise incorrect parameters)
 CIM_ERR_FAILED (some other unspecified error occurred)
 

addCIMListener

public void addCIMListener(CIMListener l)
                    throws CIMException

Adds the specified listener which receives indications from the CIM Object Manager. Requests to add duplicate listeners are ignored.

Specified by:

addCIMListener in interface CIMOMHandle

Parameters:

l - The listener to add.

Returns:

void

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

 CIM_ERR_ACCESS_DENIED,
 CIM_ERR_NOT_SUPPORTED (if CIMOM does not support events),
 CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized 
 or otherwise incorrect parameters),
 CIM_ERR_FAILED (some other unspecified error occurred)
 

removeCIMListener

public void removeCIMListener(CIMListener l)
                       throws CIMException

Removes the specified listener which receives indications from the CIM Object Manager. No exception is thrown if l is null or the listener does not exist.

Specified by:

removeCIMListener in interface CIMOMHandle

Parameters:

l - The listener to add.

Returns:

void

Throws:

CIMException - If unsuccessful, one of the following status codes MUST be returned. The ORDERED list is:

 CIM_ERR_ACCESS_DENIED,
 CIM_ERR_NOT_SUPPORTED (if CIMOM does not support events),
 CIM_ERR_FAILED (some other unspecified error occurred)
 

performBatchOperations

public BatchResult performBatchOperations(BatchHandle bc)
                                   throws CIMException

Specified by:

performBatchOperations in interface CIMOMHandle