Home       Trees       Indices       Help   
w3af homepage
Package core :: Package controllers :: Package basePlugin :: Module baseOutputPlugin :: Class baseOutputPlugin
[hide private]
[frames] | no frames]

Class baseOutputPlugin



This is the base class for data output, all output plugins should inherit from it and implement the following methods :
  1. debug( message, verbose )
  2. information( message, verbose )
  3. error( message, verbose )
  4. vulnerability( message, verbose )


Author: Andres Riancho ( andres.riancho@gmail.com )

Instance Methods [hide private]
  __init__(self)
  console(self, message)
This method is called from the output managerobject.
  debug(self, message)
This method is called from the output managerobject.
  end(self)
This method is called when the plugin aint going to be used anymore.
  error(self, message, verbose)
This method is called from the output managerobject.
  getMessageCache(self)
Ouput plugins with caches should implement this method.
  getOptionsXML(self)
This method returns a XML containing the Options that the plugin has.
  getPluginDeps(self)
  getType(self)
  information(self, message, verbose)
This method is called from the output managerobject.
  logHttp(self, request, response)
This method is called from the output managerobject.
  setOptions(self, OptionList)
Sets the Options given on the OptionList to self.
  vulnerability(self, message)
This method is called from the output managerobject.

Inherited from basePlugin.basePlugin: __eq__, getDesc, getLongDesc, getName, printUniq, setUrlOpener

Inherited from basePlugin.basePlugin (private): _sendMutant


Method Details [hide private]

__init__(self)
(Constructor)

 
None
Overrides: basePlugin.basePlugin.__init__

console(self, message)

 
This method is called from the output managerobject. The OM object was called from a plugin or from the framework. This method should take an action for vulnerability messages.
Returns:
No value is returned.

debug(self, message)

 
This method is called from the output managerobject. The OM object was called from a plugin or from the framework. This method should take an action for debug messages.
Returns:
No value is returned.

end(self)

 
This method is called when the plugin aint going to be used anymore.

error(self, message, verbose)

 
This method is called from the output managerobject. The OM object was called from a plugin or from the framework. This method should take an action for error messages.
Returns:
No value is returned.

getMessageCache(self)

 
Ouput plugins with caches should implement this method. Used in the webUI.

getOptionsXML(self)

 

This method returns a XML containing the Options that the plugin has. Using this XML the framework will build a window, a menu, or some other input method to retrieve the info from the user. The XML has to validate against the xml schema file located at : w3af/core/display.xsd

This method MUST be implemented on every plugin.
Returns:
XML String
Overrides: basePlugin.basePlugin.getOptionsXML

See Also: core/display.xsd

getPluginDeps(self)

 
Returns:
A list with the names of the plugins that should be runned before the current one.
Overrides: basePlugin.basePlugin.getPluginDeps

getType(self)

 
None
Overrides: basePlugin.basePlugin.getType

information(self, message, verbose)

 
This method is called from the output managerobject. The OM object was called from a plugin or from the framework. This method should take an action for information messages.
Returns:
No value is returned.

logHttp(self, request, response)

 
This method is called from the output managerobject. The OM object was called from a plugin or from the framework. This method should take an action to log HTTP requests and responses.
Returns:
No value is returned.

setOptions(self, OptionList)

 

Sets the Options given on the OptionList to self. The options are the result of a user entering some data on a window that was constructed using the XML Options that was retrieved from the plugin using getOptionsXML()

This method MUST be implemented on every plugin.
Returns:
No value is returned.
Overrides: basePlugin.basePlugin.setOptions

vulnerability(self, message)

 
This method is called from the output managerobject. The OM object was called from a plugin or from the framework. This method should take an action for vulnerability messages.
Returns:
No value is returned.

   Home       Trees       Indices       Help   
w3af homepage
Generated by Epydoc 3.0alpha3 on Thu Oct 18 19:36:42 2007 http://epydoc.sourceforge.net