src/WMIMapper/PegServer/CIMOperationRequestDecoder.h

   1 //%2005////////////////////////////////////////////////////////////////////////
   2 //
   3 // 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 // IBM Corp.; EMC Corporation, The Open Group.
   7 // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
   8 // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
   9 // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
  10 // EMC Corporation; VERITAS Software Corporation; The Open Group.
  11 //
  12 // Permission is hereby granted, free of charge, to any person obtaining a copy
  13 // of this software and associated documentation files (the "Software"), to
  14 // deal in the Software without restriction, including without limitation the
  15 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  16 // sell copies of the Software, and to permit persons to whom the Software is
  17 // furnished to do so, subject to the following conditions:
  18 //
  19 // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
  20 // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
  21 // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
  22 // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  23 // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  24 // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25 // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28 //==============================================================================
  29 //
  30 // Author: Mike Brasher (mbrasher@bmc.com)
  31 //
  32 // Modified By: Nitin Upasani, Hewlett-Packard Company (Nitin_Upasani@hp.com)
  33 //              Nag Boranna, Hewlett-Packard Company (nagaraja_boranna@hp.com)
  34 //              Jenny Yu, Hewlett-Packard Company (jenny_yu@hp.com)
  35 //              Sushma Fernandes, Hewlett-Packard Company
  36 //              (sushma_fernandes@hp.com)
  37 //              Carol Ann Krug Graves, Hewlett-Packard Company
  38 //                (carolann_graves@hp.com)
  39 //                              Jair Santos, Hewlett-Packard Company (jair.santos@hp.com)
  40 //              Amit K Arora, IBM (amita@in.ibm.com) for PEP#101
  41 //                              Mateus Baur, Hewlett-Packard Company (mateus.baur@hp.com)
  42 //
  43 //%/////////////////////////////////////////////////////////////////////////////
  44
  45 #ifndef Pegasus_CIMOperationRequestDecoder_h
  46 #define Pegasus_CIMOperationRequestDecoder_h
  47
  48 #include <Pegasus/Common/Config.h>
  49 #include <Pegasus/Common/MessageQueueService.h>
  50 #include <Pegasus/Common/CIMMessage.h>
  51 #include <Pegasus/Common/HTTPMessage.h>
  52 #include <Pegasus/Common/AcceptLanguageList.h>
  53 #include <Pegasus/Common/ContentLanguageList.h>
  54 #include <Pegasus/Common/AutoPtr.h>
  55
  56 PEGASUS_NAMESPACE_BEGIN
  57
  58 class XmlParser;
  59
  60 /** This class decodes CIM operation requests and passes them down-stream.
  61  */
  62 class CIMOperationRequestDecoder : public MessageQueueService
  63 {
  64    public:
  65       typedef MessageQueueService Base;
  66
  67       CIMOperationRequestDecoder(
  68          MessageQueueService* outputQueue,
  69          Uint32 returnQueueId);
  70
  71       ~CIMOperationRequestDecoder();
  72
  73       void sendResponse(
  74          Uint32 queueId,
  75          Buffer& message);
  76
  77       void sendIMethodError(
  78          Uint32 queueId,
  79          HttpMethod httpMethod,
  80          const String& messageId,
  81          const String& methodName,
  82          const CIMException& cimException);
  83
  84       void sendMethodError(
  85          Uint32 queueId,
  86          HttpMethod httpMethod,
  87          const String& messageId,
  88          const String& methodName,
  89          const CIMException& cimException);
  90
  91       void sendHttpError(
  92          Uint32 queueId,
  93          const String& status,
  94          const String& cimError = String::EMPTY,
  95          const String& messageBody = String::EMPTY);
  96
  97       virtual void handleEnqueue(Message *);
  98
  99       virtual void handleEnqueue();
 100
 101       void handleHTTPMessage(HTTPMessage* httpMessage);
 102
 103 // l10n
 104       void handleMethodCall(
 105          Uint32 queueId,
 106          HttpMethod httpMethod,
 107          char* content,
 108          Uint32 contentLength,
 109          const String& cimProtocolVersionInHeader,
 110          const String& cimMethodInHeader,
 111          const String& cimObjectInHeader,
 112          String authType,
 113          String userName,
 114          String password,
 115          const AcceptLanguageList& httpAcceptLanguages,
 116          const ContentLanguageList& httpContentLanguages);
 117
 118       CIMCreateClassRequestMessage* decodeCreateClassRequest(
 119          Uint32 queueId,
 120          XmlParser& parser,
 121          const String& messageId,
 122          const CIMNamespaceName& nameSpace,
 123          const String& authType,
 124          const String& userName);
 125
 126
 127       CIMGetClassRequestMessage* decodeGetClassRequest(
 128          Uint32 queueId,
 129          XmlParser& parser,
 130          const String& messageId,
 131          const CIMNamespaceName& nameSpace,
 132          const String& authType,
 133          const String& userName);
 134
 135       CIMModifyClassRequestMessage* decodeModifyClassRequest(
 136          Uint32 queueId,
 137          XmlParser& parser,
 138          const String& messageId,
 139          const CIMNamespaceName& nameSpace,
 140          const String& authType,
 141          const String& userName);
 142
 143       CIMEnumerateClassNamesRequestMessage* decodeEnumerateClassNamesRequest(
 144          Uint32 queueId,
 145          XmlParser& parser,
 146          const String& messageId,
 147          const CIMNamespaceName& nameSpace,
 148          const String& authType,
 149          const String& userName);
 150
 151       CIMEnumerateClassesRequestMessage* decodeEnumerateClassesRequest(
 152          Uint32 queueId,
 153          XmlParser& parser,
 154          const String& messageId,
 155          const CIMNamespaceName& nameSpace,
 156          const String& authType,
 157          const String& userName);
 158
 159       CIMDeleteClassRequestMessage* decodeDeleteClassRequest(
 160          Uint32 queueId,
 161          XmlParser& parser,
 162          const String& messageId,
 163          const CIMNamespaceName& nameSpace,
 164          const String& authType,
 165          const String& userName);
 166
 167       CIMCreateInstanceRequestMessage* decodeCreateInstanceRequest(
 168          Uint32 queueId,
 169          XmlParser& parser,
 170          const String& messageId,
 171          const CIMNamespaceName& nameSpace,
 172          const String& authType,
 173          const String& userName);
 174
 175       CIMGetInstanceRequestMessage* decodeGetInstanceRequest(
 176          Uint32 queueId,
 177          XmlParser& parser,
 178          const String& messageId,
 179          const CIMNamespaceName& nameSpace,
 180          const String& authType,
 181          const String& userName);
 182
 183       CIMModifyInstanceRequestMessage* decodeModifyInstanceRequest(
 184          Uint32 queueId,
 185          XmlParser& parser,
 186          const String& messageId,
 187          const CIMNamespaceName& nameSpace,
 188          const String& authType,
 189          const String& userName);
 190
 191       CIMEnumerateInstanceNamesRequestMessage* decodeEnumerateInstanceNamesRequest(
 192          Uint32 queueId,
 193          XmlParser& parser,
 194          const String& messageId,
 195          const CIMNamespaceName& nameSpace,
 196          const String& authType,
 197          const String& userName);
 198
 199       CIMEnumerateInstancesRequestMessage* decodeEnumerateInstancesRequest(
 200          Uint32 queueId,
 201          XmlParser& parser,
 202          const String& messageId,
 203          const CIMNamespaceName& nameSpace,
 204          const String& authType,
 205          const String& userName);
 206
 207       CIMDeleteInstanceRequestMessage* decodeDeleteInstanceRequest(
 208          Uint32 queueId,
 209          XmlParser& parser,
 210          const String& messageId,
 211          const CIMNamespaceName& nameSpace,
 212          const String& authType,
 213          const String& userName);
 214
 215       CIMSetQualifierRequestMessage* decodeSetQualifierRequest(
 216          Uint32 queueId,
 217          XmlParser& parser,
 218          const String& messageId,
 219          const CIMNamespaceName& nameSpace,
 220          const String& authType,
 221          const String& userName);
 222
 223       CIMGetQualifierRequestMessage* decodeGetQualifierRequest(
 224          Uint32 queueId,
 225          XmlParser& parser,
 226          const String& messageId,
 227          const CIMNamespaceName& nameSpace,
 228          const String& authType,
 229          const String& userName);
 230
 231       CIMEnumerateQualifiersRequestMessage* decodeEnumerateQualifiersRequest(
 232          Uint32 queueId,
 233          XmlParser& parser,
 234          const String& messageId,
 235          const CIMNamespaceName& nameSpace,
 236          const String& authType,
 237          const String& userName);
 238
 239       CIMDeleteQualifierRequestMessage* decodeDeleteQualifierRequest(
 240          Uint32 queueId,
 241          XmlParser& parser,
 242          const String& messageId,
 243          const CIMNamespaceName& nameSpace,
 244          const String& authType,
 245          const String& userName);
 246
 247       CIMReferenceNamesRequestMessage* decodeReferenceNamesRequest(
 248          Uint32 queueId,
 249          XmlParser& parser,
 250          const String& messageId,
 251          const CIMNamespaceName& nameSpace,
 252          const String& authType,
 253          const String& userName);
 254
 255       CIMReferencesRequestMessage* decodeReferencesRequest(
 256          Uint32 queueId,
 257          XmlParser& parser,
 258          const String& messageId,
 259          const CIMNamespaceName& nameSpace,
 260          const String& authType,
 261          const String& userName);
 262
 263       CIMAssociatorNamesRequestMessage* decodeAssociatorNamesRequest(
 264          Uint32 queueId,
 265          XmlParser& parser,
 266          const String& messageId,
 267          const CIMNamespaceName& nameSpace,
 268          const String& authType,
 269          const String& userName);
 270
 271       CIMAssociatorsRequestMessage* decodeAssociatorsRequest(
 272          Uint32 queueId,
 273          XmlParser& parser,
 274          const String& messageId,
 275          const CIMNamespaceName& nameSpace,
 276          const String& authType,
 277          const String& userName);
 278
 279       CIMGetPropertyRequestMessage* decodeGetPropertyRequest(
 280          Uint32 queueId,
 281          XmlParser& parser,
 282          const String& messageId,
 283          const CIMNamespaceName& nameSpace,
 284          const String& authType,
 285          const String& userName);
 286
 287       CIMSetPropertyRequestMessage* decodeSetPropertyRequest(
 288          Uint32 queueId,
 289          XmlParser& parser,
 290          const String& messageId,
 291          const CIMNamespaceName& nameSpace,
 292          const String& authType,
 293          const String& userName);
 294
 295       CIMExecQueryRequestMessage* decodeExecQueryRequest(
 296          Uint32 queueId,
 297          XmlParser& parser,
 298          const String& messageId,
 299          const CIMNamespaceName& nameSpace,
 300          const String& authType,
 301          const String& userName);
 302
 303       CIMInvokeMethodRequestMessage* decodeInvokeMethodRequest(
 304          Uint32 queueId,
 305          XmlParser& parser,
 306          const String& messageId,
 307          const CIMObjectPath& reference,
 308          const String& cimMethodName,
 309          const String& authType,
 310          const String& userName);
 311
 312       /** Sets the flag to indicate whether or not the CIMServer is
 313           shutting down.
 314       */
 315       void setServerTerminating(Boolean flag);
 316
 317    private:
 318
 319       AutoPtr<MessageQueueService> _outputQueue; //PEP101
 320
 321       // Queue where responses should be enqueued.
 322       Uint32 _returnQueueId;
 323
 324       // Flag to indicate whether or not the CIMServer is shutting down.
 325       Boolean _serverTerminating;
 326 };
 327
 328 PEGASUS_NAMESPACE_END
 329
 330 #endif /* Pegasus_CIMOperationRequestDecoder_h */