org.sblim.cimclient.internal.wbem
Class WBEMClientCIMXML

java.lang.Object
  extended by org.sblim.cimclient.internal.wbem.WBEMClientCIMXML
All Implemented Interfaces:
WBEMClient, WBEMClientSBLIM

public class WBEMClientCIMXML
extends Object
implements WBEMClientSBLIM

The WBEMClientCIMXML is a implementation of the javax.wbem.client.WBEMClient interface for the CIM-XML protocol including the extensions of the org.sblim.cimclient.WBEMClientSBLIM interface.

See Also:
WBEMClient, WBEMClientSBLIM

Constructor Summary
WBEMClientCIMXML()
          Ctor.
 
Method Summary
 CloseableIterator<CIMClass> associatorClasses(CIMObjectPath pObjectName, String pAssociationClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList)
          Enumerates CIM classes that are associated to a specified source CIM class.
 CloseableIterator<CIMInstance> associatorInstances(CIMObjectPath pObjectName, String pAssociationClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeClassOrigin, String[] pPropertyList)
          Enumerates CIM Instances associated to a specified source CIM Instance.
 CloseableIterator<CIMObjectPath> associatorNames(CIMObjectPath pObjectName, String pAssociationClass, String pResultClass, String pRole, String pResultRole)
          Enumerates the CIMObjectPaths of CIM Objects that are associated to a particular source CIM Object.
 EnumerateResponse<CIMObjectPath> associatorPaths(CIMObjectPath pObjectName, String pAssociationClass, String pResultClass, String pRole, String pResultRole, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects)
          associatorPaths will start an enumeration session for traversing associations starting from the instance defined in the pInstancePath parameter using any specified filtering criteria and return zero or more CIMObjectPath objects.
 EnumerateResponse<CIMInstance> associators(CIMObjectPath pObjectName, String pAssocClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeClassOrigin, String[] pPropertyList, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects)
          associators will start an enumeration session for traversing associations starting from the instance defined in the pInstancePath parameter using any specified filtering criteria and return zero or more CIMInstance objects.
 void close()
          Closes the WBEMClient session.
 void closeEnumeration(CIMObjectPath pObjectName, String pEnumerationContext)
          closeEnumeration will close an enumeration session that has been previously started but not yet completed.
 void createClass(CIMClass pClass)
          Create a CIM class.
 CIMObjectPath createInstance(CIMInstance pInstance)
          Create a CIM Instance.
 void deleteClass(CIMObjectPath pPath)
          Deletes the CIM class for the object specified by the CIM object path.
 void deleteInstance(CIMObjectPath pPath)
          Delete the CIM instance specified by the CIM object path.
 void deleteQualifierType(CIMObjectPath pPath)
          Delete a CIM Qualifier type.
 CloseableIterator<CIMClass> enumerateClasses(CIMObjectPath pPath, boolean pDeep, boolean pPropagated, boolean pIncludeQualifiers, boolean pIncludeClassOrigin)
          Enumerate CIM Classes.
 CloseableIterator<CIMObjectPath> enumerateClassNames(CIMObjectPath pPath, boolean pDeep)
          Enumerate the names of CIM Classes.
 CloseableIterator<CIMObjectPath> enumerateInstanceNames(CIMObjectPath pPath)
          Enumerate the names of the instances for a specified class.
 EnumerateResponse<CIMObjectPath> enumerateInstancePaths(CIMObjectPath pObjectName, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects)
          enumerateInstancePaths will enumerate the instances of the specified class in pClassPath and return zero or more CIMObjectPaths.
 CloseableIterator<CIMInstance> enumerateInstances(CIMObjectPath pPath, boolean pDeep, boolean pPropagated, boolean pIncludeClassOrigin, String[] pPropertyList)
          Enumerate the instances of a class.
 EnumerateResponse<CIMInstance> enumerateInstances(CIMObjectPath pObjectName, boolean pDeepInheritance, boolean pIncludeClassOrigin, String[] pPropertyList, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects)
          enumerateInstances will enumerate the instances of the specified class in pClassPath and return zero or more CIMInstances.
 CloseableIterator<CIMObjectPath> enumerateNamespaces(String pNamespace)
          Enumerate the names of the instances of CIM namespaces.
 CloseableIterator<CIMQualifierType<?>> enumerateQualifierTypes(CIMObjectPath pPath)
          Enumerates the CIM Qualifier types for a specific namespace.
 UnsignedInteger64 enumerationCount(CIMObjectPath pObjectName, String pEnumerationContext)
          enumerationCount provides an estimated count of the total number of objects in an open enumeration session represented by an enumeration context.
 CloseableIterator<CIMInstance> execQuery(CIMObjectPath pPath, String pQuery, String pQueryLanguage)
          execQuery will execute a query to retrieve objects.
 EnumerateResponse<CIMInstance> execQueryInstances(CIMObjectPath pObjectName, String pFilterQuery, String pFilterQueryLanguage, boolean pReturnQueryResultClass, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects, CIMClass pQueryResultClass)
          execQueryInstances will execute a query to retrieve instances.
 CIMClass getClass(CIMObjectPath pName, boolean pPropagated, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList)
          Returns the CIMClass for the specified CIMObjectPath.
 SocketFactory getCustomSocketFactory()
          Gets the custom socket factory if one is set.
 CIMInstance getInstance(CIMObjectPath pName, boolean pPropagated, boolean pIncludeClassOrigin, String[] pPropertyList)
          Get a CIMInstance.
 EnumerateResponse<CIMObjectPath> getInstancePaths(CIMObjectPath pObjectName, String pContext, UnsignedInteger32 pMaxObjects)
          getInstancePaths will get the CIMObjectPaths using an enumeration context.
 EnumerateResponse<CIMInstance> getInstances(CIMObjectPath pObjectName, String pContext, UnsignedInteger32 pMaxObjects)
          getInstances will get the instances from an enumeration session started by execQueryInstances.
 EnumerateResponse<CIMInstance> getInstancesWithPath(CIMObjectPath pObjectName, String pContext, UnsignedInteger32 pMaxObjects)
          getInstancesWithPath will use the enumeration context provided to get the next set of instances for the enumeration session.
 Properties getLocalProperties()
          Returns the configuration properties that are local to the current thread.
 Properties getProperties()
          Returns the client specific configuration properties.
 String getProperty(String pKey)
          Get property values.
 CIMQualifierType<?> getQualifierType(CIMObjectPath pName)
          Get a CIMQualifierType.
 void initialize(CIMObjectPath pName, Subject pSubject, Locale[] pLocales)
          Initialize the client connection.
 void initialize(URI pUri, Subject pSubject, Locale[] pLocales)
          Initialize the client connection.
 Object invokeMethod(CIMObjectPath pName, String pMethodName, CIMArgument<?>[] pInputArguments, CIMArgument<?>[] pOutputArguments)
          Executes the specified method on the specified object.
 boolean isActive()
          Returns an indication of whether the client is active (initialized and not closed) or inactive (not initialized or closed).
 void modifyClass(CIMClass pClass)
          Modify the CIMClass.
 void modifyInstance(CIMInstance pInst, String[] pPropertyList)
          Modify some or all of the properties of the specified CIMInstance.
 CloseableIterator<CIMClass> referenceClasses(CIMObjectPath pObjectName, String pResultClass, String pRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList)
          Enumerates the Association classes that refer to a specified source CIM Class.
 CloseableIterator<CIMInstance> referenceInstances(CIMObjectPath pObjectName, String pResultClass, String pRole, boolean pIncludeClassOrigin, String[] pPropertyList)
          Enumerates the Association instances that refer to a specified source CIM Instance.
 CloseableIterator<CIMObjectPath> referenceNames(CIMObjectPath pObjectName, String pResultClass, String pRole)
          Enumerates the CIMObjectPaths of Association Objects that refer to a particular source CIM Object.
 EnumerateResponse<CIMObjectPath> referencePaths(CIMObjectPath pObjectName, String pResultClass, String pRole, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects)
          referencePaths will start an enumeration session for association instances that have references that refer to the instance defined in the pInstancePath parameter and return zero or more CIMObjectPath objects.
 EnumerateResponse<CIMInstance> references(CIMObjectPath pObjectName, String pResultClass, String pRole, boolean pIncludeClassOrigin, String[] pPropertyList, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects)
          references will start an enumeration session for association instances that have references that refer to the instance defined in the pInstancePath parameter and return zero or more CIMInstance objects.
 boolean sendIndication(URI pRecipient, CIMInstance pIndication)
          Sends the indication to the specified recipient.
 void setCustomSocketFactory(SocketFactory pFactory)
          Sets a custom socket factory.
 void setLocales(Locale[] pLocales)
          Change the locales that were provided during initialization.
 void setLocalProperties(Properties pProperties)
          Sets the configuration properties that are local to the current thread.
 void setLocalProperty(String pKey, String pValue)
          Sets a local configuration property for the current thread.
 void setProperties(Properties pProperties)
          Sets the client specific configuration properties.
 void setProperty(String pKey, String pValue)
          Set properties that enable options or protocol specific properties.
 void setQualifierType(CIMQualifierType<?> pQualifierType)
          Add a CIMQualifierType to the specified namespace if it does not already exist.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WBEMClientCIMXML

public WBEMClientCIMXML()
Ctor.

Method Detail

initialize

public void initialize(CIMObjectPath pName,
                       Subject pSubject,
                       Locale[] pLocales)
                throws IllegalArgumentException,
                       WBEMException
Description copied from interface: WBEMClient
Initialize the client connection. This must be called before any operations. This must only be called once.

