Package archipelcore :: Module archipelPlugin :: Class TNArchipelPlugin
[hide private]
[frames] | no frames]

Class TNArchipelPlugin

source code

Known Subclasses:

Instance Methods [hide private]
 
__init__(self, configuration=None, entity=None, entry_point_group=None)
Initialize the plugin.
source code
 
register_handlers(self)
This method will be called to when entiyt will register handlers for stanzas.
source code
 
unregister_handlers(self)
Unregister the handlers.
source code
Class Methods [hide private]
 
plugin_info(self, group)
Return plugin information.
source code
Method Details [hide private]

__init__(self, configuration=None, entity=None, entry_point_group=None)
(Constructor)

source code 

Initialize the plugin.

Parameters:
  • configuration (Configuration object) - the configuration
  • entity (TNArchipelEntity) - the entity that owns the plugin
  • entry_point_group (string) - the group name of plugin entry_point

register_handlers(self)

source code 

This method will be called to when entiyt will register handlers for stanzas. Place plugin handlers registration here.

unregister_handlers(self)

source code 

Unregister the handlers. This method must be implemented if register_handlers is implemented.

plugin_info(self, group)
Class Method

source code 

Return plugin information. it must return a dict like:
plugin_friendly_name           = "User friendly name of plugin"
plugin_identifier              = "plugin_identifier"
plugin_configuration_section   = "required [SECTION] in configuration"
plugin_configuration_tokens    = [  "required_token_section1",
                                    "required_token_section2"]
return {    "common-name"               : plugin_friendly_name,
            "identifier"                : plugin_identifier,
            "configuration-section"     : plugin_configuration_section,
            "configuration-tokens"      : plugin_configuration_tokens }
@raise Exception: Exception if not implemented