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

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

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

 19 karl  1.5 <P>This is a working document that contains the interfaces for the Pegasus 
 20           CIM Server implementation.  This is being created by the OpenGroup 
 21           Enterprise Management Program Group.  
 22           
 23           <p>In addition to this documentation, Pegasus has a Users' Guide that 
 24           specifies overview information and how to set up and install Pegasus.  In 
 25           addition to the manual, the README files contain specific information to 
 26           aide you in when working with Pegasus and its documentation.</p> 

 27 karl  1.1 

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

 29 karl  1.1 <UL>

 30 karl  1.4 <LI>A definition of the public APIs defined for the current version of Pegasus including the client, CIMOM, and provider APIs.
 31           <LI>Information on the status of these APIs (frozen, experimental, etc.).

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

 33 karl  1.1 </UL>
 34           

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

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

 41 karl  1.4 
 42           
 43           <p>The following are interfaces that are experimental:

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

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

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

 52 karl  1.4   </p>

 53 karl  1.1    
 54           TBD: Pegasus API version information
 55           */
 56           

 57 karl  1.2 /** @name Pegasus CIM Objects and Common Function APIs

 58 karl  1.5 	This section defines the Pegasus C++ Class that represent
 59                   the CIM objects and the common functions used by Pegasus 

 60 karl  1.1 */    
 61                   //@{

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

 63 karl  1.1            //@{ 
 64           		//@Include: ../../src/Pegasus/Common/Array.h

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

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

 88 karl  1.2 		//@Include: ../../src/Pegasus/Common/Config.h
 89           		//@Include: ../../src/Pegasus/Common/String.h

 90 karl  1.3 		//@Include: ../../src/Pegasus/Common/CIMIndication.h
 91           	    //@}
 92                   /// @name Classes General Functionality
 93                      //@{ 

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

 95 karl  1.2 		//@Include: ../../src/Pegasus/Common/ResponseHandler.h
 96           		//@Include: ../../src/Pegasus/Common/SSLContext.h

 97 karl  1.3             //@}

 98 karl  1.5        /// @name CIM Object Exceptions

 99 karl  1.3             //@{

100 karl  1.1         	//@Include: ../../src/Pegasus/Common/Exception.h
101                       //@}

102 karl  1.3        //@}

103 karl  1.2     /// @name ClientInterfaces

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

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

112 karl  1.1 		//@{    
113           		    //@Include: ../../src/Pegasus/Client/CIMClient.h

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

115 karl  1.1 		//@}

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

126 karl  1.2        //@}
127              /// @name Pegasus Provider Interfaces
128           	//@{

129 karl  1.3 	    /// Pegasus CIM Provider Types and Interfaces
130           	        //@{
131           			//@Include: ../../src/Pegasus/Provider/CIMProvider.h
132           			//@Include: ../../src/Pegasus/Provider/CIMAssociationProvider.h

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

134 karl  1.3 			//@Include: ../../src/Pegasus/Provider/CIMIndicationProvider.h
135           			//@Include: ../../src/Pegasus/Provider/CIMInstanceProvider.h
136           			//@Include: ../../src/Pegasus/Provider/CIMMethodProvider.h
137           	        //@}  	 
138           	    /// Pegasus CIM Provider  CIMOM Handle Callback
139           	      //@{ 

140 karl  1.2 		//@Include: ../../src/Pegasus/Provider/CIMOMHandle.h

141 karl  1.5 	      //@}  	 

142 karl  1.3 	    /// Pegasus CIM Provider Exceptions
143           	      //@{ 

144 karl  1.2 		//@Include: ../../src/Pegasus/Provider/ProviderException.h

145 karl  1.3 	      //@}  	 

146 karl  1.5 	//@}
147             /// @name Pegasus Server Indication Consumer
148                   //@{
149                           //@Include: ../../src/Pegasus/Consumer/CIMIndicationConsumer.h
150                   //@}  	 
151           
152           /** @name References and Glossary
153           This section contains common definitions, glossary information, etc.
154           */ 
155                //@{
156                   //@Include: ../DevManual/references.dxx
157                //@}
158           

159 karl  1.1 /** @name Document References
160           
161           This section will contain references to external documents.
162           
163           NOTE: documents we must reference include:
164           
165           <UL>
166           	<LI>DMTF Specifications
167           	<LI>
168           </UL/

169 karl  1.5 */    

170 karl  1.1  
171