Specified by:
initialize in interface WBEMClient
Parameters:
pName - The protocol and host to use (e.g. http://192.168.1.128/). Any other fields will be ignored.
pSubject - The principal/credential pairs for this connection.
pLocales - An array of locales in order of priority of preference.
Throws:
IllegalArgumentException - If the host or scheme portion of the object path is null, or if the protocol is not supported.
WBEMException - If the protocol adapter or security cannot be initialized.

initialize

public void initialize(URI pUri,
                       Subject pSubject,
                       Locale[] pLocales)
                throws IllegalArgumentException,
                       WBEMException
Description copied from interface: WBEMClientSBLIM
Initialize the client connection. This must be called before any operations. This must only be called once.

Specified by:
initialize in interface WBEMClientSBLIM
Parameters:
pUri - The protocol and host to use. Any other fields will be ignored.
pSubject - The principal/credential pairs for this connection.
pLocales - An array of locales in order of priority of preference.
Throws:
IllegalArgumentException - If the host or scheme portion of the object path is null, or if the protocol is not supported.
WBEMException - If the protocol adapter or security cannot be initialized.

getProperties

public Properties getProperties()
Description copied from interface: WBEMClientSBLIM
Returns the client specific configuration properties. Note that only these properties are returned that override the global settings. The global settings can be accessed via the java.lang.System class.
If the no client specific configuration is set, this method returns null

Specified by:
getProperties in interface WBEMClientSBLIM
Returns:
The configuration properties
See Also:
System.getProperties()

getProperty

public String getProperty(String pKey)
Description copied from interface: WBEMClient
Get property values. See WBEMClientConstants for a list of standard properties.

Specified by:
getProperty in interface WBEMClient
Specified by:
getProperty in interface WBEMClientSBLIM
Parameters:
pKey - The name of the property.
Returns:
The value of the property.
See Also:
WBEMClientConstants

setProperties

public void setProperties(Properties pProperties)
Description copied from interface: WBEMClientSBLIM
Sets the client specific configuration properties. Any previously set client specific properties are overwritten. The given properties are handled as an overlay on the global settings. That means that properties specified here override the corresponding global properties whereas properties not specified here are taken from the global properties. The global settings can be accessed via the java.lang.System class.

Specified by:
setProperties in interface WBEMClientSBLIM
Parameters:
pProperties - The session specific properties. null resets this client to the global settings.
See Also:
System.setProperties(Properties)

setProperty

public void setProperty(String pKey,
                        String pValue)
Description copied from interface: WBEMClient
Set properties that enable options or protocol specific properties. See WBEMClientConstants for a list of standard properties.

Specified by:
setProperty in interface WBEMClient
Specified by:
setProperty in interface WBEMClientSBLIM
Parameters:
pKey - The name of the property.
pValue - The value of the property.
See Also:
WBEMClientConstants

associatorNames

public CloseableIterator<CIMObjectPath> associatorNames(CIMObjectPath pObjectName,
                                                        String pAssociationClass,
                                                        String pResultClass,
                                                        String pRole,
                                                        String pResultRole)
                                                 throws WBEMException
Description copied from interface: WBEMClient
Enumerates the CIMObjectPaths of CIM Objects that are associated to a particular source CIM Object. If the source Object is a CIM Class, then a CloseableIterator of CIMObjectPath s of the classes associated to the source Object is returned. If the source Object is a CIM Instance, then a CloseableIterator of CIMObjectPaths of the CIMInstance objects associated to the source Object is returned.

Specified by:
associatorNames in interface WBEMClient
Parameters:
pObjectName - CIMObjectPath defining the source CIM Object whose associated Objects are to be returned. This argument may contain either a Class name or the modelpath of an Instance. (i.e. Keys populated)
pAssociationClass - This string MUST either contain a valid CIM Association class name or be null. It filters the Objects returned to contain only Objects associated to the source Object via this CIM Association class or one of its subclasses.
pResultClass - This string MUST either contain a valid CIM Class name or be null. It filters the Objects returned to contain only the Objects of this Class name or one of its subclasses.
pRole - This string MUST either contain a valid Property name or be null. It filters the Objects returned to contain only Objects associated to the source Object via an Association class in which the source Object plays the specified role. (i.e. the Property name in the Association class that refers to the source Object matches this value) If "Antecedent" is specified, then only Associations in which the source Object is the "Antecedent" reference are examined.
pResultRole - This string MUST either contain a valid Property name or be null. It filters the Objects returned to contain only Objects associated to the source Object via an Association class in which the Object returned plays the specified role. (i.e. the Property name in the Association class that refers to the Object returned matches this value) If "Dependent" is specified, then only Associations in which the Object returned is the "Dependent" reference are examined.
Returns:
If successful, a CloseableIterator containing zero or more CIMObjectPath objects of the CIM Classes or CIM Instances meeting the specified criteria is returned.
Throws:
WBEMException - 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)
 

associatorClasses

public CloseableIterator<CIMClass> associatorClasses(CIMObjectPath pObjectName,
                                                     String pAssociationClass,
                                                     String pResultClass,
                                                     String pRole,
                                                     String pResultRole,
                                                     boolean pIncludeQualifiers,
                                                     boolean pIncludeClassOrigin,
                                                     String[] pPropertyList)
                                              throws WBEMException
Description copied from interface: WBEMClient
Enumerates CIM classes that are associated to a specified source CIM class.

Specified by:
associatorClasses in interface WBEMClient
Parameters:
pObjectName - CIMObjectPath defining the source CIM Class whose associated classes are to be returned. The pObjectName shall include the host, namespace and object name. The keys shall not be populated.
pAssociationClass - This string shall contain a valid CIM Association class name or be null. It filters the classes returned to contain only classes associated to the source Object via this CIM Association class or one of its subclasses.
pResultClass - This string shall either contain a valid CIM Class name or be null. It filters the classes returned to contain only the classes of this class name or one of its subclasses.
pRole - This string shall either contain a valid Property name or be null. It filters the classes returned to contain only classes associated to the source class via an Association class in which the source class plays the specified role. (i.e. the Property name in the Association class that refers to the source class matches this value) For example, if "Antecedent" is specified, then only Associations in which the source class is the "Antecedent" reference are examined.
pResultRole - This string shall either contain a valid Property name or be null. It filters the classes returned to contain only classes associated to the source class via an Association class in which the class returned plays the specified role. (i.e. the Property name in the Association class that refers to the class returned matches this value)
pIncludeQualifiers - If true, all Qualifiers for each class (including Qualifiers on the Object and on any returned Properties) MUST be included in the classes returned. If false, no Qualifiers are present in each class returned.
pIncludeClassOrigin - The class origin attribute is the name of the class that first defined the property or method. If true, the class origin attribute will be present for each property and method on all classes returned. If false, the class origin will not be present.
pPropertyList - An array of property names used to filter what is contained in the classes returned. Each CIMClass returned shall only contain elements for the properties of the names specified. Duplicate and invalid property names are ignored and the request is otherwise processed normally. An empty array indicates that no properties should be included in the classes returned. A null value indicates that all properties should be contained in the classes returned.
Returns:
If successful, a CloseableIterator containing zero or more CIMClasses meeting the specified criteria are returned.
Throws:
WBEMException - If unsuccessful, one of the following status codes shall be returned along with zero or more instances of CIM_Error. 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)
 

associatorInstances

public CloseableIterator<CIMInstance> associatorInstances(CIMObjectPath pObjectName,
                                                          String pAssociationClass,
                                                          String pResultClass,
                                                          String pRole,
                                                          String pResultRole,
                                                          boolean pIncludeClassOrigin,
                                                          String[] pPropertyList)
                                                   throws WBEMException
Description copied from interface: WBEMClient
Enumerates CIM Instances associated to a specified source CIM Instance.

Specified by:
associatorInstances in interface WBEMClient
Parameters:
pObjectName - CIMObjectPath defining the source CIM Instance whose associated instances are to be returned. The pObjectName must contain the host, namespace, object name and keys for the instance.
pAssociationClass - This string shall either contain a valid CIM Association class name or be null. It filters the instances returned to contain only instances associated to the source instance via this CIM Association class or one of its subclasses.
pResultClass - This string shall either contain a valid CIM Class name or be null. It filters the instances returned to contain only the instances of this Class name or one of its subclasses.
pRole - This string shall either contain a valid Property name or be null. It filters the Objects returned to contain only Objects associated to the source Object via an Association class in which the source Object plays the specified role. (i.e. the Property name in the Association class that refers to the source Object matches this value) If "Antecedent" is specified, then only Associations in which the source Object is the "Antecedent" reference are examined.
pResultRole - This string shall either contain a valid Property name or be null. It filters the instances returned to contain only instances associated to the source instance via an Association class in which the instance returned plays the specified role. (i.e. the Property name in the Association class that refers to the instance returned matches this value) For example, if "Dependent" is specified, then only Associations in which the instance returned is the "Dependent" reference are examined.
pIncludeClassOrigin - The class origin attribute is the name of the class that first defined the property. If true, the class origin attribute will be present for each property on all instances returned. If false, the class origin will not be present.
pPropertyList - An array of property names used to filter what is contained in the Objects returned. Each CIMInstance returned only contains elements for the properties of the names specified. Duplicate and invalid property names are ignored and the request is otherwise processed normally. An empty array indicates that no properties should be included in the instances returned. A null value indicates that all properties should be contained in the instances returned.
Returns:
If successful, a CloseableIterator containing zero or more CIMInstances meeting the specified criteria is returned.
Throws:
WBEMException - If unsuccessful, one of the following status codes shall be returned along with zero or more instances of CIM_Error. 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)
 

close

public void close()
Description copied from interface: WBEMClient
Closes the WBEMClient session.

Specified by:
close in interface WBEMClient

createClass

public void createClass(CIMClass pClass)
                 throws WBEMException
Description copied from interface: WBEMClient
Create a CIM class. The namespace from the CIMClass.getObjectPath() will be used.

Specified by:
createClass in interface WBEMClient
Parameters:
pClass - The CIMClass to be created.
Throws:
WBEMException - 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)
 

createInstance

public CIMObjectPath createInstance(CIMInstance pInstance)
                             throws WBEMException
Description copied from interface: WBEMClient
Create a CIM Instance. The namespace from the CIMInstance.getObjectPath() will be used. The keys of the CIMInstance may be modified by the implementation and the client must use the returned object path to determine the name of the instance. It is possible for a client to leave keys of instances empty/ null and the provider can fill them in. This is implementation specific unless specified by a CIM Schema or in a DMTF Profile.

Specified by:
createInstance in interface WBEMClient
Parameters:
pInstance - The CIMInstance to be created.
Returns:
CIMObjectPath of the instance created.
Throws:
WBEMException - 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)
 

deleteClass

public void deleteClass(CIMObjectPath pPath)
                 throws WBEMException
Description copied from interface: WBEMClient
Deletes the CIM class for the object specified by the CIM object path.

Specified by:
deleteClass in interface WBEMClient
Parameters:
pPath - The CIMObjectPath identifying the namespace and class name to delete.
Throws:
WBEMException - 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 pPath)
                    throws WBEMException
Description copied from interface: WBEMClient
Delete the CIM instance specified by the CIM object path.

Specified by:
deleteInstance in interface WBEMClient
Parameters:
pPath - The object path of the instance to be deleted. It must include all of the keys.
Throws:
WBEMException - 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 the instance does not exist)
      CIM_ERR_FAILED (some other unspecified error occurred)
 

deleteQualifierType

public void deleteQualifierType(CIMObjectPath pPath)
                         throws WBEMException
Description copied from interface: WBEMClient
Delete a CIM Qualifier type.

Specified by:
deleteQualifierType in interface WBEMClient
Parameters:
pPath - The CIMObjectPath identifying the name and namespace of the CIM qualifier type to delete.
Throws:
WBEMException - 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 (for this method)
      CIM_ERR_NOT_FOUND (the Qualifier did not exist)
      CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerateClassNames

public CloseableIterator<CIMObjectPath> enumerateClassNames(CIMObjectPath pPath,
                                                            boolean pDeep)
                                                     throws WBEMException
Description copied from interface: WBEMClient
Enumerate the names of CIM Classes.

Specified by:
enumerateClassNames in interface WBEMClient
Parameters:
pPath - The CIMObjectPath identifying the class to be enumerated. If the class name in the object path specified is an empty string (i.e. ""), all base classes in the target namespace are returned. Note that only the namespace and the name components should be populated.
pDeep - If true, the enumeration returned will contain the names of all classes derived from the class being enumerated. If false, the enumeration returned contains only the names of the first level children of the class.
Returns:
A CloseableIterator of CIMObjectPaths.
Throws:
WBEMException - 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 CloseableIterator<CIMClass> enumerateClasses(CIMObjectPath pPath,
                                                    boolean pDeep,
                                                    boolean pPropagated,
                                                    boolean pIncludeQualifiers,
                                                    boolean pIncludeClassOrigin)
                                             throws WBEMException
Description copied from interface: WBEMClient
Enumerate CIM Classes.

Specified by:
enumerateClasses in interface WBEMClient
Parameters:
pPath - The object path of the class to be enumerated. Only the namespace and object name should be populated. If the object name is set to an empty string (i.e. ""), then all base classes in the target namespace are returned.
pDeep - If true, the classes returned will include subclasses. If false, the classes returned will not include subclasses.
pPropagated - If true, only elements (properties, methods and qualifiers) defined in, or overridden in the class are included in the response. If false, all elements of the class definition are returned.
pIncludeQualifiers - If true, all Qualifiers for each Class and its elements (properties, methods, references) are included. If false, no Qualifiers are present in the classes returned.
pIncludeClassOrigin - The class origin attribute is the name of the class that first defined the property or method. If true, the class origin attribute will be present for each property and method on all returned CIMClasses. If false, the class origin will not be present.
Returns:
A CloseableIterator of CIMClasses.
Throws:
WBEMException - 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 CloseableIterator<CIMObjectPath> enumerateInstanceNames(CIMObjectPath pPath)
                                                        throws WBEMException
Description copied from interface: WBEMClient
Enumerate the names of the instances for a specified class. The names of all subclass instances are returned.

Specified by:
enumerateInstanceNames in interface WBEMClient
Parameters:
pPath - The CIMObjectPath identifying the class whose instances are to be enumerated. Only the namespace and class name components are used. All other information (e.g. Keys) is ignored.
Returns:
CloseabelIterator of CIMObjectPaths.
Throws:
WBEMException - 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 CloseableIterator<CIMInstance> enumerateInstances(CIMObjectPath pPath,
                                                         boolean pDeep,
                                                         boolean pPropagated,
                                                         boolean pIncludeClassOrigin,
                                                         String[] pPropertyList)
                                                  throws WBEMException
Description copied from interface: WBEMClient
Enumerate the instances of a class. The instances of all subclasses are also returned.

Specified by:
enumerateInstances in interface WBEMClient
Parameters:
pPath - The object path of the class to be enumerated. Only the namespace and class name components are used. Any other information (e.g. Keys) is ignored.
pDeep - If true, this specifies that, for each returned Instance of the Class, all properties of the Instance must be present (subject to constraints imposed by the other parameters), including any which were added by subclassing the specified Class. If false, each returned Instance includes only properties defined for the specified Class in path.
pPropagated - If true, only elements values that were instantiated in the instance are returned.
pIncludeClassOrigin - The class origin attribute is the name of the class that first defined the property. If true, the class origin attribute will be present for each property on all returned CIMInstances. If false, the class origin will not be present.
pPropertyList - An array of property names used to filter what is contained in the instances returned. Each instance returned only contains elements for the properties of the names specified. Duplicate and invalid property names are ignored and the request is otherwise processed normally. An empty array indicates that no properties should be returned. A null value indicates that all properties should be returned.
Returns:
A CloseableIterator of CIMInstances.
Throws:
WBEMException - 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 (for this method)
      CIM_ERR_INVALID_CLASS (in this namespace)
      CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerateNamespaces

public CloseableIterator<CIMObjectPath> enumerateNamespaces(String pNamespace)
                                                     throws WBEMException
Description copied from interface: WBEMClientSBLIM
Enumerate the names of the instances of CIM namespaces.

Specified by:
enumerateNamespaces in interface WBEMClientSBLIM
Parameters:
pNamespace - The Interop Namespace, if known. If null, the default Interop Namespace names defined by DSP1033 are used.
Returns:
A CloseableIterator of CIMObjectPaths.
Throws:
WBEMException - If unsuccessful, one of the following status codes must be returned. The ORDERED list is:
      CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerateQualifierTypes

public CloseableIterator<CIMQualifierType<?>> enumerateQualifierTypes(CIMObjectPath pPath)
                                                               throws WBEMException
Description copied from interface: WBEMClient
Enumerates the CIM Qualifier types for a specific namespace.

Specified by:
enumerateQualifierTypes in interface WBEMClient
Parameters:
pPath - The CIMObjectPath identifying the namespace whose qualifier types are to be enumerated.
Returns:
A CloseableIterator of CIMQualifierType s.
Throws:
WBEMException - 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)
 

execQuery

public CloseableIterator<CIMInstance> execQuery(CIMObjectPath pPath,
                                                String pQuery,
                                                String pQueryLanguage)
                                         throws WBEMException
Description copied from interface: WBEMClient
execQuery will execute a query to retrieve objects.

Specified by:
execQuery in interface WBEMClient
Parameters:
pPath - CIMObjectPath identifying the class to query. Only the namespace and class name components are used. All other information (e.g. Keys) is ignored.
pQuery - A string containing the text of the query.
pQueryLanguage - A string that identifies the query language to use to parse the query string specified.
Returns:
A CloseableIterator of CIMInstances.
Throws:
WBEMException - 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_QUERY_LANGUAGE_NOT_SUPPORTED (the requested query language
            is not recognized)
      CIM_ERR_INVALID_QUERY (the query is not a valid query in the specified
            query language)
      CIM_ERR_FAILED (some other unspecified error occurred)
 

getClass

public CIMClass getClass(CIMObjectPath pName,
                         boolean pPropagated,
                         boolean pIncludeQualifiers,
                         boolean pIncludeClassOrigin,
                         String[] pPropertyList)
                  throws WBEMException
Description copied from interface: WBEMClient
Returns the CIMClass for the specified CIMObjectPath.

Specified by:
getClass in interface WBEMClient
Parameters:
pName - The object path of the class to be returned. Only the name space and class name components are used. All other information (e.g. keys) is ignored.
pPropagated - If true, only elements (properties, methods, references) overridden or defined in the class are included in the CIMClassreturned. If false, all elements of the class definition are returned.
pIncludeQualifiers - If true, all Qualifiers for the class and its elements are included in the CIMClass returned. If false, no Qualifier information is contained in the CIMClass returned.
pIncludeClassOrigin - The class origin attribute is the name of the class that first defined the property or method. If true, the class origin attribute will be present for each property and method on all returned CIMClasses. If false, the class origin will not be present.
pPropertyList - An array of property names used to filter what is contained in the CIMClass returned. The CIMClass returned only contains elements for the properties of the names specified. Duplicate and invalid property names are ignored and the request is otherwise processed normally. An empty array indicates that no properties should be returned. A null value indicates that all properties should be returned.
Returns:
CIMClass meeting the criteria specified.
Throws:
WBEMException - 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 requested CIM Class does not exist in the
            specified namespace)
      CIM_ERR_FAILED (some other unspecified error occurred)
 

getInstance

public CIMInstance getInstance(CIMObjectPath pName,
                               boolean pPropagated,
                               boolean pIncludeClassOrigin,
                               String[] pPropertyList)
                        throws WBEMException
Description copied from interface: WBEMClient
Get a CIMInstance.

Specified by:
getInstance in interface WBEMClient
Parameters:
pName - The object path of the instance to be returned. The Keys in this CIMObjectPath must be populated.
pPropagated - If true, only elements (properties, methods, references) overridden or defined in the class are included in the CIMInstance returned. If false, all elements of the class definition are returned.
pIncludeClassOrigin - The class origin attribute is the name of the class that first defined the property or method. If true, the class origin attribute will be present for each property of the CIMInstance. If false, the class origin will not be present.
pPropertyList - An array of property names used to filter what is contained in the CIMClass returned. The CIMClass returned only contains elements for the properties of the names specified. Duplicate and invalid property names are ignored and the request is otherwise processed normally. An empty array indicates that no properties should be returned. A null value indicates that all properties should be returned.
Returns:
CIMInstance identified by the CIMObjectPath specified.
Throws:
WBEMException - 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)
 

getQualifierType

public CIMQualifierType<?> getQualifierType(CIMObjectPath pName)
                                     throws WBEMException
Description copied from interface: WBEMClient
Get a CIMQualifierType.

Specified by:
getQualifierType in interface WBEMClient
Parameters:
pName - CIMObjectPath that identifies the CIMQualifierType to return.
Returns:
The CIMQualifierType object.
Throws:
WBEMException - 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)
 

invokeMethod

public Object invokeMethod(CIMObjectPath pName,
                           String pMethodName,
                           CIMArgument<?>[] pInputArguments,
                           CIMArgument<?>[] pOutputArguments)
                    throws WBEMException
Description copied from interface: WBEMClient
Executes the specified method on the specified object.

Specified by:
invokeMethod in interface WBEMClient
Parameters:
pName - CIM object path of the object whose method must be invoked. It must include all of the keys.
pMethodName - The name of the method to be invoked.
pInputArguments - The CIMArgument array of method input parameters.

pOutputArguments - The CIMArgument array of method output parameters. The array should be allocated large enough to hold all returned parameters.
Returns:
The return value of the specified method.
Throws:
WBEMException - If unsuccessful, one of the following status codes must be returned. The ORDERED list is:
      CIM_ERR_ACCESS_DENIED
      CIM_ERR_NOT_SUPPORTED (implementation DOES NOT support ANY 
            Extrinsic Method Invocation)
      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)
 

isActive

public boolean isActive()
Description copied from interface: WBEMClientSBLIM
Returns an indication of whether the client is active (initialized and not closed) or inactive (not initialized or closed).

Specified by:
isActive in interface WBEMClientSBLIM
Returns:
true if client is active, false otherwise.

modifyClass

public void modifyClass(CIMClass pClass)
                 throws WBEMException
Description copied from interface: WBEMClient
Modify the CIMClass.

Specified by:
modifyClass in interface WBEMClient
Parameters:
pClass - CIMClass to be modified.
Throws:
WBEMException - 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)
 

modifyInstance

public void modifyInstance(CIMInstance pInst,
                           String[] pPropertyList)
                    throws WBEMException
Description copied from interface: WBEMClient
Modify some or all of the properties of the specified CIMInstance.

Specified by:
modifyInstance in interface WBEMClient
Parameters:
pInst - CIMInstance to be modified. All Keys must be populated.
pPropertyList - An array of property names used to specify which values from the CIMInstance specified to set. Properties not specified in this list but set in the CIMInstance specified are not modified. Duplicate property names are ignored and the request is otherwise processed normally. If the pPropertyList contains invalid property names for the instance to be modified, the server shall reject the request. An empty array indicates that no properties should be modified. A null value indicates that all properties should be modified.
Throws:
WBEMException - 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_FAILED (some other unspecified error occurred)
 

referenceClasses

public CloseableIterator<CIMClass> referenceClasses(CIMObjectPath pObjectName,
                                                    String pResultClass,
                                                    String pRole,
                                                    boolean pIncludeQualifiers,
                                                    boolean pIncludeClassOrigin,
                                                    String[] pPropertyList)
                                             throws WBEMException
Description copied from interface: WBEMClient
Enumerates the Association classes that refer to a specified source CIM Class.

Specified by:
referenceClasses in interface WBEMClient
Parameters:
pObjectName - CIMObjectPath defining the source CIM class whose referring classes are to be returned. pObjectName shall contain the scheme, host, namespace and object name (class name).
pResultClass - This string shall either contain a valid CIM Class name or be null. The pResultClass filters the classes returned to contain only the classes of this Class name or one of its subclasses.
pRole - This string MUST either contain a valid Property name or be null. It filters the Objects returned to contain only Objects referring to the source Object via a Property with the specified name. If "Antecedent" is specified, then only Associations in which the source Object is the "Antecedent" reference are returned.
pIncludeQualifiers - If true, all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) shall be included in the classes returned. If false, no Qualifiers shall be present in each class returned.
pIncludeClassOrigin - The class origin attribute is the name of the class that first defined the property or method. If true, the class Origin attribute will be present for each property and method on all classes returned. If false, the class origin will not be present.
pPropertyList - An array of property names used to filter what is contained in the Objects returned. Each CIMClass returned shall only contains elements for the properties of the names specified. Duplicate and invalid property names are ignored and the request is otherwise processed normally. An empty array indicates that no properties should be included in the classes returned. A null value indicates that all properties should be contained in the classes returned.
Returns:
If successful, a CloseableIterator referencing zero or more CIMClasses meeting the specified criteria.
Throws:
WBEMException - If unsuccessful, one of the following status codes shall be returned along with zero or more instance of CIM_Error. 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)
 

referenceInstances

public CloseableIterator<CIMInstance> referenceInstances(CIMObjectPath pObjectName,
                                                         String pResultClass,
                                                         String pRole,
                                                         boolean pIncludeClassOrigin,
                                                         String[] pPropertyList)
                                                  throws WBEMException
Description copied from interface: WBEMClient
Enumerates the Association instances that refer to a specified source CIM Instance.

Specified by:
referenceInstances in interface WBEMClient
Parameters:
pObjectName - CIMObjectPath defining the source CIM Instance whose referring instances are to be returned. The pObjectName shall include the host, object name and keys.
pResultClass - This string shall either contain a valid CIM Class name or be null. It filters the instances returned to contain only the instances of this Class name or one of its subclasses.
pRole - This string shall either contain a valid Property name or be null. The role filters the instances returned to contain only instances referring to the source instance via a property with the specified name. For example, If "Antecedent" is specified, then only Associations in which the source instance is the "Antecedent" reference are returned.
pIncludeClassOrigin - The class origin attribute is the name of the class that first defined the property. If true, the class origin attribute will be present for each property and on all instances returned. If false, the class origin will not be present.
pPropertyList - An array of property names used to filter what is contained in the instances returned. Each CIMInstance returned shall only contain elements for the properties of the names specified. Duplicate and invalid property names are ignored and the request is otherwise processed normally. An empty array indicates that no properties should be included in the instances returned. A null value indicates that all properties supported shall be contained in the instance returned.
Returns:
If successful, a CloseableIterator referencing zero or more CIMInstances meeting the specified criteria.
Throws:
WBEMException - If unsuccessful, one of the following status codes shall be returned along with zero or more CIM_Error instances. 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 CloseableIterator<CIMObjectPath> referenceNames(CIMObjectPath pObjectName,
                                                       String pResultClass,
                                                       String pRole)
                                                throws WBEMException
Description copied from interface: WBEMClient
Enumerates the CIMObjectPaths of Association Objects that refer to a particular source CIM Object. If the source Object is a CIM Class, then a CloseableIterator of CIMObjectPaths of the Association classes that refer to the source Object is returned. If the source Object is a CIM Instance, then a CloseableIterator of CIMObjectPaths of the CIMInstance objects that refer to the source Object is returned.

Specified by:
referenceNames in interface WBEMClient
Parameters:
pObjectName - CIMObjectPath defining the source CIM Object whose referring Objects are to be returned. This argument may contain either a Class name or the modelpath of an Instance. (i.e. Keys populated)
pResultClass - This string MUST either contain a valid CIM Class name or be null. It filters the Objects returned to contain only the Objects of this Class name or one of its subclasses.
pRole - This string MUST either contain a valid Property name or be null. It filters the Objects returned to contain only Objects referring to the source Object via a Property with the specified name. If "Antecedent" is specified, then only Associations in which the source Object is the "Antecedent" reference are returned.
Returns:
If successful, a CloseableIterator referencing zero or more CIMObjectPaths of CIMClasses or CIMInstances meeting the specified criteria.
Throws:
WBEMException - 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)
 

setLocales

public void setLocales(Locale[] pLocales)
Description copied from interface: WBEMClient
Change the locales that were provided during initialization.

Specified by:
setLocales in interface WBEMClient
Parameters:
pLocales - An array of locales in order of priority of preference.

