CedarBackup2.extend.encrypt.EncryptConfig

Package CedarBackup2 :: Package extend :: Module encrypt :: Class EncryptConfig |
[hide private]
[frames] | no frames]

# Class EncryptConfig

source code

    object --+
             |
            EncryptConfig

Class representing encrypt configuration.

Encrypt configuration is used for encrypting staging directories.

The following restrictions exist on data in this class:

- The encrypt mode must be one of the values in VALID_ENCRYPT_MODES
- The encrypt target value must be a non-empty string

Instance Methods | [hide private]
__init__(self, encryptMode=None, encryptTarget=None) Constructor for the `EncryptConfig` 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
_setEncryptMode(self, value) Property target used to set the encrypt mode. | source code
_getEncryptMode(self) Property target used to get the encrypt mode. | source code
_setEncryptTarget(self, value) Property target used to set the encrypt target. | source code
_getEncryptTarget(self) Property target used to get the encrypt target. | source code
Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties | [hide private]
| encryptMode Encrypt mode.
| encryptTarget Encrypt target (i.e.
Inherited from `object`: `__class__`

Method Details | [hide private]

### __init__(self, encryptMode=None, encryptTarget=None) (Constructor) | source code
Constructor for the `EncryptConfig` class. Parameters: `encryptMode` - Encryption mode `encryptTarget` - Encryption target (for instance, GPG recipient) 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. 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.

### _setEncryptMode(self, value) | source code
Property target used to set the encrypt mode. If not `None`, the mode must be one of the values in VALID_ENCRYPT_MODES. Raises: `ValueError` - If the value is not valid.

Property Details | [hide private]

### encryptMode Encrypt mode. Get Method: _getEncryptMode(self) - Property target used to get the encrypt mode. Set Method: _setEncryptMode(self, value) - Property target used to set the encrypt mode.

### encryptTarget Encrypt target (i.e. GPG recipient). Get Method: _getEncryptTarget(self) - Property target used to get the encrypt target. Set Method: _setEncryptTarget(self, value) - Property target used to set the encrypt target.