<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>flumotion.admin.command.common.AdminCommand</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package flumotion ::
<a href="flumotion.admin-module.html">Package admin</a> ::
<a href="flumotion.admin.command-module.html">Package command</a> ::
<a href="flumotion.admin.command.common-module.html">Module common</a> ::
Class AdminCommand
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class AdminCommand</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.admin.command.common-pysrc.html#AdminCommand">source code</a></span></p>
<pre class="base-tree">
<a href="flumotion.extern.command.command.Command-class.html">extern.command.command.Command</a> --+
|
<a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a> --+
|
monitor.nagios.util.LogCommand --+
|
<strong class="uidshort">AdminCommand</strong>
</pre>
<dl><dt>Known Subclasses:</dt>
<dd>
<ul class="subclass-list">
<li><a href="flumotion.admin.command.manager.Invoke-class.html">manager.Invoke</a></li><li>, <a href="flumotion.admin.command.manager.Load-class.html">manager.Load</a></li><li>, <a href="flumotion.admin.command.component.Delete-class.html">component.Delete</a></li><li>, <a href="flumotion.admin.command.component.Invoke-class.html">component.Invoke</a></li><li>, <a href="flumotion.admin.command.component.List-class.html">component.List</a></li><li>, <a href="flumotion.admin.command.component.Mood-class.html">component.Mood</a></li><li>, <a href="flumotion.admin.command.component.PropertyGet-class.html">component.PropertyGet</a></li><li>, <a href="flumotion.admin.command.component.PropertyList-class.html">component.PropertyList</a></li><li>, <a href="flumotion.admin.command.component.Start-class.html">component.Start</a></li><li>, <a href="flumotion.admin.command.component.Stop-class.html">component.Stop</a></li><li>, <a href="flumotion.admin.command.worker.Invoke-class.html">worker.Invoke</a></li><li>, <a href="flumotion.admin.command.worker.List-class.html">worker.List</a></li><li>, <a href="flumotion.admin.command.worker.Run-class.html">worker.Run</a></li> </ul>
</dd></dl>
<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.admin.command.common.AdminCommand-class.html#do" class="summary-sig-name">do</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">args</span>)</span><br />
Override me to implement the functionality of the command.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.admin.command.common-pysrc.html#AdminCommand.do">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_callback"></a><span class="summary-sig-name">_callback</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">result</span>,
<span class="summary-sig-arg">args</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.admin.command.common-pysrc.html#AdminCommand._callback">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.admin.command.common.AdminCommand-class.html#doCallback" class="summary-sig-name">doCallback</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">args</span>)</span><br />
Subclasses should implement this as an alternative to the normal do
method.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.admin.command.common-pysrc.html#AdminCommand.doCallback">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code class="link">defer.Deferred</code> firing <a
href="flumotion.admin.admin.AdminModel-class.html"
class="link">flumotion.admin.admin.AdminModel</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.admin.command.common.AdminCommand-class.html#connectToManager" class="summary-sig-name">connectToManager</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">connection</span>)</span><br />
Connect to a manager.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.admin.command.common-pysrc.html#AdminCommand.connectToManager">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_connectToManagerCb"></a><span class="summary-sig-name">_connectToManagerCb</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">result</span>,
<span class="summary-sig-arg">adminMedium</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.admin.command.common-pysrc.html#AdminCommand._connectToManagerCb">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_connectToManagerEb"></a><span class="summary-sig-name">_connectToManagerEb</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">failure</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.admin.command.common-pysrc.html#AdminCommand._connectToManagerEb">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>monitor.nagios.util.LogCommand</code></b>:
<code>__init__</code>,
<code>debug</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.extern.command.command.Command-class.html">extern.command.command.Command</a></code></b>:
<code><a href="flumotion.extern.command.command.Command-class.html#addOptions">addOptions</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#getRootCommand">getRootCommand</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#handleOptions">handleOptions</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#outputHelp">outputHelp</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#outputUsage">outputUsage</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#parse">parse</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a></code></b>:
<code><a href="flumotion.extern.log.log.Loggable-class.html#doLog">doLog</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#error">error</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#info">info</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#log">log</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#logFunction">logFunction</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#logObjectName">logObjectName</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#warning">warning</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#warningFailure">warningFailure</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#writeMarker">writeMarker</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.extern.command.command.Command-class.html">extern.command.command.Command</a></code></b>:
<code><a href="flumotion.extern.command.command.Command-class.html#aliasedSubCommands">aliasedSubCommands</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#aliases">aliases</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#description">description</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#name">name</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#parentCommand">parentCommand</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#parser">parser</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#subCommandClasses">subCommandClasses</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#subCommands">subCommands</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#summary">summary</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#usage">usage</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a></code></b>:
<code><a href="flumotion.extern.log.log.Loggable-class.html#logCategory">logCategory</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="do"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">do</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">args</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.admin.command.common-pysrc.html#AdminCommand.do">source code</a></span>
</td>
</tr></table>
<p>Override me to implement the functionality of the command.</p>
<dl class="fields">
<dt>Overrides:
<a href="flumotion.extern.command.command.Command-class.html#do">extern.command.command.Command.do</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="doCallback"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">doCallback</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">args</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.admin.command.common-pysrc.html#AdminCommand.doCallback">source code</a></span>
</td>
</tr></table>
<p>Subclasses should implement this as an alternative to the normal do
method. It will be called after a connection to the manager is made.</p>
<p>Don't forget to return a deferred you create to properly chain
execution.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="connectToManager"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">connectToManager</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">connection</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.admin.command.common-pysrc.html#AdminCommand.connectToManager">source code</a></span>
</td>
</tr></table>
<p>Connect to a manager.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>connection</code></strong> (<a href="flumotion.common.connection.PBConnectionInfo-class.html"
class="link">flumotion.common.connection.PBConnectionInfo</a>)</li>
</ul></dd>
<dt>Returns: <code class="link">defer.Deferred</code> firing <a
href="flumotion.admin.admin.AdminModel-class.html"
class="link">flumotion.admin.admin.AdminModel</a></dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sun Sep 13 13:13:58 2009
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
contrib-release
>
by-pkgid
>
2eca861f24be6048290ed27335ec22aa
>
files
>
52
