[an error occurred while processing this directive]

Pegasus CIM Object Broker Documentation

[an error occurred while processing this directive]

Contents

Introduction
Objectives
Overview
Credits
Pegasus Architecture
Design Goals
The Broker
Pegasus Providers.
Extension Services
Pegasus Clients.
Functional Flow
Pegasus Components
Component Descriptions
Pegasus Directory Structure
Pegasus Utilization
Pegasus Availability
Pegasus Installation
Pegasus Operation
Pegasus CIM Clients
Pegasus Providers
Pegasus MOF Compiler
Programming Pegasus
CIM Objects in Pegasus
CIM Object Table
Class Definitions
Pegasus Interfaces
CIM Operations over HTTP
Pegasus Client Interfaces
Pegasus Provider Interfaces
Pegasus Service Extension Interfaces
Repository Interfaces
Writing Providers.
Glossary
Pegasus Code Examples
Client Examples
Client Coding Examples
Provider Coding Examples
Document References
Pegausus FAQ

In file ../../src/Pegasus/Client/CIMClient.h:

class PEGASUS_CLIENT_LINKAGE CIMClient

The CIMClient class provides an interface for a client application to communicate with a CIM Server.

Documentation

The CIMClient class provides an interface for a client application to communicate with a CIM Server. The client application specifies the target CIM Server by providing connection parameters and authentication credentials (as necessary).
The CIMClient class models the functionality defined in the DMTF's Specification for CIM Operations over HTTP (DSP0200) version 1.2, using similar operations and parameters.

Inheritance:

Public Methods

CIMClient()

Constructs a CIMClient object

~CIMClient()

Destructs a CIMClient object

Uint32 getTimeout() const

Gets the currently configured timeout value for the CIMClient object.


Returns:: An integer indicating the currently configured timeout value (in milliseconds).

void setTimeout(Uint32 timeoutMilliseconds)

Sets the timeout value for CIMClient operations. If an operation response is not received within this timeout value, a ConnectionTimeoutException is thrown and the connection is reset. The default timeout value is 20 seconds (20000 milliseconds).


Parameters:: timeoutMilliseconds - An integer specifying the timeout value (in milliseconds).

void connect( const String& host, const Uint32 portNumber, const String& userName, const String& password)

Connects to the CIM Server at the specified host name and port number. Example usage:

            CIMClient client;
            String host("localhost");
            try
            {
                client.connect(host, 5988, "guest", "guest");
            }
            catch (Exception& e)
            {
                cerr << "Pegasus Exception: " << e.getMessage() <<
                    ". Trying to connect to " << host << endl;
            }


Throws:: AlreadyConnectedException If the CIMClient is already connected to a CIM Server.
InvalidLocatorException If the specified address is improperly formed.
CannotCreateSocketException If a socket cannot be created.
CannotConnectException If the socket connection fails.
CIMClientConnectionException If any other failure occurs.
Parameters:: host - A String host name to connect to. If host is an empty string and portNumber is 0, the client will attempt to connect to the server's unix domain socket (on supporting platforms).
portNumber - A Uint32 port number to connect to.
userName - A String specifying the user name for the connection.
password - A String containing the password of the specified user.

void connect( const String& host, const Uint32 portNumber, const SSLContext& sslContext, const String& userName, const String& password)

Connects to the CIM Server at the specified host name, port number and SSL context.


Throws:: AlreadyConnectedException If the CIMClient is already connected to a CIM Server.
InvalidLocatorException If the specified address is improperly formed.
CannotCreateSocketException If a socket cannot be created.
CannotConnectException If the socket connection fails.
CIMClientConnectionException If any other failure occurs.
Parameters:: host - A String host name to connect to.
portNumber - A Uint32 port number to connect to.
sslContext - The SSL context to use for this connection.
userName - A String specifying the user name for the connection.
password - A String containing the password of the specified user.

void connectLocal()

Connects to the local CIM Server as the current user. Authentication is performed automatically, so no credentials are required for this connection.


Throws:: AlreadyConnectedException If the CIMClient is already connected to a CIM Server.
CannotCreateSocketException If a socket cannot be created.
CannotConnectException If the socket connection fails.
CIMClientConnectionException If any other failure occurs.

void disconnect()

Disconnects from the CIM Server. If no connection is established, this method has no effect. A CIMClient with an existing connection must be disconnected before establishing a new connection.

void setRequestAcceptLanguages(const AcceptLanguageList& langs)

Configures the accept languages to be specified on subsequent requests from this client. Accept languages are the preferred languages for response data.


Parameters:: langs - An AcceptLanguageList object specifying the languages preferred by this client.

AcceptLanguageList getRequestAcceptLanguages() const

Gets the accept languages currently configured for this client. Accept languages are the preferred languages for response data.


Returns:: An AcceptLanguageList object specifying the preferred languages configured for this client.

void setRequestContentLanguages(const ContentLanguageList& langs)

Configures the content languages to be specified on subsequent requests from this client. The content languages indicate the languages associated with request data sent from this client.


Parameters:: langs - A ContentLanguageList object specifying the languages associated with this client's request data.

ContentLanguageList getRequestContentLanguages() const

Gets the content languages currently configured for this client. The content languages indicate the languages associated with request data sent from this client.


Returns:: A ContentLanguageList object specifying the languages used in request data from this client.

ContentLanguageList getResponseContentLanguages() const

Gets the content languages of the last response received by this client. The content languages indicate the languages associated with the data included in the response.


Returns:: A ContentLanguageList object specifying the languages used in the last response received by this client.

void setRequestDefaultLanguages()

Experimental Interface

CIMClass getClass( const CIMNamespaceName& nameSpace, const CIMName& className, Boolean localOnly = true, Boolean includeQualifiers = true, Boolean includeClassOrigin = false, const CIMPropertyList& propertyList = CIMPropertyList())

Gets a specified CIM Class from a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
className - A CIMName that specifies the CIM Class to be retrieved.
localOnly - A Boolean indicating whether only the elements (properties, methods, and qualifiers) defined or overridden within the definition of the Class are to be returned. If false, all elements are requested. If not specified, this parameter defaults to true.
includeQualifiers - A Boolean indicating whether the Qualifiers for the Class (including Qualifiers on the Class and on any returned Properties, Methods, or Method Parameters) are to be included in the response. If false, no Qualifiers are requested. If not specified, this parameter defaults to true.
includeClassOrigin - A Boolean indicating whether the Class Origin attribute is to be included in elements of the returned Class. If false, no Class Origin attributes are requested. If not specified, this parameter defaults to false.
propertyList - A CIMPropertyList which optionally limits the Property elements included in the returned Class. If not NULL, the returned Class is not to include Properties that are omitted from the list. If NULL, no specific filtering of Properties is requested. (An empty list, distinct from a NULL list, indicates that no Properties are to be included in the returned Class.) Note that this parameter acts as an additional filter in conjunction with the localOnly parameter. If not specified, this parameter defaults to NULL.
Returns:: A CIMClass containing the requested Class definition.

CIMInstance getInstance( const CIMNamespaceName& nameSpace, const CIMObjectPath& instanceName, Boolean localOnly = true, Boolean includeQualifiers = false, Boolean includeClassOrigin = false, const CIMPropertyList& propertyList = CIMPropertyList())

Gets a specified CIM Instance from a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
instanceName - A CIMObjectPath that identifies the CIM Instance to be retrieved.
localOnly - (DEPRECATED) A Boolean indicating whether only the properties and qualifiers defined or overridden within the Instance are to be returned. If false, all elements are requested. If not specified, this parameter defaults to true.
includeQualifiers - (DEPRECATED) A Boolean indicating whether the Qualifiers for the Instance (including Qualifiers on the Instance and on any returned Properties) are to be included in the response. If false, no Qualifiers are requested. If not specified, this parameter defaults to false.
includeClassOrigin - A Boolean indicating whether the Class Origin attribute is to be included in elements of the returned Instance. If false, no Class Origin attributes are requested. If not specified, this parameter defaults to false.
propertyList - A CIMPropertyList which optionally limits the Property elements included in the returned Instance. If not NULL, the returned Instance is not to include Properties that are omitted from the list. If NULL, no specific filtering of Properties is requested. (An empty list, distinct from a NULL list, indicates that no Properties are to be included in the returned Instance.) Note that this parameter acts as an additional filter in conjunction with the localOnly parameter. If not specified, this parameter defaults to NULL.
Returns:: A CIMInstance containing the requested Instance.

void deleteClass( const CIMNamespaceName& nameSpace, const CIMName& className)

Deletes a specified CIM Class from a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
className - A CIMName that specifies the CIM Class to be deleted.

void deleteInstance( const CIMNamespaceName& nameSpace, const CIMObjectPath& instanceName)

Deletes a specified CIM Instance from a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
instanceName - A CIMObjectPath that identifies the CIM Instance to be deleted.

void createClass( const CIMNamespaceName& nameSpace, const CIMClass& newClass)

Creates a specified CIM Class in a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
newClass - A CIMClass containing the new Class definition to be created.

CIMObjectPath createInstance( const CIMNamespaceName& nameSpace, const CIMInstance& newInstance)

Creates a specified CIM Instance in a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
newInstance - A CIMInstance containing the new Instance to be created.
Returns:: A CIMObjectPath containing the name of the newly created Instance.

void modifyClass( const CIMNamespaceName& nameSpace, const CIMClass& modifiedClass)

Modifies a specified CIM Class in a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
modifiedClass - A CIMClass containing the updates to be made to the Class definition.

void modifyInstance( const CIMNamespaceName& nameSpace, const CIMInstance& modifiedInstance, Boolean includeQualifiers = true, const CIMPropertyList& propertyList = CIMPropertyList())

Modifies a specified CIM Instance in a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
modifiedInstance - A CIMInstance containing the name of the Instance to be modified (specified by the Path attribute) and the updates to be made to the Instance.
includeQualifiers - (DEPRECATED) A Boolean indicating whether the Qualifiers for the Instance (including Qualifiers on the Instance and its Properties) are to be updated. If not specified, this parameter defaults to true.
propertyList - A CIMPropertyList which optionally limits the Property elements that are updated. If not NULL, Properties that are omitted from the list are not updated. If NULL, all Properties are updated. (An empty list, distinct from a NULL list, indicates that no Properties are to be updated.) If not specified, this parameter defaults to NULL.

Array<CIMClass> enumerateClasses( const CIMNamespaceName& nameSpace, const CIMName& className = CIMName(), Boolean deepInheritance = false, Boolean localOnly = true, Boolean includeQualifiers = true, Boolean includeClassOrigin = false)

Enumerates CIM Classes derived from a specified Class in a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
className - A CIMName that specifies the CIM Class for which to enumerate derived Classes. If NULL, the Classes which have no superclass are enumerated.
deepInheritance - A Boolean indicating whether the enumeration should include all levels of derivation. If false, only the immediate subclasses are enumerated. If not specified, this parameter defaults to false.
localOnly - A Boolean indicating whether only the elements (properties, methods, and qualifiers) defined or overridden within the definition of each Class are to be returned. If false, all elements are requested. If not specified, this parameter defaults to true.
includeQualifiers - A Boolean indicating whether the Qualifiers for each Class (including Qualifiers on the Class and on any returned Properties, Methods, or Method Parameters) are to be included in the response. If false, no Qualifiers are requested. If not specified, this parameter defaults to true.
includeClassOrigin - A Boolean indicating whether the Class Origin attribute is to be included in elements of each returned Class. If false, no Class Origin attributes are requested. If not specified, this parameter defaults to false.
Returns:: An Array of zero or more CIMClass objects containing the requested Class definitions.

Array<CIMName> enumerateClassNames( const CIMNamespaceName& nameSpace, const CIMName& className = CIMName(), Boolean deepInheritance = false)

Enumerates the names of CIM Classes derived from a specified Class in a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
className - A CIMName that specifies the CIM Class for which to enumerate the names of derived Classes. If NULL, the names of Classes which have no superclass are enumerated.
deepInheritance - A Boolean indicating whether the enumeration should include all levels of derivation. If false, only the names of immediate subclasses are enumerated. If not specified, this parameter defaults to false.
Returns:: An Array of zero or more CIMName objects containing the requested Class names.

Array<CIMInstance> enumerateInstances( const CIMNamespaceName& nameSpace, const CIMName& className, Boolean deepInheritance = true, Boolean localOnly = true, Boolean includeQualifiers = false, Boolean includeClassOrigin = false, const CIMPropertyList& propertyList = CIMPropertyList())

Enumerates CIM Instances of a specified Class and its subclasses in a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
className - A CIMName that specifies the CIM Class for which to enumerate Instances.
localOnly - (DEPRECATED) A Boolean indicating whether only the properties and qualifiers defined or overridden within each Instance are to be returned. If false, all elements are requested. If not specified, this parameter defaults to true.
deepInheritance - A Boolean indicating whether the returned Instances should include properties defined in subclasses of the specified class. If false, only properties defined in the specified class are requested. If not specified, this parameter defaults to true.
includeQualifiers - (DEPRECATED) A Boolean indicating whether the Qualifiers for each Instance (including Qualifiers on the Instance and on any returned Properties) are to be included in the response. If false, no Qualifiers are requested. If not specified, this parameter defaults to false.
includeClassOrigin - A Boolean indicating whether the Class Origin attribute is to be included in elements of each returned Instance. If false, no Class Origin attributes are requested. If not specified, this parameter defaults to false.
propertyList - A CIMPropertyList which optionally limits the Property elements included in the returned Instances. If not NULL, the returned Instances are not to include Properties that are omitted from the list. If NULL, no specific filtering of Properties is requested. (An empty list, distinct from a NULL list, indicates that no Properties are to be included in the returned Instances.) Note that this parameter acts as an additional filter in conjunction with the deepInheritance and localOnly parameters. If not specified, this parameter defaults to NULL.
Returns:: An Array of zero or more CIMInstance objects containing the requested Instances.

Array<CIMObjectPath> enumerateInstanceNames( const CIMNamespaceName& nameSpace, const CIMName& className)

Enumerates the names of CIM Instances of a specified Class and its subclasses in a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
className - A CIMName that specifies the CIM Class for which to enumerate Instance names.
Returns:: An Array of zero or more CIMObjectPaths containing the requested Instance names. Host and namespace attributes are not included in these CIMObjectPath values, per the WBEM protocol.

Array<CIMObject> execQuery( const CIMNamespaceName& nameSpace, const String& queryLanguage, const String& query)

Executes a query against a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
queryLanguage - Defines the query language in which the query parameter is expressed.
query - Specifies the query to be executed.
Returns:: An Array of zero or more CIM Classes or Instances that comprise the query result.

Array<CIMObject> associators( const CIMNamespaceName& nameSpace, const CIMObjectPath& objectName, const CIMName& assocClass = CIMName(), const CIMName& resultClass = CIMName(), const String& role = String::EMPTY, const String& resultRole = String::EMPTY, Boolean includeQualifiers = false, Boolean includeClassOrigin = false, const CIMPropertyList& propertyList = CIMPropertyList())

Enumerates CIM Objects (Classes or Instances) which are associated with a specified Object in a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
objectName - A CIMObjectPath that specifies the CIM Object for which to enumerate associated Objects. It may contain either a Class name or Instance name (model path).
assocClass - A CIMName specifying an association class constraint. If not NULL, the returned Objects are to be limited to those associated with the specified Object via an Instance of this Class or one of its subclasses.
resultClass - A CIMName specifying a result filter. If not NULL, each returned Object is to be either an Instance of this Class (or one of its subclasses) or be this Class (or one of its subclasses).
role - A String specifying a role filter. If not the empty String, each returned Object is to be associated to the specified Object via an Association in which the specified Object plays the specified role (I.e., the role value matches the name of the Property in the Association Class that refers to the specified object).
resultRole - A String specifying a result role filter. If not the empty String, each returned Object is to be associated to the specified Object via an Association in which the returned Object plays the specified role (I.e., the role value matches the name of the Property in the Association Class that refers to the returned Object).
includeQualifiers - (DEPRECATED) A Boolean indicating whether the Qualifiers for each Object are to be included in the response. If false, no Qualifiers are requested. If not specified, this parameter defaults to false.
includeClassOrigin - A Boolean indicating whether the Class Origin attribute is to be included in elements of each returned Object. If false, no Class Origin attributes are requested. If not specified, this parameter defaults to false.
propertyList - A CIMPropertyList which optionally limits the Property elements included in the returned Objects. If not NULL, the returned Objects are not to include Properties that are omitted from the list. If NULL, no specific filtering of Properties is requested. (An empty list, distinct from a NULL list, indicates that no Properties are to be included in the returned Objects.) If not specified, this parameter defaults to NULL.
Returns:: An Array of zero or more CIMObjects containing the associated Classes or Instances.

Array<CIMObjectPath> associatorNames( const CIMNamespaceName& nameSpace, const CIMObjectPath& objectName, const CIMName& assocClass = CIMName(), const CIMName& resultClass = CIMName(), const String& role = String::EMPTY, const String& resultRole = String::EMPTY)

Enumerates the names of CIM Objects (Classes or Instances) which are associated with a specified Object in a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
objectName - A CIMObjectPath that specifies the CIM Object for which to enumerate the names of associated Objects. It may contain either a Class name or Instance name (model path).
assocClass - A CIMName specifying an association class constraint. If not NULL, the returned Object names are to be limited to those associated with the specified Object via an Instance of this Class or one of its subclasses.
resultClass - A CIMName specifying a result filter. If not NULL, each returned name is to identify an Object which either is an Instance of this Class (or one of its subclasses) or is this Class (or one of its subclasses).
role - A String specifying a role filter. If not the empty String, each returned Object name is to be associated to the specified Object via an Association in which the specified Object plays the specified role (I.e., the role value matches the name of the Property in the Association Class that refers to the specified object).
resultRole - A String specifying a result role filter. If not the empty String, each returned Object name is to be associated to the specified Object via an Association in which the returned Object name plays the specified role (I.e., the role value matches the name of the Property in the Association Class that refers to the returned Object name).
Returns:: An Array of zero or more CIMObjectPaths containing the names of associated Classes or Instances.

Array<CIMObject> references( const CIMNamespaceName& nameSpace, const CIMObjectPath& objectName, const CIMName& resultClass = CIMName(), const String& role = String::EMPTY, Boolean includeQualifiers = false, Boolean includeClassOrigin = false, const CIMPropertyList& propertyList = CIMPropertyList())

Enumerates CIM Association Objects (Classes or Instances) which refer to a specified Object in a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
objectName - A CIMObjectPath that specifies the CIM Object for which to enumerate referring Objects. It may contain either a Class name or Instance name (model path).
resultClass - A CIMName specifying a result filter. If not NULL, each returned Object is to be either an Instance of this Class (or one of its subclasses) or be this Class (or one of its subclasses).
role - A String specifying a result role filter. If not the empty String, each returned Object is to refer to the specified Object via a CIMProperty whose name matches the value of this parameter.
includeQualifiers - (DEPRECATED) A Boolean indicating whether the Qualifiers for each Object are to be included in the response. If false, no Qualifiers are requested. If not specified, this parameter defaults to false.
includeClassOrigin - A Boolean indicating whether the Class Origin attribute is to be included in elements of each returned Object. If false, no Class Origin attributes are requested. If not specified, this parameter defaults to false.
propertyList - A CIMPropertyList which optionally limits the Property elements included in the returned Objects. If not NULL, the returned Objects are not to include Properties that are omitted from the list. If NULL, no specific filtering of Properties is requested. (An empty list, distinct from a NULL list, indicates that no Properties are to be included in the returned Objects.) If not specified, this parameter defaults to NULL.
Returns:: An Array of zero or more CIMObjects containing the Classes or Instances that refer to the specified Object. Each returned Object contains a full Path attribute.

Array<CIMObjectPath> referenceNames( const CIMNamespaceName& nameSpace, const CIMObjectPath& objectName, const CIMName& resultClass = CIMName(), const String& role = String::EMPTY)

