|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WBEMClient
The WBEMClient interface is use to invoke WBEM operations against a WBEM Server. A WBEMClient implementation can be retrieved from the WBEMClientFactory specifying the protocol to be used.
WBEMClientFactory
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 Object. |
CloseableIterator<CIMInstance> |
associatorInstances(CIMObjectPath pObjectName,
String pAssociationClass,
String pResultClass,
String pRole,
String pResultRole,
boolean pIncludeClassOrigin,
String[] pPropertyList)
Enumerates CIMInstances that are associated to a specified source CIM Object. |
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 instancePath,
String associationClass,
String resultClass,
String role,
String resultRole,
String filterQueryLanguage,
String filterQuery,
UnsignedInteger32 timeout,
boolean continueOnError,
UnsignedInteger32 maxObjects)
associatorPaths will start an enumeration session for traversing associations starting from the instance defined in the instancePath parameter using any specified filtering criteria and return zero or more CIMObjectPath objects. |
CloseableIterator |
associators(CIMObjectPath pObjectName,
String pAssociationClass,
String pResultClass,
String pRole,
String pResultRole,
boolean pIncludeQualifiers,
boolean pIncludeClassOrigin,
String[] pPropertyList)
This function will be deprecated soon. |
EnumerateResponse<CIMInstance> |
associators(CIMObjectPath instancePath,
String associationClass,
String resultClass,
String role,
String resultRole,
boolean includeClassOrigin,
String[] propertyList,
String filterQueryLanguage,
String filterQuery,
UnsignedInteger32 timeout,
boolean continueOnError,
UnsignedInteger32 maxObjects)
associators will start an enumeration session for traversing associations starting from the instance defined in the instancePath parameter using any specified filtering criteria and return zero or more CIMInstance objects. |
void |
close()
Closes the connection. |
void |
closeEnumeration(CIMObjectPath path,
String context)
closeEnumeration will close an enumeration session that has been previously started but not yet completed. |
void |
createClass(CIMClass pClass)
Create a CIM class The namespace from the CIMClass.getObjectPath() will be used. |
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 classPath,
String filterQueryLanguage,
String filterQuery,
UnsignedInteger32 timeout,
boolean continueOnError,
UnsignedInteger32 maxObjects)
enumerateInstancePaths will enumerate the instances of the specified class in classPath and return zero or more CIMObjectPath |
CloseableIterator<CIMInstance> |
enumerateInstances(CIMObjectPath pPath,
boolean pDeep,
boolean pPropagated,
boolean pIncludeClassOrigin,
String[] pPropertyList)
Enumerate the instances of a class. |
EnumerateResponse<CIMInstance> |
enumerateInstances(CIMObjectPath classPath,
boolean deepInheritance,
boolean includeClassOrigin,
String[] propertyList,
String filterQueryLanguage,
String filterQuery,
UnsignedInteger32 timeout,
boolean continueOnError,
UnsignedInteger32 maxObjects)
enumerateInstances will enumerate the instances of the specified class in classPath and return zero or more CIMInstances. |
CloseableIterator<CIMQualifierType<?>> |
enumerateQualifierTypes(CIMObjectPath pPath)
Enumerates the CIM Qualifier Types for a specific namespace |
UnsignedInteger64 |
enumerationCount(CIMObjectPath path,
String enumerationContext)
enumerationCount provides an estimated count of the total number of objects in an open enumeration session represented by an EnumerationContext. |
CloseableIterator<CIMInstance> |
execQuery(CIMObjectPath pPath,
String pQuery,
String pQueryLanguage)
ExecQuery will execute a query to retrieve objects. |
EnumerateResponse<CIMInstance> |
execQueryInstances(CIMObjectPath pObjectName,
String filterQuery,
String filterQueryLanguage,
Boolean returnQueryResultClass,
UnsignedInteger32 timeout,
Boolean continueOnError,
UnsignedInteger32 maxObjectCount,
CIMClass queryResultClass)
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
. |
CIMInstance |
getInstance(CIMObjectPath pName,
boolean pPropagated,
boolean pIncludeClassOrigin,
String[] pPropertyList)
Get a CIMInstance . |
EnumerateResponse<CIMObjectPath> |
getInstancePaths(CIMObjectPath path,
String context,
UnsignedInteger32 maxObjects)
getInstancePaths will get the CIMObjectPaths using an enumeration context. |
EnumerateResponse<CIMInstance> |
getInstances(CIMObjectPath path,
String context,
UnsignedInteger32 maxObjects)
getInstances will get the instances from an enumeration session started by execQueryInstances(). |
EnumerateResponse<CIMInstance> |
getInstancesWithPath(CIMObjectPath path,
String context,
UnsignedInteger32 maxObjects)
getInstancesWithPath will use the enumeration context provided to get the next set of instances for the enumeration session. |
String |
getProperty(String pKey)
Get protocol specific property values. |
CIMQualifierType<?> |
getQualifierType(CIMObjectPath pName)
Get a CIMQualifierType . |
void |
initialize(CIMObjectPath pName,
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. |
void |
modifyClass(CIMClass pClass)
Modify the CIMClass . |
void |
modifyInstance(CIMInstance ci,
String[] propertyList)
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 CIMObjectPath s of Association Objects that
are refer to a particular source CIM Object. |
EnumerateResponse<CIMObjectPath> |
referencePaths(CIMObjectPath instancePath,
String resultClass,
String role,
String filterQueryLanguage,
String filterQuery,
UnsignedInteger32 timeout,
boolean continueOnError,
UnsignedInteger32 maxObjects)
referencePaths will start an enumeration session for association instances that have references that refer to the instance defined in the instancePath parameter and return zero or more CIMObjectPath objects. |
CloseableIterator |
references(CIMObjectPath pObjectName,
String pResultClass,
String pRole,
boolean pIncludeQualifiers,
boolean pIncludeClassOrigin,
String[] pPropertyList)
This function will be deprecated soon. |
EnumerateResponse<CIMInstance> |
references(CIMObjectPath instancePath,
String resultClass,
String role,
boolean includeClassOrigin,
String[] propertyList,
String filterQueryLanguage,
String filterQuery,
UnsignedInteger32 timeout,
boolean continueOnError,
UnsignedInteger32 maxObjects)
references will start an enumeration session for association instances that have references that refer to the instance defined in the instancePath parameter and return zero or more CIMInstance objects. |
void |
setLocales(Locale[] pLocales)
Change the locales that were provided during initialization. |
void |
setProperty(String pKey,
String pValue)
Set protocol specific properties. |
void |
setQualifierType(CIMQualifierType<?> pQualifierType)
Add a CIMQualifierType to the specified namespace if it does
not already exist. |
Method Detail |
---|
CloseableIterator<CIMClass> associatorClasses(CIMObjectPath pObjectName, String pAssociationClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
pObjectName
- CIMObjectPath defining the source CIM Class whose associated classes are to be returned. The objectName 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 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 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.
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)
CloseableIterator<CIMInstance> associatorInstances(CIMObjectPath pObjectName, String pAssociationClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
pObjectName
- CIMObjectPath defining the source CIM Instance whose associated instances are to be returned. The objectName 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 instances 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.
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)
CloseableIterator<CIMObjectPath> associatorNames(CIMObjectPath pObjectName, String pAssociationClass, String pResultClass, String pRole, String pResultRole) throws WBEMException
CIMObjectPaths
of CIM Objects that are
associated to a particular source CIM Object. If the source Object is a
CIM Class, then an Enumeration
of
CIMObjectPaths
of the classes associated to the source
Object is returned. If the source Object is a CIM Instance, then an
Enumeration
of CIMObjectPaths
of the
CIMInstance
objects associated to the source Object is
returned.
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.
CIMObjectPath
objects of the CIM Classes or CIM
Instances meeting the specified criteria is returned.
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)
EnumerateResponse<CIMObjectPath> associatorPaths(CIMObjectPath instancePath, String associationClass, String resultClass, String role, String resultRole, String filterQueryLanguage, String filterQuery, UnsignedInteger32 timeout, boolean continueOnError, UnsignedInteger32 maxObjects) throws WBEMException
instancePath
- The CIMObjectPath for the instance for which the enumeration is to be performed.
associationClass
- 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.
resultClass
- 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.
role
- 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.
resultRole
- 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.
filterQueryLanguage
- The filterQueryLanguage represents the query language for the filterQuery 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.
filterQuery
- The filterQuery specifies a query in the form of the query language specified by the filterQueryLanguage parameter. If this value is not null, the filterQueryLanguage 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.
timeout
- 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. An OperationTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If OperationTimeout is NULL, the implementation shall choose an operation timeout. All other values for OperationTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for OperationTimeout. 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.
continueOnError
- If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and ContinueOnError 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 ContinueOnError 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 ContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.
maxObjects
- Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to MaxObjects but shall not deliver more than MaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of MaxObjectCount. Note that a CIM client can use a MaxObjectCount value of 0 to specify that it does not want to retrieve any instances in the Open operation.
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)
CloseableIterator associators(CIMObjectPath pObjectName, String pAssociationClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
Enumeration
of CIMClass
objects is returned
containing the classes associated to the source Object. If the source
Object is a CIM Instance, then an Enumeration
of
CIMInstance
objects is returned containing the instances
associated to the source Object.
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.
pIncludeQualifiers
- If true
, all
Qualifiers for each Object (including Qualifiers on the Object
and on any returned Properties) MUST be included in the
Objects returned. If false
, no Qualifiers are
present in each Object returned.
pIncludeClassOrigin
- If true
, the
CLASSORIGIN
attribute will be present on all
appropriate elements in the Objects returned. If
false
, no CLASSORIGIN
attributes are
present in the Objects returned. CLASSORIGIN
is
attached to an element (properties, methods, references) to
indicate the class in which it was first defined.
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
resultClass
parameter.
CloseableIterator
containing zero
or more CIMClass
or CIMInstance
Objects
meeting the specified criteria is returned.
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)
EnumerateResponse<CIMInstance> associators(CIMObjectPath instancePath, String associationClass, String resultClass, String role, String resultRole, boolean includeClassOrigin, String[] propertyList, String filterQueryLanguage, String filterQuery, UnsignedInteger32 timeout, boolean continueOnError, UnsignedInteger32 maxObjects) throws WBEMException
instancePath
- The CIMObjectPath for the instance for which the enumeration is to be performed.
associationClass
- 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.
resultClass
- 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.
role
- 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.
resultRole
- 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.
includeClassOrigin
- If true
, the
CLASSORIGIN
attribute will be present on all
appropriate elements in the Objects returned. If
false
, no CLASSORIGIN
attributes are
present in the Objects returned. CLASSORIGIN
is
attached to an element (properties, methods, references) to
indicate the class in which it was first defined.
propertyList
- 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
resultClass
parameter.
filterQueryLanguage
- The filterQueryLanguage
represents the query language for the filterQuery 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.
filterQuery
- The filterQuery specifies a
query in the form of the query language specified by the
filterQueryLanguage parameter. If this value is not null, the
filterQueryLanguage 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.
timeout
- 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. An OperationTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If OperationTimeout is NULL, the implementation shall choose an operation timeout. All other values for OperationTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for OperationTimeout. 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.
continueOnError
- If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and ContinueOnError 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 ContinueOnError 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 ContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.
maxObjects
- Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to MaxObjects but shall not deliver more than MaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of MaxObjectCount. Note that a CIM client can use a MaxObjectCount value of 0 to specify that it does not want to retrieve any instances in the Open operation.
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)
void close()
void closeEnumeration(CIMObjectPath path, String context) throws WBEMException
path
- The CIMObjectPath representing the namespace to be used.context
- The EnumerationContext to close.
WBEMException
void createClass(CIMClass pClass) throws WBEMException
pClass
- The CIMClass to be created.
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)
CIMObjectPath createInstance(CIMInstance pInstance) throws WBEMException
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 the CIM Schema or in a DMTF
Profile.
pInstance
- The CIMInstance
to be created.
CIMObjectPath
of the instance created.
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)
void deleteClass(CIMObjectPath pPath) throws WBEMException
pPath
- The CIMObjectPath
identifying the namespace and
class name to delete.
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)
void deleteInstance(CIMObjectPath pPath) throws WBEMException
pPath
- The object path of the instance to be deleted. It must include
all of the keys.
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)
void deleteQualifierType(CIMObjectPath pPath) throws WBEMException
pPath
- The CIMObjectPath
identifying the name and
namespace of the CIM qualifier type to delete.
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)
CloseableIterator<CIMClass> enumerateClasses(CIMObjectPath pPath, boolean pDeep, boolean pPropagated, boolean pIncludeQualifiers, boolean pIncludeClassOrigin) throws WBEMException
pPath
- The object path of the class to be enumerated. Only the name space and class name components are used. All other information (e.g. Keys) is ignored.
pDeep
- If true
, the
enumeration returned contains the specified class and all
subclasses. If false
, the enumeration returned
contains only the contents of the first level children of the
specified class.
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). If false
, no Qualifiers are
present in the classes returned.
pIncludeClassOrigin
- If true
, the
CLASSORIGIN attribute MUST be present on all appropriate
elements in each classes returned. If false
, no
CLASSORIGIN attributes are present in each class returned.
CLASSORIGIN is attached to an element to indicate the class in
which it was first defined.
CloseableIterator
of CIMClass
es.
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)
CloseableIterator<CIMObjectPath> enumerateClassNames(CIMObjectPath pPath, boolean pDeep) throws WBEMException
pPath
- The CIMObjectPath
identifying the class to be enumerated. If the class name in
the object path specified is null, all base classes in
the target namespace are returned.
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.
CloseableIterator
of CIMObjectPath
s
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)
CloseableIterator<CIMObjectPath> enumerateInstanceNames(CIMObjectPath pPath) throws WBEMException
pPath
- The CIMObjectPath
identifying the class whose instances are to be enumerated.
Only the name space and class name components are used. All
other information (e.g. Keys) is ignored.
CloseabelIterator
of CIMObjectPath
s.
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)
EnumerateResponse<CIMObjectPath> enumerateInstancePaths(CIMObjectPath classPath, String filterQueryLanguage, String filterQuery, UnsignedInteger32 timeout, boolean continueOnError, UnsignedInteger32 maxObjects) throws WBEMException
classPath
- The CIMObjectPath for the class for which the enumeration is to be performed.
filterQueryLanguage
- The filterQueryLanguage represents the query language for the filterQuery 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.
filterQuery
- The filterQuery specifies a query in the form of the query language specified by the filterQueryLanguage parameter. If this value is not null, the filterQueryLanguage 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.
timeout
- 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. An OperationTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If OperationTimeout is NULL, the implementation shall choose an operation timeout. All other values for OperationTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for OperationTimeout. 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.
continueOnError
- If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and ContinueOnError 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 ContinueOnError 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 ContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.
maxObjects
- Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to MaxObjects but shall not deliver more than MaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of MaxObjectCount. Note that a CIM client can use a MaxObjectCount value of 0 to specify that it does not want to retrieve any instances in the Open operation.
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)
CloseableIterator<CIMInstance> enumerateInstances(CIMObjectPath pPath, boolean pDeep, boolean pPropagated, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
pPath
- The object path of the class to be enumerated. Only the name space and class name components are used. Any other information (e.g. Keys) is ignored.
pDeep
- If true
, the
enumeration returned contains all instances of the specified
class and all classes derived from it. If false
, only
names of instances of the specified class are returned.
pPropagated
- If true
, only
elements (properties, methods, references) overridden or
defined in the class are included in the instances returned.
pIncludeClassOrigin
- If true
, the
CLASSORIGIN attribute will be present on all appropriate
elements in the instances returned. If false
, no
CLASSORIGIN attributes are present in the instances returned.
CLASSORIGIN is attached to an element (properties, methods,
references) to indicate the class in which it was first
defined.
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.
CloseableIterator
of CIMInstance
s
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)
EnumerateResponse<CIMInstance> enumerateInstances(CIMObjectPath classPath, boolean deepInheritance, boolean includeClassOrigin, String[] propertyList, String filterQueryLanguage, String filterQuery, UnsignedInteger32 timeout, boolean continueOnError, UnsignedInteger32 maxObjects) throws WBEMException
classPath
- The CIMObjectPath for the class for which the enumeration is to be performed.
deepInheritance
- If true
, the
enumeration returned contains all instances of the specified
class and all classes derived from it. If false
, only
names of instances of the specified class are returned.
includeClassOrigin
- If true
, the
CLASSORIGIN attribute will be present on all appropriate
elements in the instances returned. If false
, no
CLASSORIGIN attributes are present in the instances returned.
CLASSORIGIN is attached to an element (properties, methods,
references) to indicate the class in which it was first
defined.
propertyList
- 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.
filterQueryLanguage
- The filterQueryLanguage represents the query language for the filterQuery 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.
filterQuery
- The filterQuery specifies a query in the form of the query language specified by the filterQueryLanguage parameter. If this value is not null, the filterQueryLanguage 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.
timeout
- 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. An OperationTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If OperationTimeout is NULL, the implementation shall choose an operation timeout. All other values for OperationTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for OperationTimeout. 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.
continueOnError
- If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and ContinueOnError 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 ContinueOnError 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 ContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.
maxObjects
- Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to MaxObjects but shall not deliver more than MaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of MaxObjectCount. Note that a CIM client can use a MaxObjectCount value of 0 to specify that it does not want to retrieve any instances in the Open operation.
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)
CloseableIterator<CIMQualifierType<?>> enumerateQualifierTypes(CIMObjectPath pPath) throws WBEMException
pPath
- The CIMObjectPath
identifying the namespace whose qualifier types are to be
enumerated.
CloseableIterator
of CIMQualifierType
s
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)
UnsignedInteger64 enumerationCount(CIMObjectPath path, String enumerationContext) throws WBEMException
path
- The namespace for the enumeration contextenumerationContext
- The enumerationContext to count
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
CloseableIterator<CIMInstance> execQuery(CIMObjectPath pPath, String pQuery, String pQueryLanguage) throws WBEMException
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.
CloseableIterator
of CIMInstance
s.
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)
EnumerateResponse<CIMInstance> execQueryInstances(CIMObjectPath pObjectName, String filterQuery, String filterQueryLanguage, Boolean returnQueryResultClass, UnsignedInteger32 timeout, Boolean continueOnError, UnsignedInteger32 maxObjectCount, CIMClass queryResultClass) throws WBEMException
pObjectName
- CIMObjectPath
identifying the class to query. Only the namespace and class
name components are used. All other information (e.g. Keys) is
ignored.
filterQueryLanguage
- The filterQueryLanguage represents the query language for the filterQuery 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.
filterQuery
- The filterQuery specifies a query in the form of the query language specified by the filterQueryLanguage parameter. If this value is not null, the filterQueryLanguage 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.
returnQueryResultClass
- The returnQueryResultClass controls whether a class definition is returned in QueryResultClass. If it is set to false, QueryResultClass shall be set to NULL on output. If it is set to true, the value of the QueryResultClass on output shall be a class definition that defines the properties (columns) of each row of the query result.
timeout
- 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. An OperationTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If OperationTimeout is NULL, the implementation shall choose an operation timeout. All other values for OperationTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for OperationTimeout. 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.
continueOnError
- If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and ContinueOnError 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 ContinueOnError 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 ContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.
maxObjectCount
- Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to MaxObjects but shall not deliver more than MaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of MaxObjectCount. Note that a CIM client can use a MaxObjectCount value of 0 to specify that it does not want to retrieve any instances in the Open operation.
queryResultClass
- The queryResultClass output parameter shall be set to NULL if the returnQueryResultClass 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.
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)
CIMClass getClass(CIMObjectPath pName, boolean pPropagated, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
CIMClass
for the specified CIMObjectPath
.
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 CIMClass
returned. 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 either originally defined or
overrode the definition of the property or method. If
true
, the class Origin attribute will be present
on all 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.
CIMClass
meeting the criteria specified.
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 request CIM Class does not exist in the
specified namespace)
CIM_ERR_FAILED (some other unspecified error occurred)
CIMInstance getInstance(CIMObjectPath pName, boolean pPropagated, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
CIMInstance
.
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
- If true
, the
CLASSORIGIN attribute will be present on all appropriate
elements in the CIMInstance
returned. If
false
, no CLASSORIGIN attributes are present in
the
CIMInstance
returned. CLASSORIGIN is attached to
an element (properties, methods, references) to indicate the
class in which it was first defined.
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.
CIMInstance
identified by the CIMObjectPath
specified.
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)
EnumerateResponse<CIMObjectPath> getInstancePaths(CIMObjectPath path, String context, UnsignedInteger32 maxObjects) throws WBEMException
path
- The CIMObjectPath representing the namespace to be used.
context
- The enumeration context value for the enumeration session to be used.
maxObjects
- Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to MaxObjects but shall not deliver more than MaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of MaxObjectCount.
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)
EnumerateResponse<CIMInstance> getInstances(CIMObjectPath path, String context, UnsignedInteger32 maxObjects) throws WBEMException
path
- The CIMObjectPath representing the namespace to be used.
context
- The enumeration context value for the enumeration session to be used.
maxObjects
- Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to MaxObjects but shall not deliver more than MaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of MaxObjectCount. Note that a CIM client can use a MaxObjectCount value of 0 to specify that it does not want to retrieve any instances in the Open operation.
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
EnumerateResponse<CIMInstance> getInstancesWithPath(CIMObjectPath path, String context, UnsignedInteger32 maxObjects) throws WBEMException
path
- The CIMObjectPath representing the namespace to be used.
context
- The enumeration context value for the enumeration session to be used.
maxObjects
- Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to MaxObjects but shall not deliver more than MaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of MaxObjectCount. Note that a CIM client can use a MaxObjectCount value of 0 to specify that it does not want to retrieve any instances in the Open operation.
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)
String getProperty(String pKey)
pKey
- The name of the property
CIMQualifierType<?> getQualifierType(CIMObjectPath pName) throws WBEMException
CIMQualifierType
.
pName
- CIMObjectPath
that
identifies the CIMQualifierType
to return.
CIMQualifierType
object
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)
void initialize(CIMObjectPath pName, Subject pSubject, Locale[] pLocales) throws IllegalArgumentException, WBEMException
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.
IllegalArgumentException
- If the host or scheme portion of the object path is null. If the protocol is not supported.
WBEMException
- If the protocol adapter or security can not be initialized.Object invokeMethod(CIMObjectPath pName, String pMethodName, CIMArgument<?>[] pInputArguments, CIMArgument<?>[] pOutputArguments) throws WBEMException
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, but
should not initialize any elements.
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 Server 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)
void modifyClass(CIMClass pClass) throws WBEMException
CIMClass
.
pClass
- CIMClass
to be modified
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)
void modifyInstance(CIMInstance ci, String[] propertyList) throws WBEMException
CIMInstance
.
ci
- CIMInstance
to be
modified. All Keys must be populated.
propertyList
- 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 and invalid property names are ignored and
the request is otherwise processed normally. An empty
array indicates that no properties should be modified. A
null value indicates that all properties should be
modified.
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)
CloseableIterator<CIMClass> referenceClasses(CIMObjectPath pObjectName, String pResultClass, String pRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
pObjectName
- CIMObjectPath defining the source CIM class whose referring classes are to be returned. objectNames shall contain the scheme, host, namespace and object name (class name).
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.
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.
UnsupportedOperationException
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)
CloseableIterator<CIMInstance> referenceInstances(CIMObjectPath pObjectName, String pResultClass, String pRole, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
pObjectName
- CIMObjectPath defining the source CIM Instance whose referring instances are to be returned. The objectName 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.
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)
CloseableIterator<CIMObjectPath> referenceNames(CIMObjectPath pObjectName, String pResultClass, String pRole) throws WBEMException
CIMObjectPath
s of Association Objects that
are refer to a particular source CIM Object. If the source Object is a
CIM Class, then an Enumeration
of CIMObjectPath
s of the Association classes that refer to the source Object is returned.
If the source Object is a CIM Instance, then an Enumeration
of
CIMObjectPath
s of the CIMInstance
objects that
refer to the source Object is returned.
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.
CloseableIterator
referencing zero
or more CIMObjectPath
s of CIMClass
es or
CIMInstance
s meeting the specified criteria.
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)
EnumerateResponse<CIMObjectPath> referencePaths(CIMObjectPath instancePath, String resultClass, String role, String filterQueryLanguage, String filterQuery, UnsignedInteger32 timeout, boolean continueOnError, UnsignedInteger32 maxObjects) throws WBEMException
instancePath
- The CIMObjectPath for the instance for which the enumeration is to be performed
filterQueryLanguage
- The filterQueryLanguage represents the query language for the filterQuery 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.
resultClass
- 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.
role
- 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.
filterQuery
- The filterQuery specifies a query in the form of the query language specified by the filterQueryLanguage parameter. If this value is not null, the filterQueryLanguage 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.
timeout
- 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. An OperationTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If OperationTimeout is NULL, the implementation shall choose an operation timeout. All other values for OperationTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for OperationTimeout. 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.
continueOnError
- If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and ContinueOnError 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 ContinueOnError 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 ContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.
maxObjects
- Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to MaxObjects but shall not deliver more than MaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of MaxObjectCount. Note that a CIM client can use a MaxObjectCount value of 0 to specify that it does not want to retrieve any instances in the Open operation.
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)
CloseableIterator references(CIMObjectPath pObjectName, String pResultClass, String pRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
Enumeration
of CIMClass
objects is returned containing the Association
classes that refer to the source Object. If the source Object is a CIM
Instance, an Enumeration
of CIMInstance
objects
is returned containing the Association class instances that refer to the
source Object.
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.
pIncludeQualifiers
- If true
, all
Qualifiers for each Object (including Qualifiers on the Object
and on any returned Properties) MUST be included in the
Objects returned. If false
, no Qualifiers are
present in each Object returned.
pIncludeClassOrigin
- If true
, the
CLASSORIGIN attribute will be present on all appropriate
elements in the Objects returned. If false
, no
CLASSORIGIN attributes are present in the Objects returned.
CLASSORIGIN is attached to an element (properties, methods,
references) to indicate the class in which it was first
defined.
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
resultClass
parameter.
CloseableIterator
referencing zero
or more CIMClass
or CIMInstance
s
meeting the specified criteria.
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)
EnumerateResponse<CIMInstance> references(CIMObjectPath instancePath, String resultClass, String role, boolean includeClassOrigin, String[] propertyList, String filterQueryLanguage, String filterQuery, UnsignedInteger32 timeout, boolean continueOnError, UnsignedInteger32 maxObjects) throws WBEMException
instancePath
- The CIMObjectPath for the instance for which the enumeration is to be performed.
resultClass
- 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.
role
- 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.
includeClassOrigin
- If true
, the
CLASSORIGIN attribute will be present on all appropriate
elements in the Objects returned. If false
, no
CLASSORIGIN attributes are present in the Objects returned.
CLASSORIGIN is attached to an element (properties, methods,
references) to indicate the class in which it was first
defined.
propertyList
- 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
resultClass
parameter.
filterQueryLanguage
- The filterQueryLanguage represents the query language for the filterQuery 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.
filterQuery
- The filterQuery specifies a query in the form of the query language specified by the filterQueryLanguage parameter. If this value is not null, the filterQueryLanguage 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.
timeout
- 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. An OperationTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If OperationTimeout is NULL, the implementation shall choose an operation timeout. All other values for OperationTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for OperationTimeout. 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.
continueOnError
- If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and ContinueOnError 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 ContinueOnError 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 ContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.
maxObjects
- Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to MaxObjects but shall not deliver more than MaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of MaxObjectCount. Note that a CIM client can use a MaxObjectCount value of 0 to specify that it does not want to retrieve any instances in the Open operation.
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)
void setLocales(Locale[] pLocales) throws UnsupportedOperationException
pLocales
- An array of locales in order of priority of preference.
UnsupportedOperationException
- If the method is not supported. Some protocols may only allow
the locales to be set during initialization. void setProperty(String pKey, String pValue)
pKey
- The name of the propertypValue
- The value of the property
IllegalArgumentException
- If the name is not a supported property name.void setQualifierType(CIMQualifierType<?> pQualifierType) throws WBEMException
CIMQualifierType
to the specified namespace if it does
not already exist. Otherwise, it modifies the qualifier type to the value
specified.
pQualifierType
- The CIM qualifier type to be added.
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)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |