OW_CIMRepository2.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2002 Center 7, 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 Center 7 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 Center 7, 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_CIM_REPOSITORY2_HPP_INCLUDE_GUARD_
#define OW_CIM_REPOSITORY2_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_RepositoryIFC.hpp"
#include "OW_ServiceEnvironmentIFC.hpp"
#include "OW_MetaRepository2.hpp"
#include "OW_InstanceRepository2.hpp"
#ifndef OW_DISABLE_ASSOCIATION_TRAVERSAL
#include "OW_AssocDb2.hpp"
#endif
#include "OW_Exception.hpp"

#include <db.h>

namespace OW_NAMESPACE
{

OW_DECLARE_EXCEPTION(CIMRepository2);

// This class is responsible for storing/retrieving the static CIM data.
class CIMRepository2 : public RepositoryIFC
{
public:
   CIMRepository2(ServiceEnvironmentIFCRef env);
   virtual ~CIMRepository2();
   virtual void open(const String& path);
   virtual void close();
#ifndef OW_DISABLE_INSTANCE_MANIPULATION

   virtual void createNameSpace(const String& ns, OperationContext& context);
   virtual void deleteNameSpace(const String& ns, OperationContext& context);
#endif // #ifndef OW_DISABLE_INSTANCE_MANIPULATION

   virtual void enumNameSpace(StringResultHandlerIFC& result,
      OperationContext& context);
   virtual CIMQualifierType getQualifierType(const String& ns,
      const String& qualifierName,
      OperationContext& context);
#ifndef OW_DISABLE_QUALIFIER_DECLARATION

   virtual void enumQualifierTypes(
      const String& ns,
      CIMQualifierTypeResultHandlerIFC& result,
      OperationContext& context);
   virtual void deleteQualifierType(const String& ns, const String& qualName,
      OperationContext& context);
   virtual void setQualifierType(const String& ns,
      const CIMQualifierType& qt, OperationContext& context);
#endif // #ifndef OW_DISABLE_QUALIFIER_DECLARATION

   virtual CIMClass getClass(
      const String& ns,
      const String& className,
      WBEMFlags::ELocalOnlyFlag localOnly, WBEMFlags::EIncludeQualifiersFlag includeQualifiers,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin, const StringArray* propertyList,
      OperationContext& context);
#ifndef OW_DISABLE_SCHEMA_MANIPULATION

   virtual CIMClass deleteClass(const String& ns, const String& className,
      OperationContext& context);
   virtual void createClass(const String& ns, const CIMClass& cimClass,
      OperationContext& context);
   virtual CIMClass modifyClass(
      const String& ns,
      const CIMClass& cc,
      OperationContext& context);
#endif // #ifndef OW_DISABLE_SCHEMA_MANIPULATION

   virtual void enumClasses(const String& ns,
      const String& className,
      CIMClassResultHandlerIFC& result,
      WBEMFlags::EDeepFlag deep, WBEMFlags::ELocalOnlyFlag localOnly, WBEMFlags::EIncludeQualifiersFlag includeQualifiers,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin, OperationContext& context);
   virtual void enumClassNames(const String& ns,
      const String& className,
      StringResultHandlerIFC& result,
      WBEMFlags::EDeepFlag deep, OperationContext& context);
   virtual void enumInstances(
      const String& ns,
      const String& className,
      CIMInstanceResultHandlerIFC& result,
      WBEMFlags::EDeepFlag deep, WBEMFlags::ELocalOnlyFlag localOnly,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin,
      const StringArray* propertyList,
      WBEMFlags::EEnumSubclassesFlag enumSubclasses,
      OperationContext& context);
   virtual void enumInstanceNames(
      const String& ns,
      const String& className,
      CIMObjectPathResultHandlerIFC& result,
      WBEMFlags::EDeepFlag deep, OperationContext& context);
   virtual CIMInstance getInstance(
      const String& ns,
      const CIMObjectPath& instanceName,
      WBEMFlags::ELocalOnlyFlag localOnly, WBEMFlags::EIncludeQualifiersFlag includeQualifiers,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin, const StringArray* propertyList,
      OperationContext& context);
   virtual CIMInstance getInstance(
      const String& ns,
      const CIMObjectPath& instanceName,
      WBEMFlags::ELocalOnlyFlag localOnly, WBEMFlags::EIncludeQualifiersFlag includeQualifiers,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin, const StringArray* propertyList,
      CIMClass* pOutClass, OperationContext& context);
#ifndef OW_DISABLE_INSTANCE_MANIPULATION

