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

Type RemotePeer

object --+
         |
        RemotePeer


Class representing a Cedar Backup peer.

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, name, collectDir, remoteUser, rcpCommand)
Constructor for the RemotePeer 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.
  _getCollectDir(self)
Property target used to get the collect directory.
  _getName(self)
Property target used to get the peer name.
  _getRcpCommand(self)
Property target used to get the rcp command.
  _getRemoteUser(self)
Property target used to get the remote user.
  _setCollectDir(self, value)
Property target used to set the collect directory.
  _setName(self, value)
Property target used to set the peer name.
  _setRcpCommand(self, value)
Property target used to set the rcp command.
  _setRemoteUser(self, value)
Property target used to set the remote user.
    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
  name: Name of the peer, must be a valid hostname.
  collectDir: Collect directory to stage files from on peer.
  remoteUser: Name of backup user on remote peer.
  rcpCommand: Overridden rcp-compatible copy command for peer.

Method Details

__init__(self, name=None, collectDir=None, remoteUser=None, rcpCommand=None)
(Constructor)

Constructor for the RemotePeer class.
Parameters:
name - Name of the peer, must be a valid hostname.
collectDir - Collect directory to stage files from on peer.
remoteUser - Name of backup user on remote peer.
rcpCommand - Overridden rcp-compatible copy command for peer.
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.

_getCollectDir(self)

Property target used to get the collect directory.

_getName(self)

Property target used to get the peer name.

_getRcpCommand(self)

Property target used to get the rcp command.

_getRemoteUser(self)

Property target used to get the remote user.

_setCollectDir(self, value)

Property target used to set the collect 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.

_setName(self, value)

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

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

_setRemoteUser(self, value)

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

Property Details

name

Name of the peer, must be a valid hostname.
Get Method:
_getName(self)
Set Method:
_setName(self, value)

collectDir

Collect directory to stage files from on peer.
Get Method:
_getCollectDir(self)
Set Method:
_setCollectDir(self, value)

remoteUser

Name of backup user on remote peer.
Get Method:
_getRemoteUser(self)
Set Method:
_setRemoteUser(self, value)

rcpCommand

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

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