setQualifierType

public void setQualifierType(CIMQualifierType<?> pQualifierType)
                      throws WBEMException
Description copied from interface: WBEMClient
Add a CIMQualifierType to the specified namespace if it does not already exist. Otherwise, it modifies the qualifier type to the value specified.

Specified by:
setQualifierType in interface WBEMClient
Parameters:
pQualifierType - The CIM qualifier type to be added.
Throws:
WBEMException - 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)
 

getCustomSocketFactory

public SocketFactory getCustomSocketFactory()
Description copied from interface: WBEMClientSBLIM
Gets the custom socket factory if one is set. The client uses this factory for socket creation instead of the default one.

Specified by:
getCustomSocketFactory in interface WBEMClientSBLIM
Returns:
The custom factory used for socket creation. null indicates set the JRE default factory is used.

setCustomSocketFactory

public void setCustomSocketFactory(SocketFactory pFactory)
                            throws UnsupportedOperationException
Description copied from interface: WBEMClientSBLIM
Sets a custom socket factory. The client will use this factory for socket creation instead of the JRE default.

Specified by:
setCustomSocketFactory in interface WBEMClientSBLIM
Parameters:
pFactory - The factory to use for socket creation. null resets to the JRE default factory.
Throws:
UnsupportedOperationException - Some protocols might not communicate via TCP sockets

getLocalProperties

public Properties getLocalProperties()
Description copied from interface: WBEMClientSBLIM
Returns the configuration properties that are local to the current thread. Note that only these properties are returned that override the global and the client settings. The global settings can be accessed via the java.lang.System class, the client setting via getProperties().
If the no client specific configuration is set, this method returns null

Specified by:
getLocalProperties in interface WBEMClientSBLIM
Returns:
The configuration properties
See Also:
System.getProperties(), WBEMClientSBLIM.getProperties()

setLocalProperties

public void setLocalProperties(Properties pProperties)
Description copied from interface: WBEMClientSBLIM
Sets the configuration properties that are local to the current thread. Any previously set local properties (of the current thread) are overwritten. The given properties are handled as an overlay on the global settings and the client settings. That means that properties specified here override the corresponding properties whereas properties not specified here are taken from the client or global properties. The global settings can be accessed via the java.lang.System class, the client setting via getProperties().

Specified by:
setLocalProperties in interface WBEMClientSBLIM
Parameters:
pProperties - The thread specific properties. null remove the local setting of the current thread.
See Also:
System.setProperties(Properties), WBEMClientSBLIM.setProperties(Properties)

setLocalProperty

public void setLocalProperty(String pKey,
                             String pValue)
Description copied from interface: WBEMClientSBLIM
Sets a local configuration property for the current thread. This property will override the corresponding global and client property for this client instance. The global settings can be accessed via the java.lang.System class, the client setting via getProperties(). Valid property names can be found in the WBEMConfigurationProperties interface. Unknown properties are ignored.

Specified by:
setLocalProperty in interface WBEMClientSBLIM
Parameters:
pKey - The name of the configuration property
pValue - The value of the configuration property. null resets to the global setting.
See Also:
WBEMConfigurationProperties, System.setProperty(String, String), WBEMClientSBLIM.setProperty(String, String)

associatorPaths

public EnumerateResponse<CIMObjectPath> associatorPaths(CIMObjectPath pObjectName,
                                                        String pAssociationClass,
                                                        String pResultClass,
                                                        String pRole,
                                                        String pResultRole,
                                                        String pFilterQueryLanguage,
                                                        String pFilterQuery,
                                                        UnsignedInteger32 pTimeout,
                                                        boolean pContinueOnError,
                                                        UnsignedInteger32 pMaxObjects)
                                                 throws WBEMException
Description copied from interface: WBEMClient
associatorPaths will start an enumeration session for traversing associations starting from the instance defined in the pInstancePath parameter using any specified filtering criteria and return zero or more CIMObjectPath objects.

Specified by:
associatorPaths in interface WBEMClient
Parameters:
pObjectName - The CIMObjectPath for the instance for which the enumeration is to be performed.
pAssociationClass - This string MUST either contain a valid CIM Association class name or be null. It filters the Objects returned to contain only Objects associated to the source Object via this CIM Association class or one of its subclasses.
pResultClass - This string MUST either contain a valid CIM Class name or be null. It filters the Objects returned to contain only the Objects of this Class name or one of its subclasses.
pRole - This string MUST either contain a valid Property name or be null. It filters the Objects returned to contain only Objects associated to the source Object via an Association class in which the source Object plays the specified role. (i.e. the Property name in the Association class that refers to the source Object matches this value) If "Antecedent" is specified, then only Associations in which the source Object is the "Antecedent" reference are examined.
pResultRole - This string MUST either contain a valid Property name or be null. It filters the Objects returned to contain only Objects associated to the source Object via an Association class in which the Object returned plays the specified role. (i.e. the Property name in the Association class that refers to the Object returned matches this value) If "Dependent" is specified, then only Associations in which the Object returned is the "Dependent" reference are examined.
pFilterQueryLanguage - The pFilterQueryLanguage represents the query language for the pFilterQuery argument. This must be left null if a pFilterQuery is not supplied. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.
pFilterQuery - The pFilterQuery specifies a query in the form of the query language specified by the pFilterQueryLanguage parameter. If this value is not null, the pFilterQueryLanguage parameter must be non-null. This value will act as an additional filter on the result set. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.
pTimeout - This input parameter determines the minimum time the CIM server shall maintain the open enumeration session after the last Open or Pull operation (unless the enumeration session is closed). If the operation timeout is exceeded, the implementation may close the enumeration session at any time, releasing any resources allocated to the enumeration session. A pTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If pTimeout is null, the implementation shall choose an operation timeout. All other values for pTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for pTimeout. Specifically, the implementation may not allow 0 (no timeout). If the specified value is not an allowable value, the implementation shall return failure with the status code CIM_ERR_INVALID_OPERATION_TIMEOUT.
pContinueOnError - If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and pContinueOnError is true, it shall throw a WBEMException with the status code CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED. If a implementation supports continuation on error and pContinueOnError is true, the enumeration session shall remain open when a Pull operation fails, and any subsequent successful Pull operations shall return the set of elements that would have been returned if the failing Pull operations were successful. This behavior is subject to the consistency rules defined for pulled enumerations. If pContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.
pMaxObjects - Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to pMaxObjects but shall not deliver more than pMaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of pMaxObjects. Note that a CIM client can use a pMaxObjects value of 0 to specify that it does not want to retrieve any instances in the Open operation.
Returns:
The return value of a successful Open operation is an array of enumerated elements with a number of entries from 0 up to a maximum defined by pMaxObjects. These entries meet the criteria defined in the Open operation. Note that returning no entries in the array does not imply that the enumeration session is exhausted. Client must evaluate the EnumerateResponse.isEnd() to determine if there are more elements.
Throws:
WBEMException - If unsuccessful, one of the following status codes must be returned. The ORDERED list is:
      CIM_ERR_ACCESS_DENIED
      CIM_ERR_SERVER_IS_SHUTTING_DOWN
      CIM_ERR_NOT_SUPPORTED
      CIM_ERR_INVALID_NAMESPACE
      CIM_ERR_INVALID_OPERATION_TIMEOUT
      CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
      CIM_ERR_INVALID_PARAMETER
      CIM_ERR_NOT_FOUND (the source instance was not found)
      CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
      CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
      CIM_ERR_INVALID_QUERY
      CIM_ERR_FAILED (some other unspecified error occurred)
 

associators

public EnumerateResponse<CIMInstance> associators(CIMObjectPath pObjectName,
                                                  String pAssocClass,
                                                  String pResultClass,
                                                  String pRole,
                                                  String pResultRole,
                                                  boolean pIncludeClassOrigin,
                                                  String[] pPropertyList,
                                                  String pFilterQueryLanguage,
                                                  String pFilterQuery,
                                                  UnsignedInteger32 pTimeout,
                                                  boolean pContinueOnError,
                                                  UnsignedInteger32 pMaxObjects)
                                           throws WBEMException
Description copied from interface: WBEMClient
associators will start an enumeration session for traversing associations starting from the instance defined in the pInstancePath parameter using any specified filtering criteria and return zero or more CIMInstance objects.

