← Back to branch summary

~ubuntu-branches/ubuntu/lucid/cedar-backup2/lucid

« back to all changes in this revision

Viewing changes to doc/interface/CedarBackup2.extend.encrypt.LocalConfig-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Kenneth J. Pronovici
  • Date: 2009-03-29 15:00:28 UTC
  • mfrom: (1.1.10 upstream) (4.1.4 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090329150028-ljhfp6mxplcbmx4i
Tags: 2.19.3-1
* New upstream release.
* Remove references to user manual PDF (no longer shipped).
* Update debian/copyright based on new upstream CREDITS.
* Bump standards version to 3.8.1 (no packaging changes).
* Bump debhelper compatibility to 7, per linitian recommendation.
* Declare a dependency on debhelper (>= 7.0.1) to match compatibility.
* Reference /usr/share/common-licenses/GPL-2 rather than just GPL.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/interface/CedarBackup2.extend.encrypt.LocalConfig-class.html
62
62
  </tr>
63
63
</table>
64
64
<!-- ==================== CLASS DESCRIPTION ==================== -->
65
 
<h1 class="epydoc">Class LocalConfig</h1><span class="codelink"><a href="CedarBackup2.extend.encrypt-pysrc.html#LocalConfig">source&nbsp;code</a></span><br /><br />
 
65
<h1 class="epydoc">Class LocalConfig</h1><p class="nomargin-top"><span class="codelink"><a href="CedarBackup2.extend.encrypt-pysrc.html#LocalConfig">source&nbsp;code</a></span></p>
66
66
<pre class="base-tree">
67
67
object --+
68
68
         |
71
71
 
72
72
<hr />
73
73
<p>Class representing this extension's configuration document.</p>
74
 
  This is not a general-purpose configuration object like the main Cedar
 
74
  <p>This is not a general-purpose configuration object like the main Cedar
75
75
  Backup configuration object.  Instead, it just knows how to parse and 
76
76
  emit encrypt-specific configuration values.  Third parties who need to 
77
77
  read and write configuration related to this extension should access it 
78
78
  through the constructor, <code>validate</code> and <code>addConfig</code>
79
 
  methods.<br /><br />
 
79
  methods.</p>
80
80
 
81
81
<hr />
82
82
<div class="fields">      <p><strong>Note:</strong>
198
198
          <td><span class="summary-sig"><a href="CedarBackup2.extend.encrypt.LocalConfig-class.html#addConfig" class="summary-sig-name">addConfig</a>(<span class="summary-sig-arg">self</span>,
199
199
        <span class="summary-sig-arg">xmlDom</span>,
200
200
        <span class="summary-sig-arg">parentNode</span>)</span><br />
201
 
      Adds an &lt;encrypt&gt; configuration section as the next child of
202
 
      a parent.</td>
 
201
      Adds an &lt;encrypt&gt; configuration section as the next child of a 
 
202
      parent.</td>
203
203
          <td align="right" valign="top">
204
204
            <span class="codelink"><a href="CedarBackup2.extend.encrypt-pysrc.html#LocalConfig.addConfig">source&nbsp;code</a></span>
205
205
            
215
215
    </td><td class="summary">
216
216
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
217
217
        <tr>
218
 
          <td><span class="summary-sig"><a href="CedarBackup2.extend.encrypt.LocalConfig-class.html#_setEncrypt" class="summary-sig-name">_setEncrypt</a>(<span class="summary-sig-arg">self</span>,
 
218
          <td><span class="summary-sig"><a href="CedarBackup2.extend.encrypt.LocalConfig-class.html#_setEncrypt" class="summary-sig-name" onclick="show_private();">_setEncrypt</a>(<span class="summary-sig-arg">self</span>,
219
219
        <span class="summary-sig-arg">value</span>)</span><br />
220
220
      Property target used to set the encrypt configuration value.</td>
221
221
          <td align="right" valign="top">
250
250
    </td><td class="summary">
251
251
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
252
252
        <tr>
253
 
          <td><span class="summary-sig"><a href="CedarBackup2.extend.encrypt.LocalConfig-class.html#_parseXmlData" class="summary-sig-name">_parseXmlData</a>(<span class="summary-sig-arg">self</span>,
 
253
          <td><span class="summary-sig"><a href="CedarBackup2.extend.encrypt.LocalConfig-class.html#_parseXmlData" class="summary-sig-name" onclick="show_private();">_parseXmlData</a>(<span class="summary-sig-arg">self</span>,
254
254
        <span class="summary-sig-arg">xmlData</span>)</span><br />
255
255
      Internal method to parse an XML string into the object.</td>
256
256
          <td align="right" valign="top">
299
299
    </td><td class="summary">
300
300
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
301
301
        <tr>
302
 
          <td><span class="summary-sig"><a href="CedarBackup2.extend.encrypt.LocalConfig-class.html#_parseEncrypt" class="summary-sig-name">_parseEncrypt</a>(<span class="summary-sig-arg">parent</span>)</span><br />
 
302
          <td><span class="summary-sig"><a href="CedarBackup2.extend.encrypt.LocalConfig-class.html#_parseEncrypt" class="summary-sig-name" onclick="show_private();">_parseEncrypt</a>(<span class="summary-sig-arg">parent</span>)</span><br />
303
303
      Parses an encrypt configuration section.</td>
304
304
          <td align="right" valign="top">
305
305
            <span class="codelink"><a href="CedarBackup2.extend.encrypt-pysrc.html#LocalConfig._parseEncrypt">source&nbsp;code</a></span>
379
379
  </td><td align="right" valign="top"
380
380
    ><span class="codelink"><a href="CedarBackup2.extend.encrypt-pysrc.html#LocalConfig.__init__">source&nbsp;code</a></span>&nbsp;
381
381
    </td>
382
 
  </table>
 
382
  </tr></table>
383
383
  
384
384
  <p>Initializes a configuration object.</p>
385
385
  <p>If you initialize the object without passing either 
388
388
  <p>No reference to the original XML data or original path is saved off by
389
389
  this class.  Once the data has been parsed (successfully or not) this 
390
390
  original information is discarded.</p>
391
 
  Unless the <code>validate</code> argument is <code>False</code>, the 
 
391
  <p>Unless the <code>validate</code> argument is <code>False</code>, the 
392
392
  <a href="CedarBackup2.extend.encrypt.LocalConfig-class.html#validate" 
393
393
  class="link">LocalConfig.validate</a> method will be called (with its 
394
394
  default arguments) against configuration after successfully parsing any 
395
395
  passed-in XML.  Keep in mind that even if <code>validate</code> is 
396
396
  <code>False</code>, it might not be possible to parse the passed-in XML 
397
 
  document if lower-level validations fail.
 
397
  document if lower-level validations fail.</p>
398
398
  <dl class="fields">
399
399
    <dt>Parameters:</dt>
400
400
    <dd><ul class="nomargin-top">
411
411
        <li><code><strong class='fraise'>ValueError</strong></code> - If the parsed configuration document is not valid.</li>
412
412
    </ul></dd>
413
413
    <dt>Overrides:
414
 
      object.__init__
 
414
        object.__init__
415
415
    </dt>
416
416
  </dl>
417
417
<div class="fields">      <p><strong>Note:</strong>
434
434
  </td><td align="right" valign="top"
435
435
    ><span class="codelink"><a href="CedarBackup2.extend.encrypt-pysrc.html#LocalConfig.__repr__">source&nbsp;code</a></span>&nbsp;
436
436
    </td>
437
 
  </table>
 
437
  </tr></table>
438
438
  
439
 
  Official string representation for class instance.
 
439
  <p>Official string representation for class instance.</p>
440
440
  <dl class="fields">
441
441
    <dt>Overrides:
442
 
      object.__repr__
 
442
        object.__repr__
443
443
    </dt>
444
444
  </dl>
445
445
</td></tr></table>
457
457
  </td><td align="right" valign="top"
458
458
    ><span class="codelink"><a href="CedarBackup2.extend.encrypt-pysrc.html#LocalConfig.__str__">source&nbsp;code</a></span>&nbsp;
459
459
    </td>
460
 
  </table>
 
460
  </tr></table>
461
461
  
462
 
  Informal string representation for class instance.
 
462
  <p>Informal string representation for class instance.</p>
463
463
  <dl class="fields">
464
464
    <dt>Overrides:
465
 
      object.__str__
 
465
        object.__str__
466
466
    </dt>
467
467
  </dl>
468
468
</td></tr></table>
481
481
  </td><td align="right" valign="top"
482
482
    ><span class="codelink"><a href="CedarBackup2.extend.encrypt-pysrc.html#LocalConfig.__cmp__">source&nbsp;code</a></span>&nbsp;
483
483
    </td>
484
 
  </table>
 
484
  </tr></table>
485
485
  
486
 
  Definition of equals operator for this class. Lists within this class 
487
 
  are &quot;unordered&quot; for equality comparisons.
 
486
  <p>Definition of equals operator for this class. Lists within this class 
 
487
  are &quot;unordered&quot; for equality comparisons.</p>
488
488
  <dl class="fields">
489
489
    <dt>Parameters:</dt>
490
490
    <dd><ul class="nomargin-top">
508
508
  </td><td align="right" valign="top"
509
509
    ><span class="codelink"><a href="CedarBackup2.extend.encrypt-pysrc.html#LocalConfig.validate">source&nbsp;code</a></span>&nbsp;
510
510
    </td>
511
 
  </table>
 
511
  </tr></table>
512
512
  
513
513
  <p>Validates configuration represented by the object.</p>
514
 
  Encrypt configuration must be filled in.  Within that, both the 
515
 
  encrypt mode and encrypt target must be filled in.
 
514
  <p>Encrypt configuration must be filled in.  Within that, both the 
 
515
  encrypt mode and encrypt target must be filled in.</p>
516
516
  <dl class="fields">
517
517
    <dt>Raises:</dt>
518
518
    <dd><ul class="nomargin-top">
535
535
  </td><td align="right" valign="top"
536
536
    ><span class="codelink"><a href="CedarBackup2.extend.encrypt-pysrc.html#LocalConfig.addConfig">source&nbsp;code</a></span>&nbsp;
537
537
    </td>
538
 
  </table>
 
538
  </tr></table>
539
539
  
540
540
  <p>Adds an &lt;encrypt&gt; configuration section as the next child of a 
541
541
  parent.</p>
542
542
  <p>Third parties should use this function to write configuration related 
543
543
  to this extension.</p>
544
 
  We add the following fields to the document:
 
544
  <p>We add the following fields to the document:</p>
545
545
<pre class="literalblock">
546
546
  encryptMode    //cb_config/encrypt/encrypt_mode
547
547
  encryptTarget  //cb_config/encrypt/encrypt_target
568
568
  </td><td align="right" valign="top"
569
569
    ><span class="codelink"><a href="CedarBackup2.extend.encrypt-pysrc.html#LocalConfig._setEncrypt">source&nbsp;code</a></span>&nbsp;
570
570
    </td>
571
 
  </table>
 
571
  </tr></table>
572
572
  
573
 
  Property target used to set the encrypt configuration value. If not 
 
573
  <p>Property target used to set the encrypt configuration value. If not 
574
574
  <code>None</code>, the value must be a <code>EncryptConfig</code> 
575
 
  object.
 
575
  object.</p>
576
576
  <dl class="fields">
577
577
    <dt>Raises:</dt>
578
578
    <dd><ul class="nomargin-top">
594
594
  </td><td align="right" valign="top"
595
595
    ><span class="codelink"><a href="CedarBackup2.extend.encrypt-pysrc.html#LocalConfig._parseXmlData">source&nbsp;code</a></span>&nbsp;
596
596
    </td>
597
 
  </table>
 
597
  </tr></table>
598
598
  
599
599
  <p>Internal method to parse an XML string into the object.</p>
600
 
  This method parses the XML document into a DOM tree 
 
600
  <p>This method parses the XML document into a DOM tree 
601
601
  (<code>xmlDom</code>) and then calls a static method to parse the encrypt
602
 
  configuration section.
 
602
  configuration section.</p>
603
603
  <dl class="fields">
604
604
    <dt>Parameters:</dt>
605
605
    <dd><ul class="nomargin-top">
625
625
  </td><td align="right" valign="top"
626
626
    ><span class="codelink"><a href="CedarBackup2.extend.encrypt-pysrc.html#LocalConfig._parseEncrypt">source&nbsp;code</a></span>&nbsp;
627
627
    </td>
628
 
  </table>
 
628
  </tr></table>
629
629
  
630
630
  <p>Parses an encrypt configuration section.</p>
631
 
  We read the following individual fields:
 
631
  <p>We read the following individual fields:</p>
632
632
<pre class="literalblock">
633
633
  encryptMode    //cb_config/encrypt/encrypt_mode
634
634
  encryptTarget  //cb_config/encrypt/encrypt_target
673
673
       cellspacing="0" width="100%" bgcolor="white">
674
674
<tr><td>
675
675
  <h3 class="epydoc">encrypt</h3>
676
 
  Encrypt configuration in terms of a <code>EncryptConfig</code> 
677
 
  object.
 
676
  <p>Encrypt configuration in terms of a <code>EncryptConfig</code> 
 
677
  object.</p>
678
678
  <dl class="fields">
679
679
    <dt>Get Method:</dt>
680
 
    <dd class="value"><span class="summary-sig"><a href="CedarBackup2.extend.encrypt.LocalConfig-class.html#_getEncrypt" class="summary-sig-name">CedarBackup2.extend.encrypt.LocalConfig._getEncrypt</a>(<span class="summary-sig-arg">self</span>)</span>
 
680
    <dd class="value"><span class="summary-sig"><a href="CedarBackup2.extend.encrypt.LocalConfig-class.html#_getEncrypt" class="summary-sig-name" onclick="show_private();">_getEncrypt</a>(<span class="summary-sig-arg">self</span>)</span>
681
681
        - Property target used to get the encrypt configuration value.
682
682
    </dd>
683
683
    <dt>Set Method:</dt>
684
 
    <dd class="value"><span class="summary-sig"><a href="CedarBackup2.extend.encrypt.LocalConfig-class.html#_setEncrypt" class="summary-sig-name">CedarBackup2.extend.encrypt.LocalConfig._setEncrypt</a>(<span class="summary-sig-arg">self</span>,
 
684
    <dd class="value"><span class="summary-sig"><a href="CedarBackup2.extend.encrypt.LocalConfig-class.html#_setEncrypt" class="summary-sig-name" onclick="show_private();">_setEncrypt</a>(<span class="summary-sig-arg">self</span>,
685
685
        <span class="summary-sig-arg">value</span>)</span>
686
686
        - Property target used to set the encrypt configuration value.
687
687
    </dd>
720
720
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
721
721
  <tr>
722
722
    <td align="left" class="footer">
723
 
    Generated by Epydoc 3.0beta1 on Sat Nov 15 12:16:58 2008
 
723
    Generated by Epydoc 3.0.1 on Sun Mar 29 14:50:17 2009
724
724
    </td>
725
725
    <td align="right" class="footer">
726
 
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
 
726
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
 
727
        >http://epydoc.sourceforge.net</a>
727
728
    </td>
728
729
  </tr>
729
730
</table>
734
735
  // javascript is turned off then we want them to be
735
736
  // visible); but by default, we want to hide them.  So hide
736
737
  // them unless we have a cookie that says to show them.
737
 
  checkCookie()
 
738
  checkCookie();
738
739
  // -->
739
740
</script>
740
 
  
741
741
</body>
742
742
</html>