(file) Return to CIMMessageSerializer.h CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / Common

  1 karl  1.14 //%2006////////////////////////////////////////////////////////////////////////
  2 kumpf 1.1  //
  3 karl  1.7  // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
  4            // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
  5            // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
  6 kumpf 1.1  // IBM Corp.; EMC Corporation, The Open Group.
  7 karl  1.7  // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
  8            // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
  9 karl  1.10 // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 10            // EMC Corporation; VERITAS Software Corporation; The Open Group.
 11 karl  1.14 // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 12            // EMC Corporation; Symantec Corporation; The Open Group.
 13 kumpf 1.1  //
 14            // Permission is hereby granted, free of charge, to any person obtaining a copy
 15            // of this software and associated documentation files (the "Software"), to
 16            // deal in the Software without restriction, including without limitation the
 17            // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 18            // sell copies of the Software, and to permit persons to whom the Software is
 19            // furnished to do so, subject to the following conditions:
 20 karl  1.7  // 
 21 kumpf 1.1  // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
 22            // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
 23            // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 24            // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 25            // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 26            // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 27            // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 28            // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 29            //
 30            //==============================================================================
 31            //
 32            // Author: Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com)
 33            //
 34 david.dillard 1.8  // Modified By: David Dillard, VERITAS Software Corp.
 35                    //                  (david.dillard@veritas.com)
 36 carolann.graves 1.11 //              Carol Ann Krug Graves, Hewlett-Packard Company
 37                      //                  (carolann_graves@hp.com)
 38 kumpf           1.1  //
 39                      //%/////////////////////////////////////////////////////////////////////////////
 40                      
 41                      #ifndef Pegasus_CIMMessageSerializer_h
 42                      #define Pegasus_CIMMessageSerializer_h
 43                      
 44                      #include <Pegasus/Common/Config.h>
 45                      #include <Pegasus/Common/CIMMessage.h>
 46                      
 47                      PEGASUS_NAMESPACE_BEGIN
 48                      
 49                      /**
 50                          CIMMessageSerializer provides a mechanism to convert a CIMMessage (or one
 51                          of its subclasses) to a stream of bytes.  This stream of bytes can be
 52                          converted back to a CIMMessage object through use of the related
 53                          CIMMessageDeserializer class.
 54                      
 55                          The format of the serialized message is not defined and is therefore
 56                          subject to change.  The only requirement is that the CIMMessageSerializer
 57                          and CIMMessageDeserializer classes remain in sync to provide a two-way
 58                          mapping.  (A quasi-XML encoding is currently used as an expedient
 59 kumpf           1.1      solution.  However, this encoding is not compliant with the CIM-XML
 60                          specification.  A number of shortcuts have been taken to improve
 61                          operational efficiency.)
 62                      
 63                          Note:  Changes or additions to the CIMMessage definitions must be
 64                          reflected in these serialization classes.  Likewise, changes to the
 65 kumpf           1.13     structure of member data (such as the AcceptLanguageList class) and
 66 kumpf           1.1      addition of new OperationContext containers will affect message
 67                          serialization.
 68                       */
 69                      class PEGASUS_COMMON_LINKAGE CIMMessageSerializer
 70                      {
 71                      public:
 72                      
 73 mike            1.12     static void serialize(Buffer& out, CIMMessage* cimMessage);
 74 kumpf           1.1  
 75                      private:
 76                      
 77 mike            1.15     PEGASUS_HIDDEN_LINKAGE
 78 kumpf           1.1      static void _serializeCIMRequestMessage(
 79 mike            1.12         Buffer& out,
 80 kumpf           1.1          CIMRequestMessage* cimMessage);
 81                      
 82 mike            1.15     PEGASUS_HIDDEN_LINKAGE
 83 kumpf           1.1      static void _serializeCIMResponseMessage(
 84 mike            1.12         Buffer& out,
 85 kumpf           1.1          CIMResponseMessage* cimMessage);
 86                      
 87                          //
 88                          // Utility Methods
 89                          //
 90                      
 91 mike            1.15     PEGASUS_HIDDEN_LINKAGE
 92 kumpf           1.1      static void _serializeUserInfo(
 93 mike            1.12         Buffer& out,
 94 kumpf           1.1          const String& authType,
 95                              const String& userName);
 96                      
 97 mike            1.15     PEGASUS_HIDDEN_LINKAGE
 98 kumpf           1.1      static void _serializeQueueIdStack(
 99 mike            1.12         Buffer& out,
100 kumpf           1.1          const QueueIdStack& queueIdStack);
101                      
102 mike            1.15     PEGASUS_HIDDEN_LINKAGE
103 kumpf           1.1      static void _serializeOperationContext(
104 mike            1.12         Buffer& out,
105 kumpf           1.1          const OperationContext& operationContext);
106                      
107 mike            1.15     PEGASUS_HIDDEN_LINKAGE
108 kumpf           1.13     static void _serializeContentLanguageList(
109 mike            1.12         Buffer& out,
110 kumpf           1.13         const ContentLanguageList& contentLanguages);
111 kumpf           1.1  
112 mike            1.15     PEGASUS_HIDDEN_LINKAGE
113 kumpf           1.13     static void _serializeAcceptLanguageList(
114 mike            1.12         Buffer& out,
115 kumpf           1.13         const AcceptLanguageList& acceptLanguages);
116 kumpf           1.1  
117 mike            1.15     PEGASUS_HIDDEN_LINKAGE
118 kumpf           1.1      static void _serializeCIMException(
119 mike            1.12         Buffer& out,
120 kumpf           1.1          const CIMException& cimException);
121                      
122 mike            1.15     PEGASUS_HIDDEN_LINKAGE
123 kumpf           1.1      static void _serializeCIMPropertyList(
124 mike            1.12         Buffer& out,
125 kumpf           1.1          const CIMPropertyList& cimPropertyList);
126                      
127 mike            1.15     PEGASUS_HIDDEN_LINKAGE
128 kumpf           1.1      static void _serializeCIMObjectPath(
129 mike            1.12         Buffer& out,
130 kumpf           1.1          const CIMObjectPath& cimObjectPath);
131                      
132 mike            1.15     PEGASUS_HIDDEN_LINKAGE
133 kumpf           1.1      static void _serializeCIMInstance(
134 mike            1.12         Buffer& out,
135 kumpf           1.1          const CIMInstance& cimInstance);
136                      
137 mike            1.15     PEGASUS_HIDDEN_LINKAGE
138 kumpf           1.1      static void _serializeCIMNamespaceName(
139 mike            1.12         Buffer& out,
140 kumpf           1.1          const CIMNamespaceName& cimNamespaceName);
141                      
142 mike            1.15     PEGASUS_HIDDEN_LINKAGE
143 kumpf           1.1      static void _serializeCIMName(
144 mike            1.12         Buffer& out,
145 kumpf           1.1          const CIMName& cimName);
146                      
147 mike            1.15     PEGASUS_HIDDEN_LINKAGE
148 jenny.yu        1.9      static void _serializeCIMObject(
149 mike            1.12         Buffer& out,
150 jenny.yu        1.9          const CIMObject& object);
151                      
152 kumpf           1.1      //
153                          //
154                          // CIM Request Messages
155                          //
156                          //
157                      
158                          //
159                          // CIMOperationRequestMessages
160                          //
161                      
162 mike            1.15     PEGASUS_HIDDEN_LINKAGE
163 kumpf           1.1      static void _serializeCIMGetInstanceRequestMessage(
164 mike            1.12         Buffer& out,
165 kumpf           1.1          CIMGetInstanceRequestMessage* message);
166                      
167 mike            1.15     PEGASUS_HIDDEN_LINKAGE
168 kumpf           1.1      static void _serializeCIMDeleteInstanceRequestMessage(
169 mike            1.12         Buffer& out,
170 kumpf           1.1          CIMDeleteInstanceRequestMessage* message);
171                      
172 mike            1.15     PEGASUS_HIDDEN_LINKAGE
173 kumpf           1.1      static void _serializeCIMCreateInstanceRequestMessage(
174 mike            1.12         Buffer& out,
175 kumpf           1.1          CIMCreateInstanceRequestMessage* message);
176                      
177 mike            1.15     PEGASUS_HIDDEN_LINKAGE
178 kumpf           1.1      static void _serializeCIMModifyInstanceRequestMessage(
179 mike            1.12         Buffer& out,
180 kumpf           1.1          CIMModifyInstanceRequestMessage* message);
181                      
182 mike            1.15     PEGASUS_HIDDEN_LINKAGE
183 kumpf           1.1      static void _serializeCIMEnumerateInstancesRequestMessage(
184 mike            1.12         Buffer& out,
185 kumpf           1.1          CIMEnumerateInstancesRequestMessage* message);
186                      
187 mike            1.15     PEGASUS_HIDDEN_LINKAGE
188 kumpf           1.1      static void _serializeCIMEnumerateInstanceNamesRequestMessage(
189 mike            1.12         Buffer& out,
190 kumpf           1.1          CIMEnumerateInstanceNamesRequestMessage* message);
191                      
192 mike            1.15     PEGASUS_HIDDEN_LINKAGE
193 kumpf           1.1      static void _serializeCIMExecQueryRequestMessage(
194 mike            1.12         Buffer& out,
195 kumpf           1.1          CIMExecQueryRequestMessage* message);
196                      
197 mike            1.15     PEGASUS_HIDDEN_LINKAGE
198 kumpf           1.1      static void _serializeCIMAssociatorsRequestMessage(
199 mike            1.12         Buffer& out,
200 kumpf           1.1          CIMAssociatorsRequestMessage* message);
201                      
202 mike            1.15     PEGASUS_HIDDEN_LINKAGE
203 kumpf           1.1      static void _serializeCIMAssociatorNamesRequestMessage(
204 mike            1.12         Buffer& out,
205 kumpf           1.1          CIMAssociatorNamesRequestMessage* message);
206                      
207 mike            1.15     PEGASUS_HIDDEN_LINKAGE
208 kumpf           1.1      static void _serializeCIMReferencesRequestMessage(
209 mike            1.12         Buffer& out,
210 kumpf           1.1          CIMReferencesRequestMessage* message);
211                      
212 mike            1.15     PEGASUS_HIDDEN_LINKAGE
213 kumpf           1.1      static void _serializeCIMReferenceNamesRequestMessage(
214 mike            1.12         Buffer& out,
215 kumpf           1.1          CIMReferenceNamesRequestMessage* message);
216                      
217 mike            1.15     PEGASUS_HIDDEN_LINKAGE
218 kumpf           1.1      static void _serializeCIMGetPropertyRequestMessage(
219 mike            1.12         Buffer& out,
220 kumpf           1.1          CIMGetPropertyRequestMessage* message);
221                      
222 mike            1.15     PEGASUS_HIDDEN_LINKAGE
223 kumpf           1.1      static void _serializeCIMSetPropertyRequestMessage(
224 mike            1.12         Buffer& out,
225 kumpf           1.1          CIMSetPropertyRequestMessage* message);
226                      
227 mike            1.15     PEGASUS_HIDDEN_LINKAGE
228 kumpf           1.1      static void _serializeCIMInvokeMethodRequestMessage(
229 mike            1.12         Buffer& out,
230 kumpf           1.1          CIMInvokeMethodRequestMessage* message);
231                      
232                          //
233                          // CIMIndicationRequestMessages
234                          //
235                      
236 mike            1.15     PEGASUS_HIDDEN_LINKAGE
237 kumpf           1.1      static void _serializeCIMCreateSubscriptionRequestMessage(
238 mike            1.12         Buffer& out,
239 kumpf           1.1          CIMCreateSubscriptionRequestMessage* message);
240                      
241 mike            1.15     PEGASUS_HIDDEN_LINKAGE
242 kumpf           1.1      static void _serializeCIMModifySubscriptionRequestMessage(
243 mike            1.12         Buffer& out,
244 kumpf           1.1          CIMModifySubscriptionRequestMessage* message);
245                      
246 mike            1.15     PEGASUS_HIDDEN_LINKAGE
247 kumpf           1.1      static void _serializeCIMDeleteSubscriptionRequestMessage(
248 mike            1.12         Buffer& out,
249 kumpf           1.1          CIMDeleteSubscriptionRequestMessage* message);
250                      
251                          //
252                          // Generic CIMRequestMessages
253                          //
254                      
255 mike            1.15     PEGASUS_HIDDEN_LINKAGE
256 kumpf           1.1      static void _serializeCIMExportIndicationRequestMessage(
257 mike            1.12         Buffer& out,
258 kumpf           1.1          CIMExportIndicationRequestMessage* message);
259                      
260 mike            1.15     PEGASUS_HIDDEN_LINKAGE
261 kumpf           1.1      static void _serializeCIMProcessIndicationRequestMessage(
262 mike            1.12         Buffer& out,
263 kumpf           1.1          CIMProcessIndicationRequestMessage* message);
264                      
265 mike            1.15     PEGASUS_HIDDEN_LINKAGE
266 kumpf           1.1      static void _serializeCIMDisableModuleRequestMessage(
267 mike            1.12         Buffer& out,
268 kumpf           1.1          CIMDisableModuleRequestMessage* message);
269                      
270 mike            1.15     PEGASUS_HIDDEN_LINKAGE
271 kumpf           1.1      static void _serializeCIMEnableModuleRequestMessage(
272 mike            1.12         Buffer& out,
273 kumpf           1.1          CIMEnableModuleRequestMessage* message);
274                      
275 mike            1.15     PEGASUS_HIDDEN_LINKAGE
276 kumpf           1.1      static void _serializeCIMStopAllProvidersRequestMessage(
277 mike            1.12         Buffer& out,
278 kumpf           1.1          CIMStopAllProvidersRequestMessage* message);
279                      
280 mike            1.15     PEGASUS_HIDDEN_LINKAGE
281 kumpf           1.2      static void _serializeCIMInitializeProviderRequestMessage(
282 mike            1.12         Buffer& out,
283 kumpf           1.2          CIMInitializeProviderRequestMessage* message);
284                      
285 mike            1.15     PEGASUS_HIDDEN_LINKAGE
286 kumpf           1.5      static void _serializeCIMInitializeProviderAgentRequestMessage(
287 mike            1.12         Buffer& out,
288 kumpf           1.5          CIMInitializeProviderAgentRequestMessage* message);
289                      
290 mike            1.15     PEGASUS_HIDDEN_LINKAGE
291 kumpf           1.6      static void _serializeCIMNotifyConfigChangeRequestMessage(
292 mike            1.12         Buffer& out,
293 kumpf           1.6          CIMNotifyConfigChangeRequestMessage* message);
294                      
295 mike            1.15     PEGASUS_HIDDEN_LINKAGE
296 carolann.graves 1.11     static void _serializeCIMSubscriptionInitCompleteRequestMessage(
297 mike            1.12         Buffer& out,
298 carolann.graves 1.11         CIMSubscriptionInitCompleteRequestMessage* message);
299                      
300 kumpf           1.2  
301 kumpf           1.1      //
302                          //
303                          // CIM Response Messages
304                          //
305                          //
306                      
307                          //
308                          // CIMOperationResponseMessages
309                          //
310                      
311 mike            1.15     PEGASUS_HIDDEN_LINKAGE
312 kumpf           1.1      static void _serializeCIMGetInstanceResponseMessage(
313 mike            1.12         Buffer& out,
314 kumpf           1.1          CIMGetInstanceResponseMessage* message);
315                      
316 mike            1.15     PEGASUS_HIDDEN_LINKAGE
317 kumpf           1.1      static void _serializeCIMDeleteInstanceResponseMessage(
318 mike            1.12         Buffer& out,
319 kumpf           1.1          CIMDeleteInstanceResponseMessage* message);
320                      
321 mike            1.15     PEGASUS_HIDDEN_LINKAGE
322 kumpf           1.1      static void _serializeCIMCreateInstanceResponseMessage(
323 mike            1.12         Buffer& out,
324 kumpf           1.1          CIMCreateInstanceResponseMessage* message);
325                      
326 mike            1.15     PEGASUS_HIDDEN_LINKAGE
327 kumpf           1.1      static void _serializeCIMModifyInstanceResponseMessage(
328 mike            1.12         Buffer& out,
329 kumpf           1.1          CIMModifyInstanceResponseMessage* message);
330                      
331 mike            1.15     PEGASUS_HIDDEN_LINKAGE
332 kumpf           1.1      static void _serializeCIMEnumerateInstancesResponseMessage(
333 mike            1.12         Buffer& out,
334 kumpf           1.1          CIMEnumerateInstancesResponseMessage* message);
335                      
336 mike            1.15     PEGASUS_HIDDEN_LINKAGE
337 kumpf           1.1      static void _serializeCIMEnumerateInstanceNamesResponseMessage(
338 mike            1.12         Buffer& out,
339 kumpf           1.1          CIMEnumerateInstanceNamesResponseMessage* message);
340                      
341 mike            1.15     PEGASUS_HIDDEN_LINKAGE
342 kumpf           1.1      static void _serializeCIMExecQueryResponseMessage(
343 mike            1.12         Buffer& out,
344 kumpf           1.1          CIMExecQueryResponseMessage* message);
345                      
346 mike            1.15     PEGASUS_HIDDEN_LINKAGE
347 kumpf           1.1      static void _serializeCIMAssociatorsResponseMessage(
348 mike            1.12         Buffer& out,
349 kumpf           1.1          CIMAssociatorsResponseMessage* message);
350                      
351 mike            1.15     PEGASUS_HIDDEN_LINKAGE
352 kumpf           1.1      static void _serializeCIMAssociatorNamesResponseMessage(
353 mike            1.12         Buffer& out,
354 kumpf           1.1          CIMAssociatorNamesResponseMessage* message);
355                      
356 mike            1.15     PEGASUS_HIDDEN_LINKAGE
357 kumpf           1.1      static void _serializeCIMReferencesResponseMessage(
358 mike            1.12         Buffer& out,
359 kumpf           1.1          CIMReferencesResponseMessage* message);
360                      
361 mike            1.15     PEGASUS_HIDDEN_LINKAGE
362 kumpf           1.1      static void _serializeCIMReferenceNamesResponseMessage(
363 mike            1.12         Buffer& out,
364 kumpf           1.1          CIMReferenceNamesResponseMessage* message);
365                      
366 mike            1.15     PEGASUS_HIDDEN_LINKAGE
367 kumpf           1.1      static void _serializeCIMGetPropertyResponseMessage(
368 mike            1.12         Buffer& out,
369 kumpf           1.1          CIMGetPropertyResponseMessage* message);
370                      
371 mike            1.15     PEGASUS_HIDDEN_LINKAGE
372 kumpf           1.1      static void _serializeCIMSetPropertyResponseMessage(
373 mike            1.12         Buffer& out,
374 kumpf           1.1          CIMSetPropertyResponseMessage* message);
375                      
376 mike            1.15     PEGASUS_HIDDEN_LINKAGE
377 kumpf           1.1      static void _serializeCIMInvokeMethodResponseMessage(
378 mike            1.12         Buffer& out,
379 kumpf           1.1          CIMInvokeMethodResponseMessage* message);
380                      
381                          //
382                          // CIMIndicationResponseMessages
383                          //
384                      
385 mike            1.15     PEGASUS_HIDDEN_LINKAGE
386 kumpf           1.1      static void _serializeCIMCreateSubscriptionResponseMessage(
387 mike            1.12         Buffer& out,
388 kumpf           1.1          CIMCreateSubscriptionResponseMessage* message);
389                      
390 mike            1.15     PEGASUS_HIDDEN_LINKAGE
391 kumpf           1.1      static void _serializeCIMModifySubscriptionResponseMessage(
392 mike            1.12         Buffer& out,
393 kumpf           1.1          CIMModifySubscriptionResponseMessage* message);
394                      
395 mike            1.15     PEGASUS_HIDDEN_LINKAGE
396 kumpf           1.1      static void _serializeCIMDeleteSubscriptionResponseMessage(
397 mike            1.12         Buffer& out,
398 kumpf           1.1          CIMDeleteSubscriptionResponseMessage* message);
399                      
400                          //
401                          // Generic CIMResponseMessages
402                          //
403                      
404 mike            1.15     PEGASUS_HIDDEN_LINKAGE
405 kumpf           1.1      static void _serializeCIMExportIndicationResponseMessage(
406 mike            1.12         Buffer& out,
407 kumpf           1.1          CIMExportIndicationResponseMessage* message);
408                      
409 mike            1.15     PEGASUS_HIDDEN_LINKAGE
410 kumpf           1.1      static void _serializeCIMProcessIndicationResponseMessage(
411 mike            1.12         Buffer& out,
412 kumpf           1.1          CIMProcessIndicationResponseMessage* message);
413                      
414 mike            1.15     PEGASUS_HIDDEN_LINKAGE
415 kumpf           1.1      static void _serializeCIMDisableModuleResponseMessage(
416 mike            1.12         Buffer& out,
417 kumpf           1.1          CIMDisableModuleResponseMessage* message);
418                      
419 mike            1.15     PEGASUS_HIDDEN_LINKAGE
420 kumpf           1.1      static void _serializeCIMEnableModuleResponseMessage(
421 mike            1.12         Buffer& out,
422 kumpf           1.1          CIMEnableModuleResponseMessage* message);
423                      
424 mike            1.15     PEGASUS_HIDDEN_LINKAGE
425 kumpf           1.1      static void _serializeCIMStopAllProvidersResponseMessage(
426 mike            1.12         Buffer& out,
427 kumpf           1.1          CIMStopAllProvidersResponseMessage* message);
428                      
429 mike            1.15     PEGASUS_HIDDEN_LINKAGE
430 kumpf           1.2      static void _serializeCIMInitializeProviderResponseMessage(
431 mike            1.12         Buffer& out,
432 kumpf           1.2          CIMInitializeProviderResponseMessage* message);
433                      
434 mike            1.15     PEGASUS_HIDDEN_LINKAGE
435 kumpf           1.5      static void _serializeCIMInitializeProviderAgentResponseMessage(
436 mike            1.12         Buffer& out,
437 kumpf           1.5          CIMInitializeProviderAgentResponseMessage* message);
438 kumpf           1.6  
439 mike            1.15     PEGASUS_HIDDEN_LINKAGE
440 kumpf           1.6      static void _serializeCIMNotifyConfigChangeResponseMessage(
441 mike            1.12         Buffer& out,
442 kumpf           1.6          CIMNotifyConfigChangeResponseMessage* message);
443 carolann.graves 1.11 
444 mike            1.15     PEGASUS_HIDDEN_LINKAGE
445 carolann.graves 1.11     static void _serializeCIMSubscriptionInitCompleteResponseMessage(
446 mike            1.12         Buffer& out,
447 carolann.graves 1.11         CIMSubscriptionInitCompleteResponseMessage* message);
448 kumpf           1.1  };
449                      
450                      PEGASUS_NAMESPACE_END
451                      
452                      #endif /* Pegasus_CIMMessageSerializer_h */

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2