|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.sblim.wbem.client.CIMClient
A CIM client providing the main interface for a CIM client application to interact with a CIM server.
Each 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 java.lang.String |
CIM_XML
Protocol identifier for CIM Operations over HTTP. |
static java.lang.String |
CQL
QueryLanguage identifier for CIM Query Language (CQL). |
static java.lang.String |
ITSANM_CIMXML
TODO Proposal: Constants ITSANM_CIMXML, ITSANM_SOAP, ITSANM_LOCAL never used, remove them. |
static java.lang.String |
ITSANM_LOCAL
|
static java.lang.String |
ITSANM_SOAP
|
static java.lang.String |
WQL
QueryLanguage identifier for WBEM Query Language (WQL). |
static java.lang.String |
WQL1
WBEM Query Language level 1. |
static java.lang.String |
WQL2
WBEM Query Language level 2. |
static java.lang.String |
WQL3
WBEM Query Language level 3. |
static java.lang.String |
WQL4
WBEM Query Language level 4. |
Constructor Summary | |
---|---|
CIMClient(CIMNameSpace pNameSpace,
java.security.Principal pPrincipal,
java.lang.Object pCredential)
Initializes this CIMClient with connection information to
a target CIM server and a default namespace, using the specified
principal and credential, and using the default protocol
CIM_XML (CIM Operations over HTTP). |
|
CIMClient(CIMNameSpace pNameSpace,
java.security.Principal pPrincipal,
java.lang.Object pCredential,
java.lang.String pProtocol)
Initializes this CIMClient with connection information to
a target CIM server and a default namespace, using the specified
principal, credential and protocol. |
|
CIMClient(CIMNameSpace pNameSpace,
java.security.Principal pPrincipal,
java.lang.Object pCredential,
java.lang.String pProtocol,
SessionProperties pProperties)
Initializes this CIMClient with connection information to
a target CIM server and a default namespace, using the specified
principal, credential and protocol. |
|
CIMClient(CIMOMHandle pCimomHandle)
Initializes this CIMClient from an existing
CIMOMHandle . |
Method Summary | |
---|---|
void |
addCIMListener(CIMListener pListener)
Adds the specified CIMListener to start receiving indications from the CIM server. |
java.util.Enumeration |
associatorNames(CIMObjectPath pObjectPath)
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. |
java.util.Enumeration |
associatorNames(CIMObjectPath pObjectPath,
java.lang.String pAssociationClass,
java.lang.String pResultClass,
java.lang.String pRole,
java.lang.String pResultRole)
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. |
java.util.Enumeration |
associators(CIMObjectPath pObjectPath,
java.lang.String pAssociationClass,
java.lang.String pResultClass,
java.lang.String pRole,
java.lang.String pResultRole,
boolean pIncludeQualifiers,
boolean pIncludeClassOrigin,
java.lang.String[] pPropertyList)
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. |
void |
close()
Closes the connection to the CIM server. |
void |
close(boolean pKeepEnumerations)
Closes the connection to the CIM server. |
void |
createClass(CIMObjectPath pClassPath,
CIMClass pNewClass)
Creates a CIM class on the target CIM server. |
CIMObjectPath |
createInstance(CIMObjectPath pNamespacePath,
CIMInstance pNewInstance)
Creates a CIM instance in the specified namespace on the target CIM server. |
void |
createNameSpace(CIMNameSpace pNameSpace)
Creates a CIM namespace on the target CIM server. |
void |
createQualifierType(CIMObjectPath pNamespacePath,
CIMQualifierType pQualifierType)
Creates or replaces a CIM qualifier declaration on the target CIM server. |
void |
deleteClass(CIMObjectPath pClassPath)
Deletes a CIM class on the target CIM server. |
void |
deleteInstance(CIMObjectPath pInstancePath)
Deletes a CIM instance on the target CIM server. |
void |
deleteNameSpace(CIMNameSpace pNameSpace)
Deletes a CIM namespace from the target CIM server. |
void |
deleteQualifierType(CIMObjectPath pQualifierPath)
Deletes a CIM qualifier declaration on the target CIM server. |
java.util.Enumeration |
enumClass(CIMObjectPath pClassPath)
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes. |
java.util.Enumeration |
enumClass(CIMObjectPath pClassPath,
boolean pDeepInheritance)
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes. |
java.util.Enumeration |
enumClass(CIMObjectPath pClassPath,
boolean pDeepInheritance,
boolean pLocalOnly)
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes. |
java.util.Enumeration |
enumerateClasses()
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes. |
java.util.Enumeration |
enumerateClasses(CIMObjectPath pClassPath)
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes. |
java.util.Enumeration |
enumerateClasses(CIMObjectPath pClassPath,
boolean pDeepInheritance)
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes. |
java.util.Enumeration |
enumerateClasses(CIMObjectPath pClassPath,
boolean pDeepInheritance,
boolean pLocalOnly)
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes. |
java.util.Enumeration |
enumerateClasses(CIMObjectPath pClassPath,
boolean pDeepInheritance,
boolean pLocalOnly,
boolean pIncludeQualifiers)
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes. |
java.util.Enumeration |
enumerateClasses(CIMObjectPath pClassPath,
boolean pDeepInheritance,
boolean pLocalOnly,
boolean pIncludeQualifiers,
boolean pIncludeClassOrigin)
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns copies of these classes. |
java.util.Enumeration |
enumerateClassNames()
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns CIM class paths to these classes. |
java.util.Enumeration |
enumerateClassNames(CIMObjectPath pClassPath)
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns CIM class paths to these classes. |
java.util.Enumeration |
enumerateClassNames(CIMObjectPath pClassPath,
boolean pDeepInheritance)
Enumerates the CIM classes on the target CIM server that are subclasses of the specified class, and returns CIM class paths to these classes. |
java.util.Enumeration |
enumerateInstanceNames(CIMObjectPath pClassPath)
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. |
java.util.Enumeration |
enumerateInstances(CIMObjectPath pClassPath)
Enumerates the CIM instances on the target CIM server that are of the specified class or its subclasses and returns copies of these instances. |
java.util.Enumeration |
enumerateInstances(CIMObjectPath pClassPath,
boolean pDeepInheritance)
Enumerates the CIM instances on the target CIM server that are of the specified class or its subclasses and returns copies of these instances. |
java.util.Enumeration |
enumerateInstances(CIMObjectPath pClassPath,
boolean pDeepInheritance,
boolean pLocalOnly)
Enumerates the CIM instances on the target CIM server that are of the specified class or its subclasses and returns copies of these instances. |
java.util.Enumeration |
enumerateInstances(CIMObjectPath pClassPath,
boolean pDeepInheritance,
boolean pLocalOnly,
boolean pIncludeQualifiers)
Enumerates the CIM instances on the target CIM server that are of the specified class or its subclasses and returns copies of these instances. |
java.util.Enumeration |
enumerateInstances(CIMObjectPath pClassPath,
boolean pDeepInheritance,
boolean pLocalOnly,
boolean pIncludeQualifiers,
boolean pIncludeClassOrigin)
Enumerates the CIM instances on the target CIM server that are of the specified class or its subclasses and returns copies of these instances. |
java.util.Enumeration |
enumerateInstances(CIMObjectPath pClassPath,
boolean pDeepInheritance,
boolean pLocalOnly,
boolean pIncludeQualifiers,
boolean pIncludeClassOrigin,
java.lang.String[] pPropertyList)
Enumerates the CIM instances on the target CIM server that are of the specified class or its subclasses and returns copies of these instances. |
java.util.Enumeration |
enumInstances(CIMObjectPath pClassPath,
boolean pDeepInheritance)
Enumerates the CIM instances on the target CIM server that are of the specified class or its subclasses and returns copies of these instances. |
java.util.Enumeration |
enumInstances(CIMObjectPath pClassPath,
boolean pDeepInheritance,
boolean pLocalOnly)
Enumerates the CIM instances on the target CIM server that are of the specified class or its subclasses and returns copies of these instances. |
java.util.Enumeration |
enumNameSpace(CIMObjectPath pNamespacePath,
boolean pDeep)
Enumerates the CIM namespaces on the target CIM server, and returns CIM instance paths to the CIM_Namespace instances representing them. |
java.util.Enumeration |
enumQualifierTypes(CIMObjectPath pNamespacePath)
Enumerates the CIM qualifier declarations in a namespace on the target CIM server. |
java.util.Enumeration |
execQuery(CIMObjectPath pNamespacePath,
java.lang.String pQuery,
java.lang.String pQueryLanguage)
Executes a query on the target CIM server. |
CIMClass |
getClass(CIMObjectPath pClassPath)
Gets a copy of a CIM class from the target CIM server. |
CIMClass |
getClass(CIMObjectPath pClassPath,
boolean pLocalOnly)
Gets a copy of a CIM class from the target CIM server. |
CIMClass |
getClass(CIMObjectPath pClassPath,
boolean pLocalOnly,
boolean pIncludeQualifiers)
Gets a copy of a CIM class from the target CIM server. |
CIMClass |
getClass(CIMObjectPath pClassPath,
boolean pLocalOnly,
boolean pIncludeQualifiers,
boolean pIncludeClassOrigin)
Gets a copy of a CIM class from the target CIM server. |
CIMClass |
getClass(CIMObjectPath pClassPath,
boolean pLocalOnly,
boolean pIncludeQualifiers,
boolean pIncludeClassOrigin,
java.lang.String[] pPropertyList)
Gets a copy of a CIM class from the target CIM server. |
CIMInstance |
getIndicationHandler(CIMListener pListener)
This methods return an instance of CIM_IndicationHandler, since CIM over HTTP is used as transport an instance of CIM_IndicationHandlerCIMXML is returned. |
CIMInstance |
getIndicationListener(CIMListener pListener)
This methods return an instance of CIM_IndicationDestination, since CIM over HTTP is used as transport an instance of CIM_ListenerDestinationCIMXML is returned. |
CIMInstance |
getInstance(CIMObjectPath pInstancePath)
Gets a copy of a CIM instance from the target CIM server. |
CIMInstance |
getInstance(CIMObjectPath pInstancePath,
boolean pLocalOnly)
Gets a copy of a CIM instance. |
CIMInstance |
getInstance(CIMObjectPath pInstancePath,
boolean pLocalOnly,
boolean pIncludeQualifiers)
Gets a copy of a CIM instance from the target CIM server. |
CIMInstance |
getInstance(CIMObjectPath pInstancePath,
boolean pLocalOnly,
boolean pIncludeQualifiers,
boolean pIncludeClassOrigin)
Gets a copy of a CIM instance from the target CIM server. |
CIMInstance |
getInstance(CIMObjectPath pInstancePath,
boolean pLocalOnly,
boolean pIncludeQualifiers,
boolean pIncludeClassOrigin,
java.lang.String[] pPropertyList)
Gets a copy of a CIM instance from the target CIM server. |
java.util.Locale |
getLocale()
Gets the current locale information of the CIM client. |
CIMNameSpace |
getNameSpace()
Gets the default CIM namespace associated with this CIM client. |
CIMValue |
getProperty(CIMObjectPath pInstancePath,
java.lang.String pPropertyName)
Gets a copy of a property value of a CIM instance on the target CIM server. |
CIMQualifierType |
getQualifierType(CIMObjectPath pQualifierPath)
Gets a copy of a CIM qualifier declaration from the target CIM server. |
SessionProperties |
getSessionProperties()
Gets the session properties of the CIM client. |
CIMValue |
invokeMethod(CIMObjectPath pObjectPath,
java.lang.String pMethodName,
CIMArgument[] pInputArguments,
CIMArgument[] pOutputArguments)
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) . |
CIMValue |
invokeMethod(CIMObjectPath pObjectPath,
java.lang.String pMethodName,
java.util.Vector pInputArguments,
java.util.Vector pOutputArguments)
Invokes the specified CIM method on a CIM object (instance or class) on the target CIM server. |
BatchResult |
performBatchOperations(BatchHandle pBatchHandle)
Performs the operations specified in the BatchHandle object. |
java.util.Enumeration |
referenceNames(CIMObjectPath pObjectPath)
Enumerates the CIM asociation objects on the target CIM server that reference a particular CIM object, and returns CIM object paths to these objects. |
java.util.Enumeration |
referenceNames(CIMObjectPath pObjectPath,
java.lang.String pResultClass,
java.lang.String pRole)
Enumerates the CIM asociation objects on the target CIM server that reference a particular CIM object, and returns CIM object paths to these objects. |
java.util.Enumeration |
references(CIMObjectPath pObjectPath)
Enumerates the CIM asociation objects on the target CIM server that reference a particular CIM object, and returns copies of these objects. |
java.util.Enumeration |
references(CIMObjectPath pObjectPath,
java.lang.String pResultClass,
java.lang.String pRole,
boolean pIncludeQualifiers,
boolean pIncludeClassOrigin,
java.lang.String[] pPropertyList)
Enumerates the CIM asociation objects on the target CIM server that reference a particular CIM object, and returns copies of these objects. |
void |
removeCIMListener(CIMListener pListener)
Removes the specified CIMListener, to stop receiving indications from the CIM server. |
void |
setClass(CIMObjectPath pClassPath,
CIMClass pModifiedClass)
Modifies a CIM class on the target CIM server. |
void |
setInstance(CIMObjectPath pInstancePath,
CIMInstance pModifiedInstance)
Modifies a CIM instance on the target CIM server. |
void |
setInstance(CIMObjectPath pInstancePath,
CIMInstance pModifiedInstance,
boolean pIncludeQualifiers,
java.lang.String[] pPropertyList)
Modifies a CIM instance on the target CIM server. |
void |
setLocale(java.util.Locale pLocale)
Modifies the locale information of the CIM client. |
void |
setProperty(CIMObjectPath pInstancePath,
java.lang.String pPropertyName)
Modifies a property value of a CIM instance on the target CIM server. |
void |
setProperty(CIMObjectPath pInstancePath,
java.lang.String pPropertyName,
CIMValue pNewValue)
Modifies a property value of a CIM instance on the target CIM server. |
void |
setQualifierType(CIMObjectPath pNamespacePath,
CIMQualifierType pQualifierType)
Creates or replaces a CIM qualifier declaration on the target CIM server. |
void |
setSessionProperties(SessionProperties pProperties)
Sets the session properties for the CIM client. |
void |
useHttp11(boolean pValue)
Control the use of HTTP 1.1. |
void |
useMPost(boolean pValue)
Control the use of HTTP MPost request. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String ITSANM_CIMXML
public static final java.lang.String ITSANM_SOAP
public static final java.lang.String ITSANM_LOCAL
public static final java.lang.String CIM_XML
public static final java.lang.String WQL
public static final java.lang.String CQL
public static final java.lang.String WQL1
public static final java.lang.String WQL2
public static final java.lang.String WQL3
public static final java.lang.String WQL4
Constructor Detail |
public CIMClient(CIMNameSpace pNameSpace, java.security.Principal pPrincipal, java.lang.Object pCredential) throws CIMException
CIMClient
with connection information to
a target CIM server and a default namespace, using the specified
principal and credential, and using the default protocol
CIM_XML
(CIM Operations over HTTP). The global session
properties are applied.
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.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_PARAMETER
CIM_ERR_FAILED
CIMClient(CIMNameSpace, Principal, Object, String,
SessionProperties)
public CIMClient(CIMNameSpace pNameSpace, java.security.Principal pPrincipal, java.lang.Object pCredential, java.lang.String pProtocol) throws CIMException
CIMClient
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.
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:
CIM_XML
- CIM Operations over
HTTPCIMOMHandle
.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_PARAMETER
CIM_ERR_FAILED
CIMClient(CIMNameSpace, Principal, Object, String,
SessionProperties)
public CIMClient(CIMNameSpace pNameSpace, java.security.Principal pPrincipal, java.lang.Object pCredential, java.lang.String pProtocol, SessionProperties pProperties) throws CIMException
CIMClient
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).
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:
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.
If null
the global properties are used.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_PARAMETER
CIM_ERR_FAILED
CIMOMHandle
,
SessionProperties
,
SessionProperties.getGlobalProperties()
public CIMClient(CIMOMHandle pCimomHandle) throws CIMException
CIMClient
from an existing
CIMOMHandle
.
A CIMOMHandle
can be obtained from a
CIMClientFactory
. This allows to extend the CIM client
(for instance with an additional protocol) without changing the interface
to the CIM client application.
pCimomHandle
-
CIMException
- with one of these CIM status codes:
CIM_ERR_INVALID_PARAMETER
CIMOMHandle
,
CIMClientFactory
Method Detail |
public java.util.Enumeration associatorNames(CIMObjectPath pObjectPath, java.lang.String pAssociationClass, java.lang.String pResultClass, java.lang.String pRole, java.lang.String pResultRole) throws CIMException
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.
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.
CIMEnumeration
object containing zero or more
CIMObjectPath
objects referencing the enumerated
classes or instances using global CIM class or instance paths.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_FAILED
public java.util.Enumeration associatorNames(CIMObjectPath pObjectPath) throws CIMException
This method produces the same results as
associatorNames(pObjectPath, null, null, null, null)
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.
CIMEnumeration
object containing zero or more
CIMObjectPath
objects referencing the enumerated
classes or instances using global CIM class or instance paths.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_FAILED
associatorNames(CIMObjectPath, String, String, String, String)
public java.util.Enumeration associators(CIMObjectPath pObjectPath, java.lang.String pAssociationClass, java.lang.String pResultClass, java.lang.String pRole, java.lang.String pResultRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, java.lang.String[] pPropertyList) throws CIMException
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.
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. getClass
) instead, and to set this
parameter to false
.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 the
getOriginClass()
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.
CIMEnumeration
object containing zero or more
CIMInstance
or CIMClass
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_FAILED
CIMProperty.getOriginClass()
,
CIMMethod.getOriginClass()
,
CIMInstance
,
CIMClass
public void deleteInstance(CIMObjectPath pInstancePath) throws CIMException
Dependent on the semantics of the CIM class, this may result in also deleting the real world resource represented by the CIM instance.
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.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_NOT_FOUND
CIM_ERR_FAILED
public java.util.Enumeration enumInstances(CIMObjectPath pClassPath, boolean pDeepInheritance) throws CIMException
This method produces the same results as
enumerateInstances(pClassPath, pDeepInheritance, false, false, false, null)
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.
CIMEnumeration
object containing zero or more
CIMInstance
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
enumerateInstances(CIMObjectPath, boolean, boolean, boolean,
boolean, String[])
public java.util.Enumeration enumInstances(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly) throws CIMException
This method produces the same results as
enumerateInstances(pClassPath, pDeepInheritance, localOnly, false, false, null)
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. pLocalOnly
to
false
and not to rely on
pLocalOnly
filtering. To minimize the impact of
implementing this recommendation in CIM client applications, a
CIM server may choose to treat the value of
pLocalOnly
as false
, 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
implemented pLocalOnly
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
the pLocalOnly
parameter, but which one is left
open.
CIMEnumeration
object containing zero or more
CIMInstance
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
enumerateInstances(CIMObjectPath, boolean, boolean, boolean,
boolean, String[])
public java.util.Enumeration enumerateInstances(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly) throws CIMException
This method produces the same results as
enumerateInstances(pClassPath, pDeepInheritance, localOnly, false, false, null)
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. pLocalOnly
to
false
and not to rely on
pLocalOnly
filtering. To minimize the impact of
implementing this recommendation in CIM client applications, a
CIM server may choose to treat the value of
pLocalOnly
as false
, 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
implemented pLocalOnly
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
the pLocalOnly
parameter, but which one is left
open.
CIMEnumeration
object containing zero or more
CIMInstance
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
enumerateInstances(CIMObjectPath, boolean, boolean, boolean,
boolean, String[])
public java.util.Enumeration enumerateInstances(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, java.lang.String[] pPropertyList) throws CIMException
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. pLocalOnly
to
false
and not to rely on
pLocalOnly
filtering. To minimize the impact of
implementing this recommendation in CIM client applications, a
CIM server may choose to treat the value of
pLocalOnly
as false
, 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
implemented pLocalOnly
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
the pLocalOnly
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. getClass
) instead, and to set this
parameter to false
.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 the
getOriginClass()
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.
CIMEnumeration
object containing zero or more
CIMInstance
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
CIMProperty.getOriginClass()
,
CIMMethod.getOriginClass()
public java.util.Enumeration enumerateInstances(CIMObjectPath pClassPath) throws CIMException
This method produces the same results as
enumerateInstances(pClassPath, true,
true, false, false, null)
Deprecation Note: The CIM Operations
over HTTP specification [DSP0200] V1.2 has deprecated the
pLocalOnly
parameter. It is recommended that CIM client
applications set pLocalOnly
to false
.
Therefore, it is not recommended that CIM client applications use this
flavor of enumerateInstances
.
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.
CIMEnumeration
object containing zero or more
CIMInstance
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
enumerateInstances(CIMObjectPath, boolean, boolean, boolean,
boolean, String[])
public java.util.Enumeration enumerateInstances(CIMObjectPath pClassPath, boolean pDeepInheritance) throws CIMException
This method produces the same results as
enumerateInstances(pClassPath, pDeepInheritance, false, false, false, null)
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.
CIMEnumeration
object containing zero or more
CIMInstance
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
enumerateInstances(CIMObjectPath, boolean, boolean, boolean,
boolean, String[])
public java.util.Enumeration enumerateInstances(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly, boolean pIncludeQualifiers) throws CIMException
This method produces the same results as
enumerateInstances(pClassPath, pDeepInheritance, pLocalOnly, pIncludeQualifiers, false, null)
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. pLocalOnly
to
false
and not to rely on
pLocalOnly
filtering. To minimize the impact of
implementing this recommendation in CIM client applications, a
CIM server may choose to treat the value of
pLocalOnly
as false
, 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
implemented pLocalOnly
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
the pLocalOnly
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. getClass
) instead, and to set this
parameter to false
.
CIMEnumeration
object containing zero or more
CIMInstance
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
enumerateInstances(CIMObjectPath, boolean, boolean, boolean,
boolean, String[])
public java.util.Enumeration enumerateInstances(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin) throws CIMException
This method produces the same results as
enumerateInstances(pClassPath, pDeepInheritance, pLocalOnly, pIncludeQualifiers, pIncludeClassOrigin, null)
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. pLocalOnly
to
false
and not to rely on
pLocalOnly
filtering. To minimize the impact of
implementing this recommendation in CIM client applications, a
CIM server may choose to treat the value of
pLocalOnly
as false
, 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
implemented pLocalOnly
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
the pLocalOnly
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. getClass
) instead, and to set this
parameter to false
.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 the
getOriginClass()
method. If false, class origin
information will not be present in the returned objects.
CIMEnumeration
object containing zero or more
CIMInstance
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
enumerateInstances(CIMObjectPath, boolean, boolean, boolean,
boolean, String[])
public java.util.Enumeration enumerateInstanceNames(CIMObjectPath pClassPath) throws CIMException
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.
CIMEnumeration
object containing zero or more
CIMObjectPath
objects referencing the enumerated
instances using intra-namespace CIM instance paths (model paths).
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
public CIMInstance getInstance(CIMObjectPath pInstancePath) throws CIMException
This method produces the same results as
getInstance(pInstancePath, true,
false, false, null)
Deprecation Note: The CIM Operations
over HTTP specification [DSP0200] V1.2 has deprecated the
pLocalOnly
parameter. It is recommended that CIM client
applications set pLocalOnly
to false
.
Therefore, it is not recommended that CIM client applications use this
flavor of getInstance
.
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.
CIMInstance
object.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_NOT_FOUND
CIM_ERR_FAILED
getInstance(CIMObjectPath, boolean, boolean, boolean, String[])
public CIMInstance getInstance(CIMObjectPath pInstancePath, boolean pLocalOnly) throws CIMException
This method produces the same results as
getInstance(pInstancePath, pLocalOnly, false, false, null)
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. pLocalOnly
to
false
and not to rely on
pLocalOnly
filtering. To minimize the impact of
implementing this recommendation in CIM client applications, a
CIM server may choose to treat the value of
pLocalOnly
as false
, 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
implemented pLocalOnly
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
the pLocalOnly
parameter, but which one is left
open.
CIMInstance
object.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_NOT_FOUND
CIM_ERR_FAILED
getInstance(CIMObjectPath, boolean, boolean, boolean, String[])
public CIMInstance getInstance(CIMObjectPath pInstancePath, boolean pLocalOnly, boolean pIncludeQualifiers) throws CIMException
This method produces the same results as
getInstance(pObjectPath, pLocalOnly, pIncludeQualifiers, false, null)
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. pLocalOnly
to
false
and not to rely on
pLocalOnly
filtering. To minimize the impact of
implementing this recommendation in CIM client applications, a
CIM server may choose to treat the value of
pLocalOnly
as false
, 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
implemented pLocalOnly
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
the pLocalOnly
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. getClass
) instead, and to set this
parameter to false
.
CIMInstance
object.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_NOT_FOUND
CIM_ERR_FAILED
getInstance(CIMObjectPath, boolean, boolean, boolean, String[])
public CIMInstance getInstance(CIMObjectPath pInstancePath, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin) throws CIMException
This method produces the same results as
getInstance(pInstancePath, pLocalOnly, pIncludeQualifiers, pIncludeClassOrigin, null)
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. pLocalOnly
to
false
and not to rely on
pLocalOnly
filtering. To minimize the impact of
implementing this recommendation in CIM client applications, a
CIM server may choose to treat the value of
pLocalOnly
as false
, 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
implemented pLocalOnly
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
the pLocalOnly
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. getClass
) instead, and to set this
parameter to false
.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 the
getOriginClass()
method. If false, class origin
information will not be present in the returned instance.
CIMInstance
object.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_NOT_FOUND
CIM_ERR_FAILED
getInstance(CIMObjectPath, boolean, boolean, boolean, String[])
public CIMInstance getInstance(CIMObjectPath pInstancePath, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, java.lang.String[] pPropertyList) throws CIMException
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. pLocalOnly
to
false
and not to rely on
pLocalOnly
filtering. To minimize the impact of
implementing this recommendation in CIM client applications, a
CIM server may choose to treat the value of
pLocalOnly
as false
, 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
implemented pLocalOnly
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
the pLocalOnly
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. getClass
) instead, and to set this
parameter to false
.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 the
getOriginClass()
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.
CIMInstance
object.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_NOT_FOUND
CIM_ERR_FAILED
CIMProperty.getOriginClass()
,
CIMMethod.getOriginClass()
public void createClass(CIMObjectPath pClassPath, CIMClass pNewClass) throws CIMException
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 in
newClass
will be ignored (it is reconstructed
by the CIM server). Must not be null.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_ALREADY_EXISTS
CIM_ERR_INVALID_SUPERCLASS
CIM_ERR_FAILED
public CIMObjectPath createInstance(CIMObjectPath pNamespacePath, CIMInstance pNewInstance) throws CIMException
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.
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 in newInstance
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 in
newInstance
, 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 in newInstance
will be
ignored (it is reconstructed by the CIM server). Any
qualifiers included in newInstance
may be
ignored (it is recommended that CIM servers ignore them). createClass
) instead.
Must not be null.
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 from
newInstance
.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_ALREADY_EXISTS
CIM_ERR_FAILED
public void createQualifierType(CIMObjectPath pNamespacePath, CIMQualifierType pQualifierType) throws CIMException
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.
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].
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_FAILED
public void deleteClass(CIMObjectPath pClassPath) throws CIMException
This includes deleting all instances of the specified class, all of its subclasses, and all instances of these subclasses in the same namespace.
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.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_NOT_FOUND
CIM_ERR_CLASS_HAS_CHILDREN
CIM_ERR_CLASS_HAS_INSTANCES
CIM_ERR_FAILED
public void deleteQualifierType(CIMObjectPath pQualifierPath) throws CIMException
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.
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.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_NOT_FOUND
CIM_ERR_FAILED
public CIMClass getClass(CIMObjectPath pClassPath) throws CIMException
This method produces the same results as
getClass(pClassPath, true, true, false, null)
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.
CIMClass
object.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_NOT_FOUND
CIM_ERR_FAILED
getClass(CIMObjectPath, boolean, boolean, boolean, String[])
public CIMClass getClass(CIMObjectPath pClassPath, boolean pLocalOnly) throws CIMException
This method produces the same results as
getClass(pClassPath, pLocalOnly, true, false, null)
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.
CIMClass
object.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_NOT_FOUND
CIM_ERR_FAILED
getClass(CIMObjectPath, boolean, boolean, boolean, String[])
public CIMClass getClass(CIMObjectPath pClassPath, boolean pLocalOnly, boolean pIncludeQualifiers) throws CIMException
This method produces the same results as
getClass(pClassPath, pLocalOnly, pIncludeQualifiers, false, null)
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.
CIMClass
object.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_NOT_FOUND
CIM_ERR_FAILED
getClass(CIMObjectPath, boolean, boolean, boolean, String[])
public CIMClass getClass(CIMObjectPath pClassPath, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin) throws CIMException
This method produces the same results as
getClass(pClassPath, pLocalOnly, pIncludeQualifiers, pIncludeClassOrigin, null)
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 the
getOriginClass()
method. If false, class origin
information will not be present in the returned class.
CIMClass
object.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_NOT_FOUND
CIM_ERR_FAILED
getClass(CIMObjectPath, boolean, boolean, boolean, String[])
public CIMClass getClass(CIMObjectPath pClassPath, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, java.lang.String[] pPropertyList) throws CIMException
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 the
getOriginClass()
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.
CIMClass
object.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_NOT_FOUND
CIM_ERR_FAILED
CIMProperty.getOriginClass()
,
CIMMethod.getOriginClass()
public CIMValue getProperty(CIMObjectPath pInstancePath, java.lang.String pPropertyName) throws CIMException
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.
CIMValue
object.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_NOT_FOUND
CIM_ERR_NO_SUCH_PROPERTY
CIM_ERR_FAILED
public CIMValue invokeMethod(CIMObjectPath pObjectPath, java.lang.String pMethodName, java.util.Vector pInputArguments, java.util.Vector pOutputArguments) throws CIMException
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 a
CIMArgument
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 a
CIMArgument
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.
CIMValue
object representing the return value of
the CIM method.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_NOT_FOUND
CIM_ERR_METHOD_NOT_FOUND
CIM_ERR_METHOD_NOT_AVAILABLE
CIM_ERR_FAILED
public CIMValue invokeMethod(CIMObjectPath pObjectPath, java.lang.String pMethodName, CIMArgument[] pInputArguments, CIMArgument[] pOutputArguments) throws CIMException
invokeMethod(CIMObjectPath, String, Vector, Vector)
.
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 a
CIMArgument
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 a
CIMArgument
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.
CIMValue
object representing the return value of
the CIM method.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_NOT_FOUND
CIM_ERR_METHOD_NOT_FOUND
CIM_ERR_METHOD_NOT_AVAILABLE
CIM_ERR_FAILED
public void addCIMListener(CIMListener pListener) throws CIMException
The CIMListener must differentiate itself from other CIMListener instances through the hashCode().
TODO Clarify: CIMListener does not have a hashcode() method.
pListener
- CIMListener to be added. Must not be null.
java.lang.IllegalArgumentException
- if the listener is null.
CIMException
- with one of these CIM status codes:
CIM_ERR_FAILED
public void removeCIMListener(CIMListener pListener) throws CIMException
pListener
- CIMListener to be added. Must not be null.
java.lang.IllegalArgumentException
- if the listener is null.
CIMException
- with one of these CIM status codes:
CIM_ERR_FAILED
public CIMInstance getIndicationListener(CIMListener pListener) throws CIMException
TODO Docu: Improve documentation.
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.
java.lang.IllegalArgumentException
- if the listener is null.
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 loadpublic CIMInstance getIndicationHandler(CIMListener pListener) throws CIMException
TODO Docu: Improve documentation.
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.
java.lang.IllegalArgumentException
- if the listener is null.
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 loadpublic void close() throws CIMException
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_FAILED
public void close(boolean pKeepEnumerations) throws CIMException
pKeepEnumerations
- If true
all open enumeration will be preserved,
if false
all enumerations are invalidated
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_FAILED
public void createNameSpace(CIMNameSpace pNameSpace) throws CIMException
The namespace must not exist on the target CIM server.
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.
java.lang.IllegalArgumentException
- if a null namespace is passed as an argument
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_PARAMETER
CIM_ERR_ALREADY_EXISTS
CIM_ERR_FAILED
public void deleteNameSpace(CIMNameSpace pNameSpace) throws CIMException
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.
java.lang.IllegalArgumentException
- if a null namespace is passed as an argument
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_PARAMETER
CIM_ERR_ALREADY_EXISTS
CIM_ERR_FAILED
public java.util.Enumeration enumQualifierTypes(CIMObjectPath pNamespacePath) throws CIMException
The namespace must exist.
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.
CIMEnumeration
object containing zero or more
CIMQualifierType
objects.
java.lang.IllegalArgumentException
- if a null namespace is passed as an argument
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_FAILED
public java.util.Enumeration enumClass(CIMObjectPath pClassPath) throws CIMException
This method produces the same results as
enumerateClasses(pClassPath, false, true, true, false)
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.
CIMEnumeration
object containing zero or more
CIMClass
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
enumerateClasses(CIMObjectPath, boolean, boolean, boolean, boolean)
public java.util.Enumeration enumClass(CIMObjectPath pClassPath, boolean pDeepInheritance) throws CIMException
This method produces the same results as
enumerateClasses(pClassPath, pDeepInheritance, true, true, false)
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 of pDeepInheritance
applies
only to the methods for class enumeration and is different
from its usage in the methods for instance enumeration.
CIMEnumeration
object containing zero or more
CIMClass
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
enumerateClasses(CIMObjectPath, boolean, boolean, boolean, boolean)
public java.util.Enumeration enumClass(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly) throws CIMException
This method produces the same results as
enumerateClasses(pClassPath, pDeepInheritance, pLocalOnly, true, false)
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 of pDeepInheritance
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.
CIMEnumeration
object containing zero or more
CIMClass
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
enumerateClasses(CIMObjectPath, boolean, boolean, boolean, boolean)
public java.util.Enumeration enumerateClasses() throws CIMException
This method produces the same results as
enumerateClasses(null, false, true, true, false)
CIMEnumeration
object containing zero or more
CIMClass
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
enumerateClasses(CIMObjectPath, boolean, boolean, boolean, boolean)
public java.util.Enumeration enumerateClasses(CIMObjectPath pClassPath) throws CIMException
This method produces the same results as
enumerateClasses(pClassPath, false, true, true, false)
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.
CIMEnumeration
object containing zero or more
CIMClass
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
enumerateClasses(CIMObjectPath, boolean, boolean, boolean, boolean)
public java.util.Enumeration enumerateClasses(CIMObjectPath pClassPath, boolean pDeepInheritance) throws CIMException
This method produces the same results as
enumerateClasses(pClassPath, pDeepInheritance, true, true, false)
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 of pDeepInheritance
applies
only to the methods for class enumeration and is different
from its usage in the methods for instance enumeration.
CIMEnumeration
object containing zero or more
CIMClass
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
enumerateClasses(CIMObjectPath, boolean, boolean, boolean, boolean)
public java.util.Enumeration enumerateClasses(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly) throws CIMException
This method produces the same results as
enumerateClasses(pClassPath, pDeepInheritance, pLocalOnly, true, false)
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 of pDeepInheritance
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.
CIMEnumeration
object containing zero or more
CIMClass
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
enumerateClasses(CIMObjectPath, boolean, boolean, boolean, boolean)
public java.util.Enumeration enumerateClasses(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly, boolean pIncludeQualifiers) throws CIMException
This method produces the same results as
enumerateClasses(pClassPath, pDeepInheritance, pLocalOnly, pIncludeQualifiers, false)
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 of pDeepInheritance
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.
CIMEnumeration
object containing zero or more
CIMClass
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
enumerateClasses(CIMObjectPath, boolean, boolean, boolean, boolean)
public java.util.Enumeration enumerateClasses(CIMObjectPath pClassPath, boolean pDeepInheritance, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin) throws CIMException
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 of pDeepInheritance
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 the
getOriginClass()
method. If false, class origin
information will not be present in the returned classes.
CIMEnumeration
object containing zero or more
CIMClass
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
CIMProperty.getOriginClass()
,
CIMMethod.getOriginClass()
public java.util.Enumeration enumerateClassNames() throws CIMException
This method produces the same results as
enumerateClassNames(null, false)
CIMEnumeration
object containing zero or more
CIMObjectPath
objects referencing the enumerated
classes using intra-namespace CIM class paths (class names).
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
enumerateClassNames(CIMObjectPath, boolean)
public java.util.Enumeration enumerateClassNames(CIMObjectPath pClassPath) throws CIMException
This method produces the same results as
enumerateClassNames(pClassPath, false)
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.
CIMEnumeration
object containing zero or more
CIMObjectPath
objects referencing the enumerated
classes using intra-namespace CIM class paths (class names).
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
enumerateClassNames(CIMObjectPath, boolean)
public java.util.Enumeration enumerateClassNames(CIMObjectPath pClassPath, boolean pDeepInheritance) throws CIMException
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 of pDeepInheritance
applies
only to the methods for class enumeration and is different
from its usage in the methods for instance enumeration.
CIMEnumeration
object containing zero or more
CIMObjectPath
objects referencing the enumerated
classes using intra-namespace CIM class paths (class names).
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
public java.util.Enumeration enumNameSpace(CIMObjectPath pNamespacePath, boolean pDeep) throws CIMException
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.
CIMEnumeration
object containing zero or more
CIMInstancePath
objects referencing the enumerated
CIM_NameSpace instances using intra-namespace CIM instance paths
(model paths).
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_FAILED
public java.util.Enumeration execQuery(CIMObjectPath pNamespacePath, java.lang.String pQuery, java.lang.String pQueryLanguage) throws CIMException
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:
CIMException
public CIMQualifierType getQualifierType(CIMObjectPath pQualifierPath) throws CIMException
The CIM qualifier declaration must exist.
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.
CIMQualifierType
object.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_NOT_FOUND
CIM_ERR_FAILED
public BatchResult performBatchOperations(BatchHandle pBatchHandle) throws CIMException
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").
pBatchHandle
- Batch handle with the set of operations to be performed.
BatchResult
object with the results of these
operations.
CIMException
- with any one of the possible CIM status codes.public java.util.Enumeration referenceNames(CIMObjectPath pObjectPath) throws CIMException
This method produces the same results as
referenceNames(pObjectPath, null, null)
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.
CIMEnumeration
object containing zero or more
CIMObjectPath
objects referencing the enumerated
association classes or instances using global CIM class or
instance paths.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_FAILED
referenceNames(CIMObjectPath, String, String)
public java.util.Enumeration referenceNames(CIMObjectPath pObjectPath, java.lang.String pResultClass, java.lang.String pRole) throws CIMException
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.
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.
CIMEnumeration
object containing zero or more
CIMObjectPath
objects referencing the enumerated
association classes or instances using global CIM class or
instance paths.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_FAILED
public java.util.Enumeration references(CIMObjectPath pObjectPath) throws CIMException
This method produces the same results as
references(pObjectPath, null, null, true, true, null)
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.
CIMEnumeration
object containing zero or more
CIMInstance
or CIMClass
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_FAILED
references(CIMObjectPath, String, String, boolean, boolean,
String[])
public java.util.Enumeration references(CIMObjectPath pObjectPath, java.lang.String pResultClass, java.lang.String pRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, java.lang.String[] pPropertyList) throws CIMException
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.
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. getClass
) instead, and to set this
parameter to false
.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 the
getOriginClass()
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.
CIMEnumeration
object containing zero or more
CIMInstance
or CIMClass
objects.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_FAILED
CIMProperty.getOriginClass()
,
CIMMethod.getOriginClass()
,
CIMInstance
,
CIMClass
public void setProperty(CIMObjectPath pInstancePath, java.lang.String pPropertyName) throws CIMException
This method produces the same results as
setProperty(pInstancePath, propertyName, null)
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.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_NOT_FOUND
CIM_ERR_NO_SUCH_PROPERTY
CIM_ERR_TYPE_MISMATCH
CIM_ERR_FAILED
setProperty(CIMObjectPath, String, CIMValue)
public void setProperty(CIMObjectPath pInstancePath, java.lang.String pPropertyName, CIMValue pNewValue) throws CIMException
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 use
setInstance(CIMObjectPath, CIMInstance, boolean, String[])
instead.
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.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_NOT_FOUND
CIM_ERR_NO_SUCH_PROPERTY
CIM_ERR_TYPE_MISMATCH
CIM_ERR_FAILED
public void setClass(CIMObjectPath pClassPath, CIMClass pModifiedClass) throws CIMException
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 in
modifiedClass
will be ignored (it is
reconstructed by the CIM server).
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_NOT_FOUND
CIM_ERR_INVALID_SUPERCLASS
CIM_ERR_CLASS_HAS_CHILDREN
CIM_ERR_CLASS_HAS_INSTANCES
CIM_ERR_FAILED
public void setInstance(CIMObjectPath pInstancePath, CIMInstance pModifiedInstance) throws CIMException
This method produces the same results as
setInstance(pInstancePath, modifiedInstance, true, null)
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 in
modifiedInstance
will be ignored (it is
reconstructed by the CIM server). Any qualifiers included in
modifiedInstance
may be ignored (it is
recommended that CIM servers ignore them). setClass
) instead. Must not
be null.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_NOT_FOUND
CIM_ERR_FAILED
setInstance(CIMObjectPath, CIMInstance, boolean, String[])
public void setInstance(CIMObjectPath pInstancePath, CIMInstance pModifiedInstance, boolean pIncludeQualifiers, java.lang.String[] pPropertyList) throws CIMException
The set of property values to be modified is determined by
pPropertyList
. Out of that set, the properties of the
instance are attempted to be modified as follows:
modifiedInstance
,
the value specified there will be used as the new value (this is true
also for the null value).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.
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 in
modifiedInstance
will be ignored (it is
reconstructed by the CIM server). Any qualifiers included in
modifiedInstance
may be ignored (it is
recommended that CIM servers ignore them). 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. setClass
) instead, and to set this
parameter to false
.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.
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_NOT_FOUND
CIM_ERR_FAILED
public void setQualifierType(CIMObjectPath pNamespacePath, CIMQualifierType pQualifierType) throws CIMException
If the qualifier declaration does not exist, it will be created. If it exists, it will be replaced.
The CIM namespace must exist.
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].
CIMException
- with one of these CIM status codes:
CIM_ERR_ACCESS_DENIED
CIM_ERR_NOT_SUPPORTED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_FAILED
public void useMPost(boolean pValue)
pValue
- If true, use the HTTP MPost request. Else, use the HTTP Post
request.public void useHttp11(boolean pValue)
pValue
- If true, use HTTP 1.1. Else, use HTTP 1.0.public CIMNameSpace getNameSpace()
CIMNameSpace
object containing the default
namespace in its namespace attribute.public void setLocale(java.util.Locale pLocale)
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.
pLocale
- The new locale information. Must not be null.
CIMException
- with one of these CIM status codes:
CIM_ERR_INVALID_PARAMETER
public java.util.Locale getLocale()
setLocale
) is the value Locale.getDefault()
.
public SessionProperties getSessionProperties()
null
public void setSessionProperties(SessionProperties pProperties)
pProperties
- The session properties
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |