version 1.2, 2003/10/03 16:55:31
|
version 1.6, 2003/10/30 14:46:09
|
|
|
<CENTER><FONT Size=+4>PEGASUS Public APIs</FONT></CENTER> | <CENTER><FONT Size=+4>PEGASUS Public APIs</FONT></CENTER> |
| |
<P><B><CENTER>STATUS: DRAFT FOR REVIEW</CENTER></B> | <P><B><CENTER>STATUS: DRAFT FOR REVIEW</CENTER></B> |
<SMALL><CENTER>version 1.01 13 September 2003, Pegasus 2.3</CENTER></SMALL> |
<SMALL><CENTER>version 1.01 30 October 2003, Pegasus 2.3</CENTER></SMALL> |
| |
Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards. | Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards. |
| |
<B>This Document</B> |
|
| |
<P>This is a working document that is the temporary user and developers manual for the Pegasus CIM Server implementation which is being created by the OpenGroup Enterprise Management Program Group. |
<P>This is a working document that contains the interfaces for the Pegasus |
|
CIM Server implementation. This is being created by the OpenGroup |
|
Enterprise Management Program Group. |
|
|
|
<p>In addition to this documentation, Pegasus has a Users' Guide that |
|
specifies overview information and how to set up and install Pegasus. In |
|
addition to the manual, the README files contain specific information to |
|
aide you in when working with Pegasus and its documentation.</p> |
| |
This manual serves as both a manual for installation and operation of the prototype version of Pegasus and a manual for developing components to attach to Pegasus. In addition to the manual, we keep current working information in a set of README files within the Pegasus distributions. Please consult these files also. |
<p>Within this document, you will find the following:</p> |
|
|
Within this document you will find: |
|
<UL> | <UL> |
<LI>definition of the public APIs defined for the current version of Pegasus including the client, CIMOM, and provider APIs |
<LI>A definition of the public APIs defined for the current version of Pegasus including the client, CIMOM, and provider APIs. |
<LI> Information on the status of these APIs (frozen, experimental, etc.) |
<LI>Information on the status of these APIs (frozen, experimental, etc.). |
<LI> Usage examples of the APIs with the defintions. | <LI> Usage examples of the APIs with the defintions. |
</UL> | </UL> |
*/ |
|
| |
/* The following is the complete file hiearchy for this document. |
<p>The following are interfaces that are frozen with the 2.3 release of Pegasus: |
|
CONNIE: we will go nuts if we try to do the lists this way. We need to mark them |
|
in the classes and methods themselves, not in this list. In reality |
|
all interfaces that are not explicitly marked experimental are frozen. |
|
We should state that. |
|
Need to reference PEP 57 as the authority for this release. |
|
|
|
|
|
<p>The following are interfaces that are experimental: |
|
CONNIE: We might get by with this experimental list but it will change for each |
|
version of the document. |
|
|
|
|
|
<p>The following is the complete file hiearchy for this document. |
We have tried to keep all file references in only this one place | We have tried to keep all file references in only this one place |
to make modification easier. In the future, please keep the | to make modification easier. In the future, please keep the |
references here and text in the individual files. | references here and text in the individual files. |
|
</p> |
| |
TBD: Pegasus API version information | TBD: Pegasus API version information |
*/ | */ |
| |
/** @name Pegasus CIM Objects and Common Function APIs | /** @name Pegasus CIM Objects and Common Function APIs |
NOTE: This needs to be reorganized to take into account a structure for these APIs |
This section defines the Pegasus C++ Class that represent |
|
the CIM objects and the common functions used by Pegasus |
*/ | */ |
|
|
//@{ | //@{ |
|
/// @name Classes for CIM Objects and Containers |
//@{ | //@{ |
//@Include: ../../src/Pegasus/Common/Array.h | //@Include: ../../src/Pegasus/Common/Array.h |
//@Include: ../../src/Pegasus/Common/ArrayInter.h | //@Include: ../../src/Pegasus/Common/ArrayInter.h |
|
|
//@Include: ../../src/Pegasus/Common/CIMObjectPath.h | //@Include: ../../src/Pegasus/Common/CIMObjectPath.h |
//@Include: ../../src/Pegasus/Common/CIMParamValue.h | //@Include: ../../src/Pegasus/Common/CIMParamValue.h |
//@Include: ../../src/Pegasus/Common/CIMParameter.h | //@Include: ../../src/Pegasus/Common/CIMParameter.h |
//@Include: ../../src/Pegasus/Common/CIMPredicate.h |
|
//@Include: ../../src/Pegasus/Common/CIMProperty.h | //@Include: ../../src/Pegasus/Common/CIMProperty.h |
//@Include: ../../src/Pegasus/Common/CIMPropertyList.h | //@Include: ../../src/Pegasus/Common/CIMPropertyList.h |
//@Include: ../../src/Pegasus/Common/CIMQualifier.h | //@Include: ../../src/Pegasus/Common/CIMQualifier.h |
|
|
//@Include: ../../src/Pegasus/Common/Char16.h | //@Include: ../../src/Pegasus/Common/Char16.h |
//@Include: ../../src/Pegasus/Common/Config.h | //@Include: ../../src/Pegasus/Common/Config.h |
//@Include: ../../src/Pegasus/Common/String.h | //@Include: ../../src/Pegasus/Common/String.h |
|
//@Include: ../../src/Pegasus/Common/CIMIndication.h |
|
//@} |
|
/// @name Classes General Functionality |
|
//@{ |
//@Include: ../../src/Pegasus/Common/OperationContext.h | //@Include: ../../src/Pegasus/Common/OperationContext.h |
//@Include: ../../src/Pegasus/Common/ResponseHandler.h | //@Include: ../../src/Pegasus/Common/ResponseHandler.h |
|
|
//@Include: ../../src/Pegasus/Common/SSLContext.h | //@Include: ../../src/Pegasus/Common/SSLContext.h |
/* effective 2.3 */ |
//@} |
//@Include: ../../src/Pegasus/Common/CIMIndication.h |
/// @name CIM Object Exceptions |
|
|
//@{ | //@{ |
/// @name Exceptions |
|
//@Include: ../../src/Pegasus/Common/Exception.h | //@Include: ../../src/Pegasus/Common/Exception.h |
//@} | //@} |
//@} | //@} |
|
|
//@} |
|
/// @name ClientInterfaces | /// @name ClientInterfaces |
//@{ | //@{ |
/** @name Pegasus Operations | /** @name Pegasus Operations |
|
|
//@{ | //@{ |
//@Include: ../../doc/CIMOperations.h | //@Include: ../../doc/CIMOperations.h |
//@} | //@} |
/// @name Pegasus Client Interfaces |
/// @name Pegasus Client CIM Operation and Connection Interfaces |
//@{ | //@{ |
//@Include: ../../src/Pegasus/Client/CIMClient.h | //@Include: ../../src/Pegasus/Client/CIMClient.h |
|
//@Include: ../../src/Pegasus/Client/CIMClientException.h |
|
//@} |
|
/// @name Pegasus Client SLP interfaces |
|
//@{ |
|
//@Include: ../../src/Pegasus/Client/CIMServerDiscovery.h |
|
//@Include: ../../src/Pegasus/Client/CIMServerDescription.h |
|
//@Include: ../../src/Pegasus/Client/Attribute.h |
|
//@} |
|
/// @name Pegasus Listener Interfaces |
|
//@{ |
|
//@Include: ../../src/Pegasus/Listener/CIMListener.h |
//@} | //@} |
//@} | //@} |
/// @name Pegasus Provider Interfaces | /// @name Pegasus Provider Interfaces |
//@{ | //@{ |
|
/// Pegasus CIM Provider Types and Interfaces |
|
//@{ |
//@Include: ../../src/Pegasus/Provider/CIMProvider.h | //@Include: ../../src/Pegasus/Provider/CIMProvider.h |
//@Include: ../../src/Pegasus/Provider/CIMAssociationProvider.h | //@Include: ../../src/Pegasus/Provider/CIMAssociationProvider.h |
//@Include: ../../src/Pegasus/Provider/CIMIndicationConsumer.h |
//@Include: ../../src/Pegasus/Consumer/CIMIndicationConsumer.h |
//@Include: ../../src/Pegasus/Provider/CIMIndicationProvider.h | //@Include: ../../src/Pegasus/Provider/CIMIndicationProvider.h |
//@Include: ../../src/Pegasus/Provider/CIMInstanceProvider.h | //@Include: ../../src/Pegasus/Provider/CIMInstanceProvider.h |
//@Include: ../../src/Pegasus/Provider/CIMMethodProvider.h | //@Include: ../../src/Pegasus/Provider/CIMMethodProvider.h |
|
//@} |
|
/// Pegasus CIM Provider CIMOM Handle Callback |
|
//@{ |
//@Include: ../../src/Pegasus/Provider/CIMOMHandle.h | //@Include: ../../src/Pegasus/Provider/CIMOMHandle.h |
|
//@} |
|
/// Pegasus CIM Provider Exceptions |
|
//@{ |
//@Include: ../../src/Pegasus/Provider/ProviderException.h | //@Include: ../../src/Pegasus/Provider/ProviderException.h |
//@} | //@} |
|
//@} |
|
/// @name Pegasus Server Indication Consumer |
|
//@{ |
|
//@Include: ../../src/Pegasus/Consumer/CIMIndicationConsumer.h |
|
//@} |
|
|
|
/** @name References and Glossary |
|
This section contains common definitions, glossary information, etc. |
|
*/ |
|
//@{ |
|
//@Include: ../DevManual/references.dxx |
|
//@} |
|
|
/** @name Document References | /** @name Document References |
| |
This section will contain references to external documents. | This section will contain references to external documents. |
|
|
<LI>DMTF Specifications | <LI>DMTF Specifications |
<LI> | <LI> |
</UL/ | </UL/ |
*/ //@Include: references.dxx |
*/ |
| |
| |