~ubuntu-branches/ubuntu/trusty/sblim-sfcb/trusty-proposed

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
/*
 * cmpiftx.h
 *
 * (C) Copyright IBM Corp. 2005
 *
 * THIS FILE IS PROVIDED UNDER THE TERMS OF THE ECLIPSE PUBLIC LICENSE
 * ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS FILE
 * CONSTITUTES RECIPIENTS ACCEPTANCE OF THE AGREEMENT.
 *
 * You can obtain a current copy of the Eclipse Public License from
 * http://www.opensource.org/licenses/eclipse-1.0.php
 *
 * Author:        Adrian Schuur <schuur@de.ibm.com>
 * Contributions  Sven Schuetz <sven@de.ibm.com>
 *
 * Description:
 *
 * CMPI extdended function tables.
 *
*/

#ifndef _CMPIFTX_H_
#define _CMPIFTX_H_

#include "constClass.h"
#include "qualifier.h"
#include "cmpidt.h"

#ifdef __cplusplus
extern "C" {
#endif

   //---------------------------------------------------
   //--
   //	_CMPIClassMI Class Provider object
   //--
   //---------------------------------------------------


   /** This structure represents a Class provider.
   */
   typedef struct _CMPIClassMIFT CMPIClassMIFT;
   typedef struct _CMPIClassMI {

       /** Opaque pointer to Provider specific implementation data.
       */
      void *hdl;

       /** Pointer to the Class Provider Function Table.
       */
      CMPIClassMIFT *ft;
   } CMPIClassMI;



   //---------------------------------------------------
   //--
   //	_CMPIClassMIFT Function Table
   //--
   //---------------------------------------------------


   /** This structure is a table of pointers providing access to Class
       provider functions. This table must be returend during initialization
       by the provider.
   */
   struct _CMPIClassMIFT {

       /** Function table version
       */
     int ftVersion;

       /** Provider version
       */
     int miVersion;

       /** Provider name
       */
     char *miName;

       /** Cleanup is called prior to unloading of the provider.
	 @param mi Provider this pointer.
	 @param ctx Invocation Context
	 @return Function return status.
      */
     CMPIStatus (*cleanup)
            (CMPIClassMI* mi, CMPIContext* ctx);

       /** Enumerate ObjectPaths of Classes serviced by this provider.
	 @param mi Provider this pointer.
	 @param ctx Invocation Context.
	 @param rslt Result data container.
	 @param op ObjectPath containing namespace and classname components.
	 @return Function return status.
      */
     CMPIStatus (*enumClassNames)
             (CMPIClassMI* mi, CMPIContext* ctx, CMPIResult* rslt,
              CMPIObjectPath* op);

       /** Enumerate the Classes serviced by this provider.
	 @param mi Provider this pointer.
	 @param ctx Invocation Context.
	 @param rslt Result data container.
	 @param op ObjectPath containing namespace and classname components.
	 @return Function return status.
      */
     CMPIStatus (*enumClasses)
             (CMPIClassMI* mi, CMPIContext* ctx, CMPIResult* rslt,
              CMPIObjectPath* op);

       /** Get the Class defined by &lt;op&gt;.
	 @param mi Provider this pointer.
	 @param ctx Invocation Context.
	 @param rslt Result data container.
	 @param op ObjectPath containing namespace, classname and key components.
	 @param properties If 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.
	 @return Function return status.
      */
     CMPIStatus (*getClass)
             (CMPIClassMI* mi, CMPIContext* ctx, CMPIResult* rslt,
              CMPIObjectPath* op, char** properties);

       /** Create Class from &lt;cls&gt; using &lt;op&gt; as reference.
	 @param mi Provider this pointer.
	 @param ctx Invocation Context.
	 @param rslt Result data container.
	 @param op ObjectPath containing namespace and classname components.
	 @param cls The Class.
	 @return Function return status.
      */
     CMPIStatus (*createClass)
             (CMPIClassMI* mi, CMPIContext* ctx, CMPIResult* rslt,
              CMPIObjectPath* op, CMPIConstClass* cls);

       /** Replace an existing Class from &lt;cls&gt; using &lt;op&gt; as reference.
	 @param mi Provider this pointer.
	 @param ctx Invocation Context.
	 @param rslt Result data container.
	 @param op ObjectPath containing namespace and classname components.
	 @param cls The Class.
	 @return Function return status.
      */
     CMPIStatus (*setClass)
             (CMPIClassMI* mi, CMPIContext* ctx, CMPIResult* rslt,
              CMPIObjectPath* op, CMPIConstClass* cls);

       /** Delete an existing Class defined by &lt;op&gt;.
	 @param mi Provider this pointer.
	 @param ctx Invocation Context.
	 @param rslt Result data container.
	 @param op ObjectPath containing namespace and classname components.
	 @return Function return status.
      */
     CMPIStatus (*deleteClass)
             (CMPIClassMI* mi, CMPIContext* ctx, CMPIResult* rslt,
              CMPIObjectPath* op);
  };


   //---------------------------------------------------
   //--
   //	_CMPIQualifierMI Qualifier Provider object
   //--
   //---------------------------------------------------


   /** This structure represents a Qualifier provider.
   */
   typedef struct _CMPIQualifierDeclMIFT CMPIQualifierDeclMIFT;
   typedef struct _CMPIQualifierDeclMI {

       /** Opaque pointer to Provider specific implementation data.
       */
      void *hdl;

       /** Pointer to the Qualifier Provider Function Table.
       */
      CMPIQualifierDeclMIFT *ft;
   } CMPIQualifierDeclMI;



   //---------------------------------------------------
   //--
   //	_CMPIQualifierMIFT Function Table
   //--
   //---------------------------------------------------


   /** This structure is a table of pointers providing access to Qualifier
       provider functions. This table must be returend during initialization
       by the provider.
   */
   struct _CMPIQualifierDeclMIFT {

       /** Function table version
       */
     int ftVersion;

       /** Provider version
       */
     int miVersion;

       /** Provider name
       */
     char *miName;

       /** Cleanup is called prior to unloading of the provider.
	 @param mi Provider this pointer.
	 @param ctx Invocation Context
	 @return Function return status.
      */
     CMPIStatus (*cleanup)
            (CMPIQualifierDeclMI* mi, CMPIContext* ctx);

       /** Enumerate Qualifiers serviced by this provider.
	 @param mi Provider this pointer.
	 @param ctx Invocation Context.
	 @param rslt Result data container.
	 @param op ObjectPath containing namespace.
	 @return Function return status.
      */
     CMPIStatus (*enumQualifiers)
             (CMPIQualifierDeclMI* mi, CMPIContext* ctx, CMPIResult* rslt,
              CMPIObjectPath* op);

       /** Get a Qualifier defined in the specified namespace.
	 @param mi Provider this pointer.
	 @param ctx Invocation Context.
	 @param rslt Result data container.
	 @param op ObjectPath containing namespace.
	 @param name Name of the qualifier to be returned
	 @return Function return status.
      */
     CMPIStatus (*getQualifier)
             (CMPIQualifierDeclMI* mi, CMPIContext* ctx, CMPIResult* rslt,
              CMPIObjectPath* op);

       /** Create or modify Qualifier
	 @param mi Provider this pointer.
	 @param ctx Invocation Context.
	 @param rslt Result data container.
	 @param op ObjectPath containing namespace.
	 @param qualifier the qualifier
	 @return Function return status.
      */
     CMPIStatus (*setQualifier)
             (CMPIQualifierDeclMI* mi, CMPIContext* ctx, CMPIResult* rslt,
              CMPIObjectPath* op, CMPIQualifierDecl* qualifier);


       /** Delete an existing Qualifier
	 @param mi Provider this pointer.
	 @param ctx Invocation Context.
	 @param rslt Result data container.
	 @param op ObjectPath containing namespace.
	 @param name Name of the qualifier to be deleted.
	 @return Function return status.
      */
     CMPIStatus (*deleteQualifier)
             (CMPIQualifierDeclMI* mi, CMPIContext* ctx, CMPIResult* rslt,
              CMPIObjectPath* op);
  };

#ifdef __cplusplus
 };
#endif

#endif // _CMPIFTX_H_