Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.sblim.wbem.client.CIMClient
public class CIMClient
extends java.lang.Object
CIMClient
instance is connected to a single target CIM
server and can be used to interact with all CIM namespaces within that
server.
Field Summary | |
static String |
|
static String |
|
static String |
|
static String | |
static String | |
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
Constructor Summary | |
| |
| |
| |
|
Method Summary | |
void |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
void |
|
void |
|
CIMObjectPath |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
CIMClass |
|
CIMClass |
|
CIMClass |
|
CIMClass |
|
CIMClass |
|
CIMInstance |
|
CIMInstance |
|
CIMInstance |
|
CIMInstance |
|
CIMInstance |
|
CIMInstance |
|
CIMInstance |
|
Locale |
|
CIMNameSpace |
|
CIMValue |
|
CIMQualifierType |
|
SessionProperties |
|
CIMValue |
|
CIMValue |
|
BatchResult |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
public static final String CIM_XML
Protocol identifier for CIM Operations over HTTP.
public static final String CQL
QueryLanguage identifier for CIM Query Language (CQL).
public static final String ITSANM_CIMXML
TODO Proposal: Constants ITSANM_CIMXML, ITSANM_SOAP, ITSANM_LOCAL never used, remove them.
public static final String ITSANM_LOCAL
public static final String ITSANM_SOAP
public static final String WQL
QueryLanguage identifier for WBEM Query Language (WQL).
public static final String WQL1
WBEM Query Language level 1. TODO Proposal: WQL1 constant is never used, remove it.
public static final String WQL2
WBEM Query Language level 2. TODO Proposal: WQL2 constant is never used, remove it.
public static final String WQL3
WBEM Query Language level 3. TODO Proposal: WQL3 constant is never used, remove it.
public static final String WQL4
WBEM Query Language level 4. TODO Proposal: WQL4 constant is never used, remove it.
public CIMClient(CIMNameSpace pNameSpace, Principal pPrincipal, Object pCredential) throws CIMException
Initializes thisCIMClient
with connection information to a target CIM server and a default namespace, using the specified principal and credential, and using the default protocolCIM_XML
(CIM Operations over HTTP). The global session properties are applied.
- Parameters:
pNameSpace
- Namespace identifying target CIM server and default CIM namespace name. Must not be null. The host and port attributes identify the target CIM server to connect to. Must be valid. The namespace attribute identifies the default namespace name to be used if object paths in subsequent method invocations do not provide a namespace name. Must be valid.pPrincipal
- Principal (e.g. userid) used to log on to the CIM Server. Must not be null.pCredential
- Credential (e.g. password) used to log on to the CIM Server. Must not be null.
- Throws:
CIMException
- with one of these CIM status codes:
public CIMClient(CIMNameSpace pNameSpace, Principal pPrincipal, Object pCredential, String pProtocol) throws CIMException
Initializes thisCIMClient
with connection information to a target CIM server and a default namespace, using the specified principal, credential and protocol. The global session properties are applied.
- Parameters:
pNameSpace
- Namespace identifying target CIM server and default CIM namespace name. Must not be null. The host and port attributes identify the target CIM server to connect to. Must be valid. The namespace attribute identifies the default namespace name to be used if object paths in subsequent method invocations do not provide a namespace name. Must be valid.pPrincipal
- Principal (e.g. userid) used to log on to the CIM Server. Must not be null.pCredential
- Credential (e.g. password) used to log on to the CIM Server. Must not be null.pProtocol
- Identifier for the CIM client protocol to be used. Must be valid. Valid identifiers are the following constants:and also the name of any Java class that implements
CIM_XML
- CIM Operations over HTTPCIMOMHandle
.
- Throws:
CIMException
- with one of these CIM status codes:
public CIMClient(CIMNameSpace pNameSpace, Principal pPrincipal, Object pCredential, String pProtocol, SessionProperties pProperties) throws CIMException
Initializes thisCIMClient
with connection information to a target CIM server and a default namespace, using the specified principal, credential and protocol. TODO Proposal: Allow the name of the Interop namespace to be passed (add a new ctor that does this).
- Parameters:
pNameSpace
- Namespace identifying target CIM server and default CIM namespace name. Must not be null. The host and port attributes identify the target CIM server to connect to. Must be valid. The namespace attribute identifies the default namespace name to be used if object paths in subsequent method invocations do not provide a namespace name. Must be valid.pPrincipal
- Principal (e.g. userid) used to log on to the CIM Server. Must not be null.pCredential
- Credential (e.g. password) used to log on to the CIM Server. Must not be null.pProtocol
- Identifier for the CIM client protocol to be used. Must be valid. Valid identifiers are the following constants:and also the name of any Java class that implements
CIM_XML
- CIM Operations over HTTPCIMOMHandle
.pProperties
- The session properties to apply. Might be either the global session properties or a connection specific property instance. Ifnull
the global properties are used.
- Throws:
CIMException
- with one of these CIM status codes:
public CIMClient(CIMOMHandle pCimomHandle) throws CIMException
Initializes thisCIMClient
from an existingCIMOMHandle
. ACIMOMHandle
can be obtained from aCIMClientFactory
. This allows to extend the CIM client (for instance with an additional protocol) without changing the interface to the CIM client application.
- Parameters:
pCimomHandle
-
- Throws:
CIMException
- with one of these CIM status codes:
- See Also:
CIMOMHandle
,CIMClientFactory
public void addCIMListener(CIMListener pListener) throws CIMException
Adds the specified CIMListener to start receiving indications from the CIM server. The CIMListener must differentiate itself from other CIMListener instances through the hashCode(). TODO Clarify: CIMListener does not have a hashcode() method.
- Parameters:
pListener
- CIMListener to be added. Must not be null.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration associatorNames(CIMObjectPath pObjectPath) throws CIMException
Enumerates the CIM objects on the target CIM server that are at the other end of all associations connecting to a source CIM object at this end of these associations, and returns CIM object paths to these objects. This method produces the same results asassociatorNames(pObjectPath, null, null, null, null)
- Parameters:
pObjectPath
- CIM object path to the source CIM object (instance or class) whose associated CIM objects are to be returned. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The source CIM object must exist.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMObjectPath
objects referencing the enumerated classes or instances using global CIM class or instance paths.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration associatorNames(CIMObjectPath pObjectPath, String pAssociationClass, String pResultClass, String pRole, String pResultRole) throws CIMException
Enumerates the CIM objects on the target CIM server that are at the other end of all associations connecting to a source CIM object at this end of these associations, and returns CIM object paths to these objects. If the source CIM object is an instance, then the associated instances are enumerated. If the source CIM object is a class, then the associated classes are enumerated.
- Parameters:
pObjectPath
- CIM object path to the source CIM object (instance or class) whose associated CIM objects are to be returned. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The source CIM object must exist.pAssociationClass
- Allows to restrict the set of returned objects. If null, the set of objects will not be restricted. If not null, must be a valid CIM association class name, and the set of objects will be restricted by removing any objects that are not associated to the source CIM object via the specified class or one of its subclasses. When combined with other object restriction filters, all restrictions are accumulated.pResultClass
- Allows to restrict the set of returned objects. If null, the set of objects will not be restricted. If not null, must be a valid CIM class name, and the set of objects will be restricted by removing any objects that do not satisfy the following conditions: (1) If the source CIM object is an instance, the enumerated objects are CIM instances of the specified class or one of its subclasses. (2) If the source CIM object is a class, the enumerated objects are the specified class or one of its subclasses. When combined with other object restriction filters, all restrictions are accumulated.pRole
- Allows to restrict the set of returned objects. If null, the set of objects will not be restricted. If not null, must be a valid CIM property name, and the set of objects will be restricted by removing any objects that are not associated to the source object via an association in which the source object plays the specified pRole (i.e. the name of the reference in the association class that refers to the source object must match the value of this parameter). When combined with other object restriction filters, all restrictions are accumulated.pResultRole
- Allows to restrict the set of returned objects. If null, the set of objects will not be restricted. If not null, must be a valid CIM property name, and the set of objects will be restricted by removing any objects that are not associated to the source object via an association in which the returned object plays the specified pRole (i.e. the name of the reference in the association class that refers to the returned object must match the value of this parameter). When combined with other object restriction filters, all restrictions are accumulated.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMObjectPath
objects referencing the enumerated classes or instances using global CIM class or instance paths.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration associators(CIMObjectPath pObjectPath, String pAssociationClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws CIMException
Enumerates the CIM objects on the target CIM server that are at the other end of all associations connecting to a source CIM object at this end of these associations, and returns copies of these CIM objects. If the source CIM object is an instance, then the associated instances are enumerated. If the source CIM object is a class, then the associated classes are enumerated.
- Parameters:
pObjectPath
- CIM object path to the source CIM object (instance or class) whose associated CIM objects are to be returned. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The source CIM object must exist.pAssociationClass
- Allows to restrict the set of returned objects. If null, the set of objects will not be restricted. If not null, must be a valid CIM association class name, and the set of objects will be restricted by removing any objects that are not associated to the source CIM object via the specified class or one of its subclasses. When combined with other object restriction filters, all restrictions are accumulated.pResultClass
- Allows to restrict the set of returned objects. If null, the set of objects will not be restricted. If not null, must be a valid CIM class name, and the set of objects will be restricted by removing any objects that do not satisfy the following conditions: (1) If the source CIM object is an instance, the enumerated objects are CIM instances of the specified class or one of its subclasses. (2) If the source CIM object is a class, enumerated objects are the specified class or one of its subclasses. When combined with other object restriction filters, all restrictions are accumulated.pRole
- Allows to restrict the set of returned objects. If null, the set of objects will not be restricted. If not null, must be a valid CIM property name, and the set of objects will be restricted by removing any objects that are not associated to the source object via an association in which the source object plays the specified pRole (i.e. the name of the reference in the association class that refers to the source object must match the value of this parameter). When combined with other object restriction filters, all restrictions are accumulated.pResultRole
- Allows to restrict the set of returned objects. If null, the set of objects will not be restricted. If not null, must be a valid CIM property name, and the set of objects will be restricted by removing any objects that are not associated to the source object via an association in which the returned object plays the specified pRole (i.e. the name of the reference in the association class that refers to the returned object must match the value of this parameter). When combined with other object restriction filters, all restrictions are accumulated.pIncludeQualifiers
- If false, no qualifiers will be included. If true, all qualifiers for each object will be included in the objects returned.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. The preferred way to retrieve qualifier information is to use the class operations (for example,getClass
) instead, and to set this parameter tofalse
.pIncludeClassOrigin
- If true, class origin information will be present in the returned objects. Class origin information indicates the class in which a CIM property, method, or reference was first defined in the class hierarchy. It can be retrieved from the Java objects representing these CIM elements by means of thegetOriginClass()
method. If false, class origin information will not be present in the returned objects.pPropertyList
- An array of CIM property names that allows to restrict the set of properties in the returned objects (classes or instances). If null, the set of properties will not be restricted by this parameter. If not null, the set of properties will be restricted such that any properties missing from this list will not be present in the returned objects. In this case, the members of the array must define zero or more property names of the specified class. This may include inherited property names or property names explicitly defined in the specified class, but must not include property names defined in subclasses of the specified class. Duplicate property names are tolerated and the duplicates are ignored.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMInstance
orCIMClass
objects.
- Throws:
CIMException
- with one of these CIM status codes:
public void close() throws CIMException
Closes the connection to the CIM server. TODO Clarify: Is it possible to reopen it afterwards ?
- Throws:
CIMException
- with one of these CIM status codes:
public void createClass(CIMObjectPath pClassPath, CIMClass pNewClass) throws CIMException
Creates a CIM class on the target CIM server.
- Parameters:
pClassPath
- CIM class path to the CIM class to be created. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM class must not exist. Must not be null.pNewClass
- CIM class definition of the new class. Must be a valid class definition according to the CIM Infrastructure Specification [DSP0004]. Any class origin and propagated information innewClass
will be ignored (it is reconstructed by the CIM server). Must not be null.
- Throws:
CIMException
- with one of these CIM status codes:
public CIMObjectPath createInstance(CIMObjectPath pNamespacePath, CIMInstance pNewInstance) throws CIMException
Creates a CIM instance in the specified namespace on the target CIM server. The namespace must exist on the CIM server. The class of the CIM instance must exist in the namespace. Dependent on the semantics of the CIM class, this may result in also creating the real world resource represented by the CIM instance.
- Parameters:
pNamespacePath
- CIM namespace path of the CIM namespace. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. Must not be null.pNewInstance
- CIM instance definition. Must be a valid instance definition for the underlying CIM class according to the CIM Infrastructure Specification [DSP0004]. The new instance definition specifies property values as follows: (1) Any property specified innewInstance
must be a property of the class (including of its superclasses). If so, its value (including null) is used for the CIM instance to be created. (2) For any properties of the class not specified innewInstance
, the default value defined in the class will be used. If no default value has been defined in the class, null is used. The CIM provider is free to override the rules above, for example in order to create key values dynamically. In any case, the new CIM instance in the target namespace will have exactly the properties of its class (that is, including those of any superclasses). Any class origin and propagated information innewInstance
will be ignored (it is reconstructed by the CIM server). Any qualifiers included innewInstance
may be ignored (it is recommended that CIM servers ignore them).
Deprecation Note: The CIM Infrastructure Specification [DSP0004] V2.3 has deprecated instance level qualifiers. The preferred way to create or modify qualifier information is to use the class operations (for example,createClass
) instead. Must not be null.
- Returns:
- A
CIMObjectPath
object referencing the newly created CIM instance using an intra-namespace instance path (model path). The instance path is returned in case one or more of the new keys of the instance are allocated dynamically during the creation process rather than used fromnewInstance
.
- Throws:
CIMException
- with one of these CIM status codes:
public void createNameSpace(CIMNameSpace pNameSpace) throws CIMException
Creates a CIM namespace on the target CIM server. The namespace must not exist on the target CIM server.
- Parameters:
pNameSpace
- CIM namespace to be created. Must not be null. The namespace attribute must be a valid namespace name according to the CIM Infrastructure Specification [DSP0004]. All other attributes are ignored.
- Throws:
CIMException
- with one of these CIM status codes:
public void createQualifierType(CIMObjectPath pNamespacePath, CIMQualifierType pQualifierType) throws CIMException
Creates or replaces a CIM qualifier declaration on the target CIM server. TODO Proposal: Deprecate this method because there is no such CIM operation, and there is SetQualifierType() with the same semantics. If the qualifier declaration does not exist, it will be created. If it exists, it will be replaced. The CIM namespace must exist.
- Parameters:
pNamespacePath
- CIM namespace path. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. Must not be null. Also, the class attribute must not be null. TODO Proposal: It turns out the code ignores the class attribute, but requires it to be non-null. Remove this check.pQualifierType
- CIM qualifier declaration. Must be a valid qualifier declaration according to the CIM Infrastructure Specification [DSP0004].
- Throws:
CIMException
- with one of these CIM status codes:
public void deleteClass(CIMObjectPath pClassPath) throws CIMException
Deletes a CIM class on the target CIM server. This includes deleting all instances of the specified class, all of its subclasses, and all instances of these subclasses in the same namespace.
- Parameters:
pClassPath
- CIM class path to the CIM class to be deleted. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM class must exist.
- Throws:
CIMException
- with one of these CIM status codes:
public void deleteInstance(CIMObjectPath pInstancePath) throws CIMException
Deletes a CIM instance on the target CIM server. Dependent on the semantics of the CIM class, this may result in also deleting the real world resource represented by the CIM instance.
- Parameters:
pInstancePath
- CIM instance path to the CIM instance to be deleted. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM instance must exist.
- Throws:
CIMException
- with one of these CIM status codes:
public void deleteNameSpace(CIMNameSpace pNameSpace) throws CIMException
Deletes a CIM namespace from the target CIM server.
- Parameters:
pNameSpace
- CIM namespace to be deleted. The namespace attribute must be a valid namespace name according to the CIM Infrastructure Specification [DSP0004]. All other attributes are ignored. Must not be null. The namespace must exist on the target CIM server and must not contain any elements.
- Throws:
CIMException
- with one of these CIM status codes:
public void deleteQualifierType(CIMObjectPath pQualifierPath) throws CIMException
Deletes a CIM qualifier declaration on the target CIM server. Note that a CIM server is not obliged to verify whether the qualifier is still used in the namespace. The CIM qualifier declaration must exist.
- Parameters:
pQualifierPath
- CIM qualifier path (a class path used to specify the qualifier name in the class attribute). Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. Must not be null.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration enumClass(CIMObjectPath pClassPath) throws CIMException
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes. This method produces the same results asenumerateClasses(pClassPath, false, true, true, false)
- Parameters:
pClassPath
- CIM class path to the CIM class whose subclasses will be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. If the classname attribute is an empty string, enumeration starts at the top of the class hierarchy, so that the immediate subclasses are the top level classes of the hierarchy. If the classname attribute is a valid class name, the class must exist in the namespace and enumeration starts at that class.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMClass
objects.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration enumClass(CIMObjectPath pClassPath, boolean pDeepInheritance) throws CIMException
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes. This method produces the same results asenumerateClasses(pClassPath, pDeepInheritance, true, true, false)
- Parameters:
pClassPath
- CIM class path to the CIM class whose subclasses will be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. If the classname attribute is an empty string, enumeration starts at the top of the class hierarchy, so that the immediate subclasses are the top level classes of the hierarchy. If the classname attribute is a valid class name, the class must exist in the namespace and enumeration starts at that class.pDeepInheritance
- Controls the set of returned subclasses. If true, all subclasses of the specified class will be returned, down to the leaves of the class hierarchy. If false, only immediate subclasses of the specified class will be returned. Note that this definition ofpDeepInheritance
applies only to the methods for class enumeration and is different from its usage in the methods for instance enumeration.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMClass
objects.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration enumClass(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly) throws CIMException
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes. This method produces the same results asenumerateClasses(pClassPath, pDeepInheritance, pLocalOnly, true, false)
- Parameters:
pClassPath
- CIM class path to the CIM class whose subclasses will be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. If the classname attribute is an empty string, enumeration starts at the top of the class hierarchy, so that the immediate subclasses are the top level classes of the hierarchy. If the classname attribute is a valid class name, the class must exist in the namespace and enumeration starts at that class.pDeepInheritance
- Controls the set of returned subclasses. If true, all subclasses of the specified class will be returned, down to the leaves of the class hierarchy. If false, only immediate subclasses of the specified class will be returned. Note that this definition ofpDeepInheritance
applies only to the methods for class enumeration and is different from its usage in the methods for instance enumeration.pLocalOnly
- Allows to restrict the set of properties present in the returned classes. If false, the set of properties will not be restricted by this parameter. If true, the set of properties will be restricted to those defined or overridden within the definition of the specified class.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMClass
objects.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration enumInstances(CIMObjectPath pClassPath, boolean pDeepInheritance) throws CIMException
Enumerates the CIM instances on the target CIM server that are of the specified class or its subclasses and returns copies of these instances. This method produces the same results asenumerateInstances(pClassPath, pDeepInheritance, false, false, false, null)
- Parameters:
pClassPath
- CIM class path to the CIM class whose instances will be enumerated. Instances of its subclasses in the same namespace will also be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM class must exist.pDeepInheritance
- Allows to restrict the set of properties present in the returned instances. If true, the set of properties will not be restricted by this parameter. If false, the set of properties will be restricted such that any properties in subclasses of the specified class are removed. When combined with other property restriction filters, all restrictions are accumulated. Note: There is an erroneous interpretation of this parameter which consists in believing that the parameter removes all instances of subclasses from the enumerated set of instances. This is wrong as it does not remove such instances, instead it removes their subclass properties.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMInstance
objects.
- Throws:
CIMException
- with one of these CIM status codes:
- See Also:
enumerateInstances(CIMObjectPath, boolean, boolean, boolean, boolean, String[])
public Enumeration enumInstances(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly) throws CIMException
Enumerates the CIM instances on the target CIM server that are of the specified class or its subclasses and returns copies of these instances. This method produces the same results asenumerateInstances(pClassPath, pDeepInheritance, localOnly, false, false, null)
- Parameters:
pClassPath
- CIM class path to the CIM class whose instances will be enumerated. Instances of its subclasses in the same namespace will also be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM class must exist.pDeepInheritance
- Allows to restrict the set of properties present in the returned instances. If true, the set of properties will not be restricted by this parameter. If false, the set of properties will be restricted such that any properties in subclasses of the specified class are removed. When combined with other property restriction filters, all restrictions are accumulated. Note: There is an erroneous interpretation of this parameter which consists in believing that the parameter removes all instances of subclasses from the enumerated set of instances. This is wrong as it does not remove such instances, instead it removes their subclass properties.pLocalOnly
- Allows to restrict the set of properties present in the returned instances. If false, the set of properties will not be restricted by this parameter. If true, the set of properties will be restricted in a way that dependens on the CIM server implementation. When combined with other property restriction filters, all restrictions are accumulated.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. It is recommended that CIM client applications setpLocalOnly
tofalse
and not to rely onpLocalOnly
filtering. To minimize the impact of implementing this recommendation in CIM client applications, a CIM server may choose to treat the value ofpLocalOnly
asfalse
, regardless how it is actually set in an operation. Details: In DSP0200 V1.0, the pLocalOnly parameter was specified ambiguously. In DSP0200 V1.1, the definition of the pLocalOnly parameter was modified with the intent to clarify the ambiguity, so that it now restricted the set of properties to those of the specified class (removing any properties of its superclasses). This change introduced backward compatibility problems for CIM client applications when working with CIM servers that implementedpLocalOnly
support with the (quite common) interpretation of the V1.0 definition that restricted the set of properties to those defined in the CIM class of each instance and its superclasses. In DSP0200 V1.2, a CIM server must consistently support a single interpretation of thepLocalOnly
parameter, but which one is left open.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMInstance
objects.
- Throws:
CIMException
- with one of these CIM status codes:
- See Also:
enumerateInstances(CIMObjectPath, boolean, boolean, boolean, boolean, String[])
public Enumeration enumNameSpace(CIMObjectPath pNamespacePath, boolean pDeep) throws CIMException
Enumerates the CIM namespaces on the target CIM server, and returns CIM instance paths to the CIM_Namespace instances representing them. TODO Proposal: Deprecate this method and define a better one, since it is ill defined: (1) caller has to know the Interop namespace name (2) only instance paths are returned (3) the "deep" argument is not used
- Parameters:
pNamespacePath
- CIM namespace path of the namespace used to enumerate the CIM_NameSpace instances. The Interop namespace of a CIM server is supposed to support this. The name of the Interop namespace can be obtained by SLP discovery. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used.pDeep
- Not used.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMInstancePath
objects referencing the enumerated CIM_NameSpace instances using intra-namespace CIM instance paths (model paths).
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration enumQualifierTypes(CIMObjectPath pNamespacePath) throws CIMException
Enumerates the CIM qualifier declarations in a namespace on the target CIM server. The namespace must exist.
- Parameters:
pNamespacePath
- CIM namespace path. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. Must not be null.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMQualifierType
objects.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration enumerateClassNames() throws CIMException
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns CIM class paths to these classes. This method produces the same results asenumerateClassNames(null, false)
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMObjectPath
objects referencing the enumerated classes using intra-namespace CIM class paths (class names).
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration enumerateClassNames(CIMObjectPath pClassPath) throws CIMException
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns CIM class paths to these classes. This method produces the same results asenumerateClassNames(pClassPath, false)
- Parameters:
pClassPath
- CIM class path to the CIM class whose subclasses will be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. If the classname attribute is an empty string, enumeration starts at the top of the class hierarchy, so that the immediate subclasses are the top level classes of the hierarchy. If the classname attribute is a valid class name, the class must exist in the namespace and enumeration starts at that class.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMObjectPath
objects referencing the enumerated classes using intra-namespace CIM class paths (class names).
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration enumerateClassNames(CIMObjectPath pClassPath, boolean pDeepInheritance) throws CIMException
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns CIM class paths to these classes.
- Parameters:
pClassPath
- CIM class path to the CIM class whose subclasses will be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. If the classname attribute is an empty string, enumeration starts at the top of the class hierarchy, so that the immediate subclasses are the top level classes of the hierarchy. If the classname attribute is a valid class name, the class must exist in the namespace and enumeration starts at that class.pDeepInheritance
- Controls the set of returned subclasses. If true, all subclasses of the specified class will be returned, down to the leaves of the class hierarchy. If false, only immediate subclasses of the specified class will be returned. Note that this definition ofpDeepInheritance
applies only to the methods for class enumeration and is different from its usage in the methods for instance enumeration.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMObjectPath
objects referencing the enumerated classes using intra-namespace CIM class paths (class names).
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration enumerateClasses() throws CIMException
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes. This method produces the same results asenumerateClasses(null, false, true, true, false)
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMClass
objects.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration enumerateClasses(CIMObjectPath pClassPath) throws CIMException
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes. This method produces the same results asenumerateClasses(pClassPath, false, true, true, false)
- Parameters:
pClassPath
- CIM class path to the CIM class whose subclasses will be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. If the classname attribute is an empty string, enumeration starts at the top of the class hierarchy, so that the immediate subclasses are the top level classes of the hierarchy. If the classname attribute is a valid class name, the class must exist in the namespace and enumeration starts at that class.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMClass
objects.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration enumerateClasses(CIMObjectPath pClassPath, boolean pDeepInheritance) throws CIMException
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes. This method produces the same results asenumerateClasses(pClassPath, pDeepInheritance, true, true, false)
- Parameters:
pClassPath
- CIM class path to the CIM class whose subclasses will be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. If the classname attribute is an empty string, enumeration starts at the top of the class hierarchy, so that the immediate subclasses are the top level classes of the hierarchy. If the classname attribute is a valid class name, the class must exist in the namespace and enumeration starts at that class.pDeepInheritance
- Controls the set of returned subclasses. If true, all subclasses of the specified class will be returned, down to the leaves of the class hierarchy. If false, only immediate subclasses of the specified class will be returned. Note that this definition ofpDeepInheritance
applies only to the methods for class enumeration and is different from its usage in the methods for instance enumeration.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMClass
objects.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration enumerateClasses(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly) throws CIMException
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes. This method produces the same results asenumerateClasses(pClassPath, pDeepInheritance, pLocalOnly, true, false)
- Parameters:
pClassPath
- CIM class path to the CIM class whose subclasses will be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. If the classname attribute is an empty string, enumeration starts at the top of the class hierarchy, so that the immediate subclasses are the top level classes of the hierarchy. If the classname attribute is a valid class name, the class must exist in the namespace and enumeration starts at that class.pDeepInheritance
- Controls the set of returned subclasses. If true, all subclasses of the specified class will be returned, down to the leaves of the class hierarchy. If false, only immediate subclasses of the specified class will be returned. Note that this definition ofpDeepInheritance
applies only to the methods for class enumeration and is different from its usage in the methods for instance enumeration.pLocalOnly
- Allows to restrict the set of properties present in the returned classes. If false, the set of properties will not be restricted by this parameter. If true, the set of properties will be restricted to those defined or overridden within the definition of the specified class.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMClass
objects.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration enumerateClasses(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly, boolean pIncludeQualifiers) throws CIMException
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes. This method produces the same results asenumerateClasses(pClassPath, pDeepInheritance, pLocalOnly, pIncludeQualifiers, false)
- Parameters:
pClassPath
- CIM class path to the CIM class whose subclasses will be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. If the classname attribute is an empty string, enumeration starts at the top of the class hierarchy, so that the immediate subclasses are the top level classes of the hierarchy. If the classname attribute is a valid class name, the class must exist in the namespace and enumeration starts at that class.pDeepInheritance
- Controls the set of returned subclasses. If true, all subclasses of the specified class will be returned, down to the leaves of the class hierarchy. If false, only immediate subclasses of the specified class will be returned. Note that this definition ofpDeepInheritance
applies only to the methods for class enumeration and is different from its usage in the methods for instance enumeration.pLocalOnly
- Allows to restrict the set of properties present in the returned classes. If false, the set of properties will not be restricted by this parameter. If true, the set of properties will be restricted to those defined or overridden within the definition of the specified class.pIncludeQualifiers
- If false, no CIM qualifiers will be included. If true, all CIM qualifiers for the specified class (including qualifiers on the class and on any returned properties, methods or method parameters) will be included in the returned classes.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMClass
objects.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration enumerateClasses(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin) throws CIMException
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes.
- Parameters:
pClassPath
- CIM class path to the CIM class whose subclasses will be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. If the classname attribute is an empty string, enumeration starts at the top of the class hierarchy, so that the immediate subclasses are the top level classes of the hierarchy. If the classname attribute is a valid class name, the class must exist in the namespace and enumeration starts at that class.pDeepInheritance
- Controls the set of returned subclasses. If true, all subclasses of the specified class will be returned, down to the leaves of the class hierarchy. If false, only immediate subclasses of the specified class will be returned. Note that this definition ofpDeepInheritance
applies only to the methods for class enumeration and is different from its usage in the methods for instance enumeration.pLocalOnly
- Allows to restrict the set of properties present in the returned classes. If false, the set of properties will not be restricted by this parameter. If true, the set of properties will be restricted to those defined or overridden within the definition of the specified class.pIncludeQualifiers
- If false, no CIM qualifiers will be included. If true, all CIM qualifiers for the specified class (including qualifiers on the class and on any returned properties, methods or method parameters) will be included in the returned classes.pIncludeClassOrigin
- If true, class origin information will be present in the returned classes. Class origin information indicates the class in which a CIM property, method, or reference was first defined in the class hierarchy. It can be retrieved from the Java objects representing these CIM elements by means of thegetOriginClass()
method. If false, class origin information will not be present in the returned classes.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMClass
objects.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration enumerateInstanceNames(CIMObjectPath pClassPath) throws CIMException
Enumerates the CIM instances on the target CIM server that are of the specified class or its subclasses and returns CIM instance paths to these instances.
- Parameters:
pClassPath
- CIM class path to the CIM class whose instances will be enumerated. Instances of its subclasses in the same namespace will also be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM class must exist.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMObjectPath
objects referencing the enumerated instances using intra-namespace CIM instance paths (model paths).
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration enumerateInstances(CIMObjectPath pClassPath) throws CIMException
Enumerates the CIM instances on the target CIM server that are of the specified class or its subclasses and returns copies of these instances. This method produces the same results asenumerateInstances(pClassPath, true, true, false, false, null)
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated thepLocalOnly
parameter. It is recommended that CIM client applications setpLocalOnly
tofalse
. Therefore, it is not recommended that CIM client applications use this flavor ofenumerateInstances
.
- Parameters:
pClassPath
- CIM class path to the CIM class whose instances will be enumerated. Instances of its subclasses in the same namespace will also be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM class must exist.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMInstance
objects.
- Throws:
CIMException
- with one of these CIM status codes:
- See Also:
enumerateInstances(CIMObjectPath, boolean, boolean, boolean, boolean, String[])
public Enumeration enumerateInstances(CIMObjectPath pClassPath, boolean pDeepInheritance) throws CIMException
Enumerates the CIM instances on the target CIM server that are of the specified class or its subclasses and returns copies of these instances. This method produces the same results asenumerateInstances(pClassPath, pDeepInheritance, false, false, false, null)
- Parameters:
pClassPath
- CIM class path to the CIM class whose instances will be enumerated. Instances of its subclasses in the same namespace will also be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM class must exist.pDeepInheritance
- Allows to restrict the set of properties present in the returned instances. If true, the set of properties will not be restricted by this parameter. If false, the set of properties will be restricted such that any properties in subclasses of the specified class are removed. When combined with other property restriction filters, all restrictions are accumulated. Note: There is an erroneous interpretation of this parameter which consists in believing that the parameter removes all instances of subclasses from the enumerated set of instances. This is wrong as it does not remove such instances, instead it removes their subclass properties.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMInstance
objects.
- Throws:
CIMException
- with one of these CIM status codes:
- See Also:
enumerateInstances(CIMObjectPath, boolean, boolean, boolean, boolean, String[])
public Enumeration enumerateInstances(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly) throws CIMException
Enumerates the CIM instances on the target CIM server that are of the specified class or its subclasses and returns copies of these instances. This method produces the same results asenumerateInstances(pClassPath, pDeepInheritance, localOnly, false, false, null)
- Parameters:
pClassPath
- CIM class path to the CIM class whose instances will be enumerated. Instances of its subclasses in the same namespace will also be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM class must exist.pDeepInheritance
- Allows to restrict the set of properties present in the returned instances. If true, the set of properties will not be restricted by this parameter. If false, the set of properties will be restricted such that any properties in subclasses of the specified class are removed. When combined with other property restriction filters, all restrictions are accumulated. Note: There is an erroneous interpretation of this parameter which consists in believing that the parameter removes all instances of subclasses from the enumerated set of instances. This is wrong as it does not remove such instances, instead it removes their subclass properties.pLocalOnly
- Allows to restrict the set of properties present in the returned instances. If false, the set of properties will not be restricted by this parameter. If true, the set of properties will be restricted in a way that dependens on the CIM server implementation. When combined with other property restriction filters, all restrictions are accumulated.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. It is recommended that CIM client applications setpLocalOnly
tofalse
and not to rely onpLocalOnly
filtering. To minimize the impact of implementing this recommendation in CIM client applications, a CIM server may choose to treat the value ofpLocalOnly
asfalse
, regardless how it is actually set in an operation. Details: In DSP0200 V1.0, the pLocalOnly parameter was specified ambiguously. In DSP0200 V1.1, the definition of the pLocalOnly parameter was modified with the intent to clarify the ambiguity, so that it now restricted the set of properties to those of the specified class (removing any properties of its superclasses). This change introduced backward compatibility problems for CIM client applications when working with CIM servers that implementedpLocalOnly
support with the (quite common) interpretation of the V1.0 definition that restricted the set of properties to those defined in the CIM class of each instance and its superclasses. In DSP0200 V1.2, a CIM server must consistently support a single interpretation of thepLocalOnly
parameter, but which one is left open.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMInstance
objects.
- Throws:
CIMException
- with one of these CIM status codes:
- See Also:
enumerateInstances(CIMObjectPath, boolean, boolean, boolean, boolean, String[])
public Enumeration enumerateInstances(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly, boolean pIncludeQualifiers) throws CIMException
Enumerates the CIM instances on the target CIM server that are of the specified class or its subclasses and returns copies of these instances. This method produces the same results asenumerateInstances(pClassPath, pDeepInheritance, pLocalOnly, pIncludeQualifiers, false, null)
- Parameters:
pClassPath
- CIM class path to the CIM class whose instances will be enumerated. Instances of its subclasses in the same namespace will also be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM class must exist.pDeepInheritance
- Allows to restrict the set of properties present in the returned instances. If true, the set of properties will not be restricted by this parameter. If false, the set of properties will be restricted such that any properties in subclasses of the specified class are removed. When combined with other property restriction filters, all restrictions are accumulated. Note: There is an erroneous interpretation of this parameter which consists in believing that the parameter removes all instances of subclasses from the enumerated set of instances. This is wrong as it does not remove such instances, instead it removes their subclass properties.pLocalOnly
- Allows to restrict the set of properties present in the returned instances. If false, the set of properties will not be restricted by this parameter. If true, the set of properties will be restricted in a way that dependens on the CIM server implementation. When combined with other property restriction filters, all restrictions are accumulated.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. It is recommended that CIM client applications setpLocalOnly
tofalse
and not to rely onpLocalOnly
filtering. To minimize the impact of implementing this recommendation in CIM client applications, a CIM server may choose to treat the value ofpLocalOnly
asfalse
, regardless how it is actually set in an operation. Details: In DSP0200 V1.0, the pLocalOnly parameter was specified ambiguously. In DSP0200 V1.1, the definition of the pLocalOnly parameter was modified with the intent to clarify the ambiguity, so that it now restricted the set of properties to those of the specified class (removing any properties of its superclasses). This change introduced backward compatibility problems for CIM client applications when working with CIM servers that implementedpLocalOnly
support with the (quite common) interpretation of the V1.0 definition that restricted the set of properties to those defined in the CIM class of each instance and its superclasses. In DSP0200 V1.2, a CIM server must consistently support a single interpretation of thepLocalOnly
parameter, but which one is left open.pIncludeQualifiers
- If false, no qualifiers will be included. If true, all qualifiers for each object will be included in the objects returned.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. The preferred way to retrieve qualifier information is to use the class operations (for example,getClass
) instead, and to set this parameter tofalse
.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMInstance
objects.
- Throws:
CIMException
- with one of these CIM status codes:
- See Also:
enumerateInstances(CIMObjectPath, boolean, boolean, boolean, boolean, String[])
public Enumeration enumerateInstances(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin) throws CIMException
Enumerates the CIM instances on the target CIM server that are of the specified class or its subclasses and returns copies of these instances. This method produces the same results asenumerateInstances(pClassPath, pDeepInheritance, pLocalOnly, pIncludeQualifiers, pIncludeClassOrigin, null)
- Parameters:
pClassPath
- CIM class path to the CIM class whose instances will be enumerated. Instances of its subclasses in the same namespace will also be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM class must exist.pDeepInheritance
- Allows to restrict the set of properties present in the returned instances. If true, the set of properties will not be restricted by this parameter. If false, the set of properties will be restricted such that any properties in subclasses of the specified class are removed. When combined with other property restriction filters, all restrictions are accumulated. Note: There is an erroneous interpretation of this parameter which consists in believing that the parameter removes all instances of subclasses from the enumerated set of instances. This is wrong as it does not remove such instances, instead it removes their subclass properties.pLocalOnly
- Allows to restrict the set of properties present in the returned instances. If false, the set of properties will not be restricted by this parameter. If true, the set of properties will be restricted in a way that dependens on the CIM server implementation. When combined with other property restriction filters, all restrictions are accumulated.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. It is recommended that CIM client applications setpLocalOnly
tofalse
and not to rely onpLocalOnly
filtering. To minimize the impact of implementing this recommendation in CIM client applications, a CIM server may choose to treat the value ofpLocalOnly
asfalse
, regardless how it is actually set in an operation. Details: In DSP0200 V1.0, the pLocalOnly parameter was specified ambiguously. In DSP0200 V1.1, the definition of the pLocalOnly parameter was modified with the intent to clarify the ambiguity, so that it now restricted the set of properties to those of the specified class (removing any properties of its superclasses). This change introduced backward compatibility problems for CIM client applications when working with CIM servers that implementedpLocalOnly
support with the (quite common) interpretation of the V1.0 definition that restricted the set of properties to those defined in the CIM class of each instance and its superclasses. In DSP0200 V1.2, a CIM server must consistently support a single interpretation of thepLocalOnly
parameter, but which one is left open.pIncludeQualifiers
- If false, no qualifiers will be included. If true, all qualifiers for each object will be included in the objects returned.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. The preferred way to retrieve qualifier information is to use the class operations (for example,getClass
) instead, and to set this parameter tofalse
.pIncludeClassOrigin
- If true, class origin information will be present in the returned objects. Class origin information indicates the class in which a CIM property, method, or reference was first defined in the class hierarchy. It can be retrieved from the Java objects representing these CIM elements by means of thegetOriginClass()
method. If false, class origin information will not be present in the returned objects.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMInstance
objects.
- Throws:
CIMException
- with one of these CIM status codes:
- See Also:
enumerateInstances(CIMObjectPath, boolean, boolean, boolean, boolean, String[])
public Enumeration enumerateInstances(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, java.lang.String[] pPropertyList) throws CIMException
Enumerates the CIM instances on the target CIM server that are of the specified class or its subclasses and returns copies of these instances.
- Parameters:
pClassPath
- CIM class path to the CIM class whose instances will be enumerated. Instances of its subclasses in the same namespace will also be enumerated. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM class must exist.pDeepInheritance
- Allows to restrict the set of properties present in the returned instances. If true, the set of properties will not be restricted by this parameter. If false, the set of properties will be restricted such that any properties in subclasses of the specified class are removed. When combined with other property restriction filters, all restrictions are accumulated. Note: There is an erroneous interpretation of this parameter which consists in believing that the parameter removes all instances of subclasses from the enumerated set of instances. This is wrong as it does not remove such instances, instead it removes their subclass properties.pLocalOnly
- Allows to restrict the set of properties present in the returned instances. If false, the set of properties will not be restricted by this parameter. If true, the set of properties will be restricted in a way that dependens on the CIM server implementation. When combined with other property restriction filters, all restrictions are accumulated.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. It is recommended that CIM client applications setpLocalOnly
tofalse
and not to rely onpLocalOnly
filtering. To minimize the impact of implementing this recommendation in CIM client applications, a CIM server may choose to treat the value ofpLocalOnly
asfalse
, regardless how it is actually set in an operation. Details: In DSP0200 V1.0, the pLocalOnly parameter was specified ambiguously. In DSP0200 V1.1, the definition of the pLocalOnly parameter was modified with the intent to clarify the ambiguity, so that it now restricted the set of properties to those of the specified class (removing any properties of its superclasses). This change introduced backward compatibility problems for CIM client applications when working with CIM servers that implementedpLocalOnly
support with the (quite common) interpretation of the V1.0 definition that restricted the set of properties to those defined in the CIM class of each instance and its superclasses. In DSP0200 V1.2, a CIM server must consistently support a single interpretation of thepLocalOnly
parameter, but which one is left open.pIncludeQualifiers
- If false, no qualifiers will be included. If true, all qualifiers for each object will be included in the objects returned.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. The preferred way to retrieve qualifier information is to use the class operations (for example,getClass
) instead, and to set this parameter tofalse
.pIncludeClassOrigin
- If true, class origin information will be present in the returned objects. Class origin information indicates the class in which a CIM property, method, or reference was first defined in the class hierarchy. It can be retrieved from the Java objects representing these CIM elements by means of thegetOriginClass()
method. If false, class origin information will not be present in the returned objects.pPropertyList
- An array of CIM property names that allows to restrict the set of properties in the returned objects (classes or instances). If null, the set of properties will not be restricted by this parameter. If not null, the set of properties will be restricted such that any properties missing from this list will not be present in the returned objects. In this case, the members of the array must define zero or more property names of the specified class. This may include inherited property names or property names explicitly defined in the specified class, but must not include property names defined in subclasses of the specified class. Duplicate property names are tolerated and the duplicates are ignored. When combined with other property restriction filters, all restrictions are accumulated.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMInstance
objects.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration execQuery(CIMObjectPath pNamespacePath, String pQuery, String pQueryLanguage) throws CIMException
Executes a query on the target CIM server.
- Parameters:
pNamespacePath
- CIM namespace path of the namespace used to run the query against. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used.pQuery
- Query in the specified query language.pQueryLanguage
- Identifier for the query language. CIM clients can interrogate which query languages a CIM server supports, as described in the CIM Operations over HTTP specification [DSP0200] (4.5.2 "Determining CIM Server Capabilities through the HTTP Options"). Typical identifiers for query languages are:
- Returns:
- An enumeration containing the query result
- Throws:
CIMException
-
public CIMClass getClass(CIMObjectPath pClassPath) throws CIMException
Gets a copy of a CIM class from the target CIM server. This method produces the same results asgetClass(pClassPath, true, true, false, null)
- Parameters:
pClassPath
- CIM class path to the CIM class to be returned. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM class must exist.
- Returns:
- A
CIMClass
object.
- Throws:
CIMException
- with one of these CIM status codes:
- See Also:
getClass(CIMObjectPath, boolean, boolean, boolean, String[])
public CIMClass getClass(CIMObjectPath pClassPath, boolean pLocalOnly) throws CIMException
Gets a copy of a CIM class from the target CIM server. This method produces the same results asgetClass(pClassPath, pLocalOnly, true, false, null)
- Parameters:
pClassPath
- CIM class path to the CIM class to be returned. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM class must exist.pLocalOnly
- Allows to restrict the set of properties present in the returned class. If false, the set of properties will not be restricted by this parameter. If true, the set of properties will be restricted to those defined or overridden within the definition of the specified class. When combined with other property restriction filters, all restrictions are accumulated.
- Returns:
- A
CIMClass
object.
- Throws:
CIMException
- with one of these CIM status codes:
- See Also:
getClass(CIMObjectPath, boolean, boolean, boolean, String[])
public CIMClass getClass(CIMObjectPath pClassPath, boolean pLocalOnly, boolean pIncludeQualifiers) throws CIMException
Gets a copy of a CIM class from the target CIM server. This method produces the same results asgetClass(pClassPath, pLocalOnly, pIncludeQualifiers, false, null)
- Parameters:
pClassPath
- CIM class path to the CIM class to be returned. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM class must exist.pLocalOnly
- Allows to restrict the set of properties present in the returned class. If false, the set of properties will not be restricted by this parameter. If true, the set of properties will be restricted to those defined or overridden within the definition of the specified class. When combined with other property restriction filters, all restrictions are accumulated.pIncludeQualifiers
- If false, no CIM qualifiers will be included. If true, all CIM qualifiers for the specified class (including qualifiers on the class and on any returned properties, methods or method parameters) will be included in the returned class.
- Returns:
- A
CIMClass
object.
- Throws:
CIMException
- with one of these CIM status codes:
- See Also:
getClass(CIMObjectPath, boolean, boolean, boolean, String[])
public CIMClass getClass(CIMObjectPath pClassPath, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin) throws CIMException
Gets a copy of a CIM class from the target CIM server. This method produces the same results asgetClass(pClassPath, pLocalOnly, pIncludeQualifiers, pIncludeClassOrigin, null)
- Parameters:
pClassPath
- CIM class path to the CIM class to be returned. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM class must exist.pLocalOnly
- Allows to restrict the set of properties present in the returned class. If false, the set of properties will not be restricted by this parameter. If true, the set of properties will be restricted to those defined or overridden within the definition of the specified class. When combined with other property restriction filters, all restrictions are accumulated.pIncludeQualifiers
- If false, no CIM qualifiers will be included. If true, all CIM qualifiers for the specified class (including qualifiers on the class and on any returned properties, methods or method parameters) will be included in the returned class.pIncludeClassOrigin
- If true, class origin information will be present in the returned class. Class origin information indicates the class in which a CIM property, method, or reference was first defined in the class hierarchy. It can be retrieved from the Java objects representing these CIM elements by means of thegetOriginClass()
method. If false, class origin information will not be present in the returned class.
- Returns:
- A
CIMClass
object.
- Throws:
CIMException
- with one of these CIM status codes:
- See Also:
getClass(CIMObjectPath, boolean, boolean, boolean, String[])
public CIMClass getClass(CIMObjectPath pClassPath, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, java.lang.String[] pPropertyList) throws CIMException
Gets a copy of a CIM class from the target CIM server.
- Parameters:
pClassPath
- CIM class path to the CIM class to be returned. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM class must exist.pLocalOnly
- Allows to restrict the set of properties present in the returned class. If false, the set of properties will not be restricted by this parameter. If true, the set of properties will be restricted to those defined or overridden within the definition of the specified class. When combined with other property restriction filters, all restrictions are accumulated.pIncludeQualifiers
- If false, no CIM qualifiers will be included. If true, all CIM qualifiers for the specified class (including qualifiers on the class and on any returned properties, methods or method parameters) will be included in the returned class.pIncludeClassOrigin
- If true, class origin information will be present in the returned class. Class origin information indicates the class in which a CIM property, method, or reference was first defined in the class hierarchy. It can be retrieved from the Java objects representing these CIM elements by means of thegetOriginClass()
method. If false, class origin information will not be present in the returned class.pPropertyList
- An array of CIM property names that allows to restrict the set of properties in the returned class. If null, the set of properties will not be restricted by this parameter. If not null, the set of properties will be restricted such that any properties missing from this list will not be present in the returned class. In this case, the members of the array must define zero or more property names of the specified class. Duplicate property names are tolerated and the duplicates are ignored. When combined with other property restriction filters, all restrictions are accumulated.
- Returns:
- A
CIMClass
object.
- Throws:
CIMException
- with one of these CIM status codes:
public CIMInstance getIndicationHandler(CIMListener pListener) throws CIMException
This methods return an instance of CIM_IndicationHandler, since CIM over HTTP is used as transport an instance of CIM_IndicationHandlerCIMXML is returned. TODO Docu: Improve documentation.
- Parameters:
pListener
- CIMListener for which the CIM)IndicationHandler subclass is being returned, which is used to deliver indications to the specific listener. Unique listeners should return unique values in their hashCode methods in order to be differenciate themself from other CIMListeners.
- Returns:
- CIMInstance an CIM Instance of the indication handler.
- Throws:
CIMException
- if unsuccessful, one of the error codes must be returned. CIM_ERR_ACCESS_DENIED CIM_ERR_INVALID_PARAMETER CIM_ERR_FAILED (some unspecified error) or the CIMListener server fails to load
public CIMInstance getIndicationListener(CIMListener pListener) throws CIMException
This methods return an instance of CIM_IndicationDestination, since CIM over HTTP is used as transport an instance of CIM_ListenerDestinationCIMXML is returned. TODO Docu: Improve documentation.
- Parameters:
pListener
- CIMListener for which the CIM_IndicationHandler subclass is being returned, which is used to deliver indications to the specific listener. Unique listeners should return unique values in their hashCode methods in order to be differenciate themself from other CIMListeners.
- Returns:
- CIMInstance an instance of the CIM_IndicationDestination
- Throws:
CIMException
- if unsuccessful, one of the error codes must be returned. CIM_ERR_ACCESS_DENIED CIM_ERR_INVALID_PARAMETER CIM_ERR_FAILED (some unspecified error) or the CIMListener server fails to load
public CIMInstance getInstance(CIMObjectPath pInstancePath) throws CIMException
Gets a copy of a CIM instance from the target CIM server. This method produces the same results asgetInstance(pInstancePath, true, false, false, null)
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated thepLocalOnly
parameter. It is recommended that CIM client applications setpLocalOnly
tofalse
. Therefore, it is not recommended that CIM client applications use this flavor ofgetInstance
.
- Parameters:
pInstancePath
- CIM instance path to the CIM instance to be returned. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM instance must exist.
- Returns:
- A
CIMInstance
object.
- Throws:
CIMException
- with one of these CIM status codes:
- See Also:
getInstance(CIMObjectPath, boolean, boolean, boolean, String[])
public CIMInstance getInstance(CIMObjectPath pInstancePath, boolean pLocalOnly) throws CIMException
Gets a copy of a CIM instance. This method produces the same results asgetInstance(pInstancePath, pLocalOnly, false, false, null)
- Parameters:
pInstancePath
- CIM instance path to the CIM instance to be returned. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM instance must exist.pLocalOnly
- Allows to restrict the set of properties present in the returned instance. If false, the set of properties will not be restricted by this parameter. If true, the set of properties will be restricted in a way that dependens on the CIM server implementation. When combined with other property restriction filters, all restrictions are accumulated.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. It is recommended that CIM client applications setpLocalOnly
tofalse
and not to rely onpLocalOnly
filtering. To minimize the impact of implementing this recommendation in CIM client applications, a CIM server may choose to treat the value ofpLocalOnly
asfalse
, regardless how it is actually set in an operation. Details: In DSP0200 V1.0, the pLocalOnly parameter was specified ambiguously. In DSP0200 V1.1, the definition of the pLocalOnly parameter was modified with the intent to clarify the ambiguity, so that it now restricted the set of properties to those of the specified class (removing any properties of its superclasses). This change introduced backward compatibility problems for CIM client applications when working with CIM servers that implementedpLocalOnly
support with the (quite common) interpretation of the V1.0 definition that restricted the set of properties to those defined in the CIM class of each instance and its superclasses. In DSP0200 V1.2, a CIM server must consistently support a single interpretation of thepLocalOnly
parameter, but which one is left open.
- Returns:
- A
CIMInstance
object.
- Throws:
CIMException
- with one of these CIM status codes:
- See Also:
getInstance(CIMObjectPath, boolean, boolean, boolean, String[])
public CIMInstance getInstance(CIMObjectPath pInstancePath, boolean pLocalOnly, boolean pIncludeQualifiers) throws CIMException
Gets a copy of a CIM instance from the target CIM server. This method produces the same results asgetInstance(pObjectPath, pLocalOnly, pIncludeQualifiers, false, null)
- Parameters:
pInstancePath
- CIM instance path to the CIM instance to be returned. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM instance must exist.pLocalOnly
- Allows to restrict the set of properties present in the returned instance. If false, the set of properties will not be restricted by this parameter. If true, the set of properties will be restricted in a way that dependens on the CIM server implementation. When combined with other property restriction filters, all restrictions are accumulated.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. It is recommended that CIM client applications setpLocalOnly
tofalse
and not to rely onpLocalOnly
filtering. To minimize the impact of implementing this recommendation in CIM client applications, a CIM server may choose to treat the value ofpLocalOnly
asfalse
, regardless how it is actually set in an operation. Details: In DSP0200 V1.0, the pLocalOnly parameter was specified ambiguously. In DSP0200 V1.1, the definition of the pLocalOnly parameter was modified with the intent to clarify the ambiguity, so that it now restricted the set of properties to those of the specified class (removing any properties of its superclasses). This change introduced backward compatibility problems for CIM client applications when working with CIM servers that implementedpLocalOnly
support with the (quite common) interpretation of the V1.0 definition that restricted the set of properties to those defined in the CIM class of each instance and its superclasses. In DSP0200 V1.2, a CIM server must consistently support a single interpretation of thepLocalOnly
parameter, but which one is left open.pIncludeQualifiers
- If false, no qualifiers will be included. If true, all qualifiers of the instance will be included in the instance returned.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. The preferred way to retrieve qualifier information is to use the class operations (for example,getClass
) instead, and to set this parameter tofalse
.
- Returns:
- A
CIMInstance
object.
- Throws:
CIMException
- with one of these CIM status codes:
- See Also:
getInstance(CIMObjectPath, boolean, boolean, boolean, String[])
public CIMInstance getInstance(CIMObjectPath pInstancePath, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin) throws CIMException
Gets a copy of a CIM instance from the target CIM server. This method produces the same results asgetInstance(pInstancePath, pLocalOnly, pIncludeQualifiers, pIncludeClassOrigin, null)
- Parameters:
pInstancePath
- CIM instance path to the CIM instance to be returned. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM instance must exist.pLocalOnly
- Allows to restrict the set of properties present in the returned instance. If false, the set of properties will not be restricted by this parameter. If true, the set of properties will be restricted in a way that dependens on the CIM server implementation. When combined with other property restriction filters, all restrictions are accumulated.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. It is recommended that CIM client applications setpLocalOnly
tofalse
and not to rely onpLocalOnly
filtering. To minimize the impact of implementing this recommendation in CIM client applications, a CIM server may choose to treat the value ofpLocalOnly
asfalse
, regardless how it is actually set in an operation. Details: In DSP0200 V1.0, the pLocalOnly parameter was specified ambiguously. In DSP0200 V1.1, the definition of the pLocalOnly parameter was modified with the intent to clarify the ambiguity, so that it now restricted the set of properties to those of the specified class (removing any properties of its superclasses). This change introduced backward compatibility problems for CIM client applications when working with CIM servers that implementedpLocalOnly
support with the (quite common) interpretation of the V1.0 definition that restricted the set of properties to those defined in the CIM class of each instance and its superclasses. In DSP0200 V1.2, a CIM server must consistently support a single interpretation of thepLocalOnly
parameter, but which one is left open.pIncludeQualifiers
- If false, no qualifiers will be included. If true, all qualifiers of the instance will be included in the instance returned.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. The preferred way to retrieve qualifier information is to use the class operations (for example,getClass
) instead, and to set this parameter tofalse
.pIncludeClassOrigin
- If true, class origin information will be present in the returned instance. Class origin information indicates the class in which a CIM property, method, or reference was first defined in the class hierarchy. It can be retrieved from the Java objects representing these CIM elements by means of thegetOriginClass()
method. If false, class origin information will not be present in the returned instance.
- Returns:
- A
CIMInstance
object.
- Throws:
CIMException
- with one of these CIM status codes:
- See Also:
getInstance(CIMObjectPath, boolean, boolean, boolean, String[])
public CIMInstance getInstance(CIMObjectPath pInstancePath, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, java.lang.String[] pPropertyList) throws CIMException
Gets a copy of a CIM instance from the target CIM server.
- Parameters:
pInstancePath
- CIM instance path to the CIM instance to be returned. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM instance must exist.pLocalOnly
- Allows to restrict the set of properties present in the returned instance. If false, the set of properties will not be restricted by this parameter. If true, the set of properties will be restricted in a way that dependens on the CIM server implementation. When combined with other property restriction filters, all restrictions are accumulated.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. It is recommended that CIM client applications setpLocalOnly
tofalse
and not to rely onpLocalOnly
filtering. To minimize the impact of implementing this recommendation in CIM client applications, a CIM server may choose to treat the value ofpLocalOnly
asfalse
, regardless how it is actually set in an operation. Details: In DSP0200 V1.0, the pLocalOnly parameter was specified ambiguously. In DSP0200 V1.1, the definition of the pLocalOnly parameter was modified with the intent to clarify the ambiguity, so that it now restricted the set of properties to those of the specified class (removing any properties of its superclasses). This change introduced backward compatibility problems for CIM client applications when working with CIM servers that implementedpLocalOnly
support with the (quite common) interpretation of the V1.0 definition that restricted the set of properties to those defined in the CIM class of each instance and its superclasses. In DSP0200 V1.2, a CIM server must consistently support a single interpretation of thepLocalOnly
parameter, but which one is left open.pIncludeQualifiers
- If false, no qualifiers will be included. If true, all qualifiers of the instance will be included in the instance returned.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. The preferred way to retrieve qualifier information is to use the class operations (for example,getClass
) instead, and to set this parameter tofalse
.pIncludeClassOrigin
- If true, class origin information will be present in the returned instance. Class origin information indicates the class in which a CIM property, method, or reference was first defined in the class hierarchy. It can be retrieved from the Java objects representing these CIM elements by means of thegetOriginClass()
method. If false, class origin information will not be present in the returned instance.pPropertyList
- An array of CIM property names that allows to restrict the set of properties in the returned instance. If null, the set of properties will not be restricted by this parameter. If not null, the set of properties will be restricted such that any properties missing from this list will not be present in the returned instance. In this case, the members of the array must define zero or more property names of the specified instance. Duplicate property names are tolerated and the duplicates are ignored. When combined with other property restriction filters, all restrictions are accumulated.
- Returns:
- A
CIMInstance
object.
- Throws:
CIMException
- with one of these CIM status codes:
public Locale getLocale()
Gets the current locale information of the CIM client. The initial locale information (that is, without any invocations ofsetLocale
) is the valueLocale.getDefault()
.
- Returns:
- Current locale information.
public CIMNameSpace getNameSpace()
Gets the default CIM namespace associated with this CIM client.
- Returns:
- A
CIMNameSpace
object containing the default namespace in its namespace attribute.
public CIMValue getProperty(CIMObjectPath pInstancePath, String pPropertyName) throws CIMException
Gets a copy of a property value of a CIM instance on the target CIM server.
- Parameters:
pInstancePath
- CIM instance path to the CIM instance containing the property. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM instance must exist.pPropertyName
- Name of the CIM property to be returned. The property must be defined on the class of the CIM instance.
- Returns:
- A
CIMValue
object.
- Throws:
CIMException
- with one of these CIM status codes:
public CIMQualifierType getQualifierType(CIMObjectPath pQualifierPath) throws CIMException
Gets a copy of a CIM qualifier declaration from the target CIM server. The CIM qualifier declaration must exist.
- Parameters:
pQualifierPath
- CIM qualifier path (a class path used to specify the qualifier name in the class attribute). Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. Must not be null.
- Returns:
- A
CIMQualifierType
object.
- Throws:
CIMException
- with one of these CIM status codes:
public SessionProperties getSessionProperties()
Gets the session properties of the CIM client. If this CIM client is associated with the global properties this method returnsnull
- Returns:
- The session properties
public CIMValue invokeMethod(CIMObjectPath pObjectPath, String pMethodName, Vector pInputArguments, Vector pOutputArguments) throws CIMException
Invokes the specified CIM method on a CIM object (instance or class) on the target CIM server.
- Parameters:
pObjectPath
- CIM object path to the CIM object (instance or class) on which the method is to be invoked. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM object must exist. If the CIM method is static, pObjectPath must reference a CIM class. If the CIM method is not static, pObjectPath must reference a CIM instance.pMethodName
- Name of the CIM method to be invoked. The method must be defined on the class.pInputArguments
- Input parameters of the CIM method, as a vector containing aCIMArgument
member for each parameter. The set of parameters must match the CIM method definition for its input parameters. Must not be null. If a method has no input parameters, an empty vector must be supplied.pOutputArguments
- Output parameters of the CIM method, as a vector containing aCIMArgument
member for each parameter. The caller supplies an empty vector, and the set of parameters returned will match the CIM method definition for its output parameters. Must not be null. If a method has no output parameters, an empty vector will be returned.
- Returns:
- A
CIMValue
object representing the return value of the CIM method.
- Throws:
CIMException
- with one of these CIM status codes:
public CIMValue invokeMethod(CIMObjectPath pObjectPath, String pMethodName, CIMArgument[] pInputArguments, CIMArgument[] pOutputArguments) throws CIMException
Deprecated. It is not recommended to use this method, since the number of output parameters may be extended by the CIM provider in the future. Instead, use
invokeMethod(CIMObjectPath,String,Vector,Vector)
.Invokes the specified CIM method on a CIM object (instance or class) on the target CIM server.
- Parameters:
pObjectPath
- CIM object path to the CIM object (instance or class) on which the method is to be invoked. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM object must exist. If the CIM method is static, pObjectPath must reference a CIM class. If the CIM method is not static, pObjectPath must reference a CIM instance.pMethodName
- Name of the CIM method to be invoked. The method must be defined on the class.pInputArguments
- Input parameters of the CIM method, as a vector containing aCIMArgument
member for each parameter. The set of parameters must match the CIM method definition for its input parameters. Must not be null. If a method has no input parameters, an empty vector must be supplied.pOutputArguments
- Output parameters of the CIM method, as a vector containing aCIMArgument
member for each parameter. The caller supplies an empty vector, and the set of parameters returned will match the CIM method definition for its output parameters. Must not be null. If a method has no output parameters, an empty vector will be returned.
- Returns:
- A
CIMValue
object representing the return value of the CIM method.
- Throws:
CIMException
- with one of these CIM status codes:
public BatchResult performBatchOperations(BatchHandle pBatchHandle) throws CIMException
Performs the operations specified in the BatchHandle object. This is a multi-operation as specified in the CIM Operations over HTTP specification [DSP0200]. The operations are executed by the server one by one in the specified order. The next operation is started only once the previous operation has completed. It is not defined whether the CIM server stops processing the sequence upon any error encountered, or continues with the next operation in a "best effort" way of processing. Multi-operations do not guarantee any transactional capabilities. For example, there is no guarantee that the single operations either all fail or all succeed. Not all CIM servers support multi-operations. CIM client applications can figure out support for multi-operations as described in CIM Operations over HTTP specification [DSP0200] (4.5.2 "Determining CIM Server Capabilities through the HTTP Options").
- Parameters:
pBatchHandle
- Batch handle with the set of operations to be performed.
- Returns:
- A
BatchResult
object with the results of these operations.
- Throws:
CIMException
- with any one of the possible CIM status codes.
public Enumeration referenceNames(CIMObjectPath pObjectPath) throws CIMException
Enumerates the CIM asociation objects on the target CIM server that reference a particular CIM object, and returns CIM object paths to these objects. This method produces the same results asreferenceNames(pObjectPath, null, null)
- Parameters:
pObjectPath
- CIM object path to the CIM object (instance or class) referenced by the association objects to be returned. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The referenced CIM object must exist.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMObjectPath
objects referencing the enumerated association classes or instances using global CIM class or instance paths.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration referenceNames(CIMObjectPath pObjectPath, String pResultClass, String pRole) throws CIMException
Enumerates the CIM asociation objects on the target CIM server that reference a particular CIM object, and returns CIM object paths to these objects. If the referenced CIM object is an instance, then the association instances are enumerated. If the referenced CIM object is a class, then the association classes are enumerated.
- Parameters:
pObjectPath
- CIM object path to the CIM object (instance or class) referenced by the association objects to be returned. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The referenced CIM object must exist.pResultClass
- Allows to restrict the set of returned objects. If null, the set of objects will not be restricted. If not null, must be a valid CIM association class name, and the set of objects will be restricted by removing any objects that do not satisfy the following conditions: (1) If the referenced CIM object is an instance, the enumerated objects are CIM instances of the specified class or one of its subclasses. (2) If the referenced CIM object is a class, the enumerated objects are the specified class or one of its subclasses. When combined with other object restriction filters, all restrictions are accumulated.pRole
- Allows to restrict the set of returned objects. If null, the set of objects will not be restricted. If not null, must be a valid CIM property name, and the set of objects will be restricted by removing any objects that are not associations in which the referenced object plays the specified pRole (i.e. the name of the reference in the association class that refers to the referenced object must match the value of this parameter). When combined with other object restriction filters, all restrictions are accumulated.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMObjectPath
objects referencing the enumerated association classes or instances using global CIM class or instance paths.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration references(CIMObjectPath pObjectPath) throws CIMException
Enumerates the CIM asociation objects on the target CIM server that reference a particular CIM object, and returns copies of these objects. This method produces the same results asreferences(pObjectPath, null, null, true, true, null)
- Parameters:
pObjectPath
- CIM object path to the CIM object (instance or class) referenced by the association objects to be returned. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The referenced CIM object must exist.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMInstance
orCIMClass
objects.
- Throws:
CIMException
- with one of these CIM status codes:
public Enumeration references(CIMObjectPath pObjectPath, String pResultClass, String pRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws CIMException
Enumerates the CIM asociation objects on the target CIM server that reference a particular CIM object, and returns copies of these objects. If the referenced CIM object is an instance, then the association instances are enumerated. If the referenced CIM object is a class, then the association classes are enumerated.
- Parameters:
pObjectPath
- CIM object path to the CIM object (instance or class) referenced by the association objects to be returned. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The referenced CIM object must exist.pResultClass
- Allows to restrict the set of returned objects. If null, the set of objects will not be restricted. If not null, must be a valid CIM association class name, and the set of objects will be restricted by removing any objects that do not satisfy the following conditions: (1) If the referenced CIM object is an instance, the enumerated objects are CIM instances of the specified class or one of its subclasses. (2) If the referenced CIM object is a class, the enumerated objects are the specified class or one of its subclasses. When combined with other object restriction filters, all restrictions are accumulated.pRole
- Allows to restrict the set of returned objects. If null, the set of objects will not be restricted. If not null, must be a valid CIM property name, and the set of objects will be restricted by removing any objects that are not associations in which the referenced object plays the specified pRole (i.e. the name of the reference in the association class that refers to the referenced object must match the value of this parameter). When combined with other object restriction filters, all restrictions are accumulated.pIncludeQualifiers
- If false, no qualifiers will be included. If true, all qualifiers for each object will be included in the objects returned.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. The preferred way to retrieve qualifier information is to use the class operations (for example,getClass
) instead, and to set this parameter tofalse
.pIncludeClassOrigin
- If true, class origin information will be present in the returned objects. Class origin information indicates the class in which a CIM property, method, or reference was first defined in the class hierarchy. It can be retrieved from the Java objects representing these CIM elements by means of thegetOriginClass()
method. If false, class origin information will not be present in the returned objects.pPropertyList
- An array of CIM property names that allows to restrict the set of properties in the returned objects (classes or instances). If null, the set of properties will not be restricted by this parameter. If not null, the set of properties will be restricted such that any properties missing from this list will not be present in the returned objects. In this case, the members of the array must define zero or more property names of the specified class. This may include inherited property names or property names explicitly defined in the specified class, but must not include property names defined in subclasses of the specified class. Duplicate property names are tolerated and the duplicates are ignored.
- Returns:
- A
CIMEnumeration
object containing zero or moreCIMInstance
orCIMClass
objects.
- Throws:
CIMException
- with one of these CIM status codes:
public void removeCIMListener(CIMListener pListener) throws CIMException
Removes the specified CIMListener, to stop receiving indications from the CIM server.
- Parameters:
pListener
- CIMListener to be added. Must not be null.
- Throws:
CIMException
- with one of these CIM status codes:
public void setClass(CIMObjectPath pClassPath, CIMClass pModifiedClass) throws CIMException
Modifies a CIM class on the target CIM server.
- Parameters:
pClassPath
- CIM class path to the CIM class to be modified. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM class must exist. Must not be null.pModifiedClass
- CIM class definition of the modified class. Must be a valid class definition according to the CIM Infrastructure Specification [DSP0004] and must not be null. The CIM server will behave as if the previous class definition was completely removed and re-created from the modified definition. If a superclass was defined on the previous class, the modified definition must observe the following restrictions: (1) The modified definition must not define a different superclass, and the superclass must exist. (2) Qualifiers with the DisableOverride flavor must not be defined in the modified definition. Any class origin and propagated information inmodifiedClass
will be ignored (it is reconstructed by the CIM server).
- Throws:
CIMException
- with one of these CIM status codes:
public void setInstance(CIMObjectPath pInstancePath, CIMInstance pModifiedInstance) throws CIMException
Modifies a CIM instance on the target CIM server. This method produces the same results assetInstance(pInstancePath, modifiedInstance, true, null)
- Parameters:
pInstancePath
- CIM instance path to the CIM instance to be modified. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM instance must exist. Must not be null.pModifiedInstance
- CIM instance defining the new values for the properties. Must be a valid instance definition for the underlying CIM class according to the CIM Infrastructure Specification [DSP0004]. The instance may contain a subset of all properties. Any class origin and propagated information inmodifiedInstance
will be ignored (it is reconstructed by the CIM server). Any qualifiers included inmodifiedInstance
may be ignored (it is recommended that CIM servers ignore them).
Deprecation Note: The CIM Infrastructure Specification [DSP0004] V2.3 has deprecated instance level qualifiers. The preferred way to modify qualifier information is to use the class operations (for example,setClass
) instead. Must not be null.
- Throws:
CIMException
- with one of these CIM status codes:
public void setInstance(CIMObjectPath pInstancePath, CIMInstance pModifiedInstance, boolean pIncludeQualifiers, String[] pPropertyList) throws CIMException
Modifies a CIM instance on the target CIM server. The set of property values to be modified is determined bypPropertyList
. Out of that set, the properties of the instance are attempted to be modified as follows:Whether or not a modification attempt actually results in a changed property value in the instance on the CIM server depends on a number of factors:
- For any properties contained in
modifiedInstance
, the value specified there will be used as the new value (this is true also for the null value).- For any properties not specified in
modifiedInstance
, the class defined default value will be used as the new value. If there is no class defined default value, null is used as the new value.
- If the property has its WRITE qualifier effectively being false, the modification request will be silently ignored. This is always the case for any key properties.
- If the property value is dynamically created by a CIM provider (for instance, for volatile properties), the modification request may or may not be honored.
- Parameters:
pInstancePath
- CIM instance path to the CIM instance to be modified. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. The CIM instance must exist. Must not be null.pModifiedInstance
- CIM instance defining the new values for the properties. Must be a valid instance definition for the underlying CIM class according to the CIM Infrastructure Specification [DSP0004]. The instance may contain a subset of all properties. Any class origin and propagated information inmodifiedInstance
will be ignored (it is reconstructed by the CIM server). Any qualifiers included inmodifiedInstance
may be ignored (it is recommended that CIM servers ignore them).
Deprecation Note: The CIM Infrastructure Specification [DSP0004] V2.3 has deprecated instance level qualifiers. The preferred way to modify qualifier information is to use the class operations (for example,setClass
) instead. Must not be null.pIncludeQualifiers
- The behavior of this parameter is not specified. A CIM client application can not rely on it to have any impact on the operation. It is recommended that the CIM server ignore any qualifiers included in the modified instance.
Deprecation Note: The CIM Operations over HTTP specification [DSP0200] V1.2 has deprecated this parameter. The preferred way to modify qualifier information is to use the class operations (for example,setClass
) instead, and to set this parameter tofalse
.pPropertyList
- An array of CIM property names that allows to restrict the set of properties being modified. If null, the set of properties will not be restricted by this parameter. If not null, the set of properties will be restricted such that any properties missing from this list will not be modified. Duplicate property names are tolerated and the duplicates are ignored.
- Throws:
CIMException
- with one of these CIM status codes:
public void setLocale(Locale pLocale)
Modifies the locale information of the CIM client. The locale information of the CIM client is used to construct the Content-Language and Accept-Language HTTP headers. The CIM server uses these headers to translate any translatable property and qualifier values, and any localized messages.
- Parameters:
pLocale
- The new locale information. Must not be null.
public void setProperty(CIMObjectPath pInstancePath, String pPropertyName) throws CIMException
Modifies a property value of a CIM instance on the target CIM server. This method produces the same results assetProperty(pInstancePath, propertyName, null)
- Parameters:
pInstancePath
- CIM instance path to the CIM instance containing the property. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. Must not be null. The CIM instance must exist.pPropertyName
- Name of the CIM property to be modified. The property must be defined on the class of the CIM instance. Must not be null.
- Throws:
CIMException
- with one of these CIM status codes:
public void setProperty(CIMObjectPath pInstancePath, String pPropertyName, CIMValue pNewValue) throws CIMException
Modifies a property value of a CIM instance on the target CIM server. This operation is supported from a client perspective even if CIM providers do not implement it, since the CIM server will use the ModifyInstance provider operation in that case. However, the setProperty client operation should be expected to go away in the future. It is therefore recommended already now to usesetInstance(CIMObjectPath,CIMInstance,boolean,String[])
instead.
- Parameters:
pInstancePath
- CIM instance path to the CIM instance containing the property. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. Must not be null. The CIM instance must exist.pPropertyName
- Name of the CIM property to be modified. The property must be defined on the class of the CIM instance. Must not be null.pNewValue
- New value for the property. If null, sets the property value to null.
- Throws:
CIMException
- with one of these CIM status codes:
public void setQualifierType(CIMObjectPath pNamespacePath, CIMQualifierType pQualifierType) throws CIMException
Creates or replaces a CIM qualifier declaration on the target CIM server. If the qualifier declaration does not exist, it will be created. If it exists, it will be replaced. The CIM namespace must exist.
- Parameters:
pNamespacePath
- CIM namespace path. Must be an intra-server or intra-namespace object path within the target CIM server. In the latter case, the default namespace name is added to this parameter before being used. Must not be null. Also, the class attribute must not be null. TODO Proposal: It turns out the code ignores the class attribute, but requires it to be non-null. Remove this check.pQualifierType
- CIM qualifier declaration. Must be a valid qualifier declaration according to the CIM Infrastructure Specification [DSP0004].
- Throws:
CIMException
- with one of these CIM status codes:
public void setSessionProperties(SessionProperties pProperties)
Sets the session properties for the CIM client.
- Parameters:
pProperties
- The session properties
public void useHttp11(boolean pValue)
Control the use of HTTP 1.1.
- Parameters:
pValue
- If true, use HTTP 1.1. Else, use HTTP 1.0.
public void useMPost(boolean pValue)
Control the use of HTTP MPost request.
- Parameters:
pValue
- If true, use the HTTP MPost request. Else, use the HTTP Post request.