OW_RepositoryCIMOMHandle.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_REPOSITORY_CIMOMHANDLE_HPP_INCLUDE_GUARD_
#define OW_REPOSITORY_CIMOMHANDLE_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_Types.hpp"
#include "OW_CIMOMHandleIFC.hpp"
#include "OW_RepositoryIFC.hpp"
#include "OW_RWLocker.hpp"
#include "OW_IntrusiveReference.hpp"
#include "OW_CommonFwd.hpp"

namespace OW_NAMESPACE
{

class OW_COMMON_API RepositoryCIMOMHandle : public CIMOMHandleIFC
{
public:

   enum ELockingFlag
   {
      E_NO_LOCKING,
      E_LOCKING
   };
   RepositoryCIMOMHandle(const RepositoryIFCRef& pRepos,
      OperationContext& context, ELockingFlag lock = E_LOCKING);
   
   virtual void close();

#if !defined(OW_DISABLE_INSTANCE_MANIPULATION) && !defined(OW_DISABLE_NAMESPACE_MANIPULATION)
   virtual void createNameSpace(const String& ns);
   virtual void deleteNameSpace(const String& ns);
#endif
   virtual void enumNameSpace(StringResultHandlerIFC& result);
   virtual void enumClass(
      const String& ns,
      const String& className,
      CIMClassResultHandlerIFC& result,
      WBEMFlags::EDeepFlag deep = WBEMFlags::E_SHALLOW,
      WBEMFlags::ELocalOnlyFlag localOnly = WBEMFlags::E_NOT_LOCAL_ONLY,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_INCLUDE_QUALIFIERS,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_INCLUDE_CLASS_ORIGIN);
   virtual void enumClassNames(
      const String& ns,
      const String& className,
      StringResultHandlerIFC& result,
      WBEMFlags::EDeepFlag deep=WBEMFlags::E_DEEP);
   virtual CIMQualifierType getQualifierType(const String& ns,
      const String& qualifierName);
#ifndef OW_DISABLE_QUALIFIER_DECLARATION
   virtual void enumQualifierTypes(
      const String& ns,
      CIMQualifierTypeResultHandlerIFC& result);
   virtual void deleteQualifierType(const String& ns, const String& qualName);
   virtual void setQualifierType(const String& ns,
      const CIMQualifierType& qt);
#endif // #ifndef OW_DISABLE_QUALIFIER_DECLARATION
   virtual CIMInstance getInstance(
      const String& ns,
      const CIMObjectPath& instanceName,
      WBEMFlags::ELocalOnlyFlag localOnly = WBEMFlags::E_NOT_LOCAL_ONLY,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,
      const StringArray* propertyList=0);
   virtual void enumInstances(
      const String& ns,
      const String& className,
      CIMInstanceResultHandlerIFC& result,
      WBEMFlags::EDeepFlag deep = WBEMFlags::E_DEEP,
      WBEMFlags::ELocalOnlyFlag localOnly = WBEMFlags::E_NOT_LOCAL_ONLY,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,
      const StringArray* propertyList=0);
   virtual void enumInstanceNames(
      const String& ns,
      const String& className,
      CIMObjectPathResultHandlerIFC& result);
   virtual CIMClass getClass(
      const String& ns,
      const String& className,
      WBEMFlags::ELocalOnlyFlag localOnly = WBEMFlags::E_NOT_LOCAL_ONLY,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_INCLUDE_QUALIFIERS,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_INCLUDE_CLASS_ORIGIN,
      const StringArray* propertyList=NULL);
   virtual CIMValue invokeMethod(
      const String& ns,
      const CIMObjectPath& path,
      const String &methodName, const CIMParamValueArray &inParams,
      CIMParamValueArray &outParams);
#ifndef OW_DISABLE_SCHEMA_MANIPULATION
   virtual void createClass(const String& ns,
      const CIMClass &cc);
   virtual void modifyClass(const String &ns, const CIMClass &cc);
   virtual void deleteClass(const String& ns, const String& className);
#endif // #ifndef OW_DISABLE_SCHEMA_MANIPULATION
#ifndef OW_DISABLE_INSTANCE_MANIPULATION
   virtual CIMObjectPath createInstance(const String& ns,
      const CIMInstance &ci);
#if !defined(OW_DISABLE_PROPERTY_OPERATIONS)
   virtual void setProperty(
      const String& ns,
      const CIMObjectPath &name,
      const String &propertyName, const CIMValue &cv);
#endif // #if !defined(OW_DISABLE_PROPERTY_OPERATIONS)
   virtual void modifyInstance(
      const String& ns,
      const CIMInstance& modifiedInstance,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers,
      const StringArray* propertyList);
   virtual void deleteInstance(const String& ns, const CIMObjectPath& path);
#endif // #ifndef OW_DISABLE_INSTANCE_MANIPULATION
#if !defined(OW_DISABLE_PROPERTY_OPERATIONS)
   virtual CIMValue getProperty(
      const String& ns,
      const CIMObjectPath &name,
      const String &propertyName);
#endif // #if !defined(OW_DISABLE_PROPERTY_OPERATIONS)
#ifndef OW_DISABLE_ASSOCIATION_TRAVERSAL
   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);
   virtual void associatorsClasses(
      const String& ns,
      const CIMObjectPath& path,
      CIMClassResultHandlerIFC& result,
      const String& assocClass=String(),
      const String& resultClass=String(),
      const String& role=String(),
      const String& resultRole=String(),
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,
      const StringArray* propertyList=0);
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);
   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);
   virtual void associatorNames(
      const String& ns,
      const CIMObjectPath &path,
      CIMObjectPathResultHandlerIFC& result,
      const String &assocClass,
      const String &resultClass, const String &role,
      const String &resultRole);
   virtual void referenceNames(
      const String& ns,
      const CIMObjectPath &path,
      CIMObjectPathResultHandlerIFC& result,
      const String &resultClass,
      const String &role);
#endif
   
   virtual void execQuery(
      const String& ns,
      CIMInstanceResultHandlerIFC& result,
      const String &query, const String& queryLanguage);

   typedef RepositoryIFCRef RepositoryCIMOMHandle::*safe_bool;
   operator safe_bool () const
      {  return (m_pServer) ? &RepositoryCIMOMHandle::m_pServer : 0; }
   bool operator!() const
      {  return !m_pServer; }
   void beginOperation(WBEMFlags::EOperationFlag op, OperationContext& context);
   void endOperation(WBEMFlags::EOperationFlag op, OperationContext& context, WBEMFlags::EOperationResultFlag result);

private:

#ifdef OW_WIN32
#pragma warning (push)
#pragma warning (disable: 4251)
#endif

   RepositoryIFCRef m_pServer;

#ifdef OW_WIN32
#pragma warning (pop)
#endif

   ELockingFlag m_lock;
   OperationContext& m_context;
};
OW_EXPORT_TEMPLATE(OW_COMMON_API, IntrusiveReference, RepositoryCIMOMHandle);

} // end namespace OW_NAMESPACE

#endif

---