Module PluginManager :: Class PluginManager
[hide private]
[frames] | no frames]

Class PluginManager

source code

object --+
         |
        PluginManager

Class used by Storage Connect Plugin consumers to discover and use the installed plugins.

Instance Methods [hide private]
 
__init__(self, plugin_logger=None)
Constructor for the Storage Connect Plugin Manager.
source code
list
discoverPlugins(self, plugin_types=['isa', 'ifs'], ignore_failed=False)
Discover all installed Storage Connect plugins on the system.
source code
Plugin
getPluginManagerClass(self, plugin_name, auto_import=True)
Get the Plugin Manager class for the named plugin.
source code
IPlugin class
getPlugin(self, plugin_name)
Get the Plugin class for the named plugin.
source code
list
getPluginNames(self)
Get the list of known plugin names.
source code
list
getPluginPath(self, plugin_name)
Get the install path for a specific plugin.
source code
str
getPluginModule(self, plugin_name)
Get the plugin's module name.
source code
list
importPlugin(self, plugin_name)
Import the plugin.
source code
bool
isPluginImported(self, plugin_name)
Get a list of names for all the imported plugins.
source code
list
getImportedPluginNames(self)
Get a list of names for all the imported plugins.
source code
dict
getPluginInfo(self, plugin_name)
Get the information for the specified plugin.
source code
PluginProxy
getPluginProxy(self, plugin_name)
Get a proxy class for the plugin.
source code
 
setLogger(self, plugin_logger)
Change the logger the plugin should use.
source code
iter
__iter__(self)
Get an iterator object.
source code
iter
next(self)
Get the next iterator value.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, plugin_logger=None)
(Constructor)

source code 

Constructor for the Storage Connect Plugin Manager.

Overrides: object.__init__

discoverPlugins(self, plugin_types=['isa', 'ifs'], ignore_failed=False)

source code 

Discover all installed Storage Connect plugins on the system.

Parameters:
Returns: list
list of newly discovered Storage Connect Plugins.

getPluginManagerClass(self, plugin_name, auto_import=True)

source code 

Get the Plugin Manager class for the named plugin.

Returns: Plugin
Plugin Manager class for the named Storage Connect plugin.

getPlugin(self, plugin_name)

source code 

Get the Plugin class for the named plugin.

Returns: IPlugin class
Plugin class for the named Storage Connect plugin.

getPluginNames(self)

source code 

Get the list of known plugin names.

Returns: list
list of known Storage Connect plugin names.

getPluginPath(self, plugin_name)

source code 

Get the install path for a specific plugin.

Parameters:
  • plugin_name (str) - Name of the specific plugin.
Returns: list
list of newly discovered Storage Connect Plugins.

getPluginModule(self, plugin_name)

source code 

Get the plugin's module name.

Parameters:
  • plugin_name (str) - Name of the specific plugin.
Returns: str
module of the Storage Connect Plugin.

importPlugin(self, plugin_name)

source code 

Import the plugin.

Parameters:
  • plugin_name (str) - Name of the plugin that should be imported.
Returns: list
Class object for the plugin.

isPluginImported(self, plugin_name)

source code 

Get a list of names for all the imported plugins.

Parameters:
  • plugin_name (str) - Name of the plugin to check.
Returns: bool
True if the plugin is found and imported.

getImportedPluginNames(self)

source code 

Get a list of names for all the imported plugins.

Returns: list
list of names of all the imported plugins.

getPluginInfo(self, plugin_name)

source code 

Get the information for the specified plugin.

Returns: dict
information on and about the Storage Connect plug-in.

getPluginProxy(self, plugin_name)

source code 

Get a proxy class for the plugin.

Parameters:
  • plugin_name (str) - Name of the plugin to obtain a proxy for.
Returns: PluginProxy
The Plugin Proxy class for the plugin.

setLogger(self, plugin_logger)

source code 

Change the logger the plugin should use.

Parameters:
  • plugin_logger (logger) - Set the Logger to use by the plugin

__iter__(self)

source code 

Get an iterator object.

Returns: iter
Iterator object.

next(self)

source code 

Get the next iterator value.

Returns: iter
Next iterator object.