Specified by:
associators in interface WBEMClient
Parameters:
pObjectName - The CIMObjectPath for the instance for which the enumeration is to be performed.
pAssocClass - This string MUST either contain a valid CIM Association class name or be null. It filters the Objects returned to contain only Objects associated to the source Object via this CIM Association class or one of its subclasses.
pResultClass - This string MUST either contain a valid CIM Class name or be null. It filters the Objects returned to contain only the Objects of this Class name or one of its subclasses.
pRole - This string MUST either contain a valid Property name or be null. It filters the Objects returned to contain only Objects associated to the source Object via an Association class in which the source Object plays the specified role. (i.e. the Property name in the Association class that refers to the source Object matches this value) If "Antecedent" is specified, then only Associations in which the source Object is the "Antecedent" reference are examined.
pResultRole - This string MUST either contain a valid Property name or be null. It filters the Objects returned to contain only Objects associated to the source Object via an Association class in which the Object returned plays the specified role. (i.e. the Property name in the Association class that refers to the Object returned matches this value) If "Dependent" is specified, then only Associations in which the Object returned is the "Dependent" reference are examined.
pIncludeClassOrigin - The class origin attribute is the name of the class that first defined the property. If true, the class origin attribute will be present for each property on all instances returned. If false, the class origin will not be present.
pPropertyList - An array of property names used to filter what is contained in the Objects returned. Each CIMClass or CIMInstance returned only contains elements for the properties of the names specified. Duplicate and invalid property names are ignored and the request is otherwise processed normally. An empty array indicates that no properties should be included in the Objects returned. A null value indicates that all properties should be contained in the Objects returned. NOTE: Properties should not be specified in this parameter unless a non- null value is specified in the pResultClass parameter.
pFilterQueryLanguage - The pFilterQueryLanguage represents the query language for the pFilterQuery argument. This must be left null if a filterQuery is not supplied. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.
pFilterQuery - The pFilterQuery specifies a query in the form of the query language specified by the pFilterQueryLanguage parameter. If this value is not null, the pFilterQueryLanguage parameter must be non-null. This value will act as an additional filter on the result set. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.
pTimeout - This input parameter determines the minimum time the CIM server shall maintain the open enumeration session after the last Open or Pull operation (unless the enumeration session is closed). If the operation timeout is exceeded, the implementation may close the enumeration session at any time, releasing any resources allocated to the enumeration session. A pTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If pTimeout is null, the implementation shall choose an operation timeout. All other values for pTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for pTimeout. Specifically, the implementation may not allow 0 (no timeout). If the specified value is not an allowable value, the implementation shall return failure with the status code CIM_ERR_INVALID_OPERATION_TIMEOUT.
pContinueOnError - If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and pContinueOnError is true, it shall throw a WBEMException with the status code CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED. If a implementation supports continuation on error and pContinueOnError is true, the enumeration session shall remain open when a Pull operation fails, and any subsequent successful Pull operations shall return the set of elements that would have been returned if the failing Pull operations were successful. This behavior is subject to the consistency rules defined for pulled enumerations. If pContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.
pMaxObjects - Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to pMaxObjects but shall not deliver more than pMaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of pMaxObjects. Note that a CIM client can use a pMaxObjects value of 0 to specify that it does not want to retrieve any instances in the Open operation.
Returns:
The return value of a successful Open operation is an array of enumerated elements with a number of entries from 0 up to a maximum defined by pMaxObjects. These entries meet the criteria defined in the Open operation. Note that returning no entries in the array does not imply that the enumeration session is exhausted. Client must evaluate the EnumerateResponse.isEnd() to determine if there are more elements.
Throws:
WBEMException - If unsuccessful, one of the following status codes must be returned. The ORDERED list is:
      CIM_ERR_ACCESS_DENIED
      CIM_ERR_SERVER_IS_SHUTTING_DOWN
      CIM_ERR_NOT_SUPPORTED
      CIM_ERR_INVALID_NAMESPACE
      CIM_ERR_INVALID_OPERATION_TIMEOUT
      CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
      CIM_ERR_INVALID_PARAMETER
      CIM_ERR_NOT_FOUND (The source instance was not found)
      CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
      CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
      CIM_ERR_INVALID_QUERY
      CIM_ERR_FAILED (Some other unspecified error occurred)
 

closeEnumeration

public void closeEnumeration(CIMObjectPath pObjectName,
                             String pEnumerationContext)
                      throws WBEMException
Description copied from interface: WBEMClient
closeEnumeration will close an enumeration session that has been previously started but not yet completed. Clients should always use this method when an enumeration session has been started and the client does not retrieve all the results. If a client has started an enumeration session and retrieves all the results until the EnumerationResponse.isEnd() is true, this method shall not be called.

Specified by:
closeEnumeration in interface WBEMClient
Parameters:
pObjectName - The CIMObjectPath representing the namespace to be used.
pEnumerationContext - The enumeration context to close.
Throws:
WBEMException

enumerateInstancePaths

public EnumerateResponse<CIMObjectPath> enumerateInstancePaths(CIMObjectPath pObjectName,
                                                               String pFilterQueryLanguage,
                                                               String pFilterQuery,
                                                               UnsignedInteger32 pTimeout,
                                                               boolean pContinueOnError,
                                                               UnsignedInteger32 pMaxObjects)
                                                        throws WBEMException
Description copied from interface: WBEMClient
enumerateInstancePaths will enumerate the instances of the specified class in pClassPath and return zero or more CIMObjectPaths.

Specified by:
enumerateInstancePaths in interface WBEMClient
Parameters:
pObjectName - The CIMObjectPath for the class for which the enumeration is to be performed.
pFilterQueryLanguage - The pFilterQueryLanguage represents the query language for the pFilterQuery argument. This must be left null if a pFilterQuery is not supplied. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.
pFilterQuery - The pFilterQuery specifies a query in the form of the query language specified by the pFilterQueryLanguage parameter. If this value is not null, the pFilterQueryLanguage parameter must be non-null. This value will act as an additional filter on the result set. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.
pTimeout - This input parameter determines the minimum time the CIM server shall maintain the open enumeration session after the last Open or Pull operation (unless the enumeration session is closed). If the operation timeout is exceeded, the implementation may close the enumeration session at any time, releasing any resources allocated to the enumeration session. A pTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If pTimeout is null, the implementation shall choose an operation timeout. All other values for pTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for pTimeout. Specifically, the implementation may not allow 0 (no timeout). If the specified value is not an allowable value, the implementation shall return failure with the status code CIM_ERR_INVALID_OPERATION_TIMEOUT.
pContinueOnError - If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and pContinueOnError is true, it shall throw a WBEMException with the status code CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED. If a implementation supports continuation on error and pContinueOnError is true, the enumeration session shall remain open when a Pull operation fails, and any subsequent successful Pull operations shall return the set of elements that would have been returned if the failing Pull operations were successful. This behavior is subject to the consistency rules defined for pulled enumerations. If pContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.
pMaxObjects - Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to pMaxObjects but shall not deliver more than pMaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of pMaxObjects. Note that a CIM client can use a pMaxObjects value of 0 to specify that it does not want to retrieve any instances in the Open operation.
Returns:
The return value of a successful Open operation is an array of enumerated elements with a number of entries from 0 up to a maximum defined by pMaxObjects. These entries meet the criteria defined in the Open operation. Note that returning no entries in the array does not imply that the enumeration session is exhausted. Client must evaluate the EnumerateResponse.isEnd() to determine if there are more elements.
Throws:
WBEMException - If unsuccessful, one of the following status codes must be returned. The ORDERED list is:
      CIM_ERR_ACCESS_DENIED
      CIM_ERR_SERVER_IS_SHUTTING_DOWN
      CIM_ERR_NOT_SUPPORTED
      CIM_ERR_INVALID_NAMESPACE
      CIM_ERR_INVALID_OPERATION_TIMEOUT
      CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
      CIM_ERR_INVALID_PARAMETER
      CIM_ERR_INVALID_CLASS (the source class does not exist)
      CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
      CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
      CIM_ERR_INVALID_QUERY
      CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerateInstances

public EnumerateResponse<CIMInstance> enumerateInstances(CIMObjectPath pObjectName,
                                                         boolean pDeepInheritance,
                                                         boolean pIncludeClassOrigin,
                                                         String[] pPropertyList,
                                                         String pFilterQueryLanguage,
                                                         String pFilterQuery,
                                                         UnsignedInteger32 pTimeout,
                                                         boolean pContinueOnError,
                                                         UnsignedInteger32 pMaxObjects)
                                                  throws WBEMException
Description copied from interface: WBEMClient
enumerateInstances will enumerate the instances of the specified class in pClassPath and return zero or more CIMInstances.

Specified by:
enumerateInstances in interface WBEMClient
Parameters:
pObjectName - The CIMObjectPath for the class for which the enumeration is to be performed.
pDeepInheritance - If true, this specifies that, for each returned Instance of the Class, all properties of the Instance must be present (subject to constraints imposed by the other parameters), including any which were added by subclassing the specified Class. If false, each returned Instance includes only properties defined for the specified Class in path.
pIncludeClassOrigin - The class origin attribute is the name of the class that first defined the property or method. If true, the class origin attribute will be present for each property and method on all Objects returned. If false, the class origin will not be present.
pPropertyList - An array of property names used to filter what is contained in the Objects returned. Each CIMInstance returned only contains elements for the properties of the names specified. Duplicate and invalid property names are ignored and the request is otherwise processed normally. An empty array indicates that no properties should be included in the Objects returned. A null value indicates that all properties should be contained in the Objects returned.
pFilterQueryLanguage - The pFilterQueryLanguage represents the query language for the pFilterQuery argument. This must be left null if a pFilterQuery is not supplied. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.
pFilterQuery - The pFilterQuery specifies a query in the form of the query language specified by the pFilterQueryLanguage parameter. If this value is not null, the pFilterQueryLanguage parameter must be non-null. This value will act as an additional filter on the result set. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.
pTimeout - This input parameter determines the minimum time the CIM server shall maintain the open enumeration session after the last Open or Pull operation (unless the enumeration session is closed). If the operation timeout is exceeded, the implementation may close the enumeration session at any time, releasing any resources allocated to the enumeration session. A pTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If pTimeout is null, the implementation shall choose an operation timeout. All other values for pTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for pTimeout. Specifically, the implementation may not allow 0 (no timeout). If the specified value is not an allowable value, the implementation shall return failure with the status code CIM_ERR_INVALID_OPERATION_TIMEOUT.
pContinueOnError - If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and pContinueOnError is true, it shall throw a WBEMException with the status code CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED. If a implementation supports continuation on error and pContinueOnError is true, the enumeration session shall remain open when a Pull operation fails, and any subsequent successful Pull operations shall return the set of elements that would have been returned if the failing Pull operations were successful. This behavior is subject to the consistency rules defined for pulled enumerations. If pContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.
pMaxObjects - Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to pMaxObjects but shall not deliver more than pMaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of pMaxObjects. Note that a CIM client can use a pMaxObjects value of 0 to specify that it does not want to retrieve any instances in the Open operation.
Returns:
The return value of a successful Open operation is an array of enumerated elements with a number of entries from 0 up to a maximum defined by pMaxObjects. These entries meet the criteria defined in the Open operation. Note that returning no entries in the array does not imply that the enumeration session is exhausted. Client must evaluate the EnumerateResponse.isEnd() to determine if there are more elements.
Throws:
WBEMException - If unsuccessful, one of the following status codes must be returned. The ORDERED list is:
 
      CIM_ERR_ACCESS_DENIED
      CIM_ERR_SERVER_IS_SHUTTING_DOWN
      CIM_ERR_NOT_SUPPORTED
      CIM_ERR_INVALID_NAMESPACE
      CIM_ERR_INVALID_OPERATION_TIMEOUT
      CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
      CIM_ERR_INVALID_PARAMETER
      CIM_ERR_INVALID_CLASS (the source class does not exist)
      CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
      CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
      CIM_ERR_INVALID_QUERY
      CIM_ERR_FAILED (some other unspecified error occurred)
 

