sbuild::chroot_directory Class Reference

A chroot located in the filesystem. More...

#include <sbuild-chroot-directory.h>

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

List of all members.

Public Member Functions

virtual ~chroot_directory ()
 The destructor.
virtual chroot::ptr clone () const
 Copy the chroot.
virtual chroot::ptr clone_session (std::string const &session_id, std::string const &user, bool root) const
 Create a session chroot.
virtual chroot::ptr clone_source () const
 Create a source chroot.
virtual std::string get_path () const
 Get the path to the chroot.
virtual void setup_env (chroot const &chroot, environment &env) const
 Set environment.
virtual std::string const & get_chroot_type () const
 Get the type of the chroot.
virtual session_flags get_session_flags (chroot const &chroot) const
 Get the session flags of the chroot.

Protected Member Functions

 chroot_directory ()
 The constructor.
 chroot_directory (const chroot_directory &rhs)
 The copy constructor.
virtual void setup_lock (chroot::setup_type type, bool lock, int status)
 Unlock a chroot during setup.
virtual void get_details (chroot const &chroot, format_detail &detail) const
 Get detailed information about the chroot for output.
virtual void get_keyfile (chroot const &chroot, keyfile &keyfile) const
 Copy the chroot properties into a keyfile.
virtual void set_keyfile (chroot &chroot, keyfile const &keyfile, string_list &used_keys)
 Set the chroot properties from a keyfile.

Friends

class chroot

Detailed Description

A chroot located in the filesystem.

It runs setup scripts and can provide multiple sessions using the union facet.


Constructor & Destructor Documentation

chroot_directory::chroot_directory (  )  [protected]
chroot_directory::chroot_directory ( const chroot_directory rhs  )  [protected]

The copy constructor.

chroot_directory::~chroot_directory (  )  [virtual]

The destructor.


Member Function Documentation

sbuild::chroot::ptr chroot_directory::clone (  )  const [virtual]

Copy the chroot.

This is a virtual copy constructor.

Returns:
a shared_ptr to the new copy of the chroot.

Implements sbuild::chroot.

References chroot_directory().

Referenced by clone_source().

sbuild::chroot::ptr chroot_directory::clone_session ( std::string const &  session_id,
std::string const &  user,
bool  root 
) const [virtual]

Create a session chroot.

Parameters:
session_id the identifier for the new session.
user the user creating the session.
root true if the user has root access, otherwise false.
Returns:
a session chroot.

Implements sbuild::chroot.

References chroot_directory().

sbuild::chroot::ptr chroot_directory::clone_source (  )  const [virtual]

Create a source chroot.

Returns:
a source chroot.

Implements sbuild::chroot.

References chroot_directory(), and clone().

std::string const & chroot_directory::get_chroot_type (  )  const [virtual]

Get the type of the chroot.

Returns:
the chroot type.

Implements sbuild::chroot.

void chroot_directory::get_details ( chroot const &  chroot,
format_detail detail 
) const [protected, virtual]

Get detailed information about the chroot for output.

Parameters:
chroot the chroot to use.
detail the details to output to.

Reimplemented from sbuild::chroot_directory_base.

void chroot_directory::get_keyfile ( chroot const &  chroot,
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:
chroot the chroot to use.
keyfile the keyfile to use.

Reimplemented from sbuild::chroot_directory_base.

std::string chroot_directory::get_path (  )  const [virtual]

Get the path to the chroot.

This is the absolute path to the root of the chroot, and is typically the same as the mount location and location concatenated together, but is overridden by the chroot type if required.

Returns:
the path.

Implements sbuild::chroot.

References sbuild::chroot::get_mount_location().

sbuild::chroot::session_flags chroot_directory::get_session_flags ( chroot const &  chroot  )  const [virtual]

Get the session flags of the chroot.

These determine how the Session controlling the chroot will operate.

Parameters:
chroot the chroot to use.
Returns:
the session flags.

Implements sbuild::chroot.

References sbuild::chroot::SESSION_NOFLAGS.

void chroot_directory::set_keyfile ( chroot chroot,
keyfile const &  keyfile,
string_list used_keys 
) [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:
chroot the chroot to use.
keyfile the keyfile to get the properties from.
used_keys a list of the keys used will be set.

Reimplemented from sbuild::chroot_directory_base.

void chroot_directory::setup_env ( chroot const &  chroot,
environment env 
) const [virtual]

Set environment.

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

Parameters:
chroot the chroot to use.
env the environment to set.

Reimplemented from sbuild::chroot_directory_base.

void chroot_directory::setup_lock ( chroot::setup_type  type,
bool  lock,
int  status 
) [protected, virtual]

Unlock a chroot during setup.

The locking technique (if any) may vary depending upon the chroot type and setup stage. For example, during creation of an LVM snapshot a block device might require locking, but afterwards this will change to the new block device.

An error will be thrown on failure.

Parameters:
type the type of setup being performed
lock true to lock, false to unlock
status the exit status of the setup commands (0 for success, nonzero for failure).

Implements sbuild::chroot.

References sbuild::chroot::setup_session_info(), sbuild::chroot::SETUP_START, and sbuild::chroot::SETUP_STOP.


Friends And Related Function Documentation

friend class chroot [friend]

Reimplemented from sbuild::chroot_directory_base.


The documentation for this class was generated from the following files:
Generated on Sat Jul 10 22:17:05 2010 for sbuild by  doxygen 1.6.3