OW_NAMESPACE::CppIndicationProviderIFC Class Reference

This is the interface implemented by indication providers. More...

#include <OW_CppIndicationProviderIFC.hpp>

Inheritance diagram for OW_NAMESPACE::CppIndicationProviderIFC:

Inheritance graph
[legend]
Collaboration diagram for OW_NAMESPACE::CppIndicationProviderIFC:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual ~CppIndicationProviderIFC ()
virtual void getIndicationProviderInfoWithEnv (const ProviderRegistrationEnvironmentIFCRef &env, IndicationProviderInfo &info)
 A provider should override this method to report which classes in which namespaces it instruments.
virtual void getIndicationProviderInfo (IndicationProviderInfo &info)
 A provider should override this method to report which classes in which namespaces it instruments.
virtual void activateFilter (const ProviderEnvironmentIFCRef &env, const WQLSelectStatement &filter, const String &eventType, const String &nameSpace, const StringArray &classes, bool firstActivation)
virtual void authorizeFilter (const ProviderEnvironmentIFCRef &env, const WQLSelectStatement &filter, const String &eventType, const String &nameSpace, const StringArray &classes, const String &owner)
virtual void deActivateFilter (const ProviderEnvironmentIFCRef &env, const WQLSelectStatement &filter, const String &eventType, const String &nameSpace, const StringArray &classes, bool lastActivation)
virtual int mustPoll (const ProviderEnvironmentIFCRef &env, const WQLSelectStatement &filter, const String &eventType, const String &nameSpace, const StringArray &classes)
 If a provider wishes to be polled, it must return a positive number.
virtual CppIndicationProviderIFCgetIndicationProvider ()

Detailed Description

This is the interface implemented by indication providers.

Definition at line 50 of file OW_CppIndicationProviderIFC.hpp.


Constructor & Destructor Documentation

OW_NAMESPACE::CppIndicationProviderIFC::~CppIndicationProviderIFC  )  [virtual]
 

Definition at line 42 of file OW_CppIndicationProviderIFC.cpp.


Member Function Documentation

void OW_NAMESPACE::CppIndicationProviderIFC::activateFilter const ProviderEnvironmentIFCRef env,
const WQLSelectStatement filter,
const String eventType,
const String nameSpace,
const StringArray classes,
bool  firstActivation
[virtual]
 

Reimplemented in OW_NAMESPACE::provindIndicationRepLayer, and OW_NAMESPACE::OpenWBEM_ObjectManagerInstProv.

Definition at line 82 of file OW_CppIndicationProviderIFC.cpp.

void OW_NAMESPACE::CppIndicationProviderIFC::authorizeFilter const ProviderEnvironmentIFCRef env,
const WQLSelectStatement filter,
const String eventType,
const String nameSpace,
const StringArray classes,
const String owner
[virtual]
 

Definition at line 56 of file OW_CppIndicationProviderIFC.cpp.

void OW_NAMESPACE::CppIndicationProviderIFC::deActivateFilter const ProviderEnvironmentIFCRef env,
const WQLSelectStatement filter,
const String eventType,
const String nameSpace,
const StringArray classes,
bool  lastActivation
[virtual]
 

Reimplemented in OW_NAMESPACE::provindIndicationRepLayer, and OW_NAMESPACE::OpenWBEM_ObjectManagerInstProv.

Definition at line 93 of file OW_CppIndicationProviderIFC.cpp.

CppIndicationProviderIFC * OW_NAMESPACE::CppIndicationProviderIFC::getIndicationProvider  )  [virtual]
 

Reimplemented from OW_NAMESPACE::CppProviderBaseIFC.

Definition at line 104 of file OW_CppIndicationProviderIFC.cpp.

void OW_NAMESPACE::CppIndicationProviderIFC::getIndicationProviderInfo IndicationProviderInfo info  )  [virtual]
 

A provider should override this method to report which classes in which namespaces it instruments.

It should insert an entry for each class it is responsible for. It should also insert one entry for each base class of the classes of indications the provider may generate. Note that this base class requirement is unique to indication providers and doesn't apply to other types of providers. The entry consists of the class name and an optional list of namespaces. If the namespace list is empty, all namespaces are implied. If the method does nothing, then the provider's class must have a provider qualifier that identifies the provider. This old behavior is deprecated and will be removed sometime in the future. This method has a default implementation that does nothing, to allow old providers to be migrated forward with little or no change, but once the old provider location method is removed, this member function will be pure virtual.

Reimplemented in OW_NAMESPACE::provindIndicationRepLayer, and OW_NAMESPACE::OpenWBEM_ObjectManagerInstProv.

Definition at line 77 of file OW_CppIndicationProviderIFC.cpp.

Referenced by getIndicationProviderInfoWithEnv().

void OW_NAMESPACE::CppIndicationProviderIFC::getIndicationProviderInfoWithEnv const ProviderRegistrationEnvironmentIFCRef env,
IndicationProviderInfo info
[virtual]
 

A provider should override this method to report which classes in which namespaces it instruments.

It should insert an entry for each class it is responsible for. It should also insert one entry for each base class of the classes of indications the provider may generate. Note that this base class requirement is unique to indication providers and doesn't apply to other types of providers. The entry consists of the class name and an optional list of namespaces. If the namespace list is empty, all namespaces are implied. If the method does nothing, then the provider's class must have a provider qualifier that identifies the provider. This old behavior is deprecated and will be removed sometime in the future. This method has a default implementation that does nothing, to allow old providers to be migrated forward with little or no change, but once the old provider location method is removed, this member function will be pure virtual.

Definition at line 68 of file OW_CppIndicationProviderIFC.cpp.

References getIndicationProviderInfo().

int OW_NAMESPACE::CppIndicationProviderIFC::mustPoll const ProviderEnvironmentIFCRef env,
const WQLSelectStatement filter,
const String eventType,
const String nameSpace,
const StringArray classes
[virtual]
 

If a provider wishes to be polled, it must return a positive number.

The int returned will be the number of seconds between polls. The cimom performs polling by calling enumInstances() each polling cycle and comparing the results with the previous cycle. It will generate CIM_Inst{Creation,Modification,Deletion} indications based on the difference in the instances. The namespace/classname that will be passed into enumInstances is the same one that is passed as the classPath parameter to mustPoll(). If an event provider does not want to be polled, it should return 0. If the provider is going to start a thread that will wait for some external event, it should do it the first time activateFilter is called firstActivation will == true. If a provider may take a long time to generate all instances in enumInstances, it should either not be polled or it should have a large poll interval. Also, a provider that is polled can only do lifecycle indications. If the provider doesn't do lifecycle indications, then it must return 0 from mustPoll, and has to generate indications by another means.

Parameters:
env 

Definition at line 45 of file OW_CppIndicationProviderIFC.cpp.


The documentation for this class was generated from the following files:
Generated on Thu Feb 9 09:15:47 2006 for openwbem by  doxygen 1.4.6