sbuild::chroot_source Class Reference

A chroot may offer a "source" chroot in addition to its normal "session" copy, to allow for maintenence of the source data. More...

#include <sbuild-chroot-source.h>

Inheritance diagram for sbuild::chroot_source:

Inheritance graph
[legend]
Collaboration diagram for sbuild::chroot_source:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual ~chroot_source ()
 The destructor.
virtual chroot::ptr clone_source () const =0
virtual string_list const & get_source_groups () const
 Get the groups allowed to access the source chroot.
virtual void set_source_groups (string_list const &groups)
 Set the groups allowed to access the source chroot.
virtual string_list const & get_source_root_groups () const
 Get the groups allowed to access the source chroot as root.
virtual void set_source_root_groups (string_list const &groups)
 Set the groups allowed to access the source chroot as root.
void setup_env (environment &env)
 Set environment.

Protected Member Functions

 chroot_source ()
 The constructor.
void clone_source_setup (chroot::ptr &clone) const
 Set the defaults in the cloned source chroot.
void print_details (std::ostream &stream) const
 Print detailed information about the chroot to a stream.
void get_keyfile (keyfile &keyfile) const
 Copy the chroot properties into a keyfile.
void set_keyfile (keyfile const &keyfile)
 Set the chroot properties from a keyfile.

Private Attributes

string_list source_groups
 Groups allowed to access the source chroot.
string_list source_root_groups
 Groups allowed to access the source chroot as root.

Friends

class chroot

Detailed Description

A chroot may offer a "source" chroot in addition to its normal "session" copy, to allow for maintenence of the source data.

This interface may be implemented by any chroot wishing to provide such functionality.

While this is effectively an interface, in practice this derives from sbuild::chroot, to allow setting and getting of data from a keyfile, including storing the keyfile options.

Chroot types implementing chroot_source should, at a minimum, implement clone_source(). This should create and return a source chroot, and must call clone_source_setup() to set up the source chroot.


Constructor & Destructor Documentation

chroot_source::chroot_source  )  [protected]
 

The constructor.

chroot_source::~chroot_source  )  [virtual]
 

The destructor.


Member Function Documentation

virtual chroot::ptr sbuild::chroot_source::clone_source  )  const [pure virtual]
 

Implemented in sbuild::chroot_file, and sbuild::chroot_lvm_snapshot.

void chroot_source::clone_source_setup chroot::ptr clone  )  const [protected]
 

Set the defaults in the cloned source chroot.

Parameters:
clone the chroot to set up.

void chroot_source::get_keyfile keyfile keyfile  )  const [protected, virtual]
 

Copy the chroot properties into a keyfile.

The keyfile group with the name of the chroot will be set; if it already exists, it will be removed before setting it.

Parameters:
keyfile the keyfile to use.

Reimplemented from sbuild::chroot.

Reimplemented in sbuild::chroot_file, and sbuild::chroot_lvm_snapshot.

string_list const & chroot_source::get_source_groups  )  const [virtual]
 

Get the groups allowed to access the source chroot.

Returns:
a list of groups.

string_list const & chroot_source::get_source_root_groups  )  const [virtual]
 

Get the groups allowed to access the source chroot as root.

Mmebers of these groups can switch to root without authenticating themselves.

Returns:
a list of groups.

void chroot_source::print_details std::ostream &  stream  )  const [protected, virtual]
 

Print detailed information about the chroot to a stream.

The information is printed in plain text with one line per property.

Parameters:
stream the stream to output to.

Reimplemented from sbuild::chroot.

Reimplemented in sbuild::chroot_file, and sbuild::chroot_lvm_snapshot.

void chroot_source::set_keyfile keyfile const &  keyfile  )  [protected, virtual]
 

Set the chroot properties from a keyfile.

The chroot name must have previously been set, so that the correct keyfile group may be determined.

Parameters:
keyfile the keyfile to get the properties from.

Reimplemented from sbuild::chroot.

Reimplemented in sbuild::chroot_file, and sbuild::chroot_lvm_snapshot.

void chroot_source::set_source_groups string_list const &  groups  )  [virtual]
 

Set the groups allowed to access the source chroot.

Parameters:
groups a list of groups.

void chroot_source::set_source_root_groups string_list const &  groups  )  [virtual]
 

Set the groups allowed to access the source chroot as root.

Mmebers of these groups can switch to root without authenticating themselves.

Parameters:
groups a list of groups.

void chroot_source::setup_env environment env  )  [virtual]
 

Set environment.

Set the environment that the setup scripts will see during execution.

Parameters:
env the environment to set.

Reimplemented from sbuild::chroot.

Reimplemented in sbuild::chroot_file, and sbuild::chroot_lvm_snapshot.


Friends And Related Function Documentation

friend class chroot [friend]
 

Reimplemented in sbuild::chroot_file, and sbuild::chroot_lvm_snapshot.


Member Data Documentation

string_list sbuild::chroot_source::source_groups [private]
 

Groups allowed to access the source chroot.

string_list sbuild::chroot_source::source_root_groups [private]
 

Groups allowed to access the source chroot as root.


The documentation for this class was generated from the following files:
Generated on Sun Mar 19 12:08:53 2006 for schroot by  doxygen 1.4.6