module.descriptor.BoswatchModule Class Reference

Adds descriptions to bwPackets. More...

Public Member Functions
	__init__ (self, config)
	Do not change anything here!
	onLoad (self)
	Called by import of the plugin.
	doWork (self, bwPacket)
	start an run of the module.
	onUnload (self)
	Called by destruction of the plugin.

Additional Inherited Members
Static Public Member Functions inherited from module.moduleBase.ModuleBase
	registerWildcard (newWildcard, bwPacketField)
	Register a new wildcard.
Data Fields inherited from module.moduleBase.ModuleBase
	config
Protected Member Functions inherited from module.moduleBase.ModuleBase
	_cleanup (self)
	Cleanup routine calls onUnload() directly.
	_run (self, bwPacket)
	start an run of the module.
	_getStatistics (self)
	Returns statistical information's from last module run.
Protected Attributes inherited from module.moduleBase.ModuleBase
	_moduleName
	_cumTime
	_moduleTime
	_runCount
	_moduleErrorCount
Static Protected Attributes inherited from module.moduleBase.ModuleBase
list	_modulesActive = []

Detailed Description

Adds descriptions to bwPackets.

Constructor & Destructor Documentation

__init__()

module.descriptor.BoswatchModule.__init__	(		self,
			config
	)

Do not change anything here!

Reimplemented from module.moduleBase.ModuleBase.

    def __init__(self, config):
        r"""!Do not change anything here!"""
        super().__init__(__name__, config)  # you can access the config class on 'self.config'
 

Member Function Documentation

onLoad()

module.descriptor.BoswatchModule.onLoad

(

self

)

Called by import of the plugin.

Reimplemented from module.moduleBase.ModuleBase.

    def onLoad(self):
        r"""!Called by import of the plugin"""
        for descriptor in self.config:
            if descriptor.get("wildcard", default=None):
                self.registerWildcard(descriptor.get("wildcard"), descriptor.get("descrField"))
 

doWork()

module.descriptor.BoswatchModule.doWork	(		self,
			bwPacket
	)

start an run of the module.

Parameters

bwPacket

A BOSWatch packet instance

Reimplemented from module.moduleBase.ModuleBase.

    def doWork(self, bwPacket):
        r"""!start an run of the module.
 
        @param bwPacket: A BOSWatch packet instance"""
        for descriptor in self.config:
            if not bwPacket.get(descriptor.get("scanField")):
                break  # scanField is not available in this packet
            bwPacket.set(descriptor.get("descrField"), bwPacket.get(descriptor.get("scanField")))
            for description in descriptor.get("descriptions"):
                if str(description.get("for")) == bwPacket.get(descriptor.get("scanField")):
                    logging.debug("Description '%s' added in packet field '%s'",
                                  description.get("add"), descriptor.get("descrField"))
                    bwPacket.set(descriptor.get("descrField"), description.get("add"))
                    break  # this descriptor has found a description - run next descriptor
        return bwPacket
 

onUnload()

module.descriptor.BoswatchModule.onUnload

(

self

)

Called by destruction of the plugin.

Reimplemented from module.moduleBase.ModuleBase.

    def onUnload(self):
        r"""!Called by destruction of the plugin"""
        pass