Package CedarBackup2 :: Module config :: Class OptionsConfig
[show private | hide private]
[frames | no frames]

Type OptionsConfig

object --+
         |
        OptionsConfig


Class representing a Cedar Backup global options configuration.

The options section is used to store global configuration options and defaults that can be applied to other sections.

As with all of the other classes that represent configuration sections, all of these values are optional. It is up to some higher-level construct to decide whether everything they need is filled in. Some validation is done on non-None assignments through the use of the Python property() construct.

The following restrictions exist on data in this class:
Method Summary
  __init__(self, startingDay, workingDir, backupUser, backupGroup, rcpCommand, overrides, hooks)
Constructor for the OptionsConfig class.
  __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.
  _getBackupGroup(self)
Property target used to get the backup group.
  _getBackupUser(self)
Property target used to get the backup user.
  _getHooks(self)
Property target used to get the command path hooks list.
  _getOverrides(self)
Property target used to get the command path overrides list.
  _getRcpCommand(self)
Property target used to get the rcp command.
  _getStartingDay(self)
Property target used to get the starting day.
  _getWorkingDir(self)
Property target used to get the working directory.
  _setBackupGroup(self, value)
Property target used to set the backup group.
  _setBackupUser(self, value)
Property target used to set the backup user.
  _setHooks(self, value)
Property target used to set the pre- and post-action hooks list.
  _setOverrides(self, value)
Property target used to set the command path overrides list.
  _setRcpCommand(self, value)
Property target used to set the rcp command.
  _setStartingDay(self, value)
Property target used to set the starting day.
  _setWorkingDir(self, value)
Property target used to set the working directory.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value

Property Summary
  startingDay: Day that starts the week.
  workingDir: Working (temporary) directory to use for backups.
  backupUser: Effective user that backups should run as.
  backupGroup: Effective group that backups should run as.
  rcpCommand: Default rcp-compatible copy command for staging.
  overrides: List of configured command path overrides, if any.
  hooks: List of configured pre- and post-action hooks.

Method Details

__init__(self, startingDay=None, workingDir=None, backupUser=None, backupGroup=None, rcpCommand=None, overrides=None, hooks=None)
(Constructor)

Constructor for the OptionsConfig class.
Parameters:
startingDay - Day that starts the week.
workingDir - Working (temporary) directory to use for backups.
backupUser - Effective user that backups should run as.
backupGroup - Effective group that backups should run as.
rcpCommand - Default rcp-compatible copy command for staging.
overrides - List of configured command path overrides, if any.
hooks - List of configured pre- and post-action hooks.
Raises:
ValueError - If one of the values is invalid.
Overrides:
__builtin__.object.__init__

__repr__(self)
(Representation operator)

Official string representation for class instance.
Overrides:
__builtin__.object.__repr__

__str__(self)
(Informal representation operator)

Informal string representation for class instance.
Overrides:
__builtin__.object.__str__

__cmp__(self, other)
(Comparison operator)

Definition of equals operator for this class.
Parameters:
other - Other object to compare to.
Returns:
-1/0/1 depending on whether self is <, = or > other.

_getBackupGroup(self)

Property target used to get the backup group.

_getBackupUser(self)

Property target used to get the backup user.

_getHooks(self)

Property target used to get the command path hooks list.

_getOverrides(self)

Property target used to get the command path overrides list.

_getRcpCommand(self)

Property target used to get the rcp command.

_getStartingDay(self)

Property target used to get the starting day.

_getWorkingDir(self)

Property target used to get the working directory.

_setBackupGroup(self, value)

Property target used to set the backup group. The value must be a non-empty string if it is not None.
Raises:
ValueError - If the value is an empty string.

_setBackupUser(self, value)

Property target used to set the backup user. The value must be a non-empty string if it is not None.
Raises:
ValueError - If the value is an empty string.

_setHooks(self, value)

Property target used to set the pre- and post-action hooks list. Either the value must be None or each element must be an ActionHook.
Raises:
ValueError - If the value is not a CommandOverride

_setOverrides(self, value)

Property target used to set the command path overrides list. Either the value must be None or each element must be a CommandOverride.
Raises:
ValueError - If the value is not a CommandOverride

_setRcpCommand(self, value)

Property target used to set the rcp command. The value must be a non-empty string if it is not None.
Raises:
ValueError - If the value is an empty string.

_setStartingDay(self, value)

Property target used to set the starting day. If it is not None, the value must be a valid English day of the week, one of "monday", "tuesday", "wednesday", etc.
Raises:
ValueError - If the value is not a valid day of the week.

_setWorkingDir(self, value)

Property target used to set the working directory. The value must be an absolute path if it is not None. It does not have to exist on disk at the time of assignment.
Raises:
ValueError - If the value is not an absolute path.
ValueError - If the value cannot be encoded properly.

Property Details

startingDay

Day that starts the week.
Get Method:
_getStartingDay(self)
Set Method:
_setStartingDay(self, value)

workingDir

Working (temporary) directory to use for backups.
Get Method:
_getWorkingDir(self)
Set Method:
_setWorkingDir(self, value)

backupUser

Effective user that backups should run as.
Get Method:
_getBackupUser(self)
Set Method:
_setBackupUser(self, value)

backupGroup

Effective group that backups should run as.
Get Method:
_getBackupGroup(self)
Set Method:
_setBackupGroup(self, value)

rcpCommand

Default rcp-compatible copy command for staging.
Get Method:
_getRcpCommand(self)
Set Method:
_setRcpCommand(self, value)

overrides

List of configured command path overrides, if any.
Get Method:
_getOverrides(self)
Set Method:
_setOverrides(self, value)

hooks

List of configured pre- and post-action hooks.
Get Method:
_getHooks(self)
Set Method:
_setHooks(self, value)

Generated by Epydoc 2.1 on Thu Dec 22 20:45:13 2005 http://epydoc.sf.net