   virtual CIMInstance deleteInstance(const String& ns, const CIMObjectPath& cop,
      OperationContext& context);
   virtual CIMObjectPath createInstance(const String& ns,
      const CIMInstance& ci,
      OperationContext& context);
   virtual CIMInstance modifyInstance(
      const String& ns,
      const CIMInstance& modifiedInstance,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers,
      const StringArray* propertyList,
      OperationContext& context);
   virtual void setProperty(
      const String& ns,
      const CIMObjectPath& name, const String& propertyName,
      const CIMValue& cv, OperationContext& context);
#endif // #ifndef OW_DISABLE_INSTANCE_MANIPULATION

   virtual CIMValue getProperty(
      const String& ns,
      const CIMObjectPath& name,
      const String& propertyName, OperationContext& context);
   virtual CIMValue invokeMethod(
      const String& ns,
      const CIMObjectPath& path,
      const String& methodName, const CIMParamValueArray& inParams,
      CIMParamValueArray& outParams, OperationContext& context);
#ifndef OW_DISABLE_ASSOCIATION_TRAVERSAL
   virtual void associatorNames(
      const String& ns,
      const CIMObjectPath& path,
      CIMObjectPathResultHandlerIFC& result,
      const String& assocClass,
      const String& resultClass, const String& role,
      const String& resultRole, OperationContext& context);
   virtual void associators(
      const String& ns,
      const CIMObjectPath& path,
      CIMInstanceResultHandlerIFC& result,
      const String& assocClass,
      const String& resultClass, const String& role,
      const String& resultRole,  WBEMFlags::EIncludeQualifiersFlag includeQualifiers,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin, const StringArray* propertyList,
      OperationContext& context);
   virtual void associatorsClasses(
      const String& ns,
      const CIMObjectPath& path,
      CIMClassResultHandlerIFC& result,
      const String& assocClass,
      const String& resultClass, const String& role,
      const String& resultRole,  WBEMFlags::EIncludeQualifiersFlag includeQualifiers,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin, const StringArray* propertyList,
      OperationContext& context);
   virtual void referenceNames(
      const String& ns,
      const CIMObjectPath& path,
      CIMObjectPathResultHandlerIFC& result,
      const String& resultClass,
      const String& role, OperationContext& context);
   virtual void references(
      const String& ns,
      const CIMObjectPath& path,
      CIMInstanceResultHandlerIFC& result,
      const String& resultClass,
      const String& role, WBEMFlags::EIncludeQualifiersFlag includeQualifiers,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin, const StringArray* propertyList,
      OperationContext& context);
   
   virtual void referencesClasses(
      const String& ns,
      const CIMObjectPath& path,
      CIMClassResultHandlerIFC& result,
      const String& resultClass,
      const String& role, WBEMFlags::EIncludeQualifiersFlag includeQualifiers,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin, const StringArray* propertyList,
      OperationContext& context);
#endif // #ifndef OW_DISABLE_ASSOCIATION_TRAVERSAL

   virtual void execQuery(
      const String& ns,
      CIMInstanceResultHandlerIFC& result,
      const String &query, const String& queryLanguage,
      OperationContext& context);
   
   virtual void beginOperation(WBEMFlags::EOperationFlag op, OperationContext& context);
   virtual void endOperation(WBEMFlags::EOperationFlag op, OperationContext& context, WBEMFlags::EOperationResultFlag result);

   ServiceEnvironmentIFCRef getEnvironment() const { return m_env; }

   CIMClass _getClass(const String& ns, const String& className);
   CIMClass _instGetClass(const String& ns, const String& className);
   void checkGetClassRvalAndThrow(CIMException::ErrNoType rval,
      const String& ns, const String& className);
   void checkGetClassRvalAndThrowInst(CIMException::ErrNoType rval,
      const String& ns, const String& className);
#ifndef OW_DISABLE_ASSOCIATION_TRAVERSAL
   void _commonAssociators(
      const String& ns,
      const CIMObjectPath& path_,
      const String& assocClassName, const String& resultClass,
      const String& role, const String& resultRole,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin,
      const StringArray* propertyList,
      CIMInstanceResultHandlerIFC* piresult,
      CIMObjectPathResultHandlerIFC* popresult,
      CIMClassResultHandlerIFC* pcresult,
      OperationContext& context);
   void _commonReferences(
      const String& ns,
      const CIMObjectPath& path_,
      const String& resultClass, const String& role,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin,
      const StringArray* propertyList, CIMInstanceResultHandlerIFC* piresult,
      CIMObjectPathResultHandlerIFC* popresult,
      CIMClassResultHandlerIFC* pcresult, OperationContext& context);
   
   void _getAssociationClasses(const String& ns,
      const String& assocClassName, const String& className,
      CIMClassResultHandlerIFC& result, const String& role,
      OperationContext& context);
   void _staticReferences(const CIMObjectPath& path,
      const SortedVectorSet<String>* refClasses, const String& role,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin,
      const StringArray* propertyList, CIMInstanceResultHandlerIFC& result,
      OperationContext& context);
   
   void _staticReferenceNames(const CIMObjectPath& path,
      const SortedVectorSet<String>* refClasses, const String& role,
      CIMObjectPathResultHandlerIFC& result);
   void _staticReferencesClass(const CIMObjectPath& path,
      const SortedVectorSet<String>* resultClasses,
      const String& role,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin,
      const StringArray* propertyList,
      CIMObjectPathResultHandlerIFC* popresult,
      CIMClassResultHandlerIFC* pcresult,
      OperationContext& context);
   void _staticAssociators(const CIMObjectPath& path,
      const SortedVectorSet<String>* passocClasses,
      const SortedVectorSet<String>* presultClasses,
      const String& role, const String& resultRole,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin,
      const StringArray* propertyList, CIMInstanceResultHandlerIFC& result,
      OperationContext& context);
   void _staticAssociatorNames(const CIMObjectPath& path,
      const SortedVectorSet<String>* passocClasses,
      const SortedVectorSet<String>* presultClasses,
      const String& role, const String& resultRole,
      CIMObjectPathResultHandlerIFC& result);
   void _staticAssociatorsClass(
      const CIMObjectPath& path,
      const SortedVectorSet<String>* assocClassNames,
      const SortedVectorSet<String>* resultClasses,
      const String& role, const String& resultRole,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin,
      const StringArray* propertyList, CIMObjectPathResultHandlerIFC* popresult,
      CIMClassResultHandlerIFC* pcresult,
      OperationContext& context);
#endif // #ifndef OW_DISABLE_ASSOCIATION_TRAVERSAL
   void _validatePropagatedKeys(const String& ns,
      const CIMInstance& ci, const CIMClass& theClass);

private:
   CIMRepository2(const CIMRepository2&); // unimplemented
   CIMRepository2& operator=(const CIMRepository2&);

public:
   InstanceRepository2 m_iStore;
   MetaRepository2 m_mStore;
#ifndef OW_DISABLE_ASSOCIATION_TRAVERSAL
   AssocDb2 m_classAssocDb;
   AssocDb2 m_instAssocDb;
#endif
   ServiceEnvironmentIFCRef m_env;
private:
   bool m_checkReferentialIntegrity;

    DB_ENV* m_dbenv;

   friend class CIMServer;
};

} // end namespace OW_NAMESPACE

#endif

---