OW_CIMOMHandleIFC.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_CIMOMHANDLE_IFC_HPP_INCLUDE_GUARD_
#define OW_CIMOMHANDLE_IFC_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_CIMFwd.hpp"
#include "OW_IntrusiveCountableBase.hpp"
#include "OW_WBEMFlags.hpp"
#include "OW_IfcsFwd.hpp"

namespace OW_NAMESPACE
{

class OW_COMMON_API CIMOMHandleIFC : public IntrusiveCountableBase
{
public:
   virtual ~CIMOMHandleIFC();
   virtual void close() = 0;
   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) = 0;
   virtual CIMClassEnumeration enumClassE(const String& ns,
      const String& className,
      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 CIMClassArray enumClassA(const String& ns,
      const String& className,
      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) = 0;
   virtual StringEnumeration enumClassNamesE(
      const String& ns,
      const String& className,
      WBEMFlags::EDeepFlag deep = WBEMFlags::E_DEEP);
   virtual StringArray enumClassNamesA(
      const String& ns,
      const String& className,
      WBEMFlags::EDeepFlag deep = WBEMFlags::E_DEEP);
   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) = 0;
   virtual CIMInstanceEnumeration enumInstancesE(
      const String& ns,
      const String& className,
      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 CIMInstanceArray enumInstancesA(
      const String& ns,
      const String& className,
      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) = 0;
   virtual CIMObjectPathEnumeration enumInstanceNamesE(
      const String& ns,
      const String& className);
   virtual CIMObjectPathArray enumInstanceNamesA(
      const String& ns,
      const String& className);
   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 = 0) = 0;
   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) = 0;
   virtual CIMValue invokeMethod(
      const String& ns,
      const CIMObjectPath& path,
      const String& methodName,
      const CIMParamValueArray& inParams,
      CIMParamValueArray& outParams) = 0;
   virtual CIMQualifierType getQualifierType(
      const String& ns,
      const String& qualifierName) = 0;
#ifndef OW_DISABLE_QUALIFIER_DECLARATION

   virtual void setQualifierType(
      const String& ns,
      const CIMQualifierType& qualifierType) = 0;
   virtual void deleteQualifierType(const String& ns, const String& qualName) = 0;
   virtual void enumQualifierTypes(
      const String& ns,
      CIMQualifierTypeResultHandlerIFC& result) = 0;
   virtual CIMQualifierTypeEnumeration enumQualifierTypesE(
      const String& ns);
   virtual CIMQualifierTypeArray enumQualifierTypesA(
      const String& ns);
#endif // #ifndef OW_DISABLE_QUALIFIER_DECLARATION
#ifndef OW_DISABLE_SCHEMA_MANIPULATION

   virtual void modifyClass(
      const String& ns,
      const CIMClass& cimClass) = 0;
   virtual void createClass(
      const String& ns,
      const CIMClass& cimClass) = 0;
   virtual void deleteClass(const String& ns, const String& className) = 0;
#endif // #ifndef OW_DISABLE_SCHEMA_MANIPULATION
#ifndef OW_DISABLE_INSTANCE_MANIPULATION

   virtual void modifyInstance(
      const String& ns,
      const CIMInstance& modifiedInstance,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_INCLUDE_QUALIFIERS,
      const StringArray* propertyList = 0) = 0;
   virtual CIMObjectPath createInstance(
      const String& ns,
      const CIMInstance& instance) = 0;
   virtual void deleteInstance(const String& ns, const CIMObjectPath& path) = 0;
#if !defined(OW_DISABLE_PROPERTY_OPERATIONS)

   virtual void setProperty(
      const String& ns,
      const CIMObjectPath& instanceName,
      const String& propertyName,
      const CIMValue& newValue) = 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& instanceName,
      const String& propertyName) = 0;
#endif // #if !defined(OW_DISABLE_PROPERTY_OPERATIONS)

