Home       Trees       Indices       Help   
CedarBackup2
Package CedarBackup2 :: Package extend :: Module postgresql :: Class LocalConfig
[hide private]
[frames] | no frames]

Class LocalConfig

source code

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 PostgreSQL-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.

Instance Methods [hide private]
 
__init__(self, xmlData=None, xmlPath=None, validate=True)
Initializes a configuration object.		 source code
 
__repr__(self)
Official string representation for class instance.		 source code
 
__str__(self)
Informal string representation for class instance.		 source code
 
__cmp__(self, other)
Definition of equals operator for this class.		 source code
 
validate(self)
Validates configuration represented by the object.		 source code
 
addConfig(self, xmlDom, parentNode)
Adds a <postgresql> configuration section as the next child of a parent.		 source code
 
_setPostgresql(self, value)
Property target used to set the postgresql configuration value.		 source code
 
_getPostgresql(self)
Property target used to get the postgresql configuration value.		 source code
 
_parseXmlData(self, xmlData)
Internal method to parse an XML string into the object.		 source code

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

Static Methods [hide private]
 
_parsePostgresql(parent)
Parses a postgresql configuration section.		 source code
Properties [hide private]
  postgresql
Postgresql configuration in terms of a PostgresqlConfig object.

Inherited from object: __class__

Method Details [hide private]

__init__(self, xmlData=None, xmlPath=None, validate=True)
(Constructor)

source code 

Initializes a configuration object.

If you initialize the object without passing either xmlData or xmlPath then configuration will be empty and will be invalid until it is filled in properly.

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 the validate 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.

Parameters:
  • xmlData (String data.) - XML data representing configuration.
  • xmlPath (Absolute path to a file on disk.) - Path to an XML file on disk.
  • validate (Boolean true/false.) - Validate the document after parsing it.
Raises:
  • ValueError - If both xmlData and xmlPath are passed-in.
  • ValueError - If the XML data in xmlData or xmlPath cannot be parsed.
  • ValueError - If the parsed configuration document is not valid.
Overrides: object.__init__

Note: It is strongly suggested that the validate option always be set to True (the default) unless there is a specific need to read in invalid configuration from disk.

__repr__(self)
(Representation operator)

source code 

Official string representation for class instance.

Overrides: object.__repr__

__str__(self)
(Informal representation operator)

source code 

Informal string representation for class instance.

Overrides: object.__str__

__cmp__(self, other)
(Comparison operator)

source code 

Definition of equals operator for this class. Lists within this class are "unordered" for equality comparisons.

Parameters:
  • other - Other object to compare to.
Returns:
-1/0/1 depending on whether self is <, = or > other.

validate(self)

source code 

Validates configuration represented by the object.

The compress mode must be filled in. Then, if the 'all' flag is set, no databases are allowed, and if the 'all' flag is not set, at least one database is required.

Raises:
  • ValueError - If one of the validations fails.

addConfig(self, xmlDom, parentNode)

source code 

Adds a <postgresql> 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:

  user           //cb_config/postgresql/user
  compressMode   //cb_config/postgresql/compress_mode
  all            //cb_config/postgresql/all

We also add groups of the following items, one list element per item:

  database       //cb_config/postgresql/database
Parameters:
  • xmlDom - DOM tree as from impl.createDocument().
  • parentNode - Parent that the section should be appended to.

_setPostgresql(self, value)

source code 

Property target used to set the postgresql configuration value. If not None, the value must be a PostgresqlConfig object.

Raises:
  • ValueError - If the value is not a PostgresqlConfig

_parseXmlData(self, xmlData)

source code 

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 postgresql configuration section.

Parameters:
  • xmlData (String data) - XML data to be parsed
Raises:
  • ValueError - If the XML cannot be successfully parsed.

_parsePostgresql(parent)
Static Method

source code 

Parses a postgresql configuration section.

We read the following fields:

  user           //cb_config/postgresql/user
  compressMode   //cb_config/postgresql/compress_mode
  all            //cb_config/postgresql/all

We also read groups of the following item, one list element per item:

  databases      //cb_config/postgresql/database
Parameters:
  • parent - Parent node to search beneath.
Returns:
PostgresqlConfig object or None if the section does not exist.
Raises:
  • ValueError - If some filled-in value is invalid.

Property Details [hide private]

postgresql

Postgresql configuration in terms of a PostgresqlConfig object.

Get Method:
_getPostgresql(self) - Property target used to get the postgresql configuration value.
Set Method:
_setPostgresql(self, value) - Property target used to set the postgresql configuration value.

   Home       Trees       Indices       Help   
CedarBackup2
Generated by Epydoc 3.0.1 on Wed Oct 12 09:25:40 2011 http://epydoc.sourceforge.net