Home | Trees | Indices | Help |
|
---|
|
object --+ | LocalConfig
Class representing this extension's configuration document.
This is not a general-purpose configuration object like the main Cedar Backup configuration object. Instead, it just knows how to parse and emit Mbox-specific configuration values. Third parties who need to read and write configuration related to this extension should access it through the constructor,validate
and addConfig
methods.Note: Lists within this class are "unordered" for equality comparisons.
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from |
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|
|||
mbox Mbox configuration in terms of a MboxConfig
object.
|
|||
Inherited from |
|
Initializes a configuration object. If you initialize the object without passing either
No reference to the original XML data or original path is saved off by this class. Once the data has been parsed (successfully or not) this original information is discarded. Unless thevalidate argument is False , the
LocalConfig.validate method will be called (with its
default arguments) against configuration after successfully parsing any
passed-in XML. Keep in mind that even if validate is
False , it might not be possible to parse the passed-in XML
document if lower-level validations fail.
Note:
It is strongly suggested that the |
|
|
|
Validates configuration represented by the object. Mbox configuration must be filled in. Within that, the collect mode and compress mode are both optional, but the list of repositories must contain at least one entry. Each configured file or directory must contain an absolute path, and then must be either able to take collect mode and compress mode configuration from the parentMboxConfig object, or must set
each value on its own.
|
Adds an <mbox> configuration section as the next child of a parent. Third parties should use this function to write configuration related to this extension. We add the following fields to the document:collectMode //cb_config/mbox/collectMode compressMode //cb_config/mbox/compressModeWe also add groups of the following items, one list element per item: mboxFiles //cb_config/mbox/file mboxDirs //cb_config/mbox/dirThe mbox files and mbox directories are added by _addMboxFile and _addMboxDir.
|
None , the value must be a MboxConfig
object.
|
Internal method to parse an XML string into the object. This method parses the XML document into a DOM tree (xmlDom ) and then calls a static method to parse the mbox
configuration section.
|
Parses an mbox configuration section. We read the following individual fields:collectMode //cb_config/mbox/collect_mode compressMode //cb_config/mbox/compress_modeWe also read groups of the following item, one list element per item: mboxFiles //cb_config/mbox/file mboxDirs //cb_config/mbox/dirThe mbox files are parsed by _parseMboxFiles and the mbox directories are parsed by _parseMboxDirs.
|
Reads a list of absolutePath abs_path collectMode collect_mode compressMode compess_mode
|
Reads a list of absolutePath abs_path collectMode collect_mode compressMode compess_modeWe also read groups of the following items, one list element per item: relativeExcludePaths exclude/rel_path excludePatterns exclude/patternThe exclusions are parsed by _parseExclusions.
|
Reads exclusions data from immediately beneath the parent. We read groups of the following items, one list element per item:relative exclude/rel_path patterns exclude/patternIf there are none of some pattern (i.e. no relative path items) then None will be returned for that item in the tuple.
|
Adds an mbox file container as the next child of a parent. We add the following fields to the document:absolutePath file/abs_path collectMode file/collect_mode compressMode file/compress_mode The <file> node itself is created as the next child of the
parent node. This method only adds one mbox file node. The parent must
loop for each mbox file in the mboxFile is None , this method call will
be a no-op.
|
Adds an mbox directory container as the next child of a parent. We add the following fields to the document:absolutePath dir/abs_path collectMode dir/collect_mode compressMode dir/compress_modeWe also add groups of the following items, one list element per item: relativeExcludePaths dir/exclude/rel_path excludePatterns dir/exclude/pattern The <dir> node itself is created as the next child of the parent
node. This method only adds one mbox directory node. The parent must
loop for each mbox directory in the mboxDir is None , this method call will be
a no-op.
|
|
mboxMbox configuration in terms of aMboxConfig object.
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0beta1 on Sat Nov 15 12:16:59 2008 | http://epydoc.sourceforge.net |