enumerationCount

public UnsignedInteger64 enumerationCount(CIMObjectPath pObjectName,
                                          String pEnumerationContext)
                                   throws WBEMException
Description copied from interface: WBEMClient
enumerationCount provides an estimated count of the total number of objects in an open enumeration session represented by an enumeration context.

Specified by:
enumerationCount in interface WBEMClient
Parameters:
pObjectName - The namespace for the enumeration context.
pEnumerationContext - The enumeration context to count.
Returns:
The estimated number of objects.
Throws:
WBEMException - If unsuccessful, one of the following status codes must be returned. The ORDERED list is:
 
      CIM_ERR_ACCESS_DENIED
      CIM_ERR_SERVER_IS_SHUTTING_DOWN
      CIM_ERR_NOT_SUPPORTED
      CIM_ERR_INVALID_NAMESPACE
      CIM_ERR_INVALID_PARAMETER
      CIM_ERR_INVALID_ENUMERATION_CONTEXT
      CIM_ERR_SERVER_LIMITS_EXCEEDED
      CIM_ERR_FAILED
 

execQueryInstances

public EnumerateResponse<CIMInstance> execQueryInstances(CIMObjectPath pObjectName,
                                                         String pFilterQuery,
                                                         String pFilterQueryLanguage,
                                                         boolean pReturnQueryResultClass,
                                                         UnsignedInteger32 pTimeout,
                                                         boolean pContinueOnError,
                                                         UnsignedInteger32 pMaxObjects,
                                                         CIMClass pQueryResultClass)
                                                  throws WBEMException
Description copied from interface: WBEMClient
execQueryInstances will execute a query to retrieve instances.

Specified by:
execQueryInstances in interface WBEMClient
Parameters:
pObjectName - The CIMObjectPath representing the namespace to be used.
pFilterQuery - The pFilterQuery specifies a query in the form of the query language specified by the pFilterQueryLanguage parameter. If this value is not null, the pFilterQueryLanguage parameter must be non-null. This value will act as an additional filter on the result set. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.
pFilterQueryLanguage - The pFilterQueryLanguage represents the query language for the pFilterQuery argument. This must be left null if a pFilterQuery is not supplied. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.
pReturnQueryResultClass - The pReturnQueryResultClass controls whether a class definition is returned in pQueryResultClass . If it is set to false, pQueryResultClass shall be set to null on output. If it is set to true , the value of the pQueryResultClass on output shall be a class definition that defines the properties (columns) of each row of the query result.
pTimeout - This input parameter determines the minimum time the CIM server shall maintain the open enumeration session after the last Open or Pull operation (unless the enumeration session is closed). If the operation timeout is exceeded, the implementation may close the enumeration session at any time, releasing any resources allocated to the enumeration session. A pTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If pTimeout is null, the implementation shall choose an operation timeout. All other values for pTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for pTimeout. Specifically, the implementation may not allow 0 (no timeout). If the specified value is not an allowable value, the implementation shall return failure with the status code CIM_ERR_INVALID_OPERATION_TIMEOUT.
pContinueOnError - If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and pContinueOnError is true, it shall throw a WBEMException with the status code CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED. If a implementation supports continuation on error and pContinueOnError is true, the enumeration session shall remain open when a Pull operation fails, and any subsequent successful Pull operations shall return the set of elements that would have been returned if the failing Pull operations were successful. This behavior is subject to the consistency rules defined for pulled enumerations. If pContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.
pMaxObjects - Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to pMaxObjects but shall not deliver more than pMaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of pMaxObjects. Note that a CIM client can use a pMaxObjects value of 0 to specify that it does not want to retrieve any instances in the Open operation.
pQueryResultClass - The pQueryResultClass is an output argument. It shall be null if the pReturnQueryResultClass input parameter is set to false. Otherwise, it shall return a class definition where each property of the class corresponds to one entry of the query select list. The class definition corresponds to one row of the query result. The class name of this returned class shall be "CIM_QueryResult". This class definition is valid only in the context of this enumeration.
Returns:
The return value of a successful Open operation is an array of enumerated elements with a number of entries from 0 up to a maximum defined by pMaxObjects. These entries meet the criteria defined in the Open operation. Note that returning no entries in the array does not imply that the enumeration session is exhausted. Client must evaluate the EnumerateResponse.isEnd() to determine if there are more elements.
Throws:
WBEMException - If unsuccessful, one of the following status codes must be returned. The ORDERED list is:
      CIM_ERR_ACCESS_DENIED
      CIM_ERR_SERVER_IS_SHUTTING_DOWN
      CIM_ERR_NOT_SUPPORTED
      CIM_ERR_INVALID_NAMESPACE
      CIM_ERR_INVALID_OPERATION_TIMEOUT
      CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
      CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized
            or otherwise incorrect parameters)
      CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED (the requested filter query
            language is not recognized)
      CIM_ERR_INVALID_QUERY (the filter query is not a valid query in the 
            specified filter query language)
      CIM_ERR_QUERY_FEATURE_NOT_SUPPORTED (the query requires support for 
            features that are not supported)
      CIM_ERR_FAILED (Some other unspecified error occurred)
 

getInstancePaths

public EnumerateResponse<CIMObjectPath> getInstancePaths(CIMObjectPath pObjectName,
                                                         String pContext,
                                                         UnsignedInteger32 pMaxObjects)
                                                  throws WBEMException
Description copied from interface: WBEMClient
getInstancePaths will get the CIMObjectPaths using an enumeration context.

Specified by:
getInstancePaths in interface WBEMClient
Parameters:
pObjectName - The CIMObjectPath representing the namespace to be used.
pContext - The enumeration context value for the enumeration session to be used.
pMaxObjects - Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to pMaxObjects but shall not deliver more than pMaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of pMaxObjects.
Returns:
EnumerateResponse that includes zero or more CIMObjectPath objects.
Throws:
WBEMException - If unsuccessful, one of the following status codes must be returned. The ORDERED list is:
 
      CIM_ERR_ACCESS_DENIED
      CIM_ERR_SERVER_IS_SHUTTING_DOWN
      CIM_ERR_NOT_SUPPORTED
      CIM_ERR_INVALID_NAMESPACE
      CIM_ERR_INVALID_PARAMETER
      CIM_ERR_INVALID_ENUMERATION_CONTEXT
      CIM_ERR_SERVER_LIMITS_EXCEEDED
      CIM_ERR_PULL_HAS_BEEN_ABANDONED
      CIM_ERR_FAILED (some other unspecified error occurred)
 

getInstances

public EnumerateResponse<CIMInstance> getInstances(CIMObjectPath pObjectName,
                                                   String pContext,
                                                   UnsignedInteger32 pMaxObjects)
                                            throws WBEMException
Description copied from interface: WBEMClient
getInstances will get the instances from an enumeration session started by execQueryInstances.

Specified by:
getInstances in interface WBEMClient
Parameters:
pObjectName - The CIMObjectPath representing the namespace to be used.
pContext - The enumeration context value for the enumeration session to be used.
pMaxObjects - Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to pMaxObjects but shall not deliver more than pMaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of pMaxObjects. Note that a CIM client can use a pMaxObjects value of 0 to specify that it does not want to retrieve any instances in the Open operation.
Returns:
EnumerateResponse that includes zero or more CIMObjectPath objects.
Throws:
WBEMException - If unsuccessful, one of the following status codes must be returned. The ORDERED list is:
 
      CIM_ERR_ACCESS_DENIED
      CIM_ERR_SERVER_IS_SHUTTING_DOWN
      CIM_ERR_NOT_SUPPORTED
      CIM_ERR_INVALID_NAMESPACE
      CIM_ERR_INVALID_PARAMETER
      CIM_ERR_INVALID_ENUMERATION_CONTEXT
      CIM_ERR_SERVER_LIMITS_EXCEEDED
      CIM_ERR_PULL_HAS_BEEN_ABANDONED
      CIM_ERR_FAILED
 

getInstancesWithPath

public EnumerateResponse<CIMInstance> getInstancesWithPath(CIMObjectPath pObjectName,
                                                           String pContext,
                                                           UnsignedInteger32 pMaxObjects)
                                                    throws WBEMException
Description copied from interface: WBEMClient
getInstancesWithPath will use the enumeration context provided to get the next set of instances for the enumeration session.

