|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface for any CIMOM Handle. The implementation must take care of communicating with the CIMOM.
Method Summary | |
void |
addCIMListener(CIMListener l)
Adds the specified listener which receives indications from the CIM Object Manager. |
java.util.Enumeration |
associatorNames(CIMObjectPath objectName,
java.lang.String assocClass,
java.lang.String resultClass,
java.lang.String role,
java.lang.String resultRole)
This operation is used to enumerate the names of CIM Objects (Classes or Instances) that are associated to a particular source CIM Object. |
java.util.Enumeration |
associators(CIMObjectPath objectName,
java.lang.String assocClass,
java.lang.String resultClass,
java.lang.String role,
java.lang.String resultRole,
boolean includeQualifiers,
boolean includeClassOrigin,
java.lang.String[] propertyList)
This operation is used to enumerate CIM Objects (Classes or Instances) that are associated to a particular source CIM Object. |
void |
close()
Closes the connection to the CIM Object Manager. |
void |
createClass(CIMObjectPath name,
CIMClass cc)
Adds the CIM class to the specified namespace. |
CIMObjectPath |
createInstance(CIMObjectPath name,
CIMInstance ci)
Invokes the object manager on this client to add the specified CIM instance to the specified namespace. |
void |
createNameSpace(CIMNameSpace ns)
Creates a CIM namespace, a directory containing CIM classes and CIM instances. |
void |
createQualifierType(CIMObjectPath name,
CIMQualifierType qt)
Adds the specified CIM qualifier type to the specified namespace. |
void |
deleteClass(CIMObjectPath path)
Deletes the CIM class for the object specified by the CIM object path, a name that uniquely identifies a CIM object. |
void |
deleteInstance(CIMObjectPath path)
Deletes the CIM instance specified by the CIM object path, a name that uniquely identifies a CIM object. |
void |
deleteNameSpace(CIMNameSpace ns)
Deletes the specified namespace. |
void |
deleteQualifierType(CIMObjectPath path)
Deletes the CIM qualfier for the object specified by the CIM object path, a name that uniquely identifies a CIM object. |
java.lang.String |
encryptData(java.lang.String clearData)
This method encrypts a limited sized string value using the current authentication exchange session key. |
java.util.Enumeration |
enumClass(CIMObjectPath path,
boolean deep)
Enumerates the class specified in the path. |
java.util.Enumeration |
enumClass(CIMObjectPath path,
boolean deep,
boolean localOnly)
Enumerates the class specified in the path. |
java.util.Enumeration |
enumInstances(CIMObjectPath path,
boolean deep)
Returns all instances belonging to the class specified in the path. |
java.util.Enumeration |
enumInstances(CIMObjectPath path,
boolean deep,
boolean localOnly)
Returns all instances (the whole instance and not just the names) belonging to the class specified in the path. |
java.util.Enumeration |
enumNameSpace(CIMObjectPath path,
boolean deep)
Gets a list of the namespaces within the namespace specified by the CIM object path. |
java.util.Enumeration |
enumQualifierTypes(CIMObjectPath path)
Enumerates the qualifiers defined in a namespace. |
java.util.Enumeration |
execQuery(CIMObjectPath name,
java.lang.String query,
int queryLanguage)
Executes a query to retrieve objects. |
CIMClass |
getClass(CIMObjectPath name,
boolean localOnly)
Gets the CIM class for the specified CIM object path. |
CIMInstance |
getInstance(CIMObjectPath name,
boolean localOnly)
Gets the CIM instance for the specified CIM object path. |
CIMValue |
getProperty(CIMObjectPath name,
java.lang.String propertyName)
Invokes the object manager on this client to get the specified CIM instance property. |
CIMQualifierType |
getQualifierType(CIMObjectPath name)
Gets the CIM qualifier type specified in the CIM object path. |
CIMValue |
invokeMethod(CIMObjectPath name,
java.lang.String methodName,
java.util.Vector inParams,
java.util.Vector outParams)
Executes the specified method on the specified object. |
java.util.Enumeration |
referenceNames(CIMObjectPath objectName,
java.lang.String resultClass,
java.lang.String role)
This operation is used to enumerate the association objects that refer to a particular target CIM Object (Class or Instance). |
java.util.Enumeration |
references(CIMObjectPath objectName,
java.lang.String resultClass,
java.lang.String role,
boolean includeQualifiers,
boolean includeClassOrigin,
java.lang.String[] propertyList)
This operation is used to enumerate the association objects that refer to a particular target CIM Object (Class or Instance). |
void |
removeCIMListener(CIMListener l)
Removes the specified listener |
void |
setClass(CIMObjectPath name,
CIMClass cc)
Adds the CIM class to the specified namespace. |
void |
setInstance(CIMObjectPath name,
CIMInstance ci)
Invokes the object manager on this client to add/set the specified CIM instance to the specified namespace. |
void |
setProperty(CIMObjectPath name,
java.lang.String propertyName,
CIMValue cv)
Invokes the object manager on this client to set the specified CIM instance property. |
void |
setQualifierType(CIMObjectPath name,
CIMQualifierType qt)
Adds the specified CIM qualifier type to the specified namespace. |
Method Detail |
public void createNameSpace(CIMNameSpace ns) throws CIMException
ns
- The CIMNameSpace object that specifies a string
for the host and a string for the namespacepublic void close() throws CIMException
Example:
The following sample code closes the client connection (cc
).
cc.close();
public void deleteNameSpace(CIMNameSpace ns) throws CIMException
ns
- The CIMNameSpace object that identifies the namespace
to be deletedpublic void deleteClass(CIMObjectPath path) throws CIMException
The model path portion of the CIM object path uniquely identifies a CIM object within the namespace on the host. The model path for a class is the class name.
path
- The CIMObjectPath identifying the class to deletepublic void deleteInstance(CIMObjectPath path) throws CIMException
KEY
qualifier.
The following code sample uses deep enumeration to
get all instances of the specified class and all
its subclasses, prints the name of each instance,
and then deletes the instance.
{ CIMObjectPath cop = new CIMObjectPath(args[1]); Enumeration e = cc.enumInstances(cop, CIMClient.DEEP); while(e.hasMoreElements()) { CIMObjectPath op = (CIMObjectPath)e.nextElement(); System.out.println(op); cc.deleteInstance(op); } }
path
- The CIMObjectPath identifying the CIM instance to deletepublic void deleteQualifierType(CIMObjectPath path) throws CIMException
path
- the CIMObjectPath identifying the CIM qualifier
to deletepublic java.util.Enumeration enumNameSpace(CIMObjectPath path, boolean deep) throws CIMException
path
- The CIMObjectPath identifying the namespace to be enumerated.deep
- If set to CIMClient.DEEP, the enumeration returned will
contain the entire hierarchy of namespaces present under the
enuerated namespace. If set to CIMClient.SHALLOW the enuermation
will return only the first level children of the enumerated
namespace.public java.util.Enumeration enumClass(CIMObjectPath path, boolean deep, boolean localOnly) throws CIMException
path
- The CIMObjectPath identifying the class to be enumerated.deep
- If set to CIMClient.DEEP, the enumeration returned will
contain the names of all classes derived from the enumerated
class. If set to CIMClient.SHALLOW the enuermation will return
only the names of the first level children of the enumerated
class.localOnly
- if true, only the non-inherited properties and
methods are returned, otherwise all properties
and methods are returned.enumClass(com.sun.wbem.cim.CIMObjectPath, boolean, boolean)
public java.util.Enumeration enumInstances(CIMObjectPath path, boolean deep, boolean localOnly) throws CIMException
path
- The CIMObjectPath identifying the class whose instances are
to be enumerated.deep
- If set to CIMClient.DEEP, the enumeration returned will contain
the names of all instances of the specified class and all
classes derived from it. If set to CIMClient.SHALLOW only
names of instances belonging to the specified class are
returned.localOnly
- if true, only the non-inherited properties
are returned, otherwise all properties are returned.public java.util.Enumeration enumClass(CIMObjectPath path, boolean deep) throws CIMException
path
- The CIMObjectPath identifying the class to be enumerated.deep
- If set to CIMClient.DEEP, the enumeration returned will
contain the names of all classes derived from the enumerated
class. If set to CIMClient.SHALLOW the enuermation will return
only the names of the first level children of the enumerated
class.public java.util.Enumeration enumInstances(CIMObjectPath path, boolean deep) throws CIMException
path
- The CIMObjectPath identifying the class whose instances are
to be enumerated.deep
- If set to CIMClient.DEEP, the enumeration returned will contain
the names of all instances of the specified class and all
classes derived from it. If set to CIMClient.SHALLOW only
names of instances belonging to the specified class are
returned.public java.util.Enumeration enumQualifierTypes(CIMObjectPath path) throws CIMException
path
- The CIMObjectPath identifying the namespace whose
qualifier definitions are to be enumerated.public CIMClass getClass(CIMObjectPath name, boolean localOnly) throws CIMException
name
- the CIMObjectPath that identifies the CIM classlocalOnly
- if true, only the non-inherited properties and
methods are returned, otherwise all properties
and methods are returned.enumClass(com.sun.wbem.cim.CIMObjectPath, boolean, boolean)
public CIMInstance getInstance(CIMObjectPath name, boolean localOnly) throws CIMException
name
- CIM Object Path that identifies this CIM instancelocalOnly
- if true, only the non-inherited properties
are returned, otherwise all properties
are returned.enumInstances(com.sun.wbem.cim.CIMObjectPath, boolean, boolean)
public CIMValue invokeMethod(CIMObjectPath name, java.lang.String methodName, java.util.Vector inParams, java.util.Vector outParams) throws CIMException
name
- CIM object path that identifies the methodmethodName
- the string name of the method to be invokedinParams
- the input parameters specified as a vector of CIMValue.outParams
- The output parameters, the CIMValue of these parameters
will be appended to the outParams vector.public CIMQualifierType getQualifierType(CIMObjectPath name) throws CIMException
name
- CIM object path that identifies the CIM qualifier typepublic void setQualifierType(CIMObjectPath name, CIMQualifierType qt) throws CIMException
name
- CIM object path that identifies the CIM
qualifier typeqt
- the CIM qualifier type to be addedpublic void createQualifierType(CIMObjectPath name, CIMQualifierType qt) throws CIMException
name
- CIM object path that identifies the CIM
qualifier typeqt
- the CIM qualifier type to be addedpublic void setClass(CIMObjectPath name, CIMClass cc) throws CIMException
name
- CIM object path that identifies the CIM
class to be addedcc
- CIMClass to be addedpublic void createClass(CIMObjectPath name, CIMClass cc) throws CIMException
name
- CIM object path that identifies the CIM
class to be addedcc
- CIMClass to be addedpublic void setInstance(CIMObjectPath name, CIMInstance ci) throws CIMException
name
- CIM object path that identifies the CIM
instance to be addedci
- CIM instance to be addedExample:
The following code sample gets instances for each element in a vector, updates the property value of b to 10 in each instance, and passes the updated instance to the CIM Object Manager.
For (int i=0; i(v.size(); i++) {
CIMInstance ci = cc.getInstance(v.elementAt(i));
ci.setProperty("b",new CIMValue(10));
// sets the instance in the current namespace.cc.setInstance(new CIMObjectPath(),ci);
}
public CIMObjectPath createInstance(CIMObjectPath name, CIMInstance ci) throws CIMException
name
- CIM object path that identifies the CIM
instance to be addedci
- CIM instance to be addedpublic CIMValue getProperty(CIMObjectPath name, java.lang.String propertyName) throws CIMException
name
- CIM object path that identifies the CIM
instance to be accessedpropertyName
- Property whose value is required.public void setProperty(CIMObjectPath name, java.lang.String propertyName, CIMValue cv) throws CIMException
name
- CIM object path that identifies the CIM
instance to be accessedpropertyName
- Property whose value is to be set.newValue
- The value for property propertyName.public java.util.Enumeration execQuery(CIMObjectPath name, java.lang.String query, int queryLanguage) throws CIMException
Only queries on class instances are supported.
relNS
- CIMObjectPath that identifies the class in which
to query.query
- A string containing the text of the query.
This parameter cannot be null.ql
- Static integer that identifies the query language to use
for parsing the query string. WQL level 1 is
the only currently supported query language.Example:
The following API call returns an enumeration of all instances of
the device_class
.
cc.execQuery(new CIMObjectPath(),
SELECT * FROM device_class, cc.WQL)
public java.util.Enumeration associators(CIMObjectPath objectName, java.lang.String assocClass, java.lang.String resultClass, java.lang.String role, java.lang.String resultRole, boolean includeQualifiers, boolean includeClassOrigin, java.lang.String[] propertyList) throws CIMException
objectName
- Defines the source CIM Object whose associated
Objects are to be returned. This may be either a Class name or
Instance name (modelpath).assocClass
- The AssocClass input parameter, if not NULL, MUST be a
valid CIM Association Class name. It acts as a filter on the
returned set of Objects by mandating that each returned Object MUST be
associated to the source Object via an Instance of this
Class or one of its subclasses.resultClass
- The ResultClass input parameter, if not NULL, MUST be
a valid CIM Class name. It acts as a filter on the returned set of
Objects by mandating that each returned Object MUST be either an
Instance of this Class (or one of its subclasses) or be this
Class (or one of its subclasses).role
- The Role input parameter, if not NULL, MUST be a valid
Property name. It acts as a filter on the returned set of Objects by
mandating that each returned Object MUST be associated to the source
Object via an Association in which the source Object plays the specified
role (i.e. the name of the Property in the Association Class that refers
to the source Object MUST match the value of this parameter).resultRole
- The ResultRole input parameter, if not NULL, MUST be a
valid Property name. It acts as a filter on the returned set of Objects
by mandating that each returned Object MUST be associated to the source
Object via an Association in which the returned Object plays the
specified role (i.e. the name of the Property in the Association Class
that refers to the returned Object MUST match the value of this
parameter).includeQualifiers
- If the IncludeQualifiers input parameter is true
this specifies that all Qualifiers for each Object (including Qualifiers
on the Object and on any returned Properties) MUST be included as
includeClassOrigin
- If the IncludeClassOrigin input parameter is
true, this specifies that the CLASSORIGIN attribute MUST be present on
all appropriate elements in each returned Object. If false, no
CLASSORIGIN attributes are present in each returned Object.propertyList
- If the PropertyList input parameter is not NULL, the
members of the array define one or more Property names. Each returned
Object MUST NOT include elements for any Properties missing from this
list. Note that if LocalOnly is specified as true (or DeepInheritance is
specified as false) this acts as an additional filter on the set of
Properties returned (for example, if Property A is included in the
PropertyList but LocalOnly is set to true and A is not local to a
returned Instance, then it will not be included in that Instance). If the
PropertyList input parameter is an empty array this signifies that no
Properties are included in each returned Object. If the PropertyList
input parameter is NULL this specifies that all Properties (subject to
the conditions expressed by the other parameters) are included in each
returned Object.
If the PropertyList contains duplicate elements, the Server ignores the
duplicates but otherwise process the request normally. If the
PropertyList contains elements which are invalid Property names for any
target Object, the Server ignores such entries but otherwise process the
request normally.
Clients SHOULD NOT explicitly specify properties in the PropertyList
parameter unless they have specified a non-NULL value for the
ResultClass parameter.public java.util.Enumeration associatorNames(CIMObjectPath objectName, java.lang.String assocClass, java.lang.String resultClass, java.lang.String role, java.lang.String resultRole) throws CIMException
public java.util.Enumeration references(CIMObjectPath objectName, java.lang.String resultClass, java.lang.String role, boolean includeQualifiers, boolean includeClassOrigin, java.lang.String[] propertyList) throws CIMException
objectName
- The ObjectName input parameter defines the target CIM
Object whose referring Objects are to be returned. This is either a Class
name or Instance name (model path).ResultClass
- The ResultClass input parameter, if not NULL, MUST be
a valid CIM Class name. It acts as a filter on the returned set of
Objects by mandating that each returned Object MUST be an Instance of
this Class (or one of its subclasses), or this Class (or one of its
subclasses).role
- The Role input parameter, if not NULL, MUST be a valid
Property name. It acts as a filter on the returned set of Objects by
mandating that each returned Objects MUST refer to the target Object via
a Property whose name matches the value of this parameter.includeQualifiers
- refer to includeQualifiers for associators.includeClassOrigin
- refer to includeQualifiers for associators.propertyList
- refer to includeQualifiers for associators.public java.util.Enumeration referenceNames(CIMObjectPath objectName, java.lang.String resultClass, java.lang.String role) throws CIMException
objectName
- refer to reference method.resultClass
- refer to reference method.role
- refer to reference method.public void addCIMListener(CIMListener l) throws CIMException
l
- The listener to add. No exception is thrown if l is null.
CIMException.CIM_ERR_NOT_SUPPORTED is thrown if the remote CIMOM does
not support events.
Any duplicate listeners are ignored.public void removeCIMListener(CIMListener l) throws CIMException
l
- The listener to remove. No exception is thrown if l is null or
the listener does not exist.public java.lang.String encryptData(java.lang.String clearData) throws CIMException
clearData
- The string to be encrypted
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |