(file) Return to BasicProviderManagerRouter.cpp CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / ProviderManager2

  1 karl  1.27 //%2006////////////////////////////////////////////////////////////////////////
  2 kumpf 1.1  //
  3 karl  1.14 // 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.14 // 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.15 // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 10            // EMC Corporation; VERITAS Software Corporation; The Open Group.
 11 karl  1.27 // 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.14 // 
 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: Chip Vincent (cvincent@us.ibm.com)
 33            //         Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com)
 34            //
 35 se.gupta 1.9  // Modified By: Seema Gupta(gseema@in.ibm.com) for PEP135
 36 gs.keenan 1.16 //              Sean Keenan, Hewlett-Packard Company (sean.keenan@hp.com)
 37 carolann.graves 1.17 //              Carol Ann Krug Graves, Hewlett-Packard Company
 38                      //                  (carolann_graves@hp.com)
 39 kumpf           1.24 //              Josephine Eskaline Joyce, IBM (jojustin@in.ibm.com) for Bug#2619, #2685,#3354
 40 j.alex          1.26 //              John Alex, IBM (johnalex@us.ibm.com) - Bug#2290
 41 kumpf           1.1  //
 42                      //%/////////////////////////////////////////////////////////////////////////////
 43                      
 44                      #include "BasicProviderManagerRouter.h"
 45                      
 46                      #include <Pegasus/Common/Config.h>
 47 se.gupta        1.9  #include <Pegasus/Common/OperationContextInternal.h>
 48 kumpf           1.1  #include <Pegasus/Common/CIMMessage.h>
 49                      #include <Pegasus/Common/Tracer.h>
 50 kumpf           1.24 #include <Pegasus/Common/Logger.h>
 51 kumpf           1.12 #include <Pegasus/Common/FileSystem.h>
 52                      #include <Pegasus/Config/ConfigManager.h>
 53 kumpf           1.1  #include <Pegasus/ProviderManager2/OperationResponseHandler.h>
 54                      #include <Pegasus/ProviderManager2/ProviderManagerModule.h>
 55                      #include <Pegasus/ProviderManager2/ProviderManager.h>
 56                      
 57                      // ProviderManager library names.  Should these be defined elsewhere?
 58                      #if defined(PEGASUS_OS_OS400)
 59 humberto        1.19 # define LIBRARY_NAME_DEFAULTPM "QSYS/QYCMPMDE00"
 60 kumpf           1.1  # define LIBRARY_NAME_CMPIPM    "QSYS/QYCMCMPIPM"
 61                      # define LIBRARY_NAME_JMPIPM    "QSYS/QYCMJMPIPM"
 62                      #else
 63                      # define LIBRARY_NAME_DEFAULTPM "DefaultProviderManager"
 64                      # define LIBRARY_NAME_CMPIPM    "CMPIProviderManager"
 65                      # define LIBRARY_NAME_JMPIPM    "JMPIProviderManager"
 66                      #endif
 67                      
 68                      PEGASUS_NAMESPACE_BEGIN
 69                      
 70                      // BEGIN TEMP SECTION
 71                      class ProviderManagerContainer
 72                      {
 73                      public:
 74                          ProviderManagerContainer()
 75                          : _manager(0)
 76                          {
 77                          }
 78                      
 79                          ProviderManagerContainer(const ProviderManagerContainer & container)
 80                          : _manager(0)
 81 kumpf           1.1      {
 82                              *this = container;
 83                          }
 84                      
 85                          ProviderManagerContainer(
 86                              const String& physicalName,
 87                              const String& logicalName,
 88                              const String& interfaceName,
 89 carolann.graves 1.17         PEGASUS_INDICATION_CALLBACK indicationCallback,
 90                              Boolean subscriptionInitComplete)
 91 kumpf           1.1      : _manager(0)
 92                          {
 93 gs.keenan       1.16 #if defined (PEGASUS_OS_VMS)
 94 carson.hovey    1.25         _physicalName = ConfigManager::getInstance()->getCurrentValue("providerDir") +
 95                                  String("/") + FileSystem::buildLibraryFileName(physicalName) + String(".exe");
 96 humberto        1.19 #elif defined (PEGASUS_OS_OS400)
 97 chuck           1.20         _physicalName = physicalName;
 98 gs.keenan       1.16 #else
 99 kumpf           1.12         _physicalName = ConfigManager::getHomedPath(PEGASUS_DEST_LIB_DIR) +
100 kumpf           1.13             String("/") + FileSystem::buildLibraryFileName(physicalName);
101 gs.keenan       1.16 #endif
102 kumpf           1.1  
103                              _logicalName = logicalName;
104                              _interfaceName = interfaceName;
105                      
106                              _module = ProviderManagerModule(_physicalName);
107 kumpf           1.24         Boolean moduleLoaded = _module.load();
108 kumpf           1.1  
109 kumpf           1.24         if (moduleLoaded)
110                              {
111                                  _manager = _module.getProviderManager(_logicalName);
112                              }
113                              else
114                              {
115                                  PEG_TRACE_STRING(TRC_PROVIDERMANAGER, Tracer::LEVEL2,
116                                      "ProviderManagerModule load failed.");
117                              }
118                      
119                              if (_manager == 0)
120                              {
121                                  PEG_TRACE_STRING(TRC_PROVIDERMANAGER, Tracer::LEVEL2,
122                                      "Failed to load ProviderManager \"" + _physicalName + "\".");
123                      
124                                  Logger::put_l(
125                                      Logger::ERROR_LOG, System::CIMSERVER, Logger::SEVERE,
126                                      "ProviderManager.BasicProviderManagerRouter."
127                                          "PROVIDERMANAGER_LOAD_FAILED",
128                                      "Failed to load the Provider Manager for interface type \"$0\""
129                                          " from library \"$1\".",
130 kumpf           1.24                 _interfaceName, _physicalName);
131                      
132                                  throw PEGASUS_CIM_EXCEPTION_L(CIM_ERR_FAILED, MessageLoaderParms(
133                                      "ProviderManager.BasicProviderManagerRouter."
134                                          "PROVIDERMANAGER_LOAD_FAILED",
135                                      "Failed to load the Provider Manager for interface type \"$0\""
136                                          " from library \"$1\".",
137                                      _interfaceName, _physicalName));
138                              }
139 kumpf           1.1  
140                              _manager->setIndicationCallback(indicationCallback);
141 carolann.graves 1.17 
142                              _manager->setSubscriptionInitComplete (subscriptionInitComplete);
143 kumpf           1.1      }
144                      
145                          ~ProviderManagerContainer()
146                          {
147 joyce.j         1.23         delete _manager;
148 kumpf           1.1          _module.unload();
149                          }
150                      
151                          ProviderManagerContainer& operator=(
152                              const ProviderManagerContainer & container)
153                          {
154                              if (this == &container)
155                              {
156                                  return *this;
157                              }
158                      
159                              _logicalName = container._logicalName;
160                              _physicalName = container._physicalName;
161                              _interfaceName = container._interfaceName;
162                      
163                              _module = container._module;
164                              _manager = container._manager;
165                      
166                              return *this;
167                          }
168                      
169 kumpf           1.1      ProviderManager* getProviderManager()
170                          {
171                              return _manager;
172                          }
173                      
174                          const String& getPhysicalName() const
175                          {
176                              return _physicalName;
177                          }
178                      
179                          const String& getLogicalName() const
180                          {
181                              return _logicalName;
182                          }
183                      
184                          const String& getInterfaceName() const
185                          {
186                              return _interfaceName;
187                          }
188                      
189                      private:
190 kumpf           1.1      String _physicalName;
191                          String _logicalName;
192                          String _interfaceName;
193                      
194                          ProviderManagerModule _module;
195                          ProviderManager* _manager;
196                      };
197                      // END TEMP SECTION
198                      
199                      
200                      PEGASUS_INDICATION_CALLBACK BasicProviderManagerRouter::_indicationCallback = 0;
201                      
202                      // Private, unimplemented constructor
203                      BasicProviderManagerRouter::BasicProviderManagerRouter()
204                      {
205                      }
206                      
207                      BasicProviderManagerRouter::BasicProviderManagerRouter(
208                          PEGASUS_INDICATION_CALLBACK indicationCallback)
209                      {
210                          PEG_METHOD_ENTER(TRC_PROVIDERMANAGER,
211 kumpf           1.1          "BasicProviderManagerRouter::BasicProviderManagerRouter");
212                      
213                          _indicationCallback = indicationCallback;
214 carolann.graves 1.17     _subscriptionInitComplete = false;
215 kumpf           1.1  
216                          PEG_METHOD_EXIT();
217                      }
218                      
219                      BasicProviderManagerRouter::~BasicProviderManagerRouter()
220                      {
221                          PEG_METHOD_ENTER(TRC_PROVIDERMANAGER,
222                              "BasicProviderManagerRouter::~BasicProviderManagerRouter");
223 joyce.j         1.21     /* Clean up the provider managers */
224                          for (Uint32 i = 0, n = _providerManagerTable.size(); i < n; i++)
225                          {
226                               ProviderManagerContainer* pmc=_providerManagerTable[i];
227                               delete pmc;
228                          }
229 kumpf           1.1      PEG_METHOD_EXIT();
230                      }
231                      
232                      Message* BasicProviderManagerRouter::processMessage(Message * message)
233                      {
234                          PEG_METHOD_ENTER(TRC_PROVIDERMANAGER,
235                              "BasicProviderManagerRouter::processMessage");
236                      
237                          CIMRequestMessage* request = dynamic_cast<CIMRequestMessage *>(message);
238                          PEGASUS_ASSERT(request != 0);
239                      
240                          Message* response = 0;
241 schuur          1.7      Boolean remoteNameSpaceRequest=false;
242 kumpf           1.1  
243                          //
244                          // Retrieve the ProviderManager routing information
245                          //
246                      
247                          CIMInstance providerModule;
248                      
249                          if ((dynamic_cast<CIMOperationRequestMessage*>(request) != 0) ||
250 kumpf           1.4          (request->getType() == CIM_EXPORT_INDICATION_REQUEST_MESSAGE) ||
251 kumpf           1.24         (request->getType() == CIM_INITIALIZE_PROVIDER_REQUEST_MESSAGE))
252 kumpf           1.1      {
253                              // Provider information is in OperationContext
254                              ProviderIdContainer pidc = (ProviderIdContainer)
255                                  request->operationContext.get(ProviderIdContainer::NAME);
256                              providerModule = pidc.getModule();
257 kumpf           1.24         remoteNameSpaceRequest=pidc.isRemoteNameSpace();
258 kumpf           1.1      }
259                          else if (dynamic_cast<CIMIndicationRequestMessage*>(request) != 0)
260                          {
261                              // Provider information is in CIMIndicationRequestMessage
262                              CIMIndicationRequestMessage* indReq =
263                                  dynamic_cast<CIMIndicationRequestMessage*>(request);
264 kumpf           1.24         ProviderIdContainer pidc = indReq->operationContext.get(ProviderIdContainer::NAME);
265                              providerModule = pidc.getModule();
266 kumpf           1.1      }
267                          else if (request->getType() == CIM_ENABLE_MODULE_REQUEST_MESSAGE)
268                          {
269                              // Provider information is in CIMEnableModuleRequestMessage
270                              CIMEnableModuleRequestMessage* emReq =
271                                  dynamic_cast<CIMEnableModuleRequestMessage*>(request);
272                              providerModule = emReq->providerModule;
273                          }
274                          else if (request->getType() == CIM_DISABLE_MODULE_REQUEST_MESSAGE)
275                          {
276                              // Provider information is in CIMDisableModuleRequestMessage
277                              CIMDisableModuleRequestMessage* dmReq =
278                                  dynamic_cast<CIMDisableModuleRequestMessage*>(request);
279                              providerModule = dmReq->providerModule;
280                          }
281 kumpf           1.6      else if ((request->getType() == CIM_STOP_ALL_PROVIDERS_REQUEST_MESSAGE) ||
282 kumpf           1.24              (request->getType() ==
283 carolann.graves 1.17               CIM_SUBSCRIPTION_INIT_COMPLETE_REQUEST_MESSAGE) ||
284 kumpf           1.24              (request->getType() == CIM_NOTIFY_CONFIG_CHANGE_REQUEST_MESSAGE))
285 kumpf           1.1      {
286                              // This operation is not provider-specific
287                          }
288                          else
289                          {
290                              // Error: Unrecognized message type.
291                              PEGASUS_ASSERT(0);
292 kumpf           1.6          CIMResponseMessage* resp = request->buildResponse();
293 schuur          1.7          resp->cimException = PEGASUS_CIM_EXCEPTION(CIM_ERR_FAILED,
294 kumpf           1.6              "Unknown message type.");
295 kumpf           1.1          response = resp;
296                          }
297                      
298                          //
299                          // Forward the request to the appropriate ProviderManager(s)
300                          //
301                      
302 carolann.graves 1.17     if ((request->getType() == CIM_STOP_ALL_PROVIDERS_REQUEST_MESSAGE) ||
303 kumpf           1.24         (request->getType() ==
304 carolann.graves 1.17          CIM_SUBSCRIPTION_INIT_COMPLETE_REQUEST_MESSAGE))
305 kumpf           1.1      {
306 carolann.graves 1.17         _subscriptionInitComplete = true;
307                      
308 kumpf           1.24         // Send CIMStopAllProvidersRequestMessage or
309 carolann.graves 1.17         // CIMSubscriptionInitCompleteRequestMessage to all ProviderManagers
310 kumpf           1.5          ReadLock tableLock(_providerManagerTableLock);
311 kumpf           1.1          for (Uint32 i = 0, n = _providerManagerTable.size(); i < n; i++)
312                              {
313                                  ProviderManagerContainer* pmc=_providerManagerTable[i];
314                                  Message* resp = pmc->getProviderManager()->processMessage(request);
315                                  if (resp)
316                                  {
317 kumpf           1.3                  delete resp;
318 kumpf           1.1              }
319                              }
320 kumpf           1.3  
321 schuur          1.7          response = request->buildResponse();
322 kumpf           1.6      }
323                          else if(request->getType() == CIM_NOTIFY_CONFIG_CHANGE_REQUEST_MESSAGE)
324                          {
325 schuur          1.7          // Do not need to forward this request to in-process provider
326 kumpf           1.6          // managers
327 schuur          1.7          response = request->buildResponse();
328 kumpf           1.1      }
329                          else
330                          {
331                              // Retrieve the provider interface type
332                              String interfaceType;
333                              CIMValue itValue = providerModule.getProperty(
334                                  providerModule.findProperty("InterfaceType")).getValue();
335                              itValue.get(interfaceType);
336                      
337 kumpf           1.24         ProviderManager* pm = 0;
338                              Boolean gotError = false;
339                              try
340                              {
341                                  // Look up the appropriate ProviderManager by InterfaceType
342                                  pm = _lookupProviderManager(interfaceType);
343                              }
344                              catch (const CIMException& e)
345                              {
346                                  CIMResponseMessage* cimResponse = request->buildResponse();
347                                  cimResponse->cimException = e;
348                                  response = cimResponse;
349                                  gotError = true;
350                              }
351                      
352                              if (remoteNameSpaceRequest && !pm->supportsRemoteNameSpaces())
353                              {
354                                  CIMResponseMessage* resp = request->buildResponse();
355                                  resp->cimException = PEGASUS_CIM_EXCEPTION(CIM_ERR_FAILED,
356                                      "Remote Namespace operations not supported for interface type "
357                                          + interfaceType);
358 kumpf           1.24             response = resp;
359                                  gotError = true;
360                              }
361                      
362                              if (!gotError)
363                              {
364                                  response = pm->processMessage(request);
365                              }
366 kumpf           1.1      }
367                      
368                          // preserve message key
369                          // set HTTP method in response from request
370 j.alex          1.26     // set closeConnect
371                         ((CIMResponseMessage *)response)->syncAttributes(request);
372 kumpf           1.1  
373                          PEG_METHOD_EXIT();
374                          return response;
375                      }
376                      
377                      // ATTN: May need to add interfaceVersion parameter to further constrain lookup
378                      ProviderManager* BasicProviderManagerRouter::_lookupProviderManager(
379                          const String& interfaceType)
380                      {
381                          PEG_METHOD_ENTER(TRC_PROVIDERMANAGER,
382                              "BasicProviderManagerRouter::_lookupProviderManager");
383                      
384                          //
385                          // Search for this InterfaceType in the table of loaded ProviderManagers
386                          //
387                          {
388                              ReadLock tableLock(_providerManagerTableLock);
389                      
390                              // find provider manager for specified provider interface type
391                              for(Uint32 i = 0, n = _providerManagerTable.size(); i < n; i++)
392                              {
393 kumpf           1.1              if (interfaceType == _providerManagerTable[i]->getInterfaceName())
394                                  {
395                                      ProviderManagerContainer* pmc=_providerManagerTable[i];
396                                      PEG_METHOD_EXIT();
397                                      return pmc->getProviderManager();
398                                  }
399                              }
400                          }
401                      
402                          //
403                          // Load the ProviderManager for this InterfaceType and add it to the table
404                          //
405                          {
406                              WriteLock tableLock(_providerManagerTableLock);
407                      
408                              // ATTN: this section is a temporary solution to populate the list of
409                              // enabled provider managers for a given distribution.  It includes
410                              // another temporary solution for converting a generic file name into
411                              // a file name useable by each platform.
412                      
413 se.gupta        1.10 #if defined(PEGASUS_ENABLE_DEFAULT_PROVIDER_MANAGER)
414 kumpf           1.1          if (interfaceType == "C++Default")
415                              {
416                                  ProviderManagerContainer* pmc = new ProviderManagerContainer(
417                                      LIBRARY_NAME_DEFAULTPM, "DEFAULT", "C++Default",
418 carolann.graves 1.17                 _indicationCallback, _subscriptionInitComplete);
419 kumpf           1.1              _providerManagerTable.append(pmc);
420                                  return pmc->getProviderManager();
421                              }
422                      #endif
423                      
424 se.gupta        1.11 #if defined(PEGASUS_ENABLE_CMPI_PROVIDER_MANAGER)
425 kumpf           1.1          if (interfaceType == "CMPI")
426                              {
427                                  ProviderManagerContainer* pmc = new ProviderManagerContainer(
428 kumpf           1.18                 LIBRARY_NAME_CMPIPM, "CMPI", "CMPI", _indicationCallback,
429                                      _subscriptionInitComplete);
430 kumpf           1.1              _providerManagerTable.append(pmc);
431                                  return pmc->getProviderManager();
432                              }
433                      #endif
434                      
435 se.gupta        1.11 #if defined(PEGASUS_ENABLE_JMPI_PROVIDER_MANAGER)
436 kumpf           1.1          if (interfaceType == "JMPI")
437                              {
438                                  ProviderManagerContainer* pmc = new ProviderManagerContainer(
439 kumpf           1.18                 LIBRARY_NAME_JMPIPM, "JMPI", "JMPI", _indicationCallback,
440                                      _subscriptionInitComplete);
441 kumpf           1.1              _providerManagerTable.append(pmc);
442                                  return pmc->getProviderManager();
443                              }
444                      #endif
445                              // END TEMP SECTION
446                          }
447                      
448                          // Error: ProviderManager not found for the specified interface type
449                          PEGASUS_ASSERT(0);
450                          PEG_METHOD_EXIT();
451                          return 0;
452                      }
453                      
454 kumpf           1.5  Boolean BasicProviderManagerRouter::hasActiveProviders()
455 kumpf           1.1  {
456                          PEG_METHOD_ENTER(TRC_PROVIDERMANAGER,
457 kumpf           1.5          "BasicProviderManagerRouter::hasActiveProviders");
458 kumpf           1.1  
459 kumpf           1.5      ReadLock tableLock(_providerManagerTableLock);
460 kumpf           1.1      for(Uint32 i = 0, n = _providerManagerTable.size(); i < n; i++)
461                          {
462                              ProviderManagerContainer* pmc = _providerManagerTable[i];
463 kumpf           1.5          if (pmc->getProviderManager()->hasActiveProviders())
464                              {
465                                  PEG_METHOD_EXIT();
466                                  return true;
467                              }
468                          }
469                      
470                          PEG_METHOD_EXIT();
471                          return false;
472                      }
473                      
474                      void BasicProviderManagerRouter::unloadIdleProviders()
475                      {
476                          PEG_METHOD_ENTER(TRC_PROVIDERMANAGER,
477                              "BasicProviderManagerRouter::unloadIdleProviders");
478                      
479                          //
480                          // Save pointers to the ProviderManagerContainers so we don't hold the
481                          // _providerManagerTableLock while unloading idle providers
482                          //
483                          Array<ProviderManagerContainer*> pmcs;
484 kumpf           1.5      {
485                              ReadLock tableLock(_providerManagerTableLock);
486                              for(Uint32 i = 0, n = _providerManagerTable.size(); i < n; i++)
487                              {
488                                  pmcs.append(_providerManagerTable[i]);
489                              }
490                          }
491                      
492                          //
493                          // Unload idle providers in each of the active ProviderManagers
494                          // _providerManagerTableLock while unloading idle providers
495                          //
496                          for (Uint32 i = 0; i < pmcs.size(); i++)
497                          {
498                              pmcs[i]->getProviderManager()->unloadIdleProviders();
499 kumpf           1.1      }
500                      
501                          PEG_METHOD_EXIT();
502                      }
503                      
504                      PEGASUS_NAMESPACE_END

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2