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

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

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2