OW_ProviderIFCBaseIFC.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2001-2004 Vintela, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
*
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the documentation
*    and/or other materials provided with the distribution.
*
*  - Neither the name of Vintela, Inc. nor the names of its
*    contributors may be used to endorse or promote products derived from this
*    software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc. OR THE CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/

#ifndef OW_PROVIDERIFC_HPP_
#define OW_PROVIDERIFC_HPP_
#include "OW_config.h"
#include "OW_SharedLibraryReference.hpp"
#include "OW_String.hpp"
#include "OW_MethodProviderIFC.hpp"
#include "OW_InstanceProviderIFC.hpp"
#include "OW_SecondaryInstanceProviderIFC.hpp"
#ifndef OW_DISABLE_ASSOCIATION_TRAVERSAL
#include "OW_AssociatorProviderIFC.hpp"
#endif
#include "OW_IndicationExportProviderIFC.hpp"
#include "OW_PolledProviderIFC.hpp"
#include "OW_IndicationProviderIFC.hpp"
#include "OW_ProviderEnvironmentIFC.hpp"
#include "OW_InstanceProviderInfo.hpp"
#include "OW_SecondaryInstanceProviderInfo.hpp"
#ifndef OW_DISABLE_ASSOCIATION_TRAVERSAL
#include "OW_AssociatorProviderInfo.hpp"
#endif
#include "OW_MethodProviderInfo.hpp"
#include "OW_IndicationProviderInfo.hpp"
#include "OW_IntrusiveReference.hpp"
#include "OW_IntrusiveCountableBase.hpp"

namespace OW_NAMESPACE
{

class OW_PROVIDER_API ProviderIFCBaseIFC : public IntrusiveCountableBase
{
public:
   ProviderIFCBaseIFC();
   virtual ~ProviderIFCBaseIFC();
   virtual const char* getName() const = 0;
   const UInt32 signature;
   void init(const ProviderEnvironmentIFCRef& env,
      InstanceProviderInfoArray& i,
      SecondaryInstanceProviderInfoArray& si,
#ifndef OW_DISABLE_ASSOCIATION_TRAVERSAL
      AssociatorProviderInfoArray& a,
#endif
      MethodProviderInfoArray& m,
      IndicationProviderInfoArray& ind);
   InstanceProviderIFCRef getInstanceProvider(const ProviderEnvironmentIFCRef& env,
      const char* provIdString);
   SecondaryInstanceProviderIFCRef getSecondaryInstanceProvider(const ProviderEnvironmentIFCRef& env,
      const char* provIdString);
   MethodProviderIFCRef getMethodProvider(const ProviderEnvironmentIFCRef& env,
      const char* provIdString);
#ifndef OW_DISABLE_ASSOCIATION_TRAVERSAL

   AssociatorProviderIFCRef getAssociatorProvider(const ProviderEnvironmentIFCRef& env,
      const char* provIdString);
#endif

   IndicationExportProviderIFCRefArray getIndicationExportProviders(
      const ProviderEnvironmentIFCRef& env);
   PolledProviderIFCRefArray getPolledProviders(const ProviderEnvironmentIFCRef& env);
   void unloadProviders(const ProviderEnvironmentIFCRef& env);
   IndicationProviderIFCRef getIndicationProvider(const ProviderEnvironmentIFCRef& env,
      const char* provIdString);

   /*
    * This function gets called for all providers just before the CIMOM
    * shuts down.  It gives providers the opportunity to do any cleanup
    * needed for shutdown, while the CIMOM services are still available.
    */
   void shuttingDown(const ProviderEnvironmentIFCRef& env);

protected:
   virtual void doInit(const ProviderEnvironmentIFCRef& env,
      InstanceProviderInfoArray& i,
      SecondaryInstanceProviderInfoArray& si,
#ifndef OW_DISABLE_ASSOCIATION_TRAVERSAL
      AssociatorProviderInfoArray& a,
#endif
      MethodProviderInfoArray& m,
      IndicationProviderInfoArray& ind) = 0;
   virtual InstanceProviderIFCRef doGetInstanceProvider(const ProviderEnvironmentIFCRef& env,
      const char* provIdString);
   virtual SecondaryInstanceProviderIFCRef doGetSecondaryInstanceProvider(const ProviderEnvironmentIFCRef& env,
      const char* provIdString);
   virtual MethodProviderIFCRef doGetMethodProvider(const ProviderEnvironmentIFCRef& env,
      const char* provIdString);
#ifndef OW_DISABLE_ASSOCIATION_TRAVERSAL
   virtual AssociatorProviderIFCRef doGetAssociatorProvider(
      const ProviderEnvironmentIFCRef& env,
      const char* provIdString);
#endif
   virtual IndicationExportProviderIFCRefArray doGetIndicationExportProviders(
      const ProviderEnvironmentIFCRef& env
      );
   virtual PolledProviderIFCRefArray doGetPolledProviders(
      const ProviderEnvironmentIFCRef& env
      );
   virtual IndicationProviderIFCRef doGetIndicationProvider(
      const ProviderEnvironmentIFCRef& env,
      const char* provIdString);
   virtual void doUnloadProviders(const ProviderEnvironmentIFCRef& env);
   virtual void doShuttingDown(const ProviderEnvironmentIFCRef& env);
};

typedef SharedLibraryReference< IntrusiveReference<ProviderIFCBaseIFC> > ProviderIFCBaseIFCRef;

} // end namespace OW_NAMESPACE

#if !defined(OW_STATIC_SERVICES)
#define OW_PROVIDERIFCFACTORY(prov, name) \
extern "C" OW_EXPORT OW_NAMESPACE::ProviderIFCBaseIFC* \
createProviderIFC() \
{ \
   return new prov; \
} \
extern "C" OW_EXPORT const char* \
getOWVersion() \
{ \
   return OW_VERSION; \
}
#else
#define OW_PROVIDERIFCFACTORY(prov, name) \
extern "C" OW_NAMESPACE::ProviderIFCBaseIFC* \
createProviderIFC_##name() \
{ \
   return new prov; \
}
#endif /* !defined(OW_STATIC_SERVICES) */

#endif

---