Package flumotion :: Package admin :: Package command :: Module component :: Class Invoke
[hide private]

Class Invoke

source code

                    object --+            
                             |            
extern.command.command.Command --+        
                                 |        
       extern.log.log.Loggable --+        
                                 |        
    monitor.nagios.util.LogCommand --+    
                                     |    
                   common.AdminCommand --+
                                         |
                                        Invoke

Instance Methods [hide private]
 
addOptions(self)
Override me to add options to the parser.
source code
 
handleOptions(self, options)
Handle the parsed options.
source code
 
doCallback(self, args)
Subclasses should implement this as an alternative to the normal do method.
source code

Inherited from common.AdminCommand: connectToManager, do

Inherited from monitor.nagios.util.LogCommand: __init__, debug

Inherited from extern.command.command.Command: getFullName, getRootCommand, outputHelp, outputUsage, parse

Inherited from extern.command.command.Command (private): _getStdout

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

Inherited from extern.log.log.Loggable: __providedBy__, __provides__, doLog, error, info, log, logFunction, logObjectName, warning, warningFailure, writeMarker

Class Variables [hide private]
  usage = '[method-name] [arguments]'
short one-line usage string; %command gets expanded to a sub-command or [commands] as appropriate.
  summary = 'invoke a method on a component'
short one-line summary of the command
  description = 'Invoke a method on a component.\n\nArguments to...
longer paragraph explaining the command

Inherited from extern.command.command.Command: aliasedSubCommands, aliases, name, parentCommand, parser, subCommandClasses, subCommands

Inherited from extern.log.log.Loggable: __implemented__, logCategory

Properties [hide private]

Inherited from extern.command.command.Command: stderr, stdout

Inherited from object: __class__

Method Details [hide private]

addOptions(self)

source code 

Override me to add options to the parser.

Overrides: extern.command.command.Command.addOptions
(inherited documentation)

handleOptions(self, options)

source code 

Handle the parsed options.

Overrides: extern.command.command.Command.handleOptions
(inherited documentation)

doCallback(self, args)

source code 

Subclasses should implement this as an alternative to the normal do method. It will be called after a connection to the manager is made.

Don't forget to return a deferred you create to properly chain execution.

Overrides: common.AdminCommand.doCallback
(inherited documentation)

Class Variable Details [hide private]

description

longer paragraph explaining the command
Value:
'''Invoke a method on a component.

Arguments to the method are passed using an argument list string, and \
the
arguments (matching the argument list string).

Example: "method ss one two" would invoke remote_method("one", "two")

...