libnmap.plugins.backendplugin.NmapBackendPlugin

class documentation

class NmapBackendPlugin(object): (source)

Known subclasses: libnmap.plugins.es.NmapElasticsearchPlugin, libnmap.plugins.mongodb.NmapMongodbPlugin, libnmap.plugins.s3.NmapS3Plugin, libnmap.plugins.sql.NmapSqlPlugin

View In Hierarchy

Abstract class showing to the minimal implementation for a plugin All subclass MUST at least implement the following methods

Method __init__ Undocumented
Method delete delete NmapReport if the backend :param id: str
Method get retrieve a NmapReport from the backend :param id: str :return: NmapReport
Method getall :return: collection of tuple (id,NmapReport) :param filter: Nice to have implement a filter capability
Method insert insert NmapReport in the backend :param NmapReport: :return: str the ident of the object in the backend for future usage or None
Instance Variable dbname Undocumented
Instance Variable store Undocumented
def __init__(self): (source)
overridden in libnmap.plugins.es.NmapElasticsearchPlugin, libnmap.plugins.mongodb.NmapMongodbPlugin, libnmap.plugins.s3.NmapS3Plugin, libnmap.plugins.sql.NmapSqlPlugin

Undocumented

def delete(self, id): (source)
overridden in libnmap.plugins.es.NmapElasticsearchPlugin, libnmap.plugins.mongodb.NmapMongodbPlugin, libnmap.plugins.s3.NmapS3Plugin, libnmap.plugins.sql.NmapSqlPlugin

delete NmapReport if the backend :param id: str

def get(self, id): (source)
overridden in libnmap.plugins.es.NmapElasticsearchPlugin, libnmap.plugins.mongodb.NmapMongodbPlugin, libnmap.plugins.s3.NmapS3Plugin, libnmap.plugins.sql.NmapSqlPlugin

retrieve a NmapReport from the backend :param id: str :return: NmapReport

def getall(self, filter): (source)
overridden in libnmap.plugins.es.NmapElasticsearchPlugin, libnmap.plugins.mongodb.NmapMongodbPlugin, libnmap.plugins.s3.NmapS3Plugin, libnmap.plugins.sql.NmapSqlPlugin

:return: collection of tuple (id,NmapReport) :param filter: Nice to have implement a filter capability

def insert(self, NmapReport): (source)
overridden in libnmap.plugins.es.NmapElasticsearchPlugin, libnmap.plugins.mongodb.NmapMongodbPlugin, libnmap.plugins.s3.NmapS3Plugin, libnmap.plugins.sql.NmapSqlPlugin

insert NmapReport in the backend :param NmapReport: :return: str the ident of the object in the backend for future usage or None

dbname: str = (source)
overridden in libnmap.plugins.mongodb.NmapMongodbPlugin

Undocumented

store: str = (source)
overridden in libnmap.plugins.mongodb.NmapMongodbPlugin

Undocumented