libnmap.plugins.mongodb.NmapMongodbPlugin

class documentation

class NmapMongodbPlugin(NmapBackendPlugin): (source)

View In Hierarchy

This class handle the persistence of NmapRepport object in mongodb Implementation is made using pymongo Object of this class must be create via the BackendPluginFactory.create(**url) where url is a named dict like {'plugin_name': "mongodb"} this dict may receive all the param MongoClient() support

Method __init__ Undocumented
Method delete delete an obj from the backend :param str: id :return: dict document with result or None
Method get select a NmapReport by Id :param str: id :return: NmapReport object
Method getall return a list of tuple (id,NmapReport) saved in the backend TODO : add a filter capability
Method insert create a json object from an NmapReport instance :param NmapReport: obj to insert :return: str id
Instance Variable collection Undocumented
Instance Variable dbclient Undocumented
Instance Variable dbname Undocumented
Instance Variable store Undocumented
def __init__(self, dbname=None, store=None, **kwargs): (source)
overrides libnmap.plugins.backendplugin.NmapBackendPlugin.__init__

Undocumented

def delete(self, report_id=None): (source)
overrides libnmap.plugins.backendplugin.NmapBackendPlugin.delete

delete an obj from the backend :param str: id :return: dict document with result or None

def get(self, str_report_id=None): (source)
overrides libnmap.plugins.backendplugin.NmapBackendPlugin.get

select a NmapReport by Id :param str: id :return: NmapReport object

def getall(self, dict_filter=None): (source)
overrides libnmap.plugins.backendplugin.NmapBackendPlugin.getall

return a list of tuple (id,NmapReport) saved in the backend TODO : add a filter capability

def insert(self, report): (source)
overrides libnmap.plugins.backendplugin.NmapBackendPlugin.insert

create a json object from an NmapReport instance :param NmapReport: obj to insert :return: str id

collection = (source)

Undocumented

dbclient = (source)

Undocumented

dbname = (source)
overrides libnmap.plugins.backendplugin.NmapBackendPlugin.dbname

Undocumented

store = (source)
overrides libnmap.plugins.backendplugin.NmapBackendPlugin.store

Undocumented