Enumerates the names of CIM Objects (Classes or Instances) which refer to a specified Object in a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
objectName - A CIMObjectPath that specifies the CIM Object for which to enumerate the names of referring Objects. It may contain either a Class name or Instance name (model path).
resultClass - A CIMName specifying a result filter. If not NULL, each returned name is to identify an Object which either is an Instance of this Class (or one of its subclasses) or is this Class (or one of its subclasses).
role - A String specifying a result role filter. If not the empty String, each Object for which the name is returned is to refer to the specified Object via a CIMProperty whose name matches the value of this parameter.
Returns:: An Array of zero or more CIMObjectPaths containing the names of referring Classes or Instances.

CIMValue getProperty( const CIMNamespaceName& nameSpace, const CIMObjectPath& instanceName, const CIMName& propertyName)

Gets a single Property value from a CIM Instance in a target Namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
instanceName - A CIMObjectPath that identifies the CIM Instance from which to retrieve the Property value.
propertyName - A String containing the name of the Property for which to retrieve the value.
Returns:: A CIMValue containing the requested Property value.

void setProperty( const CIMNamespaceName& nameSpace, const CIMObjectPath& instanceName, const CIMName& propertyName, const CIMValue& newValue = CIMValue())

Sets a single Property value in a CIM Instance in a target Namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
instanceName - A CIMObjectPath that identifies the CIM Instance in which to set the Property value.
propertyName - A String containing the name of the Property for which to set the value.
newValue - A CIMValue containing the new Property value. If not specified, the Property is set to NULL.

CIMQualifierDecl getQualifier( const CIMNamespaceName& nameSpace, const CIMName& qualifierName)

Gets a Qualifier declaration from a target Namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
qualifierName - A CIMName that identifies the Qualifier for which to retrieve the declaration.
Returns:: A CIMQualifierDecl containing the requested Qualifier declaration.

void setQualifier( const CIMNamespaceName& nameSpace, const CIMQualifierDecl& qualifierDeclaration)

Adds or updates a Qualifier declaration in a target Namespace. If the Qualifier declaration already exists, it is overwritten.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
qualifierDeclaration - A CIMQualifierDecl object containing the Qualifier declaration to be added or updated in the namespace.

void deleteQualifier( const CIMNamespaceName& nameSpace, const CIMName& qualifierName)

Deletes a Qualifier declaration in a target Namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
qualifierName - A CIMName containing the name of the Qualifier to be deleted.

Array<CIMQualifierDecl> enumerateQualifiers( const CIMNamespaceName& nameSpace)

Enumerates Qualifier declarations in a target Namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
Returns:: An Array of zero or more CIMQualifierDecl objects.

CIMValue invokeMethod( const CIMNamespaceName& nameSpace, const CIMObjectPath& instanceName, const CIMName& methodName, const Array<CIMParamValue>& inParameters, Array<CIMParamValue>& outParameters)

Executes an extrinsic CIM method in a target namespace.


Throws:: CIMException If the CIM Server fails to perform the requested operation. See DSP0200 for specific CIM Status Codes that may be expected.
Exception If an error occurs while sending the request or receiving the response.
Parameters:: nameSpace - A CIMNamespaceName that specifies the target namespace.
instanceName - A CIMObjectPath that defines the CIM Class or Instance on which to execute the method.
methodName - A CIMName the specifies the name of the method to execute.
inParameters - An Array of CIMParamValue objects specifying the input parameters for the method.
outParameters - An output Array of CIMParamValue objects containing the method output parameters.
Returns:: A CIMValue containing the method return value.

void registerClientOpPerformanceDataHandler( ClientOpPerformanceDataHandler & handler)

Registers a ClientOpPerformanceDataHandler object. The specified object is called with performance data relative to each operation performed by this CIMClient object. Only one ClientOpPerformanceDataHandler can be registered at a time. A subsequent registration replaces the previous one.


Parameters:: handler - The ClientOpPerformanceDataHandler object to register.

void deregisterClientOpPerformanceDataHandler()

Unregisters the current ClientOpPerformanceDataHandler, if applicable

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java

Pegasus CIM Object Broker Documentation

class PEGASUS_CLIENT_LINKAGE CIMClient

Documentation

Inheritance:

Public Methods

[an error occurred while processing this directive]