|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
WBEMClientFactory
Method Summary | |
---|---|
CloseableIterator<CIMClass> |
associatorClasses(CIMObjectPath objectName,
String assocClass,
String resultClass,
String role,
String resultRole,
boolean includeQualifiers,
boolean includeClassOrigin,
String[] propertyList)
Enumerates CIM classes that are associated to a specified source CIM class. |
CloseableIterator<CIMInstance> |
associatorInstances(CIMObjectPath objectName,
String assocClass,
String resultClass,
String role,
String resultRole,
boolean includeClassOrigin,
String[] propertyList)
Enumerates CIM Instances associated to a specified source CIM Instance . |
CloseableIterator<CIMObjectPath> |
associatorNames(CIMObjectPath objectName,
String assocClass,
String resultClass,
String role,
String resultRole)
Enumerates the CIMObjectPaths of CIM Objects that are associated to a particular source CIM Object. |
EnumerateResponse<CIMObjectPath> |
associatorPaths(CIMObjectPath instancePath,
String assocClass,
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 objectName,
String assocClass,
String resultClass,
String role,
String resultRole,
boolean includeQualifiers,
boolean includeClassOrigin,
String[] propertyList)
Enumerates CIM Objects that are associated to a specified source CIM Object. |
EnumerateResponse<CIMInstance> |
associators(CIMObjectPath instancePath,
String assocClass,
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 WBEMClient session. |
void |
closeEnumeration(CIMObjectPath path,
String context)
closeEnumeration will close an enumeration session that has been previously started but not yet completed. |
void |
createClass(CIMClass cc)
Create a CIM class The namespace from the CIMClass.getObjectPath() will be used. |
CIMObjectPath |
createInstance(CIMInstance ci)
Create a CIM Instance. |
void |
deleteClass(CIMObjectPath path)
Deletes the CIM class for the object specified by the CIM object path. |
void |
deleteInstance(CIMObjectPath path)
Delete the CIM instance specified by the CIM object path. |
void |
deleteQualifierType(CIMObjectPath path)
Delete a CIM Qualifier Type |
CloseableIterator<CIMClass> |
enumerateClasses(CIMObjectPath path,
boolean deep,
boolean localOnly,
boolean includeQualifiers,
boolean includeClassOrigin)
Enumerate CIM Classes. |
CloseableIterator<CIMObjectPath> |
enumerateClassNames(CIMObjectPath path,
boolean deep)
Enumerate the names of CIM Classes. |
CloseableIterator<CIMObjectPath> |
enumerateInstanceNames(CIMObjectPath path)
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 path,
boolean deep,
boolean localOnly,
boolean includeClassOrigin,
String[] propertyList)
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 path)
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 path,
String query,
String queryLanguage)
ExecQuery will execute a query to retrieve objects. |
EnumerateResponse<CIMInstance> |
execQueryInstances(CIMObjectPath path,
String filterQuery,
String filterQueryLanguage,
boolean returnQueryResultClass,
UnsignedInteger32 timeout,
boolean continueOnError,
UnsignedInteger32 maxObjects,
CIMClass pQueryResultClass)
ExecQuery will execute a query to retrieve instances. |
CIMClass |
getClass(CIMObjectPath name,
boolean localOnly,
boolean includeQualifiers,
boolean includeClassOrigin,
String[] propertyList)
Returns the CIMClass for the specified CIMObjectPath. |
CIMInstance |
getInstance(CIMObjectPath name,
boolean localOnly,
boolean includeClassOrigin,
String[] propertyList)
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 name)
Get protocol specific property values. |
CIMQualifierType<?> |
getQualifierType(CIMObjectPath name)
Get a CIMQualifierType. |
void |
initialize(CIMObjectPath name,
Subject subject,
Locale[] locales)
Initialize the client connection. |
Object |
invokeMethod(CIMObjectPath name,
String methodName,
CIMArgument<?>[] inArgs,
CIMArgument<?>[] outArgs)
Executes the specified method on the specified object. |
void |
modifyClass(CIMClass cc)
Modify the CIMClass. |
void |
modifyInstance(CIMInstance ci,
String[] propertyList)
Modify some or all of the properties of the specified CIMInstance. |
CloseableIterator<CIMClass> |
referenceClasses(CIMObjectPath objectName,
String resultClass,
String role,
boolean includeQualifiers,
boolean includeClassOrigin,
String[] propertyList)
Enumerates the Association classes that refer to a specified source CIM Class. |
CloseableIterator<CIMInstance> |
referenceInstances(CIMObjectPath objectName,
String resultClass,
String role,
boolean includeClassOrigin,
String[] propertyList)
Enumerates the Association instances that refer to a specified source CIM Instance. |
CloseableIterator<CIMObjectPath> |
referenceNames(CIMObjectPath objectName,
String resultClass,
String role)
Enumerates the CIMObjectPaths 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 objectName,
String resultClass,
String role,
boolean includeQualifiers,
boolean includeClassOrigin,
String[] propertyList)
Enumerates the Association Objects that refer to a specified source CIM Object. |
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 name,
String value)
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 objectName, String assocClass, String resultClass, String role, String resultRole, boolean includeQualifiers, boolean includeClassOrigin, String[] propertyList) throws WBEMException
objectName
- 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.assocClass
- 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.resultClass
- 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.role
- 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.resultRole
- 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)includeQualifiers
- 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.includeClassOrigin
- 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.propertyList
- 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.
UnsupportedOperationException
WBEMException
- If unsuccessful, one of the following status codes shall
be returned along with zero or more instances of
CIM_Error. The ORDERED list is:
CIM_ERR_ACCESS_DENIED CIM_ERR_NOT_SUPPORTED CIM_ERR_INVALID_NAMESPACE CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or otherwise incorrect parameters) CIM_ERR_FAILED (some other unspecified error occurred)
CloseableIterator<CIMInstance> associatorInstances(CIMObjectPath objectName, String assocClass, String resultClass, String role, String resultRole, boolean includeClassOrigin, String[] propertyList) throws WBEMException
objectName
- 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.assocClass
- 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.resultClass
- 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.role
- 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.resultRole
- 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.includeClassOrigin
- 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.propertyList
- 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 shall
be returned along with zero or more instances of
CIM_Error. The ORDERED list is:
CIM_ERR_ACCESS_DENIED CIM_ERR_NOT_SUPPORTED CIM_ERR_INVALID_NAMESPACE CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or otherwise incorrect parameters) CIM_ERR_FAILED (some other unspecified error occurred)
CloseableIterator<CIMObjectPath> associatorNames(CIMObjectPath objectName, String assocClass, String resultClass, String role, String resultRole) throws WBEMException
objectName
- 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)assocClass
- 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.
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 assocClass, 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 performedfilterQueryLanguage
- 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 maxObjects. Note that a CIM client can use
a maxObjects 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 objectName, String assocClass, String resultClass, String role, String resultRole, boolean includeQualifiers, boolean includeClassOrigin, String[] propertyList) throws WBEMException
objectName
- 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)assocClass
- 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.includeQualifiers
- 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.includeClassOrigin
- The class origin attribute is the name of the class that first
defined the property or method. If true, the class origin
attribute will be present for each property and method on all
Objects returned. If false, the class origin will not be
present.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.
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 assocClass, 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 performedfilterQueryLanguage
- 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 maxObjects. Note that a CIM client can use
a maxObjects 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 cc) throws WBEMException
cc
- 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 ci) throws WBEMException
ci
- The CIMInstance 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 (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 path) throws WBEMException
path
- 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 path) throws WBEMException
path
- 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 path) throws WBEMException
path
- 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 path, boolean deep, boolean localOnly, boolean includeQualifiers, boolean includeClassOrigin) throws WBEMException
path
- The object path of the class to be enumerated. Only the
namespace and objectName should be populated. If the
objectName is set to an empty string (i.e. ""), then all
base classes in the target namespace are returned.deep
- If true, the classes returned will include subclasses. If
false, the classes returned will not include subclasses.localOnly
- 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.includeQualifiers
- If true, all Qualifiers for each Class and its elements
(properties, methods, references). If false, no Qualifiers are
present in the classes returnedincludeClassOrigin
- The class origin attribute is the name of the class that first
defined the property or method. If true, the class Origin
attribute will be present for each property and method on all
returned CIMClasses. If false, the class origin will not be
present.
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 path, boolean deep) throws WBEMException
path
- The CIMObjectPath identifying the class to be enumerated. If
the class name in the object path specified is an empty
string (i.e. ""), all base classes in the target namespace
are returned. Note that only the namespace and the name
components should be populated.deep
- 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.
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 path) throws WBEMException
path
- 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.
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 performedfilterQueryLanguage
- 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 maxObjects. Note that a CIM client can use
a maxObjects 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 path, boolean deep, boolean localOnly, boolean includeClassOrigin, String[] propertyList) throws WBEMException
path
- 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.deep
- If true, this specifies that, for each returned Instance of
the Class, all properties of the Instance must be present
(subject to constraints imposed by the other parameters),
including any which were added by subclassing the specified
Class. If false, each returned Instance includes only
properties defined for the specified Class in path.localOnly
- If true, only elements values that were instantiated in the
instance is returned.includeClassOrigin
- The class origin attribute is the name of the class that first
defined the property. If true, the class origin attribute will
be present for each property on all returned CIMInstances. If
false, the class origin will not be present.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.
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 performedfilterQueryLanguage
- 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 maxObjects. Note that a CIM client can use
a maxObjects 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 path) throws WBEMException
path
- The CIMObjectPath identifying the namespace whose qualifier
types are to be enumerated.
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 path, String query, String queryLanguage) throws WBEMException
path
- CIMObjectPath identifying the class to query. Only the
namespace and class name components are used. All other
information (e.g. Keys) is ignored.query
- A string containing the text of the query.queryLanguage
- A string that identifies the query language to use to parse
the query string specified.
IllegalArgumentException
- If the path is null or empty.
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 path, String filterQuery, String filterQueryLanguage, boolean returnQueryResultClass, UnsignedInteger32 timeout, boolean continueOnError, UnsignedInteger32 maxObjects, CIMClass pQueryResultClass) throws WBEMException
path
- The CIMObjectPath representing the namespace to be used.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.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 maxObjects. Note that a CIM client can use
a maxObjects value of 0 to specify that it does not want
to retrieve any instances in the Open operation.
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 name, boolean localOnly, boolean includeQualifiers, boolean includeClassOrigin, String[] propertyList) throws WBEMException
name
- 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.localOnly
- 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.includeQualifiers
- 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.includeClassOrigin
- The class origin attribute is the name of the class that first
defined the property or method. If true, the class Origin
attribute will be present for each property and method on all
returned CIMClasses. If false, the class origin will not be
present.propertyList
- 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.
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 name, boolean localOnly, boolean includeClassOrigin, String[] propertyList) throws WBEMException
name
- The object path of the instance to be returned. The Keys in
this CIMObjectPath must be populated.localOnly
- 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.includeClassOrigin
- The class origin attribute is the name of the class that first
defined the property or method. If true, the class origin
attribute will be present for each property of the
CIMInstance. If false, the class origin will not be present.propertyList
- 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.
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 maxObjects.
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 maxObjects. Note that a CIM client can use
a maxObjects 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 maxObjects.
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 name)
name
- The name of the property
CIMQualifierType<?> getQualifierType(CIMObjectPath name) throws WBEMException
name
- CIMObjectPath that identifies the CIMQualifierType to return.
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 name, Subject subject, Locale[] locales) throws WBEMException
name
- The protocol and host to use (e.g. http://192.168.1.128/). Any
other fields will be ignored.subject
- The principal/credential pairs for this connection.locales
- 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 initializedObject invokeMethod(CIMObjectPath name, String methodName, CIMArgument<?>[] inArgs, CIMArgument<?>[] outArgs) throws WBEMException
name
- CIM object path of the object whose method must be invoked. It
must include all of the keys.methodName
- the name of the method to be invoked.inArgs
- the CIMArgument array of method input parameters.outArgs
- the CIMArgument array of method output parameters. The array
should be allocated large enough to hold all returned
parameters.
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 <b>DOES NOT</b> support <b>ANY</b> 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 cc) throws WBEMException
cc
- 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
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 objectName, String resultClass, String role, boolean includeQualifiers, boolean includeClassOrigin, String[] propertyList) throws WBEMException
objectName
- 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).resultClass
- This string shall either contain a valid CIM Class name
or be null. The resultClass filters the classes
returned to contain only the classes of this Class name or
one of its subclasses.role
- This string shall either contain a valid Property name
or be null. The role filters the classes returned to contain
only classes referring to the source class via a Property
with the specified name. For example, if "Antecedent" is
specified, then only Associations in which the source class
is the "Antecedent" reference are returned.includeQualifiers
- 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.includeClassOrigin
- 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.propertyList
- 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 instance of CIM_Error.
The ORDERED list is:
CIM_ERR_ACCESS_DENIED CIM_ERR_NOT_SUPPORTED CIM_ERR_INVALID_NAMESPACE CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or otherwise incorrect parameters) CIM_ERR_FAILED (some other unspecified error occurred)
CloseableIterator<CIMInstance> referenceInstances(CIMObjectPath objectName, String resultClass, String role, boolean includeClassOrigin, String[] propertyList) throws WBEMException
objectName
- CIMObjectPath defining the source CIM Instance whose referring
instances are to be returned. The objectName shall include
the host, object name and keys.resultClass
- 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.role
- 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.includeClassOrigin
- 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.propertyList
- 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 objectName, String resultClass, String role) throws WBEMException
objectName
- 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)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.
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 performedfilterQueryLanguage
- 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 maxObjects. Note that a CIM client can use
a maxObjects 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 objectName, String resultClass, String role, boolean includeQualifiers, boolean includeClassOrigin, String[] propertyList) throws WBEMException
objectName
- 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)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.includeQualifiers
- 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.includeClassOrigin
- The class origin attribute is the name of the class that first
defined the property or method. If true, the class Origin
attribute will be present for each property and method on all
Objects returned. If false, the class origin will not be
present.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.
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 performedfilterQueryLanguage
- 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 maxObjects. Note that a CIM client can use
a maxObjects 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)
pLocales
- An array of locales in order of priority of preference.void setProperty(String name, String value)
Please refer to the documentation for the specific protocol for a list of properties supported.
name
- The name of the propertyvalue
- The value of the property
IllegalArgumentException
- if the name is not a supported property name.void setQualifierType(CIMQualifierType<?> pQualifierType) throws WBEMException
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 |