diff options
Diffstat (limited to 'src/python/openlmi/common/IndicationManager.py')
| -rw-r--r-- | src/python/openlmi/common/IndicationManager.py | 31 |
1 files changed, 18 insertions, 13 deletions
diff --git a/src/python/openlmi/common/IndicationManager.py b/src/python/openlmi/common/IndicationManager.py index fe01b70..dbe25f3 100644 --- a/src/python/openlmi/common/IndicationManager.py +++ b/src/python/openlmi/common/IndicationManager.py @@ -46,7 +46,7 @@ def enumerate_namespaces(ch): first item is a list of object paths of all namespaces in broker and the second is a name of namespace, where this information can be found. - :param ch CIMOM handle. + :param ch: CIMOM handle. """ nsclasses = ["CIM_Namespace", "__Namespace"] namespaces = ['root/cimv2', 'root/PG_InterOp', 'Interop', @@ -83,7 +83,7 @@ def find_ns_interop(ch): Return name of interop namespace, where ``CIM_IndicationFilter`` class reside. - :param ch CIMOM handle. + :param ch: CIMOM handle. """ _, ns_interop = enumerate_namespaces(ch) return ns_interop @@ -98,7 +98,7 @@ def parse_filter_name(name): """ Return tuple ``(class_name, filter_id)``. - :param name (``string``) Value of cim filter's *Name* property. + :param name: (``string``) Value of cim filter's *Name* property. """ match = RE_FILTER_NAME.match(name) if not match: @@ -110,7 +110,9 @@ def make_indication_filter_path(class_name, fltr_id, ns_interop): """ Return CIM_IndicationFilter instance path for given filter id. - :param fltr_id (``string``) Filter name. + :param class_name: (``string``) *Scoped class* name. + :param fltr_id: (``string``) Filter name. + :param ns_interop: (``string``) Interop namespace. """ for arg in ('class_name', 'fltr_id', 'ns_interop'): if not isinstance(locals()[arg], basestring): @@ -131,7 +133,8 @@ def remove_cimom_filter(ch, fltr_path): Returns list of subscription instace names, that were deleted. - :param fltr_path (``CIMInstanceName``) Path of ``CIM_IndicationFilter`` to + :param ch: CIMOM handle. + :param fltr_path: (``CIMInstanceName``) Path of ``CIM_IndicationFilter`` to remove. """ if not isinstance(fltr_path, pywbem.CIMInstanceName): @@ -354,8 +357,8 @@ class IndicationManager(singletonmixin.Singleton): """ Return instance of CIM_IndicationFilter registered in CIMOM if any. - :param class_name (``string``) *Scoping class* name. - :param fltr_id (``string``) Indication name. + :param class_name: (``string``) *Scoping class* name. + :param fltr_id: (``string``) Indication name. """ ch = self._env.get_cimom_handle() cop = make_indication_filter_path(class_name, fltr_id, self.ns_interop) @@ -372,8 +375,8 @@ class IndicationManager(singletonmixin.Singleton): Ensures, that cimom has ``fltr_id`` filter registered as instance. If it has, but the query differs it is recreated at broker. - :param class_name (``string``) *Scoping class* name. - :param fltr_id (``string``) Indication name. + :param class_name: (``string``) *Scoping class* name. + :param fltr_id: (``string``) Indication name. """ inst = self._get_filter_inst(class_name, fltr_id) ch = self._env.get_cimom_handle() @@ -421,7 +424,7 @@ class IndicationManager(singletonmixin.Singleton): Return a tuple ``(class_name, filter_id, filter_properties)``. - :param query (``string``) Is filter query. + :param query: (``string``) Is filter query. """ if not isinstance(query, basestring): raise TypeError("query must be a string") @@ -438,9 +441,9 @@ class IndicationManager(singletonmixin.Singleton): must be registered with this instance before the check can be done. Without arguments all registered filters will be checked. - :param class_name (``string``) Name of *Scoped class* that reduces + :param class_name: (``string``) Name of *Scoped class* that reduces searched filters. - :param fltr_id (``string``) Indication name reducing filters that + :param fltr_id: (``string``) Indication name reducing filters that will be checked. """ cls_to_check = self._filters.keys() @@ -494,7 +497,7 @@ class IndicationManager(singletonmixin.Singleton): ``property_name -> value``, where at least ``Query`` property must be set. ``Name`` property will be automatically created as 'LMI:<class_name>:<filter_id>'. - :param ensure_installed (``bool``) Whether to check for filter presence + :param ensure_installed: (``bool``) Whether to check for filter presence at broker and install them if missing. **Note** That in order for this to work, the context must be updated with user's credentials. See :ref:`update_context-label`. @@ -643,6 +646,7 @@ class IndicationManager(singletonmixin.Singleton): """ Return True, if there is someone subscribed for given filter. + :param class_name: (``string``) *Scoping class* name. :param fltr_id: (``string``) ID of the filter to check. """ with self._access_lock: @@ -657,6 +661,7 @@ class IndicationManager(singletonmixin.Singleton): """ Return True, if filter id has been registered with current instance. + :param class_name: (``string``) *Scoping class* name. :param fltr_id: (``string``) ID of the filter to check. """ with self._access_lock: |