1 karl  1.7 /// @name Pegasus API Documentation

  2 karl  1.1 /* api.dxx - Top Level file for Developer api Documentation.
  3           This file defines the document strucuture and provides the introduction
  4           
  5           	$Author: karl $
  6           */
  7           /* do not change the following Name.  Used in the Frame definition.
  8           If you change it, the HTML Frame must also be changed.
  9           */
 10           /** @name Introduction
 11           
 12           <CENTER><FONT Size=+4>PEGASUS Public APIs</FONT></CENTER>
 13           
 14           <P><B><CENTER>STATUS: DRAFT FOR REVIEW</CENTER></B>

 15 karl  1.5 <SMALL><CENTER>version 1.01 30 October 2003, Pegasus 2.3</CENTER></SMALL>

 16 karl  1.1 
 17           Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards.
 18           
 19           

 20 karl  1.5 <P>This is a working document that contains the interfaces for the Pegasus 

 21 karl  1.7 CIM Server implementation.  This is created by the OpenGroup 

 22 karl  1.5 Enterprise Management Program Group.  
 23           
 24           <p>In addition to this documentation, Pegasus has a Users' Guide that 
 25           specifies overview information and how to set up and install Pegasus.  In 
 26           addition to the manual, the README files contain specific information to 
 27           aide you in when working with Pegasus and its documentation.</p> 

 28 karl  1.1 

 29 karl  1.4 <p>Within this document, you will find the following:</p>

 30 karl  1.1 <UL>

 31 karl  1.7 <LI>A definition of the public APIs defined for the current version of Pegasus including
 32           the client, CIMOM, and provider APIs.

 33 karl  1.4 <LI>Information on the status of these APIs (frozen, experimental, etc.).

 34 karl  1.2 <LI> Usage examples of the APIs with the defintions.

 35 karl  1.1 </UL>
 36           

 37 karl  1.4 <p>The following are interfaces that are frozen with the 2.3 release of Pegasus:

 38 karl  1.5 CONNIE: we will go nuts if we try to do the lists this way.  We need to mark them
 39                   in the classes and methods themselves, not in this list.  In reality
 40                   all interfaces that are not explicitly marked experimental are frozen.
 41                   We should state that.
 42                   Need to reference PEP 57 as the authority for this release.

 43 karl  1.4 
 44           
 45           <p>The following are interfaces that are experimental:

 46 karl  1.5 CONNIE: We might get by with this experimental list but it will change for each
 47                   version of the document.

 48 karl  1.4 
 49           
 50           <p>The following is the complete file hiearchy for this document.

 51 karl  1.1    We have tried to keep all file references in only this one place
 52              to make modification easier.  In the future, please keep the
 53              references here and text in the individual files.

 54 karl  1.4   </p>

 55 karl  1.1    
 56           TBD: Pegasus API version information
 57           */
 58           

 59 karl  1.7 /** @name Pegasus CIM Objects and Common Function APIs.
 60           	This section defines the Pegasus C++ Classes that represent

 61 karl  1.5         the CIM objects and the common functions used by Pegasus 

 62 karl  1.6 */
 63                       

 64 karl  1.1         //@{

 65 karl  1.3         /// @name Classes for CIM Objects and Containers

 66 karl  1.1            //@{ 
 67           		//@Include: ../../src/Pegasus/Common/Array.h

 68 karl  1.2 		//@Include: ../../src/Pegasus/Common/ArrayInter.h

 69 karl  1.1 		//@Include: ../../src/Pegasus/Common/Boolean.h
 70           		//@Include: ../../src/Pegasus/Common/CIMClass.h
 71           		//@Include: ../../src/Pegasus/Common/CIMDateTime.h
 72           		//@Include: ../../src/Pegasus/Common/CIMFlavor.h
 73           		//@Include: ../../src/Pegasus/Common/CIMIndication.h
 74           		//@Include: ../../src/Pegasus/Common/CIMInstance.h
 75           		//@Include: ../../src/Pegasus/Common/CIMMethod.h
 76           		//@Include: ../../src/Pegasus/Common/CIMName.h
 77           		//@Include: ../../src/Pegasus/Common/CIMObject.h
 78           		//@Include: ../../src/Pegasus/Common/CIMObjectPath.h
 79           		//@Include: ../../src/Pegasus/Common/CIMParamValue.h
 80           		//@Include: ../../src/Pegasus/Common/CIMParameter.h
 81           		//@Include: ../../src/Pegasus/Common/CIMProperty.h
 82           		//@Include: ../../src/Pegasus/Common/CIMPropertyList.h
 83           		//@Include: ../../src/Pegasus/Common/CIMQualifier.h
 84           		//@Include: ../../src/Pegasus/Common/CIMQualifierDecl.h
 85           		//@Include: ../../src/Pegasus/Common/CIMQualifierList.h
 86           		//@Include: ../../src/Pegasus/Common/CIMScope.h
 87           		//@Include: ../../src/Pegasus/Common/CIMStatusCode.h
 88           		//@Include: ../../src/Pegasus/Common/CIMType.h
 89           		//@Include: ../../src/Pegasus/Common/CIMValue.h
 90 karl  1.1 		//@Include: ../../src/Pegasus/Common/Char16.h

 91 karl  1.2 		//@Include: ../../src/Pegasus/Common/Config.h
 92           		//@Include: ../../src/Pegasus/Common/String.h

 93 karl  1.3 		//@Include: ../../src/Pegasus/Common/CIMIndication.h
 94           	    //@}

 95 karl  1.7         /// @name General Server Functionality Classes

 96 karl  1.3            //@{ 

 97 karl  1.1 		//@Include: ../../src/Pegasus/Common/OperationContext.h

 98 karl  1.2 		//@Include: ../../src/Pegasus/Common/ResponseHandler.h
 99           		//@Include: ../../src/Pegasus/Common/SSLContext.h

100 karl  1.3             //@}

101 karl  1.5        /// @name CIM Object Exceptions

102 karl  1.3             //@{

103 karl  1.1         	//@Include: ../../src/Pegasus/Common/Exception.h
104                       //@}

105 karl  1.3        //@}

106 karl  1.7     /// @name Client Interfaces

107 karl  1.1        //@{
108           	    /** @name Pegasus Operations
109           	    NOTE That this section should probably go away
110           	    */
111           	        //@{
112           		    //@Include: ../../doc/CIMOperations.h
113           		//@}

114 karl  1.3 	    /// @name Pegasus Client CIM Operation and Connection Interfaces   

115 karl  1.1 		//@{    
116           		    //@Include: ../../src/Pegasus/Client/CIMClient.h

117 karl  1.5 		    //@Include: ../../src/Pegasus/Client/CIMClientException.h

118 karl  1.1 		//@}

119 karl  1.3 	    /// @name Pegasus Client SLP interfaces   
120           		//@{    
121           		    //@Include: ../../src/Pegasus/Client/CIMServerDiscovery.h
122           		    //@Include: ../../src/Pegasus/Client/CIMServerDescription.h
123           		    //@Include: ../../src/Pegasus/Client/Attribute.h
124           		//@}
125           	    /// @name Pegasus Listener Interfaces   
126           		//@{    
127           		    //@Include: ../../src/Pegasus/Listener/CIMListener.h
128           		//@}

129 karl  1.2        //@}

130 karl  1.7    /// @name C++ Provider Interfaces

131 karl  1.2 	//@{

132 karl  1.3 	    /// Pegasus CIM Provider Types and Interfaces
133           	        //@{
134           			//@Include: ../../src/Pegasus/Provider/CIMProvider.h
135           			//@Include: ../../src/Pegasus/Provider/CIMAssociationProvider.h

136 karl  1.5 			//@Include: ../../src/Pegasus/Consumer/CIMIndicationConsumer.h

137 karl  1.3 			//@Include: ../../src/Pegasus/Provider/CIMIndicationProvider.h
138           			//@Include: ../../src/Pegasus/Provider/CIMInstanceProvider.h
139           			//@Include: ../../src/Pegasus/Provider/CIMMethodProvider.h
140           	        //@}  	 
141           	    /// Pegasus CIM Provider  CIMOM Handle Callback

142 karl  1.6 	        //@{ 
143           		    //@Include: ../../src/Pegasus/Provider/CIMOMHandle.h
144           	        //@}  	 

145 karl  1.3 	    /// Pegasus CIM Provider Exceptions

146 karl  1.6 	        //@{ 
147           		    //@Include: ../../src/Pegasus/Provider/ProviderException.h
148                           //@}
149           	//@}  	 

150 karl  1.5   /// @name Pegasus Server Indication Consumer
151                   //@{
152                           //@Include: ../../src/Pegasus/Consumer/CIMIndicationConsumer.h
153                   //@}  	 
154           

155 karl  1.7 /// @name General Information on the APIs
156                   //@{
157                           //@Include: Commondefinitions.dxx
158                   //@}
159           //@Include: definitions.dxx

160 karl  1.5 

161 karl  1.1 /** @name Document References
162           
163           This section will contain references to external documents.
164           

165 karl  1.7 NOTE: Documents we must reference include:
166           	<UL>
167           	<LI>CIM Operations Spec.
168           	<LI>CIM Spec.
169           	</UL>
170           */ 

171 karl  1.1 
172            
173