OW_RepositoryIFC.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_REPOSITORYIFC_HPP_INCLUDE_GUARD_
#define OW_REPOSITORYIFC_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_CIMFwd.hpp"
#include "OW_SharedLibraryReference.hpp"
#include "OW_ResultHandlerIFC.hpp"
#include "OW_ServiceEnvironmentIFC.hpp"
#include "OW_WBEMFlags.hpp"
#include "OW_CommonFwd.hpp"
#include "OW_IfcsFwd.hpp"
#include "OW_ServiceIFC.hpp"

// The classes and functions defined in this file are not meant for general
// use, they are internal implementation details.  They may change at any time.

namespace OW_NAMESPACE
{

class OW_COMMON_API RepositoryIFC : public ServiceIFC
{
   typedef ServiceIFC base_t;

public:
   RepositoryIFC();
   RepositoryIFC(const RepositoryIFC& x);
   virtual ~RepositoryIFC();
   virtual void open(const String& path) = 0;
   virtual void close() = 0;

   virtual ServiceEnvironmentIFCRef getEnvironment() const = 0;
#if !defined(OW_DISABLE_INSTANCE_MANIPULATION) && !defined(OW_DISABLE_NAMESPACE_MANIPULATION)

   virtual void createNameSpace(const String& ns,
      OperationContext& context) = 0;
   virtual void deleteNameSpace(const String& ns,
      OperationContext& context) = 0;
#endif

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

   virtual void enumQualifierTypes(
      const String& ns,
      CIMQualifierTypeResultHandlerIFC& result,
      OperationContext& context) = 0;
   virtual void deleteQualifierType(const String& ns, const String& qualName,
      OperationContext& context) = 0;
   virtual void setQualifierType(const String& ns,
      const CIMQualifierType& qt, OperationContext& context) = 0;
#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) = 0;
#ifndef OW_DISABLE_SCHEMA_MANIPULATION

   virtual CIMClass deleteClass(const String& ns, const String& className,
      OperationContext& context) = 0;
   virtual void createClass(const String& ns,
      const CIMClass& cimClass, OperationContext& context) = 0;
   virtual CIMClass modifyClass(const String &ns,
      const CIMClass& cimClass, OperationContext& context) = 0;
#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) = 0;
   virtual void enumClassNames(const String& ns,
      const String& className,
      StringResultHandlerIFC& result,
      WBEMFlags::EDeepFlag deep, OperationContext& context) = 0;
   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) = 0;
   virtual void enumInstanceNames(
      const String& ns,
      const String& className,
      CIMObjectPathResultHandlerIFC& result,
      WBEMFlags::EDeepFlag deep,
      OperationContext& context) = 0;
   virtual CIMInstance getInstance(
      const String& ns,
      const CIMObjectPath& instanceName,
      WBEMFlags::ELocalOnlyFlag localOnly, WBEMFlags::EIncludeQualifiersFlag includeQualifiers,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin, const StringArray* propertyList,
      OperationContext& context) = 0;
#ifndef OW_DISABLE_INSTANCE_MANIPULATION

   virtual CIMInstance deleteInstance(const String& ns, const CIMObjectPath& cop,
      OperationContext& context) = 0;
   virtual CIMObjectPath createInstance(const String& ns,
      const CIMInstance& ci, OperationContext& context) = 0;
   virtual CIMInstance modifyInstance(
      const String& ns,
      const CIMInstance& modifiedInstance,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers,
      const StringArray* propertyList,
      OperationContext& context) = 0;
#if !defined(OW_DISABLE_PROPERTY_OPERATIONS)

   virtual void setProperty(
      const String& ns,
      const CIMObjectPath& name,
      const String& propertyName, const CIMValue& cv,
      OperationContext& context) = 0;
#endif // #if !defined(OW_DISABLE_PROPERTY_OPERATIONS)
#endif // #ifndef OW_DISABLE_INSTANCE_MANIPULATION
   
#if !defined(OW_DISABLE_PROPERTY_OPERATIONS)

   virtual CIMValue getProperty(
      const String& ns,
      const CIMObjectPath& name,
      const String& propertyName, OperationContext& context) = 0;
#endif // #if !defined(OW_DISABLE_PROPERTY_OPERATIONS)

   virtual CIMValue invokeMethod(
      const String& ns,
      const CIMObjectPath& path,
      const String& methodName, const CIMParamValueArray& inParams,
      CIMParamValueArray& outParams, OperationContext& context) = 0;
#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) = 0;
   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) = 0;
   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) = 0;
   virtual void referenceNames(
      const String& ns,
      const CIMObjectPath& path,
      CIMObjectPathResultHandlerIFC& result,
      const String& resultClass,
      const String& role, OperationContext& context) = 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,
      OperationContext& context) = 0;
   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) = 0;
#endif // #ifndef OW_DISABLE_ASSOCIATION_TRAVERSAL

   virtual void execQuery(
      const String& ns,
      CIMInstanceResultHandlerIFC& result,
      const String &query, const String& queryLanguage,
      OperationContext& context) = 0;
   virtual void exportIndication(const CIMInstance&,
      const String&);

   virtual void beginOperation(WBEMFlags::EOperationFlag op, OperationContext& context) = 0;
   virtual void endOperation(WBEMFlags::EOperationFlag op, OperationContext& context, WBEMFlags::EOperationResultFlag result) = 0;
};

} // end namespace OW_NAMESPACE

#endif

---