Home | Trees | Index | Help |
|
---|
Package CedarBackup2 :: Package extend :: Module mbox :: Class LocalConfig |
|
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.
Method Summary | |
---|---|
Initializes a configuration object. | |
Official string representation for class instance. | |
Informal string representation for class instance. | |
Definition of equals operator for this class. | |
Validates configuration represented by the object. | |
Adds an <mbox> configuration section as the next child of a parent. | |
Inherited from object | |
x.__delattr__('name') <==> del x.name | |
x.__getattribute__('name') <==> x.name | |
x.__hash__() <==> hash(x) | |
T.__new__(S, ...) -> a new object with type S, a subtype of T | |
helper for pickle | |
helper for pickle | |
x.__setattr__('name', value) <==> x.name = value |
Property Summary | |
---|---|
mbox : Mbox configuration in terms of a MboxConfig object. |
Instance Method Details |
---|
__init__(self,
xmlData=None,
xmlPath=None,
validate=True)
|
__repr__(self)
Official string representation for class instance.
|
__str__(self)
Informal string representation for class instance.
|
__cmp__(self,
other)
Definition of equals operator for this class. Lists within this
class are "unordered" for equality comparisons.
|
validate(self)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.
|
addConfig(self, xmlDom, parentNode)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 .
|
Property Details |
---|
mboxMbox configuration in terms of aMboxConfig object.
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.1 on Thu Mar 29 20:58:26 2007 | http://epydoc.sf.net |