Specified by:
getInstancesWithPath in interface WBEMClient
Parameters:
pObjectName - The CIMObjectPath representing the namespace to be used.
pContext - The enumeration context value for the enumeration session to be used.
pMaxObjects - Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to pMaxObjects but shall not deliver more than pMaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of pMaxObjects.
Returns:
EnumerateResponse that includes zero or more CIMObjectPath. objects.
Throws:
WBEMException - If unsuccessful, one of the following status codes must be returned. The ORDERED list is:
 
      CIM_ERR_ACCESS_DENIED
      CIM_ERR_SERVER_IS_SHUTTING_DOWN
      CIM_ERR_NOT_SUPPORTED
      CIM_ERR_INVALID_NAMESPACE
      CIM_ERR_INVALID_PARAMETER
      CIM_ERR_INVALID_ENUMERATION_CONTEXT
      CIM_ERR_SERVER_LIMITS_EXCEEDED
      CIM_ERR_PULL_HAS_BEEN_ABANDONED
      CIM_ERR_FAILED (some other unspecified error occurred)
 

referencePaths

public EnumerateResponse<CIMObjectPath> referencePaths(CIMObjectPath pObjectName,
                                                       String pResultClass,
                                                       String pRole,
                                                       String pFilterQueryLanguage,
                                                       String pFilterQuery,
                                                       UnsignedInteger32 pTimeout,
                                                       boolean pContinueOnError,
                                                       UnsignedInteger32 pMaxObjects)
                                                throws WBEMException
Description copied from interface: WBEMClient
referencePaths will start an enumeration session for association instances that have references that refer to the instance defined in the pInstancePath parameter and return zero or more CIMObjectPath objects.

Specified by:
referencePaths in interface WBEMClient
Parameters:
pObjectName - The CIMObjectPath for the instance for which the enumeration is to be performed.
pResultClass - This string MUST either contain a valid CIM Class name or be null. It filters the Objects returned to contain only the Objects of this Class name or one of its subclasses.
pRole - This string MUST either contain a valid Property name or be null. It filters the Objects returned to contain only Objects referring to the source Object via a Property with the specified name. If "Antecedent" is specified, then only Associations in which the source Object is the "Antecedent" reference are returned.
pFilterQueryLanguage - The pFilterQueryLanguage represents the query language for the pFilterQuery argument. This must be left null if a pFilterQuery is not supplied. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.
pFilterQuery - The pFilterQuery specifies a query in the form of the query language specified by the pFilterQueryLanguage parameter. If this value is not null, the pFilterQueryLanguage parameter must be non-null. This value will act as an additional filter on the result set. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.
pTimeout - This input parameter determines the minimum time the CIM server shall maintain the open enumeration session after the last Open or Pull operation (unless the enumeration session is closed). If the operation timeout is exceeded, the implementation may close the enumeration session at any time, releasing any resources allocated to the enumeration session. A pTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If pTimeout is null, the implementation shall choose an operation timeout. All other values for pTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for pTimeout. Specifically, the implementation may not allow 0 (no timeout). If the specified value is not an allowable value, the implementation shall return failure with the status code CIM_ERR_INVALID_OPERATION_TIMEOUT.
pContinueOnError - If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and pContinueOnError is true, it shall throw a WBEMException with the status code CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED. If a implementation supports continuation on error and pContinueOnError is true, the enumeration session shall remain open when a Pull operation fails, and any subsequent successful Pull operations shall return the set of elements that would have been returned if the failing Pull operations were successful. This behavior is subject to the consistency rules defined for pulled enumerations. If pContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.
pMaxObjects - Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to pMaxObjects but shall not deliver more than pMaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of pMaxObjects. Note that a CIM client can use a pMaxObjects value of 0 to specify that it does not want to retrieve any instances in the Open operation.
Returns:
The return value of a successful Open operation is an array of enumerated elements with a number of entries from 0 up to a maximum defined by pMaxObjects. These entries meet the criteria defined in the Open operation. Note that returning no entries in the array does not imply that the enumeration session is exhausted. Client must evaluate the EnumerateResponse.isEnd() to determine if there are more elements.
Throws:
WBEMException - If unsuccessful, one of the following status codes must be returned. The ORDERED list is:
 
      CIM_ERR_ACCESS_DENIED
      CIM_ERR_SERVER_IS_SHUTTING_DOWN
      CIM_ERR_NOT_SUPPORTED
      CIM_ERR_INVALID_NAMESPACE
      CIM_ERR_INVALID_OPERATION_TIMEOUT
      CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
      CIM_ERR_INVALID_PARAMETER
      CIM_ERR_NOT_FOUND (the source instance was not found)
      CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
      CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
      CIM_ERR_INVALID_QUERY
      CIM_ERR_FAILED (some other unspecified error occurred)
 

references

public EnumerateResponse<CIMInstance> references(CIMObjectPath pObjectName,
                                                 String pResultClass,
                                                 String pRole,
                                                 boolean pIncludeClassOrigin,
                                                 String[] pPropertyList,
                                                 String pFilterQueryLanguage,
                                                 String pFilterQuery,
                                                 UnsignedInteger32 pTimeout,
                                                 boolean pContinueOnError,
                                                 UnsignedInteger32 pMaxObjects)
                                          throws WBEMException
Description copied from interface: WBEMClient
references will start an enumeration session for association instances that have references that refer to the instance defined in the pInstancePath parameter and return zero or more CIMInstance objects.

Specified by:
references in interface WBEMClient
Parameters:
pObjectName - The CIMObjectPath for the instance for which the enumeration is to be performed.
pResultClass - This string MUST either contain a valid CIM Class name or be null. It filters the Objects returned to contain only the Objects of this Class name or one of its subclasses.
pRole - This string MUST either contain a valid Property name or be null. It filters the Objects returned to contain only Objects referring to the source Object via a Property with the specified name. If "Antecedent" is specified, then only Associations in which the source Object is the "Antecedent" reference are returned.
pIncludeClassOrigin - The class origin attribute is the name of the class that first defined the property or method. If true, the class origin attribute will be present for each property and method on all Objects returned. If false, the class origin will not be present.
pPropertyList - An array of property names used to filter what is contained in the Objects returned. Each CIMInstance returned only contains elements for the properties of the names specified. Duplicate and invalid property names are ignored and the request is otherwise processed normally. An empty array indicates that no properties should be included in the Objects returned. A null value indicates that all properties should be contained in the Objects returned.
pFilterQueryLanguage - The pFilterQueryLanguage represents the query language for the pFilterQuery argument. This must be left null if a pFilterQuery is not supplied. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.
pFilterQuery - The pFilterQuery specifies a query in the form of the query language specified by the pFilterQueryLanguage parameter. If this value is not null, the pFilterQueryLanguage parameter must be non-null. This value will act as an additional filter on the result set. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.
pTimeout - This input parameter determines the minimum time the CIM server shall maintain the open enumeration session after the last Open or Pull operation (unless the enumeration session is closed). If the operation timeout is exceeded, the implementation may close the enumeration session at any time, releasing any resources allocated to the enumeration session. A pTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If pTimeout is null, the implementation shall choose an operation timeout. All other values for pTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for pTimeout. Specifically, the implementation may not allow 0 (no timeout). If the specified value is not an allowable value, the implementation shall return failure with the status code CIM_ERR_INVALID_OPERATION_TIMEOUT.
pContinueOnError - If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and pContinueOnError is true, it shall throw a WBEMException with the status code CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED. If a implementation supports continuation on error and pContinueOnError is true, the enumeration session shall remain open when a Pull operation fails, and any subsequent successful Pull operations shall return the set of elements that would have been returned if the failing Pull operations were successful. This behavior is subject to the consistency rules defined for pulled enumerations. If pContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.
pMaxObjects - Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to pMaxObjects but shall not deliver more than pMaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of pMaxObjects. Note that a CIM client can use a pMaxObjects value of 0 to specify that it does not want to retrieve any instances in the Open operation.
Returns:
The return value of a successful Open operation is an array of enumerated elements with a number of entries from 0 up to a maximum defined by pMaxObjects. These entries meet the criteria defined in the Open operation. Note that returning no entries in the array does not imply that the enumeration session is exhausted. Client must evaluate the EnumerateResponse.isEnd() to determine if there are more elements.
Throws:
WBEMException - If unsuccessful, one of the following status codes must be returned. The ORDERED list is:
      CIM_ERR_ACCESS_DENIED
      CIM_ERR_SERVER_IS_SHUTTING_DOWN
      CIM_ERR_NOT_SUPPORTED
      CIM_ERR_INVALID_NAMESPACE
      CIM_ERR_INVALID_OPERATION_TIMEOUT
      CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
      CIM_ERR_INVALID_PARAMETER
      CIM_ERR_NOT_FOUND (the source instance was not found)
      CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
      CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
      CIM_ERR_INVALID_QUERY
      CIM_ERR_FAILED (some other unspecified error occurred)
 

sendIndication

public boolean sendIndication(URI pRecipient,
                              CIMInstance pIndication)
                       throws WBEMException
Description copied from interface: WBEMClientSBLIM
Sends the indication to the specified recipient.

Specified by:
sendIndication in interface WBEMClientSBLIM
Parameters:
pRecipient - URI of indication recipient.
pIndication - Indication.
Returns:
true if indication received successfully, false otherwise.
Throws:
WBEMException - If unsuccessful, one of the following status codes must be returned. The ORDERED list is:
      CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized
            or otherwise incorrect parameters)
      CIM_ERR_FAILED (some other unspecified error occurred)
 


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