CedarBackup2.config.StoreConfig

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

# Class StoreConfig

source code

    object --+
             |
            StoreConfig

Class representing a Cedar Backup store configuration.

The following restrictions exist on data in this class:

- The source directory must be an absolute path.
- The media type must be one of the values in VALID_MEDIA_TYPES.
- The device type must be one of the values in VALID_DEVICE_TYPES.
- The device path must be an absolute path.
- The SCSI id, if provided, must be in the form specified by validateScsiId.
- The drive speed must be an integer >= 1
- The blanking behavior must be a `BlankBehavior` object
- The refresh media delay must be an integer >= 0
- The eject delay must be an integer >= 0

Note that although the blanking factor must be a positive floating point number, it is stored as a string. This is done so that we can losslessly go back and forth between XML and object representations of configuration.

Instance Methods | [hide private]
__init__(self, sourceDir=None, mediaType=None, deviceType=None, devicePath=None, deviceScsiId=None, driveSpeed=None, checkData=False, warnMidnite=False, noEject=False, checkMedia=False, blankBehavior=None, refreshMediaDelay=None, ejectDelay=None) Constructor for the `StoreConfig` class. | 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
_setSourceDir(self, value) Property target used to set the source directory. | source code
_getSourceDir(self) Property target used to get the source directory. | source code
_setMediaType(self, value) Property target used to set the media type. | source code
_getMediaType(self) Property target used to get the media type. | source code
_setDeviceType(self, value) Property target used to set the device type. | source code
_getDeviceType(self) Property target used to get the device type. | source code
_setDevicePath(self, value) Property target used to set the device path. | source code
_getDevicePath(self) Property target used to get the device path. | source code
_setDeviceScsiId(self, value) Property target used to set the SCSI id The SCSI id must be valid per validateScsiId. | source code
_getDeviceScsiId(self) Property target used to get the SCSI id. | source code
_setDriveSpeed(self, value) Property target used to set the drive speed. | source code
_getDriveSpeed(self) Property target used to get the drive speed. | source code
_setCheckData(self, value) Property target used to set the check data flag. | source code
_getCheckData(self) Property target used to get the check data flag. | source code
_setCheckMedia(self, value) Property target used to set the check media flag. | source code
_getCheckMedia(self) Property target used to get the check media flag. | source code
_setWarnMidnite(self, value) Property target used to set the midnite warning flag. | source code
_getWarnMidnite(self) Property target used to get the midnite warning flag. | source code
_setNoEject(self, value) Property target used to set the no-eject flag. | source code
_getNoEject(self) Property target used to get the no-eject flag. | source code
_setBlankBehavior(self, value) Property target used to set blanking behavior configuration. | source code
_getBlankBehavior(self) Property target used to get the blanking behavior configuration. | source code
_setRefreshMediaDelay(self, value) Property target used to set the refreshMediaDelay. | source code
_getRefreshMediaDelay(self) Property target used to get the action refreshMediaDelay. | source code
_setEjectDelay(self, value) Property target used to set the ejectDelay. | source code
_getEjectDelay(self) Property target used to get the action ejectDelay. | source code
Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties | [hide private]
| sourceDir Directory whose contents should be written to media.
| mediaType Type of the media (see notes above).
| deviceType Type of the device (optional, see notes above).
| devicePath Filesystem device name for writer device.
| deviceScsiId SCSI id for writer device (optional, see notes above).
| driveSpeed Speed of the drive.
| checkData Whether resulting image should be validated.
| checkMedia Whether media should be checked before being written to.
| warnMidnite Whether to generate warnings for crossing midnite.
| noEject Indicates that the writer device should not be ejected.
| blankBehavior Controls optimized blanking behavior.
| refreshMediaDelay Delay, in seconds, to add after refreshing media.
| ejectDelay Delay, in seconds, to add after ejecting media before closing the tray
Inherited from `object`: `__class__`

Method Details | [hide private]

### __init__(self, sourceDir=None, mediaType=None, deviceType=None, devicePath=None, deviceScsiId=None, driveSpeed=None, checkData=False, warnMidnite=False, noEject=False, checkMedia=False, blankBehavior=None, refreshMediaDelay=None, ejectDelay=None) (Constructor) | source code
Constructor for the `StoreConfig` class. Parameters: `sourceDir` - Directory whose contents should be written to media. `mediaType` - Type of the media (see notes above). `deviceType` - Type of the device (optional, see notes above). `devicePath` - Filesystem device name for writer device, i.e. `/dev/cdrw`. `deviceScsiId` - SCSI id for writer device, i.e. `[<method>:]scsibus,target,lun`. `driveSpeed` - Speed of the drive, i.e. `2` for 2x drive, etc. `checkData` - Whether resulting image should be validated. `checkMedia` - Whether media should be checked before being written to. `warnMidnite` - Whether to generate warnings for crossing midnite. `noEject` - Indicates that the writer device should not be ejected. `blankBehavior` - Controls optimized blanking behavior. `refreshMediaDelay` - Delay, in seconds, to add after refreshing media `ejectDelay` - Delay, in seconds, to add after ejecting media before closing the tray Raises: `ValueError` - If one of the values is invalid. Overrides: object.__init__

### __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. Parameters: `other` - Other object to compare to. Returns: -1/0/1 depending on whether self is `<`, `=` or `>` other.

### _setSourceDir(self, value) | source code
Property target used to set the source 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.

### _setMediaType(self, value) | source code
Property target used to set the media type. The value must be one of VALID_MEDIA_TYPES. Raises: `ValueError` - If the value is not valid.

### _setDeviceType(self, value) | source code
Property target used to set the device type. The value must be one of VALID_DEVICE_TYPES. Raises: `ValueError` - If the value is not valid.

### _setDevicePath(self, value) | source code
Property target used to set the device path. 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.

### _setDeviceScsiId(self, value) | source code
Property target used to set the SCSI id The SCSI id must be valid per validateScsiId. Raises: `ValueError` - If the value is not valid.

### _setDriveSpeed(self, value) | source code
Property target used to set the drive speed. The drive speed must be valid per validateDriveSpeed. Raises: `ValueError` - If the value is not valid.

### _setCheckData(self, value) | source code
Property target used to set the check data flag. No validations, but we normalize the value to `True` or `False`.

### _setCheckMedia(self, value) | source code
Property target used to set the check media flag. No validations, but we normalize the value to `True` or `False`.

### _setWarnMidnite(self, value) | source code
Property target used to set the midnite warning flag. No validations, but we normalize the value to `True` or `False`.

### _setNoEject(self, value) | source code
Property target used to set the no-eject flag. No validations, but we normalize the value to `True` or `False`.

### _setBlankBehavior(self, value) | source code
Property target used to set blanking behavior configuration. If not `None`, the value must be a `BlankBehavior` object. Raises: `ValueError` - If the value is not a `BlankBehavior`

### _setRefreshMediaDelay(self, value) | source code
Property target used to set the refreshMediaDelay. The value must be an integer >= 0. Raises: `ValueError` - If the value is not valid.

### _setEjectDelay(self, value) | source code
Property target used to set the ejectDelay. The value must be an integer >= 0. Raises: `ValueError` - If the value is not valid.

Property Details | [hide private]

### sourceDir Directory whose contents should be written to media. Get Method: _getSourceDir(self) - Property target used to get the source directory. Set Method: _setSourceDir(self, value) - Property target used to set the source directory.

### mediaType Type of the media (see notes above). Get Method: _getMediaType(self) - Property target used to get the media type. Set Method: _setMediaType(self, value) - Property target used to set the media type.

### deviceType Type of the device (optional, see notes above). Get Method: _getDeviceType(self) - Property target used to get the device type. Set Method: _setDeviceType(self, value) - Property target used to set the device type.

### devicePath Filesystem device name for writer device. Get Method: _getDevicePath(self) - Property target used to get the device path. Set Method: _setDevicePath(self, value) - Property target used to set the device path.

### deviceScsiId SCSI id for writer device (optional, see notes above). Get Method: _getDeviceScsiId(self) - Property target used to get the SCSI id. Set Method: _setDeviceScsiId(self, value) - Property target used to set the SCSI id The SCSI id must be valid per validateScsiId.

### driveSpeed Speed of the drive. Get Method: _getDriveSpeed(self) - Property target used to get the drive speed. Set Method: _setDriveSpeed(self, value) - Property target used to set the drive speed.

### checkData Whether resulting image should be validated. Get Method: _getCheckData(self) - Property target used to get the check data flag. Set Method: _setCheckData(self, value) - Property target used to set the check data flag.

### checkMedia Whether media should be checked before being written to. Get Method: _getCheckMedia(self) - Property target used to get the check media flag. Set Method: _setCheckMedia(self, value) - Property target used to set the check media flag.

### warnMidnite Whether to generate warnings for crossing midnite. Get Method: _getWarnMidnite(self) - Property target used to get the midnite warning flag. Set Method: _setWarnMidnite(self, value) - Property target used to set the midnite warning flag.

### noEject Indicates that the writer device should not be ejected. Get Method: _getNoEject(self) - Property target used to get the no-eject flag. Set Method: _setNoEject(self, value) - Property target used to set the no-eject flag.

### blankBehavior Controls optimized blanking behavior. Get Method: _getBlankBehavior(self) - Property target used to get the blanking behavior configuration. Set Method: _setBlankBehavior(self, value) - Property target used to set blanking behavior configuration.

### refreshMediaDelay Delay, in seconds, to add after refreshing media. Get Method: _getRefreshMediaDelay(self) - Property target used to get the action refreshMediaDelay. Set Method: _setRefreshMediaDelay(self, value) - Property target used to set the refreshMediaDelay.

### ejectDelay Delay, in seconds, to add after ejecting media before closing the tray Get Method: _getEjectDelay(self) - Property target used to get the action ejectDelay. Set Method: _setEjectDelay(self, value) - Property target used to set the ejectDelay.