#ifndef OW_DISABLE_ASSOCIATION_TRAVERSAL

   virtual void associatorNames(
      const String& ns,
      const CIMObjectPath& objectName,
      CIMObjectPathResultHandlerIFC& result,
      const String& assocClass = String(),
      const String& resultClass = String(),
      const String& role = String(),
      const String& resultRole = String()) = 0;
   virtual CIMObjectPathEnumeration associatorNamesE(
      const String& ns,
      const CIMObjectPath& objectName,
      const String& assocClass = String(),
      const String& resultClass = String(),
      const String& role = String(),
      const String& resultRole = String());
   virtual CIMObjectPathArray associatorNamesA(
      const String& ns,
      const CIMObjectPath& objectName,
      const String& assocClass = String(),
      const String& resultClass = String(),
      const String& role = String(),
      const String& resultRole = String());
   virtual void associators(
      const String& ns,
      const CIMObjectPath& path,
      CIMInstanceResultHandlerIFC& 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) = 0;
   virtual CIMInstanceEnumeration associatorsE(
      const String& ns,
      const CIMObjectPath& path,
      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 CIMInstanceArray associatorsA(
      const String& ns,
      const CIMObjectPath& path,
      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 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) = 0;
   virtual CIMClassEnumeration associatorsClassesE(
      const String& ns,
      const CIMObjectPath& path,
      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 CIMClassArray associatorsClassesA(
      const String& ns,
      const CIMObjectPath& path,
      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 referenceNames(
      const String& ns,
      const CIMObjectPath& path,
      CIMObjectPathResultHandlerIFC& result,
      const String& resultClass = String(),
      const String& role = String()) = 0;
   virtual CIMObjectPathEnumeration referenceNamesE(
      const String& ns,
      const CIMObjectPath& path,
      const String& resultClass = String(),
      const String& role = String());
   virtual CIMObjectPathArray referenceNamesA(
      const String& ns,
      const CIMObjectPath& path,
      const String& resultClass = String(),
      const String& role = String());
   virtual void references(
      const String& ns,
      const CIMObjectPath& path,
      CIMInstanceResultHandlerIFC& result,
      const String& resultClass = String(),
      const String& role = String(),
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,
      const StringArray* propertyList = 0) = 0;
   virtual CIMInstanceEnumeration referencesE(
      const String& ns,
      const CIMObjectPath& path,
      const String& resultClass = String(),
      const String& role = String(),
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,
      const StringArray* propertyList = 0);
   virtual CIMInstanceArray referencesA(
      const String& ns,
      const CIMObjectPath& path,
      const String& resultClass = String(),
      const String& role = String(),
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,
      const StringArray* propertyList = 0);
   virtual void referencesClasses(
      const String& ns,
      const CIMObjectPath& path,
      CIMClassResultHandlerIFC& result,
      const String& resultClass = String(),
      const String& role = String(),
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,
      const StringArray* propertyList = 0) = 0;
   virtual CIMClassEnumeration referencesClassesE(
      const String& ns,
      const CIMObjectPath& path,
      const String& resultClass = String(),
      const String& role = String(),
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,
      const StringArray* propertyList = 0);
   virtual CIMClassArray referencesClassesA(
      const String& ns,
      const CIMObjectPath& path,
      const String& resultClass = String(),
      const String& role = String(),
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,
      const StringArray* propertyList = 0);
#endif // #ifndef OW_DISABLE_ASSOCIATION_TRAVERSAL

   virtual void execQuery(
      const String& ns,
      CIMInstanceResultHandlerIFC& result,
      const String& query,
      const String& queryLanguage) = 0;
   virtual CIMInstanceEnumeration execQueryE(
      const String& ns,
      const String& query,
      const String& queryLanguage);
   virtual CIMInstanceArray execQueryA(
      const String& ns,
      const String& query,
      const String& queryLanguage);
   
   virtual CIMFeatures getServerFeatures();
   virtual void exportIndication(const CIMInstance& instance,
      const String& instNS);
};

} // end namespace OW_NAMESPACE

#endif

---