Interface WBEMClient
- All Known Subinterfaces:
WBEMClientSBLIM
- All Known Implementing Classes:
WBEMClientCIMXML
public interface WBEMClient
The
WBEMClient
interface is used to invoke WBEM operations
against a WBEM Server. A WBEMClient
implementation can be
retrieved from the WBEMClientFactory
specifying the protocol to
be used.- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionassociatorClasses
(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.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.associatorNames
(CIMObjectPath pObjectName, String pAssociationClass, String pResultClass, String pRole, String pResultRole) Enumerates theCIMObjectPath
s of CIM Objects that are associated to a particular source CIM Object.associatorPaths
(CIMObjectPath pInstancePath, String pAssociationClass, String pResultClass, String pRole, String pResultRole, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) associatorPaths
shall start an enumeration session for traversing associations starting from the instance defined in thepInstancePath
parameter using any specified filtering criteria and return zero or moreCIMObjectPath
objects.associators
(CIMObjectPath pInstancePath, String pAssociationClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeClassOrigin, String[] pPropertyList, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) associators
shall start an enumeration session for traversing associations starting from the instance defined in thepInstancePath
parameter using any specified filtering criteria and return zero or moreCIMInstance
objects.void
close()
Closes theWBEMClient
session.void
closeEnumeration
(CIMObjectPath pPath, String pContext) closeEnumeration
shall close an enumeration session that has been previously started but not yet completed.void
createClass
(CIMClass pClass) Create a CIM class.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.enumerateClasses
(CIMObjectPath pPath, boolean pDeep, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin) Enumerate CIM Classes.enumerateClassNames
(CIMObjectPath pPath, boolean pDeep) Enumerate the names of CIM Classes.Enumerate the names of the instances for a specified class.enumerateInstancePaths
(CIMObjectPath pClassPath, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) enumerateInstancePaths
shall enumerate the instances of the specified class inpClassPath
and return zero or moreCIMObjectPath
s.enumerateInstances
(CIMObjectPath pPath, boolean pDeep, boolean pLocalOnly, boolean pIncludeClassOrigin, String[] pPropertyList) Enumerate the instances of a class.enumerateInstances
(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pIncludeClassOrigin, String[] pPropertyList, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) enumerateInstances
shall enumerate the instances of the specified class inpClassPath
and return zero or moreCIMInstance
s.Enumerates the CIM Qualifier types for a specific namespace.enumerationCount
(CIMObjectPath pPath, String pEnumerationContext) enumerationCount
provides an estimated count of the total number of objects in an open enumeration session represented by an enumeration context.execQuery
(CIMObjectPath pPath, String pQuery, String pQueryLanguage) execQuery
shall execute a query to retrieve objects.execQueryInstances
(CIMObjectPath pObjectName, String pFilterQuery, String pFilterQueryLanguage, boolean pReturnQueryResultClass, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects, CIMClass pQueryResultClass) execQueryInstances
shall execute a query to retrieve instances.getClass
(CIMObjectPath pName, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) Returns theCIMClass
for the specifiedCIMObjectPath
.getInstance
(CIMObjectPath pName, boolean pLocalOnly, boolean pIncludeClassOrigin, String[] pPropertyList) Get aCIMInstance
.getInstancePaths
(CIMObjectPath pPath, String pContext, UnsignedInteger32 pMaxObjects) getInstancePaths
shall get theCIMObjectPath
s using an enumeration context.getInstances
(CIMObjectPath pPath, String pContext, UnsignedInteger32 pMaxObjects) getInstances
shall get the instances from an enumeration session started byexecQueryInstances
.getInstancesWithPath
(CIMObjectPath pPath, String pContext, UnsignedInteger32 pMaxObjects) getInstancesWithPath
shall use the enumeration context provided to get the next set of instances for the enumeration session.getProperty
(String pKey) Get property values.getQualifierType
(CIMObjectPath pName) Get aCIMQualifierType
.void
initialize
(CIMObjectPath pName, Subject pSubject, Locale[] pLocales) Initialize the client connection.invokeMethod
(CIMObjectPath pName, String pMethodName, CIMArgument<?>[] pInputArguments, CIMArgument<?>[] pOutputArguments) Executes the specified method on the specified object.void
modifyClass
(CIMClass pClass) Modify theCIMClass
.void
modifyInstance
(CIMInstance pInstance, String[] pPropertyList) Modify some or all of the properties of the specifiedCIMInstance
.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.referenceInstances
(CIMObjectPath pObjectName, String pResultClass, String pRole, boolean pIncludeClassOrigin, String[] pPropertyList) Enumerates the Association instances that refer to a specified source CIM Instance.referenceNames
(CIMObjectPath pObjectName, String pResultClass, String pRole) Enumerates theCIMObjectPath
s of Association Objects that refer to a particular source CIM Object.referencePaths
(CIMObjectPath pInstancePath, String pResultClass, String pRole, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) referencePaths
shall start an enumeration session for association instances that have references that refer to the instance defined in thepInstancePath
parameter and return zero or moreCIMObjectPath
objects.references
(CIMObjectPath pInstancePath, String pResultClass, String pRole, boolean pIncludeClassOrigin, String[] pPropertyList, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) references
shall start an enumeration session for association instances that have references that refer to the instance defined in thepInstancePath
parameter and return zero or moreCIMInstance
objects.void
setLocales
(Locale[] pLocales) Change the locales that were provided during initialization.void
setProperty
(String pKey, String pValue) Set properties that enable options or protocol specific properties.void
setQualifierType
(CIMQualifierType<?> pQualifierType) Add aCIMQualifierType
to the specified namespace if it does not already exist.
-
Method Details
-
associatorClasses
CloseableIterator<CIMClass> associatorClasses(CIMObjectPath pObjectName, String pAssociationClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException Enumerates CIM classes that are associated to a specified source CIM class.- Parameters:
pObjectName
-CIMObjectPath
defining the source CIM Class whose associated classes are to be returned. ThepObjectName
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 benull
. 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 benull
. 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 benull
. 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 benull
. 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
- Iftrue
, all Qualifiers for each class (including Qualifiers on the Object and on any returned Properties) MUST be included in the classes returned. Iffalse
, 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. Iftrue
, the class origin attribute shall be present for each property and method on all classes returned. Iffalse
, the class origin shall not be present.pPropertyList
- An array of property names used to filter what is contained in the classes returned. EachCIMClass
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. Anull
value indicates that all properties should be contained in the classes returned.- Returns:
- If successful, a
CloseableIterator
containing zero or moreCIMClass
es meeting the specified criteria are returned. - Throws:
UnsupportedOperationException
- If the client implementation (or protocol) does not support the operation.WBEMException
- If unsuccessful, one of the following status codes shall be returned along with zero or more instances ofCIM_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
CloseableIterator<CIMInstance> associatorInstances(CIMObjectPath pObjectName, String pAssociationClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException Enumerates CIM Instances associated to a specified source CIM Instance.- Parameters:
pObjectName
-CIMObjectPath
defining the source CIM Instance whose associated instances are to be returned. ThepObjectName
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 benull
. 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 benull
. 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 benull
. 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 benull
. 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. Iftrue
, the class origin attribute may be present for each property on all instances returned, even if requested the server may ignore the request and not return the class origin. Iffalse
, the class origin shall not be present.pPropertyList
- An array of property names used to filter what is contained in the Objects returned. EachCIMInstance
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. Anull
value indicates that all properties should be contained in the instances returned.- Returns:
- If successful, a
CloseableIterator
containing zero or moreCIMInstance
s 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 ofCIM_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)
-
associatorNames
CloseableIterator<CIMObjectPath> associatorNames(CIMObjectPath pObjectName, String pAssociationClass, String pResultClass, String pRole, String pResultRole) throws WBEMException Enumerates theCIMObjectPath
s of CIM Objects that are associated to a particular source CIM Object. If the source Object is a CIM Class, then aCloseableIterator
ofCIMObjectPath
s of the classes associated to the source Object is returned. If the source Object is a CIM Instance, then aCloseableIterator
ofCIMObjectPath
s of theCIMInstance
objects associated to the source Object is returned.- 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 benull
. 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 benull
. 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 benull
. 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 benull
. 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 moreCIMObjectPath
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)
-
associatorPaths
EnumerateResponse<CIMObjectPath> associatorPaths(CIMObjectPath pInstancePath, String pAssociationClass, String pResultClass, String pRole, String pResultRole, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) throws WBEMException associatorPaths
shall start an enumeration session for traversing associations starting from the instance defined in thepInstancePath
parameter using any specified filtering criteria and return zero or moreCIMObjectPath
objects.- Parameters:
pInstancePath
- TheCIMObjectPath
for the instance for which the enumeration is to be performed.pAssociationClass
- This string MUST either contain a valid CIM Association class name or benull
. 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 benull
. 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 benull
. 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 benull
. 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
- ThepFilterQueryLanguage
represents the query language for thepFilterQuery
argument. This must be leftnull
if apFilterQuery
is not supplied. If the implementation does not support the query language specified, theCIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall be returned. If the implementation does not support filtered enumerations, theCIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error shall be returned.pFilterQuery
- ThepFilterQuery
specifies a query in the form of the query language specified by thepFilterQueryLanguage
parameter. If this value is notnull
, thepFilterQueryLanguage
parameter must be non-null
. This value shall act as an additional filter on the result set. If the implementation does not support the query language specified, theCIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall be returned. If the implementation does not support filtered enumerations, theCIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error shall 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. ApTimeout
of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. IfpTimeout
isnull
, the implementation shall choose an operation timeout. All other values forpTimeout
specify the operation timeout in seconds. A implementation may restrict the set of allowable values forpTimeout
. 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 codeCIM_ERR_INVALID_OPERATION_TIMEOUT
.pContinueOnError
- Iftrue
, requests that the operation resume when an error is received. If a implementation does not support continuation on error andpContinueOnError
istrue
, it shall throw aWBEMException
with the status codeCIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
. If a implementation supports continuation on error andpContinueOnError
istrue
, 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. IfpContinueOnError
isfalse
, the enumeration session shall be closed when either the operation completes successfully or when aWBEMExcetpion
is thrown.pMaxObjects
- Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up topMaxObjects
but shall not deliver more thanpMaxObjects
elements. An implementation may choose to never return any elements during an Open operation, regardless of the value ofpMaxObjects
. Note that a CIM client can use apMaxObjects
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 theEnumerateResponse.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
EnumerateResponse<CIMInstance> associators(CIMObjectPath pInstancePath, String pAssociationClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeClassOrigin, String[] pPropertyList, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) throws WBEMException associators
shall start an enumeration session for traversing associations starting from the instance defined in thepInstancePath
parameter using any specified filtering criteria and return zero or moreCIMInstance
objects.- Parameters:
pInstancePath
- TheCIMObjectPath
for the instance for which the enumeration is to be performed.pAssociationClass
- This string MUST either contain a valid CIM Association class name or benull
. 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 benull
. 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 benull
. 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 benull
. 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. Iftrue
, the class origin attribute may be present for each property on all instances returned, even if requested the server may ignore the request and not return the class origin. Iffalse
, the class origin shall not be present.pPropertyList
- An array of property names used to filter what is contained in the Objects returned. EachCIMClass
orCIMInstance
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. Anull
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 thepResultClass
parameter.pFilterQueryLanguage
- ThepFilterQueryLanguage
represents the query language for thepFilterQuery
argument. This must be leftnull
if a filterQuery is not supplied. If the implementation does not support the query language specified, theCIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall be returned. If the implementation does not support filtered enumerations, theCIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error shall be returned.pFilterQuery
- ThepFilterQuery
specifies a query in the form of the query language specified by thepFilterQueryLanguage
parameter. If this value is notnull
, thepFilterQueryLanguage
parameter must be non-null
. This value shall act as an additional filter on the result set. If the implementation does not support the query language specified, theCIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall be returned. If the implementation does not support filtered enumerations, theCIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error shall 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. ApTimeout
of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. IfpTimeout
isnull
, the implementation shall choose an operation timeout. All other values forpTimeout
specify the operation timeout in seconds. A implementation may restrict the set of allowable values forpTimeout
. 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 codeCIM_ERR_INVALID_OPERATION_TIMEOUT
.pContinueOnError
- Iftrue
, requests that the operation resume when an error is received. If a implementation does not support continuation on error andpContinueOnError
istrue
, it shall throw aWBEMException
with the status codeCIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
. If a implementation supports continuation on error andpContinueOnError
istrue
, 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. IfpContinueOnError
isfalse
, the enumeration session shall be closed when either the operation completes successfully or when aWBEMExcetpion
is thrown.pMaxObjects
- Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up topMaxObjects
but shall not deliver more thanpMaxObjects
elements. An implementation may choose to never return any elements during an Open operation, regardless of the value ofpMaxObjects
. Note that a CIM client can use apMaxObjects
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 theEnumerateResponse.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)
-
close
void close()Closes theWBEMClient
session. -
closeEnumeration
closeEnumeration
shall 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 theEnumerationResponse.isEnd()
is true, this method shall not be called.- Parameters:
pPath
- TheCIMObjectPath
representing the namespace to be used.pContext
- The enumeration context to close.- Throws:
WBEMException
-
createClass
Create a CIM class. The namespace from theCIMClass.getObjectPath()
shall be used.- Parameters:
pClass
- TheCIMClass
to be created.- Throws:
UnsupportedOperationException
- If the client implementation (or protocol) does not support the operation.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
Create a CIM Instance. The namespace from theCIMInstance.getObjectPath()
shall be used. The keys of theCIMInstance
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.- Parameters:
pInstance
- TheCIMInstance
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
Deletes the CIM class for the object specified by the CIM object path.- Parameters:
pPath
- TheCIMObjectPath
identifying the namespace and class name to delete.- Throws:
UnsupportedOperationException
- If the client implementation (or protocol) does not support the operation.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
Delete the CIM instance specified by the CIM object path.- 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
Delete a CIM Qualifier type.- Parameters:
pPath
- TheCIMObjectPath
identifying the name and namespace of the CIM qualifier type to delete.- Throws:
UnsupportedOperationException
- If the client implementation (or protocol) does not support the operation.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)
-
enumerateClasses
CloseableIterator<CIMClass> enumerateClasses(CIMObjectPath pPath, boolean pDeep, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin) throws WBEMException Enumerate CIM Classes.- 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
- Iftrue
, the classes returned shall include subclasses. Iffalse
, the classes returned shall not include subclasses.pLocalOnly
- Iftrue
, only elements (properties, methods and qualifiers) defined in, or overridden in the class are included in the response. Iffalse
, all elements of the class definition are returned.pIncludeQualifiers
- Iftrue
, all Qualifiers for each Class and its elements (properties, methods, references) are included. Iffalse
, 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. Iftrue
, the class origin attribute shall be present for each property and method on all returnedCIMClass
es. Iffalse
, the class origin shall not be present.- Returns:
- A
CloseableIterator
ofCIMClass
es. - Throws:
UnsupportedOperationException
- If the client implementation (or protocol) does not support the operation.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)
-
enumerateClassNames
CloseableIterator<CIMObjectPath> enumerateClassNames(CIMObjectPath pPath, boolean pDeep) throws WBEMException Enumerate the names of CIM Classes.- Parameters:
pPath
- TheCIMObjectPath
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
- Iftrue
, the enumeration returned shall contain the names of all classes derived from the class being enumerated. Iffalse
, the enumeration returned contains only the names of the first level children of the class.- Returns:
- A
CloseableIterator
ofCIMObjectPath
s. - Throws:
UnsupportedOperationException
- If the client implementation (or protocol) does not support the operation.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
Enumerate the names of the instances for a specified class. The names of all subclass instances are returned.- Parameters:
pPath
- TheCIMObjectPath
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
ofCIMObjectPath
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 (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)
-
enumerateInstancePaths
EnumerateResponse<CIMObjectPath> enumerateInstancePaths(CIMObjectPath pClassPath, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) throws WBEMException enumerateInstancePaths
shall enumerate the instances of the specified class inpClassPath
and return zero or moreCIMObjectPath
s.- Parameters:
pClassPath
- TheCIMObjectPath
for the class for which the enumeration is to be performed.pFilterQueryLanguage
- ThepFilterQueryLanguage
represents the query language for thepFilterQuery
argument. This must be leftnull
if apFilterQuery
is not supplied. If the implementation does not support the query language specified, theCIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall be returned. If the implementation does not support filtered enumerations, theCIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error shall be returned.pFilterQuery
- ThepFilterQuery
specifies a query in the form of the query language specified by thepFilterQueryLanguage
parameter. If this value is notnull
, thepFilterQueryLanguage
parameter must be non-null
. This value shall act as an additional filter on the result set. If the implementation does not support the query language specified, theCIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall be returned. If the implementation does not support filtered enumerations, theCIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error shall 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. ApTimeout
of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. IfpTimeout
isnull
, the implementation shall choose an operation timeout. All other values forpTimeout
specify the operation timeout in seconds. A implementation may restrict the set of allowable values forpTimeout
. 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 codeCIM_ERR_INVALID_OPERATION_TIMEOUT
.pContinueOnError
- Iftrue
, requests that the operation resume when an error is received. If a implementation does not support continuation on error andpContinueOnError
istrue
, it shall throw aWBEMException
with the status codeCIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
. If a implementation supports continuation on error andpContinueOnError
istrue
, 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. IfpContinueOnError
isfalse
, the enumeration session shall be closed when either the operation completes successfully or when aWBEMExcetpion
is thrown.pMaxObjects
- Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up topMaxObjects
but shall not deliver more thanpMaxObjects
elements. An implementation may choose to never return any elements during an Open operation, regardless of the value ofpMaxObjects
. Note that a CIM client can use apMaxObjects
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 theEnumerateResponse.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
CloseableIterator<CIMInstance> enumerateInstances(CIMObjectPath pPath, boolean pDeep, boolean pLocalOnly, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException Enumerate the instances of a class. The instances of all subclasses are also returned.- 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
- Iftrue
, 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. Iffalse
, each returned Instance includes only properties defined for the specified Class in path.pLocalOnly
- Iftrue
, only properties that were instantiated in the instance are returned. WBEM Servers may ignore this parameter and return all properties.pIncludeClassOrigin
- The class origin attribute is the name of the class that first defined the property. Iftrue
, the class origin attribute may be present for each property on all returned CIMInstances, even if requested the server may ignore the request and not return the class origin. Iffalse
, the class origin shall 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
ofCIMInstance
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 (for this method) CIM_ERR_INVALID_CLASS (in this namespace) CIM_ERR_FAILED (some other unspecified error occurred)
-
enumerateInstances
EnumerateResponse<CIMInstance> enumerateInstances(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pIncludeClassOrigin, String[] pPropertyList, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) throws WBEMException enumerateInstances
shall enumerate the instances of the specified class inpClassPath
and return zero or moreCIMInstance
s.- Parameters:
pClassPath
- TheCIMObjectPath
for the class for which the enumeration is to be performed.pDeepInheritance
- Iftrue
, 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. Iffalse
, 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. Iftrue
, the class origin attribute may be present for each property on all instances returned, even if requested the server may ignore the request and not return the class origin. Iffalse
, the class origin shall not be present.pPropertyList
- An array of property names used to filter what is contained in the Objects returned. EachCIMInstance
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. Anull
value indicates that all properties should be contained in the Objects returned.pFilterQueryLanguage
- ThepFilterQueryLanguage
represents the query language for thepFilterQuery
argument. This must be leftnull
if apFilterQuery
is not supplied. If the implementation does not support the query language specified, theCIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall be returned. If the implementation does not support filtered enumerations, theCIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error shall be returned.pFilterQuery
- ThepFilterQuery
specifies a query in the form of the query language specified by thepFilterQueryLanguage
parameter. If this value is notnull
, thepFilterQueryLanguage
parameter must be non-null
. This value shall act as an additional filter on the result set. If the implementation does not support the query language specified, theCIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall be returned. If the implementation does not support filtered enumerations, theCIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error shall 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. ApTimeout
of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. IfpTimeout
isnull
, the implementation shall choose an operation timeout. All other values forpTimeout
specify the operation timeout in seconds. A implementation may restrict the set of allowable values forpTimeout
. 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 codeCIM_ERR_INVALID_OPERATION_TIMEOUT
.pContinueOnError
- Iftrue
, requests that the operation resume when an error is received. If a implementation does not support continuation on error andpContinueOnError
istrue
, it shall throw aWBEMException
with the status codeCIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
. If a implementation supports continuation on error andpContinueOnError
istrue
, 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. IfpContinueOnError
isfalse
, the enumeration session shall be closed when either the operation completes successfully or when aWBEMExcetpion
is thrown.pMaxObjects
- Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up topMaxObjects
but shall not deliver more thanpMaxObjects
elements. An implementation may choose to never return any elements during an Open operation, regardless of the value ofpMaxObjects
. Note that a CIM client can use apMaxObjects
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 theEnumerateResponse.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)
-
enumerateQualifierTypes
CloseableIterator<CIMQualifierType<?>> enumerateQualifierTypes(CIMObjectPath pPath) throws WBEMException Enumerates the CIM Qualifier types for a specific namespace.- Parameters:
pPath
- TheCIMObjectPath
identifying the namespace whose qualifier types are to be enumerated.- Returns:
- A
CloseableIterator
ofCIMQualifierType
s. - Throws:
UnsupportedOperationException
- If the client implementation (or protocol) does not support the operation.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)
-
enumerationCount
UnsignedInteger64 enumerationCount(CIMObjectPath pPath, String pEnumerationContext) throws WBEMException enumerationCount
provides an estimated count of the total number of objects in an open enumeration session represented by an enumeration context.- Parameters:
pPath
- The namespace for the enumeration context.pEnumerationContext
- The enumeration context to count.- Returns:
- The estimated number of objects.
- Throws:
UnsupportedOperationException
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
-
execQuery
CloseableIterator<CIMInstance> execQuery(CIMObjectPath pPath, String pQuery, String pQueryLanguage) throws WBEMException execQuery
shall execute a query to retrieve objects.- 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
ofCIMInstance
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 (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)
-
execQueryInstances
EnumerateResponse<CIMInstance> execQueryInstances(CIMObjectPath pObjectName, String pFilterQuery, String pFilterQueryLanguage, boolean pReturnQueryResultClass, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects, CIMClass pQueryResultClass) throws WBEMException execQueryInstances
shall execute a query to retrieve instances.- Parameters:
pObjectName
- TheCIMObjectPath
representing the namespace to be used.pFilterQuery
- ThepFilterQuery
specifies a query in the form of the query language specified by thepFilterQueryLanguage
parameter. If this value is notnull
, thepFilterQueryLanguage
parameter must be non-null
. This value shall act as an additional filter on the result set. If the implementation does not support the query language specified, theCIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall be returned. If the implementation does not support filtered enumerations, theCIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error shall be returned.pFilterQueryLanguage
- ThepFilterQueryLanguage
represents the query language for thepFilterQuery
argument. This must be leftnull
if apFilterQuery
is not supplied. If the implementation does not support the query language specified, theCIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall be returned. If the implementation does not support filtered enumerations, theCIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error shall be returned.pReturnQueryResultClass
- ThepReturnQueryResultClass
controls whether a class definition is returned inpQueryResultClass
. If it is set tofalse
,pQueryResultClass
shall be set tonull
on output. If it is set totrue
, the value of thepQueryResultClass
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. ApTimeout
of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. IfpTimeout
isnull
, the implementation shall choose an operation timeout. All other values forpTimeout
specify the operation timeout in seconds. A implementation may restrict the set of allowable values forpTimeout
. 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 codeCIM_ERR_INVALID_OPERATION_TIMEOUT
.pContinueOnError
- Iftrue
, requests that the operation resume when an error is received. If a implementation does not support continuation on error andpContinueOnError
istrue
, it shall throw aWBEMException
with the status codeCIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
. If a implementation supports continuation on error andpContinueOnError
istrue
, 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. IfpContinueOnError
isfalse
, the enumeration session shall be closed when either the operation completes successfully or when aWBEMExcetpion
is thrown.pMaxObjects
- Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up topMaxObjects
but shall not deliver more thanpMaxObjects
elements. An implementation may choose to never return any elements during an Open operation, regardless of the value ofpMaxObjects
. Note that a CIM client can use apMaxObjects
value of 0 to specify that it does not want to retrieve any instances in the Open operation.pQueryResultClass
- ThepQueryResultClass
is an output argument. It shall benull
if thepReturnQueryResultClass
input parameter is set tofalse
. 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 theEnumerateResponse.isEnd()
to determine if there are more elements. - Throws:
UnsupportedOperationException
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)
-
getClass
CIMClass getClass(CIMObjectPath pName, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException Returns theCIMClass
for the specifiedCIMObjectPath
.- 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.pLocalOnly
- Iftrue
, only elements (properties, methods, references) overridden or defined in the class are included in theCIMClass
returned. Iffalse
, all elements of the class definition are returned.pIncludeQualifiers
- Iftrue
, all Qualifiers for the class and its elements are included in theCIMClass
returned. Iffalse
, no Qualifier information is contained in theCIMClass
returned.pIncludeClassOrigin
- The class origin attribute is the name of the class that first defined the property or method. Iftrue
, the class origin attribute shall be present for each property and method on all returnedCIMClass
es. Iffalse
, the class origin shall not be present.pPropertyList
- An array of property names used to filter what is contained in theCIMClass
returned. TheCIMClass
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. Anull
value indicates that all properties should be returned.- Returns:
CIMClass
meeting the criteria specified.- Throws:
UnsupportedOperationException
- If the client implementation (or protocol) does not support the operation.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
CIMInstance getInstance(CIMObjectPath pName, boolean pLocalOnly, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException Get aCIMInstance
.- Parameters:
pName
- The object path of the instance to be returned. The Keys in thisCIMObjectPath
must be populated.pLocalOnly
- Iftrue
, only properties overridden or defined in the class are included in theCIMInstance
returned. Iffalse
, all properties of the class definition are returned. WBEM Servers may ignore this parameter and return all properties.pIncludeClassOrigin
- The class origin attribute is the name of the class that first defined the property. Iftrue
, the class origin attribute may be present for each property of theCIMInstance
, even if requested the server may ignore the request and not return the class origin. Iffalse
, the class origin shall not be present.pPropertyList
- An array of property names used to filter what is contained in theCIMClass
returned. TheCIMClass
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. Anull
value indicates that all properties should be returned.- Returns:
CIMInstance
identified by theCIMObjectPath
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)
-
getInstancePaths
EnumerateResponse<CIMObjectPath> getInstancePaths(CIMObjectPath pPath, String pContext, UnsignedInteger32 pMaxObjects) throws WBEMException getInstancePaths
shall get theCIMObjectPath
s using an enumeration context.- Parameters:
pPath
- TheCIMObjectPath
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 topMaxObjects
but shall not deliver more thanpMaxObjects
elements. An implementation may choose to never return any elements during an Open operation, regardless of the value ofpMaxObjects
.- Returns:
EnumerateResponse
that includes zero or moreCIMObjectPath
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
EnumerateResponse<CIMInstance> getInstances(CIMObjectPath pPath, String pContext, UnsignedInteger32 pMaxObjects) throws WBEMException getInstances
shall get the instances from an enumeration session started byexecQueryInstances
.- Parameters:
pPath
- TheCIMObjectPath
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 topMaxObjects
but shall not deliver more thanpMaxObjects
elements. An implementation may choose to never return any elements during an Open operation, regardless of the value ofpMaxObjects
. Note that a CIM client can use apMaxObjects
value of 0 to specify that it does not want to retrieve any instances in the Open operation.- Returns:
EnumerateResponse
that includes zero or moreCIMObjectPath
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
EnumerateResponse<CIMInstance> getInstancesWithPath(CIMObjectPath pPath, String pContext, UnsignedInteger32 pMaxObjects) throws WBEMException getInstancesWithPath
shall use the enumeration context provided to get the next set of instances for the enumeration session.- Parameters:
pPath
- TheCIMObjectPath
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 topMaxObjects
but shall not deliver more thanpMaxObjects
elements. An implementation may choose to never return any elements during an Open operation, regardless of the value ofpMaxObjects
.- Returns:
EnumerateResponse
that includes zero or moreCIMObjectPath
. 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)
-
getProperty
-
getQualifierType
Get aCIMQualifierType
.- Parameters:
pName
-CIMObjectPath
that identifies theCIMQualifierType
to return.- Returns:
- The
CIMQualifierType
object. - Throws:
UnsupportedOperationException
- If the client implementation (or protocol) does not support the operation.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)
-
initialize
void initialize(CIMObjectPath pName, Subject pSubject, Locale[] pLocales) throws IllegalArgumentException, WBEMException Initialize the client connection. This must be called before any operations. This must only be called once.- Parameters:
pName
- The protocol and host to use (e.g. http://192.168.1.128/). Any other fields shall 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.
-
invokeMethod
Object invokeMethod(CIMObjectPath pName, String pMethodName, CIMArgument<?>[] pInputArguments, CIMArgument<?>[] pOutputArguments) throws WBEMException Executes the specified method on the specified object.- 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
- TheCIMArgument
array of method input parameters.pOutputArguments
- TheCIMArgument
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)
-
modifyClass
Modify theCIMClass
.- Parameters:
pClass
-CIMClass
to be modified.- Throws:
UnsupportedOperationException
- If the client implementation (or protocol) does not support the operation.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
Modify some or all of the properties of the specifiedCIMInstance
.- Parameters:
pInstance
-CIMInstance
to be modified. All Keys must be populated.pPropertyList
- An array of property names used to specify which values from theCIMInstance
specified to set. Properties not specified in this list but set in theCIMInstance
specified are not modified. Duplicate property names are ignored and the request is otherwise processed normally. If thepPropertyList
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. Anull
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
CloseableIterator<CIMClass> referenceClasses(CIMObjectPath pObjectName, String pResultClass, String pRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException Enumerates the Association classes that refer to a specified source CIM Class.- 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 benull
. ThepResultClass
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 benull
. 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
- Iftrue
, all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) shall be included in the classes returned. Iffalse
, 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. Iftrue
, the class Origin attribute shall be present for each property and method on all classes returned. Iffalse
, the class origin shall not be present.pPropertyList
- An array of property names used to filter what is contained in the Objects returned. EachCIMClass
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. Anull
value indicates that all properties should be contained in the classes returned.- Returns:
- If successful, a
CloseableIterator
referencing zero or moreCIMClass
es meeting the specified criteria. - Throws:
UnsupportedOperationException
- If the client implementation (or protocol) does not support the operation.WBEMException
- If unsuccessful, one of the following status codes shall be returned along with zero or more instance ofCIM_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
CloseableIterator<CIMInstance> referenceInstances(CIMObjectPath pObjectName, String pResultClass, String pRole, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException Enumerates the Association instances that refer to a specified source CIM Instance.- Parameters:
pObjectName
-CIMObjectPath
defining the source CIM Instance whose referring instances are to be returned. ThepObjectName
shall include the host, object name and keys.pResultClass
- This string shall either contain a valid CIM Class name or benull
. 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 benull
. 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. Iftrue
, the class origin attribute may be present for each property and on all instances returned, even if requested the server may ignore the request and not return the class origin. Iffalse
, the class origin shall not be present.pPropertyList
- An array of property names used to filter what is contained in the instances returned. EachCIMInstance
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. Anull
value indicates that all properties supported shall be contained in the instance returned.- Returns:
- If successful, a
CloseableIterator
referencing zero or moreCIMInstance
s meeting the specified criteria. - Throws:
WBEMException
- If unsuccessful, one of the following status codes shall be returned along with zero or moreCIM_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
CloseableIterator<CIMObjectPath> referenceNames(CIMObjectPath pObjectName, String pResultClass, String pRole) throws WBEMException Enumerates theCIMObjectPath
s of Association Objects that refer to a particular source CIM Object. If the source Object is a CIM Class, then aCloseableIterator
ofCIMObjectPath
s of the Association classes that refer to the source Object is returned. If the source Object is a CIM Instance, then aCloseableIterator
ofCIMObjectPath
s of theCIMInstance
objects that refer to the source Object is returned.- 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 benull
. 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 benull
. 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 moreCIMObjectPath
s ofCIMClass
es orCIMInstance
s 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)
-
referencePaths
EnumerateResponse<CIMObjectPath> referencePaths(CIMObjectPath pInstancePath, String pResultClass, String pRole, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) throws WBEMException referencePaths
shall start an enumeration session for association instances that have references that refer to the instance defined in thepInstancePath
parameter and return zero or moreCIMObjectPath
objects.- Parameters:
pInstancePath
- TheCIMObjectPath
for the instance for which the enumeration is to be performed.pResultClass
- This string MUST either contain a valid CIM Class name or benull
. 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 benull
. 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
- ThepFilterQueryLanguage
represents the query language for thepFilterQuery
argument. This must be leftnull
if apFilterQuery
is not supplied. If the implementation does not support the query language specified, theCIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall be returned. If the implementation does not support filtered enumerations, theCIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error shall be returned.pFilterQuery
- ThepFilterQuery
specifies a query in the form of the query language specified by thepFilterQueryLanguage
parameter. If this value is notnull
, thepFilterQueryLanguage
parameter must be non-null
. This value shall act as an additional filter on the result set. If the implementation does not support the query language specified, theCIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall be returned. If the implementation does not support filtered enumerations, theCIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error shall 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. ApTimeout
of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. IfpTimeout
isnull
, the implementation shall choose an operation timeout. All other values forpTimeout
specify the operation timeout in seconds. A implementation may restrict the set of allowable values forpTimeout
. 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 codeCIM_ERR_INVALID_OPERATION_TIMEOUT
.pContinueOnError
- Iftrue
, requests that the operation resume when an error is received. If a implementation does not support continuation on error andpContinueOnError
istrue
, it shall throw aWBEMException
with the status codeCIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
. If a implementation supports continuation on error andpContinueOnError
istrue
, 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. IfpContinueOnError
isfalse
, the enumeration session shall be closed when either the operation completes successfully or when aWBEMExcetpion
is thrown.pMaxObjects
- Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up topMaxObjects
but shall not deliver more thanpMaxObjects
elements. An implementation may choose to never return any elements during an Open operation, regardless of the value ofpMaxObjects
. Note that a CIM client can use apMaxObjects
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 theEnumerateResponse.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
EnumerateResponse<CIMInstance> references(CIMObjectPath pInstancePath, String pResultClass, String pRole, boolean pIncludeClassOrigin, String[] pPropertyList, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) throws WBEMException references
shall start an enumeration session for association instances that have references that refer to the instance defined in thepInstancePath
parameter and return zero or moreCIMInstance
objects.- Parameters:
pInstancePath
- TheCIMObjectPath
for the instance for which the enumeration is to be performed.pResultClass
- This string shall either contain a CIM Class name or benull
. 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 Property name or benull
. It filters the instances returned to contain only instances referring to the source instance via a Property with the specified name. 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. Iftrue
, the class origin attribute may be present for each property on all instances returned, even if requested the server may ignore the request and not return the class origin. Iffalse
, the class origin shall not be present.pPropertyList
- An array of property names used to filter what is contained in the instances returned. EachCIMInstance
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. Anull
value indicates that all non-null properties of the instance are included.pFilterQueryLanguage
- ThepFilterQueryLanguage
represents the query language for thepFilterQuery
argument. This must be leftnull
if apFilterQuery
is not supplied. If the implementation does not support the query language specified, theCIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall be returned. If the implementation does not support filtered enumerations, theCIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error shall be returned.pFilterQuery
- ThepFilterQuery
specifies a query in the form of the query language specified by thepFilterQueryLanguage
parameter. If this value is notnull
, thepFilterQueryLanguage
parameter must be non-null
. This value shall act as an additional filter on the result set. If the implementation does not support the query language specified, theCIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall be returned. If the implementation does not support filtered enumerations, theCIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error shall 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. ApTimeout
of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. IfpTimeout
isnull
, the implementation shall choose an operation timeout. All other values forpTimeout
specify the operation timeout in seconds. A implementation may restrict the set of allowable values forpTimeout
. 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 codeCIM_ERR_INVALID_OPERATION_TIMEOUT
.pContinueOnError
- Iftrue
, requests that the operation resume when an error is received. If a implementation does not support continuation on error andpContinueOnError
istrue
, it shall throw aWBEMException
with the status codeCIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
. If a implementation supports continuation on error andpContinueOnError
istrue
, 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. IfpContinueOnError
isfalse
, the enumeration session shall be closed when either the operation completes successfully or when aWBEMExcetpion
is thrown.pMaxObjects
- Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up topMaxObjects
but shall not deliver more thanpMaxObjects
elements. An implementation may choose to never return any elements during an Open operation, regardless of the value ofpMaxObjects
. Note that a CIM client can use apMaxObjects
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 theEnumerateResponse.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)
-
setLocales
Change the locales that were provided during initialization.- Parameters:
pLocales
- An array of locales in order of priority of preference.
-
setProperty
Set properties that enable options or protocol specific properties. SeeWBEMClientConstants
for a list of standard properties.- Parameters:
pKey
- The name of the property.pValue
- The value of the property.- Throws:
IllegalArgumentException
- If the name is not a supported property name.- See Also:
-
setQualifierType
Add aCIMQualifierType
to the specified namespace if it does not already exist. Otherwise, it modifies the qualifier type to the value specified.- Parameters:
pQualifierType
- The CIM qualifier type to be added.- Throws:
UnsupportedOperationException
- If the client implementation (or protocol) does not support the operation.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)
-