|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.sblim.cimclient.internal.wbem.WBEMClientCIMXML
public class WBEMClientCIMXML
The WBEMClientCIMXML is a implementation of the
javax.wbem.client.WBEMClient
interface for the CIM-XML protocol
including the extensions of the
org.sblim.cimclient.WBEMClientSBLIM
interface.
WBEMClient
,
WBEMClientSBLIM
Constructor Summary | |
---|---|
WBEMClientCIMXML()
Ctor. |
Method Summary | |
---|---|
CloseableIterator<CIMClass> |
associatorClasses(CIMObjectPath pObjectName,
String pAssociationClass,
String pResultClass,
String pRole,
String pResultRole,
boolean pIncludeQualifiers,
boolean pIncludeClassOrigin,
String[] pPropertyList)
Enumerates CIM classes that are associated to a specified source CIM class. |
CloseableIterator<CIMInstance> |
associatorInstances(CIMObjectPath pObjectName,
String pAssociationClass,
String pResultClass,
String pRole,
String pResultRole,
boolean pIncludeClassOrigin,
String[] pPropertyList)
Enumerates CIM Instances associated to a specified source CIM Instance. |
CloseableIterator<CIMObjectPath> |
associatorNames(CIMObjectPath pObjectName,
String pAssociationClass,
String pResultClass,
String pRole,
String pResultRole)
Enumerates the CIMObjectPath s of CIM Objects that are
associated to a particular source CIM Object. |
EnumerateResponse<CIMObjectPath> |
associatorPaths(CIMObjectPath pObjectName,
String pAssociationClass,
String pResultClass,
String pRole,
String pResultRole,
String pFilterQueryLanguage,
String pFilterQuery,
UnsignedInteger32 pTimeout,
boolean pContinueOnError,
UnsignedInteger32 pMaxObjects)
associatorPaths shall start an enumeration session for
traversing associations starting from the instance defined in the
pInstancePath parameter using any specified filtering
criteria and return zero or more CIMObjectPath objects. |
EnumerateResponse<CIMInstance> |
associators(CIMObjectPath pObjectName,
String pAssocClass,
String pResultClass,
String pRole,
String pResultRole,
boolean pIncludeClassOrigin,
String[] pPropertyList,
String pFilterQueryLanguage,
String pFilterQuery,
UnsignedInteger32 pTimeout,
boolean pContinueOnError,
UnsignedInteger32 pMaxObjects)
associators shall start an enumeration session for
traversing associations starting from the instance defined in the
pInstancePath parameter using any specified filtering
criteria and return zero or more CIMInstance objects. |
void |
close()
Closes the WBEMClient session. |
void |
closeEnumeration(CIMObjectPath pObjectName,
String pEnumerationContext)
closeEnumeration shall close an enumeration session that has
been previously started but not yet completed. |
void |
createClass(CIMClass pClass)
Create a CIM class. |
CIMObjectPath |
createInstance(CIMInstance pInstance)
Create a CIM Instance. |
void |
deleteClass(CIMObjectPath pPath)
Deletes the CIM class for the object specified by the CIM object path. |
void |
deleteInstance(CIMObjectPath pPath)
Delete the CIM instance specified by the CIM object path. |
void |
deleteQualifierType(CIMObjectPath pPath)
Delete a CIM Qualifier type. |
CloseableIterator<CIMClass> |
enumerateClasses(CIMObjectPath pPath,
boolean pDeep,
boolean pPropagated,
boolean pIncludeQualifiers,
boolean pIncludeClassOrigin)
Enumerate CIM Classes. |
CloseableIterator<CIMObjectPath> |
enumerateClassNames(CIMObjectPath pPath,
boolean pDeep)
Enumerate the names of CIM Classes. |
CloseableIterator<CIMObjectPath> |
enumerateInstanceNames(CIMObjectPath pPath)
Enumerate the names of the instances for a specified class. |
EnumerateResponse<CIMObjectPath> |
enumerateInstancePaths(CIMObjectPath pObjectName,
String pFilterQueryLanguage,
String pFilterQuery,
UnsignedInteger32 pTimeout,
boolean pContinueOnError,
UnsignedInteger32 pMaxObjects)
enumerateInstancePaths shall enumerate the instances of the
specified class in pClassPath and return zero or more
CIMObjectPath s. |
CloseableIterator<CIMInstance> |
enumerateInstances(CIMObjectPath pPath,
boolean pDeep,
boolean pPropagated,
boolean pIncludeClassOrigin,
String[] pPropertyList)
Enumerate the instances of a class. |
EnumerateResponse<CIMInstance> |
enumerateInstances(CIMObjectPath pObjectName,
boolean pDeepInheritance,
boolean pIncludeClassOrigin,
String[] pPropertyList,
String pFilterQueryLanguage,
String pFilterQuery,
UnsignedInteger32 pTimeout,
boolean pContinueOnError,
UnsignedInteger32 pMaxObjects)
enumerateInstances shall enumerate the instances of the
specified class in pClassPath and return zero or more
CIMInstance s. |
CloseableIterator<CIMObjectPath> |
enumerateNamespaces(String pNamespace)
Enumerate the names of the instances of CIM namespaces. |
CloseableIterator<CIMQualifierType<?>> |
enumerateQualifierTypes(CIMObjectPath pPath)
Enumerates the CIM Qualifier types for a specific namespace. |
UnsignedInteger64 |
enumerationCount(CIMObjectPath pObjectName,
String pEnumerationContext)
enumerationCount provides an estimated count of the total
number of objects in an open enumeration session represented by an
enumeration context. |
CloseableIterator<CIMInstance> |
execQuery(CIMObjectPath pPath,
String pQuery,
String pQueryLanguage)
execQuery shall execute a query to retrieve objects. |
EnumerateResponse<CIMInstance> |
execQueryInstances(CIMObjectPath pObjectName,
String pFilterQuery,
String pFilterQueryLanguage,
boolean pReturnQueryResultClass,
UnsignedInteger32 pTimeout,
boolean pContinueOnError,
UnsignedInteger32 pMaxObjects,
CIMClass pQueryResultClass)
execQueryInstances shall execute a query to retrieve
instances. |
CIMClass |
getClass(CIMObjectPath pName,
boolean pPropagated,
boolean pIncludeQualifiers,
boolean pIncludeClassOrigin,
String[] pPropertyList)
Returns the CIMClass for the specified
CIMObjectPath . |
SocketFactory |
getCustomSocketFactory()
Gets the custom socket factory if one is set. |
CIMInstance |
getInstance(CIMObjectPath pName,
boolean pPropagated,
boolean pIncludeClassOrigin,
String[] pPropertyList)
Get a CIMInstance . |
EnumerateResponse<CIMObjectPath> |
getInstancePaths(CIMObjectPath pObjectName,
String pContext,
UnsignedInteger32 pMaxObjects)
getInstancePaths shall get the CIMObjectPath s
using an enumeration context. |
EnumerateResponse<CIMInstance> |
getInstances(CIMObjectPath pObjectName,
String pContext,
UnsignedInteger32 pMaxObjects)
getInstances shall get the instances from an enumeration
session started by execQueryInstances . |
EnumerateResponse<CIMInstance> |
getInstancesWithPath(CIMObjectPath pObjectName,
String pContext,
UnsignedInteger32 pMaxObjects)
getInstancesWithPath shall use the enumeration context
provided to get the next set of instances for the enumeration session. |
Properties |
getLocalProperties()
Returns the configuration properties that are local to the current thread. |
Properties |
getProperties()
Returns the client specific configuration properties. |
String |
getProperty(String pKey)
Get property values. |
CIMQualifierType<?> |
getQualifierType(CIMObjectPath pName)
Get a CIMQualifierType . |
void |
initialize(CIMObjectPath pName,
Subject pSubject,
Locale[] pLocales)
Initialize the client connection. |
void |
initialize(URI pUri,
Subject pSubject,
Locale[] pLocales)
Initialize the client connection. |
Object |
invokeMethod(CIMObjectPath pName,
String pMethodName,
CIMArgument<?>[] pInputArguments,
CIMArgument<?>[] pOutputArguments)
Executes the specified method on the specified object. |
boolean |
isActive()
Returns an indication of whether the client is active (initialized and not closed) or inactive (not initialized or closed). |
void |
modifyClass(CIMClass pClass)
Modify the CIMClass . |
void |
modifyInstance(CIMInstance pInst,
String[] pPropertyList)
Modify some or all of the properties of the specified CIMInstance . |
CloseableIterator<CIMClass> |
referenceClasses(CIMObjectPath pObjectName,
String pResultClass,
String pRole,
boolean pIncludeQualifiers,
boolean pIncludeClassOrigin,
String[] pPropertyList)
Enumerates the Association classes that refer to a specified source CIM Class. |
CloseableIterator<CIMInstance> |
referenceInstances(CIMObjectPath pObjectName,
String pResultClass,
String pRole,
boolean pIncludeClassOrigin,
String[] pPropertyList)
Enumerates the Association instances that refer to a specified source CIM Instance. |
CloseableIterator<CIMObjectPath> |
referenceNames(CIMObjectPath pObjectName,
String pResultClass,
String pRole)
Enumerates the CIMObjectPath s of Association Objects that
refer to a particular source CIM Object. |
EnumerateResponse<CIMObjectPath> |
referencePaths(CIMObjectPath pObjectName,
String pResultClass,
String pRole,
String pFilterQueryLanguage,
String pFilterQuery,
UnsignedInteger32 pTimeout,
boolean pContinueOnError,
UnsignedInteger32 pMaxObjects)
referencePaths shall start an enumeration session for
association instances that have references that refer to the instance
defined in the pInstancePath parameter and return zero or
more CIMObjectPath objects. |
EnumerateResponse<CIMInstance> |
references(CIMObjectPath pObjectName,
String pResultClass,
String pRole,
boolean pIncludeClassOrigin,
String[] pPropertyList,
String pFilterQueryLanguage,
String pFilterQuery,
UnsignedInteger32 pTimeout,
boolean pContinueOnError,
UnsignedInteger32 pMaxObjects)
references shall start an enumeration session for
association instances that have references that refer to the instance
defined in the pInstancePath parameter and return zero or
more CIMInstance objects. |
boolean |
sendIndication(URI pRecipient,
CIMInstance pIndication)
Sends the indication to the specified recipient. |
void |
setCustomSocketFactory(SocketFactory pFactory)
Sets a custom socket factory. |
void |
setLocales(Locale[] pLocales)
Change the locales that were provided during initialization. |
void |
setLocalProperties(Properties pProperties)
Sets the configuration properties that are local to the current thread. |
void |
setLocalProperty(String pKey,
String pValue)
Sets a local configuration property for the current thread. |
void |
setProperties(Properties pProperties)
Sets the client specific configuration properties. |
void |
setProperty(String pKey,
String pValue)
Set properties that enable options or protocol specific properties. |
void |
setQualifierType(CIMQualifierType<?> pQualifierType)
Add a CIMQualifierType to the specified namespace if it does
not already exist. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WBEMClientCIMXML()
Method Detail |
---|
public void initialize(CIMObjectPath pName, Subject pSubject, Locale[] pLocales) throws IllegalArgumentException, WBEMException
WBEMClient
initialize
in interface WBEMClient
pName
- The protocol and host to use (e.g. http://192.168.1.128/). Any
other fields shall be ignored.pSubject
- The principal/credential pairs for this connection.pLocales
- An array of locales in order of priority of preference.
IllegalArgumentException
- If the host or scheme portion of the object path is null, or
if the protocol is not supported.
WBEMException
- If the protocol adapter or security cannot be initialized.public void initialize(URI pUri, Subject pSubject, Locale[] pLocales) throws IllegalArgumentException, WBEMException
WBEMClientSBLIM
initialize
in interface WBEMClientSBLIM
pUri
- The protocol and host to use. Any other fields will be
ignored.pSubject
- The principal/credential pairs for this connection.pLocales
- An array of locales in order of priority of preference.
IllegalArgumentException
- If the host or scheme portion of the object path is null, or
if the protocol is not supported.
WBEMException
- If the protocol adapter or security cannot be initialized.public Properties getProperties()
WBEMClientSBLIM
java.lang.System
class.null
getProperties
in interface WBEMClientSBLIM
System.getProperties()
public String getProperty(String pKey)
WBEMClient
WBEMClientConstants
for a list of
standard properties.
getProperty
in interface WBEMClient
getProperty
in interface WBEMClientSBLIM
pKey
- The name of the property.
WBEMClientConstants
public void setProperties(Properties pProperties)
WBEMClientSBLIM
java.lang.System
class.
setProperties
in interface WBEMClientSBLIM
pProperties
- The session specific properties. null
resets this
client to the global settings.System.setProperties(Properties)
public void setProperty(String pKey, String pValue)
WBEMClient
WBEMClientConstants
for a list of standard properties.
setProperty
in interface WBEMClient
setProperty
in interface WBEMClientSBLIM
pKey
- The name of the property.pValue
- The value of the property.WBEMClientConstants
public CloseableIterator<CIMObjectPath> associatorNames(CIMObjectPath pObjectName, String pAssociationClass, String pResultClass, String pRole, String pResultRole) throws WBEMException
WBEMClient
CIMObjectPath
s of CIM Objects that are
associated to a particular source CIM Object. If the source Object is a
CIM Class, then a CloseableIterator
of
CIMObjectPath
s of the classes associated to the source
Object is returned. If the source Object is a CIM Instance, then a
CloseableIterator
of CIMObjectPath
s of the
CIMInstance
objects associated to the source Object is
returned.
associatorNames
in interface WBEMClient
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.
CloseableIterator
containing zero
or more 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)
public CloseableIterator<CIMClass> associatorClasses(CIMObjectPath pObjectName, String pAssociationClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
WBEMClient
associatorClasses
in interface WBEMClient
pObjectName
- CIMObjectPath
defining the source CIM Class whose
associated classes are to be returned. The
pObjectName
shall include the host, namespace and
object name. The keys shall not be populated.pAssociationClass
- This string shall contain a valid CIM Association class name
or be null
. It filters the classes returned to
contain only classes associated to the source Object via this
CIM Association class or one of its subclasses.pResultClass
- This string shall either contain a valid CIM Class name or be
null
. It filters the classes returned to contain
only the classes of this class name or one of its subclasses.pRole
- This string shall either contain a valid Property name or be
null
. It filters the classes returned to contain
only classes associated to the source class via an Association
class in which the source class plays the specified
role. (i.e. the Property name in the Association class that
refers to the source class matches this value) For
example, if "Antecedent" is specified, then only Associations
in which the source class is the "Antecedent" reference are
examined.pResultRole
- This string shall either contain a valid Property name or be
null
. It filters the classes returned to contain
only classes associated to the source class via an Association
class in which the class returned plays the specified
role. (i.e. the Property name in the Association class that
refers to the class returned matches this value)pIncludeQualifiers
- If true
, all Qualifiers for each class (including
Qualifiers on the Object and on any returned Properties) MUST
be included in the classes returned. If false
, no
Qualifiers are present in each class returned.pIncludeClassOrigin
- The class origin attribute is the name of the class that first
defined the property or method. If true
, the
class origin attribute shall be present for each property and
method on all classes returned. If false
, the
class origin shall 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.
CloseableIterator
containing zero
or more CIMClass
es meeting the specified criteria
are 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)
public CloseableIterator<CIMInstance> associatorInstances(CIMObjectPath pObjectName, String pAssociationClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
WBEMClient
associatorInstances
in interface WBEMClient
pObjectName
- CIMObjectPath
defining the source CIM Instance
whose associated instances are to be returned. The
pObjectName
must contain the host, namespace,
object name and keys for the instance.pAssociationClass
- This string shall either contain a valid CIM Association class
name or be null
. It filters the instances
returned to contain only instances associated to the source
instance via this CIM Association class or one of its
subclasses.pResultClass
- This string shall either contain a valid CIM Class name or be
null
. It filters the instances returned to
contain only the instances of this Class name or one of its
subclasses.pRole
- This string shall either contain a valid Property name or be
null
. It filters the Objects returned to contain
only Objects associated to the source Object via an
Association class in which the source Object plays the
specified role. (i.e. the Property name in the Association
class that refers to the source Object matches this
value) If "Antecedent" is specified, then only Associations in
which the source Object is the "Antecedent" reference are
examined.pResultRole
- This string shall either contain a valid Property name or be
null
. It filters the instances returned to
contain only instances associated to the source instance via
an Association class in which the instance returned
plays the specified role. (i.e. the Property name in the
Association class that refers to the instance returned
matches this value) For example, if "Dependent" is specified,
then only Associations in which the instance returned is the
"Dependent" reference are examined.pIncludeClassOrigin
- The class origin attribute is the name of the class that first
defined the property. If true
, the class origin
attribute may be present for each property on all instances
returned, even if requested the server may ignore the request
and not return the class origin. If false
, the
class origin shall 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.
CloseableIterator
containing zero
or more CIMInstance
s meeting the specified criteria
is 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)
public void close()
WBEMClient
WBEMClient
session.
close
in interface WBEMClient
public void createClass(CIMClass pClass) throws WBEMException
WBEMClient
CIMClass.getObjectPath()
shall be used.
createClass
in interface WBEMClient
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)
public CIMObjectPath createInstance(CIMInstance pInstance) throws WBEMException
WBEMClient
CIMInstance.getObjectPath()
shall be used. The keys of the
CIMInstance
may be modified by the implementation and the
client must use the returned object path to determine the name of the
instance. It is possible for a client to leave keys of instances empty/
null
and the provider can fill them in. This is
implementation specific unless specified by a CIM Schema or in a DMTF
Profile.
createInstance
in interface WBEMClient
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)
public void deleteClass(CIMObjectPath pPath) throws WBEMException
WBEMClient
deleteClass
in interface WBEMClient
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)
public void deleteInstance(CIMObjectPath pPath) throws WBEMException
WBEMClient
deleteInstance
in interface WBEMClient
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)
public void deleteQualifierType(CIMObjectPath pPath) throws WBEMException
WBEMClient
deleteQualifierType
in interface WBEMClient
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)
public CloseableIterator<CIMObjectPath> enumerateClassNames(CIMObjectPath pPath, boolean pDeep) throws WBEMException
WBEMClient
enumerateClassNames
in interface WBEMClient
pPath
- The CIMObjectPath
identifying the class to be
enumerated. If the class name in the object path specified is
an empty string (i.e. ""), all base classes in the target
namespace are returned. Note that only the namespace and the
name components should be populated.pDeep
- If true
, the enumeration returned shall 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)
public CloseableIterator<CIMClass> enumerateClasses(CIMObjectPath pPath, boolean pDeep, boolean pPropagated, boolean pIncludeQualifiers, boolean pIncludeClassOrigin) throws WBEMException
WBEMClient
enumerateClasses
in interface WBEMClient
pPath
- The object path of the class to be enumerated. Only the
namespace and object name should be populated. If the object
name is set to an empty string (i.e. ""), then all base
classes in the target namespace are returned.pDeep
- If true
, the classes returned shall include
subclasses. If false
, the classes returned shall
not include subclasses.pPropagated
- If true
, only elements (properties, methods and
qualifiers) defined in, or overridden in the class are
included in the response. If false
, all elements
of the class definition are returned.pIncludeQualifiers
- If true
, all Qualifiers for each Class and its
elements (properties, methods, references) are included. If
false
, no Qualifiers are present in the classes
returned.pIncludeClassOrigin
- The class origin attribute is the name of the class that first
defined the property or method. If true
, the
class origin attribute shall be present for each property and
method on all returned CIMClass
es. If
false
, the class origin shall not be present.
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)
public CloseableIterator<CIMObjectPath> enumerateInstanceNames(CIMObjectPath pPath) throws WBEMException
WBEMClient
enumerateInstanceNames
in interface WBEMClient
pPath
- The CIMObjectPath
identifying the class whose
instances are to be enumerated. Only the namespace and class
name components are used. All other information (e.g. Keys) is
ignored.
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)
public CloseableIterator<CIMInstance> enumerateInstances(CIMObjectPath pPath, boolean pDeep, boolean pPropagated, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
WBEMClient
enumerateInstances
in interface WBEMClient
pPath
- The object path of the class to be enumerated. Only the
namespace and class name components are used. Any other
information (e.g. Keys) is ignored.pDeep
- If true
, this specifies that, for each returned
Instance of the Class, all properties of the Instance must be
present (subject to constraints imposed by the other
parameters), including any which were added by subclassing the
specified Class. If false
, each returned Instance
includes only properties defined for the specified Class in
path.pPropagated
- If true
, only properties that were instantiated
in the instance are returned. WBEM Servers may ignore this
parameter and return all properties.pIncludeClassOrigin
- The class origin attribute is the name of the class that first
defined the property. If true
, the class origin
attribute may be present for each property on all returned
CIMInstances, even if requested the server may ignore the
request and not return the class origin. If false
, the class origin shall not be present.pPropertyList
- An array of property names used to filter what is contained in
the instances returned. Each instance returned only contains
elements for the properties of the names specified. Duplicate
and invalid property names are ignored and the request is
otherwise processed normally. An empty array indicates that no
properties should be returned. A null value indicates
that all properties should be returned.
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)
public CloseableIterator<CIMObjectPath> enumerateNamespaces(String pNamespace) throws WBEMException
WBEMClientSBLIM
enumerateNamespaces
in interface WBEMClientSBLIM
pNamespace
- The Interop Namespace, if known. If null, the default Interop
Namespace names defined by DSP1033 are used.
CloseableIterator
of CIMObjectPath
s.
WBEMException
- If unsuccessful, one of the following status codes must be
returned. The ORDERED list is:
CIM_ERR_FAILED (some other unspecified error occurred)
public CloseableIterator<CIMQualifierType<?>> enumerateQualifierTypes(CIMObjectPath pPath) throws WBEMException
WBEMClient
enumerateQualifierTypes
in interface WBEMClient
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)
public CloseableIterator<CIMInstance> execQuery(CIMObjectPath pPath, String pQuery, String pQueryLanguage) throws WBEMException
WBEMClient
execQuery
shall execute a query to retrieve objects.
execQuery
in interface WBEMClient
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)
public CIMClass getClass(CIMObjectPath pName, boolean pPropagated, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
WBEMClient
CIMClass
for the specified
CIMObjectPath
.
getClass
in interface WBEMClient
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 first
defined the property or method. If true
, the
class origin attribute shall be present for each property and
method on all returned CIMClass
es. If
false
, the class origin shall 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 requested CIM Class does not exist in the specified namespace) CIM_ERR_FAILED (some other unspecified error occurred)
public CIMInstance getInstance(CIMObjectPath pName, boolean pPropagated, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
WBEMClient
CIMInstance
.
getInstance
in interface WBEMClient
pName
- The object path of the instance to be returned. The Keys in
this CIMObjectPath
must be populated.pPropagated
- If true
, only properties overridden or defined in
the class are included in the CIMInstance
returned. If false
, all properties of the class
definition are returned. WBEM Servers may ignore this
parameter and return all properties.pIncludeClassOrigin
- The class origin attribute is the name of the class that first
defined the property. If true
, the class origin
attribute may be present for each property of the
CIMInstance
, even if requested the server may
ignore the request and not return the class origin. If
false
, the class origin shall 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.
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)
public CIMQualifierType<?> getQualifierType(CIMObjectPath pName) throws WBEMException
WBEMClient
CIMQualifierType
.
getQualifierType
in interface WBEMClient
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)
public Object invokeMethod(CIMObjectPath pName, String pMethodName, CIMArgument<?>[] pInputArguments, CIMArgument<?>[] pOutputArguments) throws WBEMException
WBEMClient
invokeMethod
in interface WBEMClient
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.
WBEMException
- If unsuccessful, one of the following status codes must be
returned. The ORDERED list is:
CIM_ERR_ACCESS_DENIED CIM_ERR_NOT_SUPPORTED (implementation DOES NOT support ANY Extrinsic Method Invocation) CIM_ERR_INVALID_NAMESPACE CIM_ERR_INVALID_PARAMETER (for this method) CIM_ERR_NOT_FOUND (if instance does not exist) CIM_ERR_METHOD_NOT_FOUND CIM_ERR_METHOD_NOT_AVAILABLE CIM_ERR_FAILED (some other unspecified error occurred)
public boolean isActive()
WBEMClientSBLIM
isActive
in interface WBEMClientSBLIM
true
if client is active, false
otherwise.public void modifyClass(CIMClass pClass) throws WBEMException
WBEMClient
CIMClass
.
modifyClass
in interface WBEMClient
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)
public void modifyInstance(CIMInstance pInst, String[] pPropertyList) throws WBEMException
WBEMClient
CIMInstance
.
modifyInstance
in interface WBEMClient
pInst
- CIMInstance
to be modified. All Keys must be
populated.pPropertyList
- An array of property names used to specify which values from
the CIMInstance
specified to set. Properties not
specified in this list but set in the CIMInstance
specified are not modified. Duplicate property names are
ignored and the request is otherwise processed normally. If
the pPropertyList
contains invalid property names
for the instance to be modified, the server shall reject the
request. An empty array indicates that no properties should be
modified. A null
value indicates that all
properties should be modified.
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)
public CloseableIterator<CIMClass> referenceClasses(CIMObjectPath pObjectName, String pResultClass, String pRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
WBEMClient
referenceClasses
in interface WBEMClient
pObjectName
- CIMObjectPath
defining the source CIM class whose
referring classes are to be returned. pObjectName
shall contain the scheme, host, namespace and object name
(class name).pResultClass
- This string shall either contain a valid CIM Class name or be
null
. The pResultClass
filters the
classes returned to contain only the classes of this Class
name or one of its subclasses.pRole
- This string MUST either contain a valid Property name or be
null
. It filters the Objects returned to contain
only Objects referring to the source Object via a Property
with the specified name. If "Antecedent" is specified, then
only Associations in which the source Object is the
"Antecedent" reference are returned.pIncludeQualifiers
- If true
, all Qualifiers for each Object
(including Qualifiers on the Object and on any returned
Properties) shall be included in the classes returned. If
false
, no Qualifiers shall be present in each
class returned.pIncludeClassOrigin
- The class origin attribute is the name of the class that first
defined the property or method. If true
, the
class Origin attribute shall be present for each property and
method on all classes returned. If false
, the
class origin shall 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.
CloseableIterator
referencing zero
or more CIMClass
es meeting the specified criteria.
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)
public CloseableIterator<CIMInstance> referenceInstances(CIMObjectPath pObjectName, String pResultClass, String pRole, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
WBEMClient
referenceInstances
in interface WBEMClient
pObjectName
- CIMObjectPath
defining the source CIM Instance
whose referring instances are to be returned. The
pObjectName
shall include the host, object name
and keys.pResultClass
- This string shall either contain a valid CIM Class name or be
null
. It filters the instances returned to
contain only the instances of this Class name or one of its
subclasses.pRole
- This string shall either contain a valid Property name or be
null
. The role filters the instances returned to
contain only instances referring to the source instance via a
property with the specified name. For example, If "Antecedent"
is specified, then only Associations in which the source
instance is the "Antecedent" reference are returned.pIncludeClassOrigin
- The class origin attribute is the name of the class that first
defined the property. If true
, the class origin
attribute may be present for each property and on all
instances returned, even if requested the server may ignore
the request and not return the class origin. If
false
, the class origin shall 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.
CloseableIterator
referencing zero
or more CIMInstance
s meeting the specified criteria.
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)
public CloseableIterator<CIMObjectPath> referenceNames(CIMObjectPath pObjectName, String pResultClass, String pRole) throws WBEMException
WBEMClient
CIMObjectPath
s of Association Objects that
refer to a particular source CIM Object. If the source Object is a CIM
Class, then a CloseableIterator
of
CIMObjectPath
s of the Association classes that refer to the
source Object is returned. If the source Object is a CIM Instance, then a
CloseableIterator
of CIMObjectPath
s of the
CIMInstance
objects that refer to the source Object is
returned.
referenceNames
in interface WBEMClient
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)
public void setLocales(Locale[] pLocales)
WBEMClient
setLocales
in interface WBEMClient
pLocales
- An array of locales in order of priority of preference.public void setQualifierType(CIMQualifierType<?> pQualifierType) throws WBEMException
WBEMClient
CIMQualifierType
to the specified namespace if it does
not already exist. Otherwise, it modifies the qualifier type to the value
specified.
setQualifierType
in interface WBEMClient
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)
public SocketFactory getCustomSocketFactory()
WBEMClientSBLIM
getCustomSocketFactory
in interface WBEMClientSBLIM
null
indicates set the JRE default factory is used.public void setCustomSocketFactory(SocketFactory pFactory) throws UnsupportedOperationException
WBEMClientSBLIM
setCustomSocketFactory
in interface WBEMClientSBLIM
pFactory
- The factory to use for socket creation. null
resets to the JRE default factory.
UnsupportedOperationException
- Some protocols might not communicate via TCP socketspublic Properties getLocalProperties()
WBEMClientSBLIM
java.lang.System
class, the client setting via
getProperties()
.null
getLocalProperties
in interface WBEMClientSBLIM
System.getProperties()
,
WBEMClientSBLIM.getProperties()
public void setLocalProperties(Properties pProperties)
WBEMClientSBLIM
java.lang.System
class, the
client setting via getProperties()
.
setLocalProperties
in interface WBEMClientSBLIM
pProperties
- The thread specific properties. null
remove the
local setting of the current thread.System.setProperties(Properties)
,
WBEMClientSBLIM.setProperties(Properties)
public void setLocalProperty(String pKey, String pValue)
WBEMClientSBLIM
java.lang.System
class, the client setting via
getProperties()
. Valid property names can be found in the
WBEMConfigurationProperties
interface. Unknown properties
are ignored.
setLocalProperty
in interface WBEMClientSBLIM
pKey
- The name of the configuration propertypValue
- The value of the configuration property. null
resets to the global setting.WBEMConfigurationProperties
,
System.setProperty(String, String)
,
WBEMClientSBLIM.setProperty(String, String)
public EnumerateResponse<CIMObjectPath> associatorPaths(CIMObjectPath pObjectName, String pAssociationClass, String pResultClass, String pRole, String pResultRole, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) throws WBEMException
WBEMClient
associatorPaths
shall start an enumeration session for
traversing associations starting from the instance defined in the
pInstancePath
parameter using any specified filtering
criteria and return zero or more CIMObjectPath
objects.
associatorPaths
in interface WBEMClient
pObjectName
- The CIMObjectPath
for the instance for which the
enumeration is to be performed.pAssociationClass
- This string MUST either contain a valid CIM Association class
name or be null
. It filters the Objects returned
to contain only Objects associated to the source Object via
this CIM Association class or one of its subclasses.pResultClass
- This string MUST either contain a valid CIM Class name or be
null
. It filters the Objects returned to contain
only the Objects of this Class name or one of its subclasses.pRole
- This string MUST either contain a valid Property name or be
null
. It filters the Objects returned to contain
only Objects associated to the source Object via an
Association class in which the source Object plays the
specified role. (i.e. the Property name in the Association
class that refers to the source Object matches this
value) If "Antecedent" is specified, then only Associations in
which the source Object is the "Antecedent" reference are
examined.pResultRole
- This string MUST either contain a valid Property name or be
null
. It filters the Objects returned to contain
only Objects associated to the source Object via an
Association class in which the Object returned plays
the specified role. (i.e. the Property name in the Association
class that refers to the Object returned matches this
value) If "Dependent" is specified, then only Associations in
which the Object returned is the "Dependent" reference are
examined.pFilterQueryLanguage
- The pFilterQueryLanguage
represents the query
language for the pFilterQuery
argument. This must
be left null
if a pFilterQuery
is
not supplied. If the implementation does not support the query
language specified, the
CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall
be returned. If the implementation does not support filtered
enumerations, the
CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error
shall be returned.pFilterQuery
- The pFilterQuery
specifies a query in the form of
the query language specified by the
pFilterQueryLanguage
parameter. If this value is
not null
, the pFilterQueryLanguage
parameter must be non-null
. This value shall 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
shall be returned. If the implementation does not support
filtered enumerations, the
CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error
shall be returned.pTimeout
- This input parameter determines the minimum time the CIM
server shall maintain the open enumeration session after the
last Open or Pull operation (unless the enumeration session is
closed). If the operation timeout is exceeded, the
implementation may close the enumeration session at any time,
releasing any resources allocated to the enumeration session.
A pTimeout
of 0 means that there is no operation
timeout. That is, the enumeration session is never closed
based on time. If pTimeout
is null
,
the implementation shall choose an operation timeout. All
other values for pTimeout
specify the operation
timeout in seconds. A implementation may restrict the set of
allowable values for pTimeout
. Specifically, the
implementation may not allow 0 (no timeout). If the specified
value is not an allowable value, the implementation shall
return failure with the status code
CIM_ERR_INVALID_OPERATION_TIMEOUT
.pContinueOnError
- If true
, requests that the operation resume when
an error is received. If a implementation does not support
continuation on error and pContinueOnError
is
true
, it shall throw a WBEMException
with the status code
CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
. If a
implementation supports continuation on error and
pContinueOnError
is true
, the
enumeration session shall remain open when a Pull operation
fails, and any subsequent successful Pull operations shall
return the set of elements that would have been returned if
the failing Pull operations were successful. This behavior is
subject to the consistency rules defined for pulled
enumerations. If pContinueOnError
is
false
, the enumeration session shall be closed
when either the operation completes successfully or when a
WBEMExcetpion
is thrown.pMaxObjects
- Defines the maximum number of elements that this Open
operation can return. The implementation may deliver any
number of elements up to pMaxObjects
but shall
not deliver more than pMaxObjects
elements. An
implementation may choose to never return any elements during
an Open operation, regardless of the value of
pMaxObjects
. Note that a CIM client can use a
pMaxObjects
value of 0 to specify that it does
not want to retrieve any instances in the Open operation.
pMaxObjects
. These entries meet
the criteria defined in the Open operation. Note that returning
no entries in the array does not imply that the enumeration
session is exhausted. Client must evaluate the
EnumerateResponse.isEnd()
to determine if there are
more elements.
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)
public EnumerateResponse<CIMInstance> associators(CIMObjectPath pObjectName, String pAssocClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeClassOrigin, String[] pPropertyList, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) throws WBEMException
WBEMClient
associators
shall start an enumeration session for
traversing associations starting from the instance defined in the
pInstancePath
parameter using any specified filtering
criteria and return zero or more CIMInstance
objects.
associators
in interface WBEMClient
pObjectName
- The CIMObjectPath
for the instance for which the
enumeration is to be performed.pAssocClass
- This string MUST either contain a valid CIM Association class
name or be null
. It filters the Objects returned
to contain only Objects associated to the source Object via
this CIM Association class or one of its subclasses.pResultClass
- This string MUST either contain a valid CIM Class name or be
null
. It filters the Objects returned to contain
only the Objects of this Class name or one of its subclasses.pRole
- This string MUST either contain a valid Property name or be
null
. It filters the Objects returned to contain
only Objects associated to the source Object via an
Association class in which the source Object plays the
specified role. (i.e. the Property name in the Association
class that refers to the source Object matches this
value) If "Antecedent" is specified, then only Associations in
which the source Object is the "Antecedent" reference are
examined.pResultRole
- This string MUST either contain a valid Property name or be
null
. It filters the Objects returned to contain
only Objects associated to the source Object via an
Association class in which the Object returned plays
the specified role. (i.e. the Property name in the Association
class that refers to the Object returned matches this
value) If "Dependent" is specified, then only Associations in
which the Object returned is the "Dependent" reference are
examined.pIncludeClassOrigin
- The class origin attribute is the name of the class that first
defined the property. If true
, the class origin
attribute may be present for each property on all instances
returned, even if requested the server may ignore the request
and not return the class origin. If false
, the
class origin shall not be present.pPropertyList
- An array of property names used to filter what is contained in
the Objects returned. Each CIMClass
or
CIMInstance
returned only contains elements for
the properties of the names specified. Duplicate and invalid
property names are ignored and the request is otherwise
processed normally. An empty array indicates that no
properties should be included in the Objects returned. A
null
value indicates that all properties should
be contained in the Objects returned. NOTE: Properties
should not be specified in this parameter unless a non-
null
value is specified in the
pResultClass
parameter.pFilterQueryLanguage
- The pFilterQueryLanguage
represents the query
language for the pFilterQuery
argument. This must
be left null
if a filterQuery is not supplied. If
the implementation does not support the query language
specified, the
CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall
be returned. If the implementation does not support filtered
enumerations, the
CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error
shall be returned.pFilterQuery
- The pFilterQuery
specifies a query in the form of
the query language specified by the
pFilterQueryLanguage
parameter. If this value is
not null
, the pFilterQueryLanguage
parameter must be non-null
. This value shall 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
shall be returned. If the implementation does not support
filtered enumerations, the
CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error
shall be returned.pTimeout
- This input parameter determines the minimum time the CIM
server shall maintain the open enumeration session after the
last Open or Pull operation (unless the enumeration session is
closed). If the operation timeout is exceeded, the
implementation may close the enumeration session at any time,
releasing any resources allocated to the enumeration session.
A pTimeout
of 0 means that there is no operation
timeout. That is, the enumeration session is never closed
based on time. If pTimeout
is null
,
the implementation shall choose an operation timeout. All
other values for pTimeout
specify the operation
timeout in seconds. A implementation may restrict the set of
allowable values for pTimeout
. Specifically, the
implementation may not allow 0 (no timeout). If the specified
value is not an allowable value, the implementation shall
return failure with the status code
CIM_ERR_INVALID_OPERATION_TIMEOUT
.pContinueOnError
- If true
, requests that the operation resume when
an error is received. If a implementation does not support
continuation on error and pContinueOnError
is
true
, it shall throw a WBEMException
with the status code
CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
. If a
implementation supports continuation on error and
pContinueOnError
is true
, the
enumeration session shall remain open when a Pull operation
fails, and any subsequent successful Pull operations shall
return the set of elements that would have been returned if
the failing Pull operations were successful. This behavior is
subject to the consistency rules defined for pulled
enumerations. If pContinueOnError
is
false
, the enumeration session shall be closed
when either the operation completes successfully or when a
WBEMExcetpion
is thrown.pMaxObjects
- Defines the maximum number of elements that this Open
operation can return. The implementation may deliver any
number of elements up to pMaxObjects
but shall
not deliver more than pMaxObjects
elements. An
implementation may choose to never return any elements during
an Open operation, regardless of the value of
pMaxObjects
. Note that a CIM client can use a
pMaxObjects
value of 0 to specify that it does
not want to retrieve any instances in the Open operation.
pMaxObjects
. These entries meet
the criteria defined in the Open operation. Note that returning
no entries in the array does not imply that the enumeration
session is exhausted. Client must evaluate the
EnumerateResponse.isEnd()
to determine if there are
more elements.
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)
public void closeEnumeration(CIMObjectPath pObjectName, String pEnumerationContext) throws WBEMException
WBEMClient
closeEnumeration
shall close an enumeration session that has
been previously started but not yet completed. Clients should always use
this method when an enumeration session has been started and the client
does not retrieve all the results. If a client has started an enumeration
session and retrieves all the results until the
EnumerationResponse.isEnd()
is true, this method shall not
be called.
closeEnumeration
in interface WBEMClient
pObjectName
- The CIMObjectPath
representing the namespace to
be used.pEnumerationContext
- The enumeration context to close.
WBEMException
public EnumerateResponse<CIMObjectPath> enumerateInstancePaths(CIMObjectPath pObjectName, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) throws WBEMException
WBEMClient
enumerateInstancePaths
shall enumerate the instances of the
specified class in pClassPath
and return zero or more
CIMObjectPath
s.
enumerateInstancePaths
in interface WBEMClient
pObjectName
- The CIMObjectPath
for the class for which the
enumeration is to be performed.pFilterQueryLanguage
- The pFilterQueryLanguage
represents the query
language for the pFilterQuery
argument. This must
be left null
if a pFilterQuery
is
not supplied. If the implementation does not support the query
language specified, the
CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall
be returned. If the implementation does not support filtered
enumerations, the
CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error
shall be returned.pFilterQuery
- The pFilterQuery
specifies a query in the form of
the query language specified by the
pFilterQueryLanguage
parameter. If this value is
not null
, the pFilterQueryLanguage
parameter must be non-null
. This value shall 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
shall be returned. If the implementation does not support
filtered enumerations, the
CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error
shall be returned.pTimeout
- This input parameter determines the minimum time the CIM
server shall maintain the open enumeration session after the
last Open or Pull operation (unless the enumeration session is
closed). If the operation timeout is exceeded, the
implementation may close the enumeration session at any time,
releasing any resources allocated to the enumeration session.
A pTimeout
of 0 means that there is no operation
timeout. That is, the enumeration session is never closed
based on time. If pTimeout
is null
,
the implementation shall choose an operation timeout. All
other values for pTimeout
specify the operation
timeout in seconds. A implementation may restrict the set of
allowable values for pTimeout
. Specifically, the
implementation may not allow 0 (no timeout). If the specified
value is not an allowable value, the implementation shall
return failure with the status code
CIM_ERR_INVALID_OPERATION_TIMEOUT
.pContinueOnError
- If true
, requests that the operation resume when
an error is received. If a implementation does not support
continuation on error and pContinueOnError
is
true
, it shall throw a WBEMException
with the status code
CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
. If a
implementation supports continuation on error and
pContinueOnError
is true
, the
enumeration session shall remain open when a Pull operation
fails, and any subsequent successful Pull operations shall
return the set of elements that would have been returned if
the failing Pull operations were successful. This behavior is
subject to the consistency rules defined for pulled
enumerations. If pContinueOnError
is
false
, the enumeration session shall be closed
when either the operation completes successfully or when a
WBEMExcetpion
is thrown.pMaxObjects
- Defines the maximum number of elements that this Open
operation can return. The implementation may deliver any
number of elements up to pMaxObjects
but shall
not deliver more than pMaxObjects
elements. An
implementation may choose to never return any elements during
an Open operation, regardless of the value of
pMaxObjects
. Note that a CIM client can use a
pMaxObjects
value of 0 to specify that it does
not want to retrieve any instances in the Open operation.
pMaxObjects
. These entries meet
the criteria defined in the Open operation. Note that returning
no entries in the array does not imply that the enumeration
session is exhausted. Client must evaluate the
EnumerateResponse.isEnd()
to determine if there are
more elements.
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)
public EnumerateResponse<CIMInstance> enumerateInstances(CIMObjectPath pObjectName, boolean pDeepInheritance, boolean pIncludeClassOrigin, String[] pPropertyList, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) throws WBEMException
WBEMClient
enumerateInstances
shall enumerate the instances of the
specified class in pClassPath
and return zero or more
CIMInstance
s.
enumerateInstances
in interface WBEMClient
pObjectName
- The CIMObjectPath
for the class for which the
enumeration is to be performed.pDeepInheritance
- If true
, this specifies that, for each returned
Instance of the Class, all properties of the Instance must be
present (subject to constraints imposed by the other
parameters), including any which were added by subclassing the
specified Class. If false
, each returned Instance
includes only properties defined for the specified Class in
path.pIncludeClassOrigin
- The class origin attribute is the name of the class that first
defined the property. If true
, the class origin
attribute may be present for each property on all instances
returned, even if requested the server may ignore the request
and not return the class origin. If false
, the
class origin shall not be present.pPropertyList
- An array of property names used to filter what is contained in
the Objects returned. Each CIMInstance
returned
only contains elements for the properties of the names
specified. Duplicate and invalid property names are ignored
and the request is otherwise processed normally. An empty
array indicates that no properties should be included in the
Objects returned. A null
value indicates that all
properties should be contained in the Objects returned.pFilterQueryLanguage
- The pFilterQueryLanguage
represents the query
language for the pFilterQuery
argument. This must
be left null
if a pFilterQuery
is
not supplied. If the implementation does not support the query
language specified, the
CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall
be returned. If the implementation does not support filtered
enumerations, the
CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error
shall be returned.pFilterQuery
- The pFilterQuery
specifies a query in the form of
the query language specified by the
pFilterQueryLanguage
parameter. If this value is
not null
, the pFilterQueryLanguage
parameter must be non-null
. This value shall 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
shall be returned. If the implementation does not support
filtered enumerations, the
CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error
shall be returned.pTimeout
- This input parameter determines the minimum time the CIM
server shall maintain the open enumeration session after the
last Open or Pull operation (unless the enumeration session is
closed). If the operation timeout is exceeded, the
implementation may close the enumeration session at any time,
releasing any resources allocated to the enumeration session.
A pTimeout
of 0 means that there is no operation
timeout. That is, the enumeration session is never closed
based on time. If pTimeout
is null
,
the implementation shall choose an operation timeout. All
other values for pTimeout
specify the operation
timeout in seconds. A implementation may restrict the set of
allowable values for pTimeout
. Specifically, the
implementation may not allow 0 (no timeout). If the specified
value is not an allowable value, the implementation shall
return failure with the status code
CIM_ERR_INVALID_OPERATION_TIMEOUT
.pContinueOnError
- If true
, requests that the operation resume when
an error is received. If a implementation does not support
continuation on error and pContinueOnError
is
true
, it shall throw a WBEMException
with the status code
CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
. If a
implementation supports continuation on error and
pContinueOnError
is true
, the
enumeration session shall remain open when a Pull operation
fails, and any subsequent successful Pull operations shall
return the set of elements that would have been returned if
the failing Pull operations were successful. This behavior is
subject to the consistency rules defined for pulled
enumerations. If pContinueOnError
is
false
, the enumeration session shall be closed
when either the operation completes successfully or when a
WBEMExcetpion
is thrown.pMaxObjects
- Defines the maximum number of elements that this Open
operation can return. The implementation may deliver any
number of elements up to pMaxObjects
but shall
not deliver more than pMaxObjects
elements. An
implementation may choose to never return any elements during
an Open operation, regardless of the value of
pMaxObjects
. Note that a CIM client can use a
pMaxObjects
value of 0 to specify that it does
not want to retrieve any instances in the Open operation.
pMaxObjects
. These entries meet
the criteria defined in the Open operation. Note that returning
no entries in the array does not imply that the enumeration
session is exhausted. Client must evaluate the
EnumerateResponse.isEnd()
to determine if there are
more elements.
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)
public UnsignedInteger64 enumerationCount(CIMObjectPath pObjectName, String pEnumerationContext) throws WBEMException
WBEMClient
enumerationCount
provides an estimated count of the total
number of objects in an open enumeration session represented by an
enumeration context.
enumerationCount
in interface WBEMClient
pObjectName
- The namespace for the enumeration context.pEnumerationContext
- The enumeration context to count.
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
public EnumerateResponse<CIMInstance> execQueryInstances(CIMObjectPath pObjectName, String pFilterQuery, String pFilterQueryLanguage, boolean pReturnQueryResultClass, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects, CIMClass pQueryResultClass) throws WBEMException
WBEMClient
execQueryInstances
shall execute a query to retrieve
instances.
execQueryInstances
in interface WBEMClient
pObjectName
- The CIMObjectPath
representing the namespace to
be used.pFilterQuery
- The pFilterQuery
specifies a query in the form of
the query language specified by the
pFilterQueryLanguage
parameter. If this value is
not null
, the pFilterQueryLanguage
parameter must be non-null
. This value shall 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
shall be returned. If the implementation does not support
filtered enumerations, the
CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error
shall be returned.pFilterQueryLanguage
- The pFilterQueryLanguage
represents the query
language for the pFilterQuery
argument. This must
be left null
if a pFilterQuery
is
not supplied. If the implementation does not support the query
language specified, the
CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall
be returned. If the implementation does not support filtered
enumerations, the
CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error
shall be returned.pReturnQueryResultClass
- The pReturnQueryResultClass
controls whether a
class definition is returned in pQueryResultClass
. If it is set to false
,
pQueryResultClass
shall be set to
null
on output. If it is set to true
, the value of the pQueryResultClass
on output
shall be a class definition that defines the properties
(columns) of each row of the query result.pTimeout
- This input parameter determines the minimum time the CIM
server shall maintain the open enumeration session after the
last Open or Pull operation (unless the enumeration session is
closed). If the operation timeout is exceeded, the
implementation may close the enumeration session at any time,
releasing any resources allocated to the enumeration session.
A pTimeout
of 0 means that there is no operation
timeout. That is, the enumeration session is never closed
based on time. If pTimeout
is null
,
the implementation shall choose an operation timeout. All
other values for pTimeout
specify the operation
timeout in seconds. A implementation may restrict the set of
allowable values for pTimeout
. Specifically, the
implementation may not allow 0 (no timeout). If the specified
value is not an allowable value, the implementation shall
return failure with the status code
CIM_ERR_INVALID_OPERATION_TIMEOUT
.pContinueOnError
- If true
, requests that the operation resume when
an error is received. If a implementation does not support
continuation on error and pContinueOnError
is
true
, it shall throw a WBEMException
with the status code
CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
. If a
implementation supports continuation on error and
pContinueOnError
is true
, the
enumeration session shall remain open when a Pull operation
fails, and any subsequent successful Pull operations shall
return the set of elements that would have been returned if
the failing Pull operations were successful. This behavior is
subject to the consistency rules defined for pulled
enumerations. If pContinueOnError
is
false
, the enumeration session shall be closed
when either the operation completes successfully or when a
WBEMExcetpion
is thrown.pMaxObjects
- Defines the maximum number of elements that this Open
operation can return. The implementation may deliver any
number of elements up to pMaxObjects
but shall
not deliver more than pMaxObjects
elements. An
implementation may choose to never return any elements during
an Open operation, regardless of the value of
pMaxObjects
. Note that a CIM client can use a
pMaxObjects
value of 0 to specify that it does
not want to retrieve any instances in the Open operation.pQueryResultClass
- The pQueryResultClass
is an output argument. It
shall be null
if the
pReturnQueryResultClass
input parameter is set to
false
. Otherwise, it shall return a class
definition where each property of the class corresponds to one
entry of the query select list. The class definition
corresponds to one row of the query result. The class name of
this returned class shall be "CIM_QueryResult". This class
definition is valid only in the context of this enumeration.
pMaxObjects
. These entries meet
the criteria defined in the Open operation. Note that returning
no entries in the array does not imply that the enumeration
session is exhausted. Client must evaluate the
EnumerateResponse.isEnd()
to determine if there are
more elements.
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)
public EnumerateResponse<CIMObjectPath> getInstancePaths(CIMObjectPath pObjectName, String pContext, UnsignedInteger32 pMaxObjects) throws WBEMException
WBEMClient
getInstancePaths
shall get the CIMObjectPath
s
using an enumeration context.
getInstancePaths
in interface WBEMClient
pObjectName
- The CIMObjectPath
representing the namespace to
be used.pContext
- The enumeration context value for the enumeration session to
be used.pMaxObjects
- Defines the maximum number of elements that this Open
operation can return. The implementation may deliver any
number of elements up to pMaxObjects
but shall
not deliver more than pMaxObjects
elements. An
implementation may choose to never return any elements during
an Open operation, regardless of the value of
pMaxObjects
.
EnumerateResponse
that includes zero or more
CIMObjectPath
objects.
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)
public EnumerateResponse<CIMInstance> getInstances(CIMObjectPath pObjectName, String pContext, UnsignedInteger32 pMaxObjects) throws WBEMException
WBEMClient
getInstances
shall get the instances from an enumeration
session started by execQueryInstances
.
getInstances
in interface WBEMClient
pObjectName
- The CIMObjectPath
representing the namespace to
be used.pContext
- The enumeration context value for the enumeration session to
be used.pMaxObjects
- Defines the maximum number of elements that this Open
operation can return. The implementation may deliver any
number of elements up to pMaxObjects
but shall
not deliver more than pMaxObjects
elements. An
implementation may choose to never return any elements during
an Open operation, regardless of the value of
pMaxObjects
. Note that a CIM client can use a
pMaxObjects
value of 0 to specify that it does
not want to retrieve any instances in the Open operation.
EnumerateResponse
that includes zero or more
CIMObjectPath
objects.
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
public EnumerateResponse<CIMInstance> getInstancesWithPath(CIMObjectPath pObjectName, String pContext, UnsignedInteger32 pMaxObjects) throws WBEMException
WBEMClient
getInstancesWithPath
shall use the enumeration context
provided to get the next set of instances for the enumeration session.
getInstancesWithPath
in interface WBEMClient
pObjectName
- The CIMObjectPath
representing the namespace to
be used.pContext
- The enumeration context value for the enumeration session to
be used.pMaxObjects
- Defines the maximum number of elements that this Open
operation can return. The implementation may deliver any
number of elements up to pMaxObjects
but shall
not deliver more than pMaxObjects
elements. An
implementation may choose to never return any elements during
an Open operation, regardless of the value of
pMaxObjects
.
EnumerateResponse
that includes zero or more
CIMObjectPath
. objects.
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)
public EnumerateResponse<CIMObjectPath> referencePaths(CIMObjectPath pObjectName, String pResultClass, String pRole, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) throws WBEMException
WBEMClient
referencePaths
shall start an enumeration session for
association instances that have references that refer to the instance
defined in the pInstancePath
parameter and return zero or
more CIMObjectPath
objects.
referencePaths
in interface WBEMClient
pObjectName
- The CIMObjectPath
for the instance for which the
enumeration is to be performed.pResultClass
- This string MUST either contain a valid CIM Class name or be
null
. It filters the Objects returned to contain
only the Objects of this Class name or one of its subclasses.pRole
- This string MUST either contain a valid Property name or be
null
. It filters the Objects returned to contain
only Objects referring to the source Object via a Property
with the specified name. If "Antecedent" is specified, then
only Associations in which the source Object is the
"Antecedent" reference are returned.pFilterQueryLanguage
- The pFilterQueryLanguage
represents the query
language for the pFilterQuery
argument. This must
be left null
if a pFilterQuery
is
not supplied. If the implementation does not support the query
language specified, the
CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall
be returned. If the implementation does not support filtered
enumerations, the
CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error
shall be returned.pFilterQuery
- The pFilterQuery
specifies a query in the form of
the query language specified by the
pFilterQueryLanguage
parameter. If this value is
not null
, the pFilterQueryLanguage
parameter must be non-null
. This value shall 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
shall be returned. If the implementation does not support
filtered enumerations, the
CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error
shall be returned.pTimeout
- This input parameter determines the minimum time the CIM
server shall maintain the open enumeration session after the
last Open or Pull operation (unless the enumeration session is
closed). If the operation timeout is exceeded, the
implementation may close the enumeration session at any time,
releasing any resources allocated to the enumeration session.
A pTimeout
of 0 means that there is no operation
timeout. That is, the enumeration session is never closed
based on time. If pTimeout
is null
,
the implementation shall choose an operation timeout. All
other values for pTimeout
specify the operation
timeout in seconds. A implementation may restrict the set of
allowable values for pTimeout
. Specifically, the
implementation may not allow 0 (no timeout). If the specified
value is not an allowable value, the implementation shall
return failure with the status code
CIM_ERR_INVALID_OPERATION_TIMEOUT
.pContinueOnError
- If true
, requests that the operation resume when
an error is received. If a implementation does not support
continuation on error and pContinueOnError
is
true
, it shall throw a WBEMException
with the status code
CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
. If a
implementation supports continuation on error and
pContinueOnError
is true
, the
enumeration session shall remain open when a Pull operation
fails, and any subsequent successful Pull operations shall
return the set of elements that would have been returned if
the failing Pull operations were successful. This behavior is
subject to the consistency rules defined for pulled
enumerations. If pContinueOnError
is
false
, the enumeration session shall be closed
when either the operation completes successfully or when a
WBEMExcetpion
is thrown.pMaxObjects
- Defines the maximum number of elements that this Open
operation can return. The implementation may deliver any
number of elements up to pMaxObjects
but shall
not deliver more than pMaxObjects
elements. An
implementation may choose to never return any elements during
an Open operation, regardless of the value of
pMaxObjects
. Note that a CIM client can use a
pMaxObjects
value of 0 to specify that it does
not want to retrieve any instances in the Open operation.
pMaxObjects
. These entries meet
the criteria defined in the Open operation. Note that returning
no entries in the array does not imply that the enumeration
session is exhausted. Client must evaluate the
EnumerateResponse.isEnd()
to determine if there are
more elements.
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)
public EnumerateResponse<CIMInstance> references(CIMObjectPath pObjectName, String pResultClass, String pRole, boolean pIncludeClassOrigin, String[] pPropertyList, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjects) throws WBEMException
WBEMClient
references
shall start an enumeration session for
association instances that have references that refer to the instance
defined in the pInstancePath
parameter and return zero or
more CIMInstance
objects.
references
in interface WBEMClient
pObjectName
- The CIMObjectPath
for the instance for which the
enumeration is to be performed.pResultClass
- This string shall either contain a 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 Property name or be
null
. It filters the instances returned to
contain only instances referring to the source instance via a
Property with the specified name. If "Antecedent" is
specified, then only Associations in which the source instance
is the "Antecedent" reference are returned.pIncludeClassOrigin
- The class origin attribute is the name of the class that first
defined the property. If true
, the class origin
attribute may be present for each property on all instances
returned, even if requested the server may ignore the request
and not return the class origin. If false
, the
class origin shall not be present.pPropertyList
- An array of property names used to filter what is contained in
the instances returned. Each CIMInstance
returned
only contains elements for the properties of the names
specified. Duplicate and invalid property names are ignored
and the request is otherwise processed normally. An empty
array indicates that no properties should be included in the
Objects returned. A null
value indicates that all
non-null properties of the instance are included.pFilterQueryLanguage
- The pFilterQueryLanguage
represents the query
language for the pFilterQuery
argument. This must
be left null
if a pFilterQuery
is
not supplied. If the implementation does not support the query
language specified, the
CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
error shall
be returned. If the implementation does not support filtered
enumerations, the
CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error
shall be returned.pFilterQuery
- The pFilterQuery
specifies a query in the form of
the query language specified by the
pFilterQueryLanguage
parameter. If this value is
not null
, the pFilterQueryLanguage
parameter must be non-null
. This value shall 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
shall be returned. If the implementation does not support
filtered enumerations, the
CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
error
shall be returned.pTimeout
- This input parameter determines the minimum time the CIM
server shall maintain the open enumeration session after the
last Open or Pull operation (unless the enumeration session is
closed). If the operation timeout is exceeded, the
implementation may close the enumeration session at any time,
releasing any resources allocated to the enumeration session.
A pTimeout
of 0 means that there is no operation
timeout. That is, the enumeration session is never closed
based on time. If pTimeout
is null
,
the implementation shall choose an operation timeout. All
other values for pTimeout
specify the operation
timeout in seconds. A implementation may restrict the set of
allowable values for pTimeout
. Specifically, the
implementation may not allow 0 (no timeout). If the specified
value is not an allowable value, the implementation shall
return failure with the status code
CIM_ERR_INVALID_OPERATION_TIMEOUT
.pContinueOnError
- If true
, requests that the operation resume when
an error is received. If a implementation does not support
continuation on error and pContinueOnError
is
true
, it shall throw a WBEMException
with the status code
CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
. If a
implementation supports continuation on error and
pContinueOnError
is true
, the
enumeration session shall remain open when a Pull operation
fails, and any subsequent successful Pull operations shall
return the set of elements that would have been returned if
the failing Pull operations were successful. This behavior is
subject to the consistency rules defined for pulled
enumerations. If pContinueOnError
is
false
, the enumeration session shall be closed
when either the operation completes successfully or when a
WBEMExcetpion
is thrown.pMaxObjects
- Defines the maximum number of elements that this Open
operation can return. The implementation may deliver any
number of elements up to pMaxObjects
but shall
not deliver more than pMaxObjects
elements. An
implementation may choose to never return any elements during
an Open operation, regardless of the value of
pMaxObjects
. Note that a CIM client can use a
pMaxObjects
value of 0 to specify that it does
not want to retrieve any instances in the Open operation.
pMaxObjects
. These entries meet
the criteria defined in the Open operation. Note that returning
no entries in the array does not imply that the enumeration
session is exhausted. Client must evaluate the
EnumerateResponse.isEnd()
to determine if there are
more elements.
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)
public boolean sendIndication(URI pRecipient, CIMInstance pIndication) throws WBEMException
WBEMClientSBLIM
sendIndication
in interface WBEMClientSBLIM
pRecipient
- URI of indication recipient.pIndication
- Indication.
true
if indication received successfully,
false
otherwise.
WBEMException
- If unsuccessful, one of the following status codes must be
returned. The ORDERED list is:
CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or otherwise incorrect parameters) CIM_ERR_FAILED (some other unspecified error occurred)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |