sbuild::chroot_loopback Class Reference

A chroot stored in a file for loopback mounting. More...

#include <sbuild-chroot-loopback.h>

Inheritance diagram for sbuild::chroot_loopback:

[legend]

Collaboration diagram for sbuild::chroot_loopback:

[legend]

List of all members.

Public Types
typedef chroot::error	error
	Exception type.
Public Member Functions
virtual	~chroot_loopback ()
	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.
std::string const &	get_file () const
	Get the file containing the chroot.
void	set_file (std::string const &file)
	Set the file containing the chroot.
std::string const &	get_chroot_type () const
	Get the type of the chroot.
virtual std::string	get_path () const
	Get the path to the chroot.
virtual void	setup_env (chroot const &chroot, environment &env) const
virtual session_flags	get_session_flags (chroot const &chroot) const
Protected Member Functions
	chroot_loopback ()
	The constructor.
	chroot_loopback (const chroot_loopback &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
virtual void	get_keyfile (chroot const &chroot, keyfile &keyfile) const
virtual void	set_keyfile (chroot &chroot, keyfile const &keyfile, string_list &used_keys)
Private Attributes
std::string	file
	The file to use.
Friends
class	chroot

Detailed Description

A chroot stored in a file for loopback mounting.

The file will be mounted on demand.

Member Typedef Documentation

typedef chroot::error sbuild::chroot_loopback::error

Exception type.

Reimplemented from sbuild::chroot.

Constructor & Destructor Documentation

chroot_loopback::chroot_loopback ( ) [protected]

The constructor.

References sbuild::chroot::add_facet(), sbuild::chroot_facet_union::create(), and sbuild::chroot_facet_mountable::create().

Referenced by clone(), clone_session(), and clone_source().

chroot_loopback::chroot_loopback ( const chroot_loopback & rhs ) [protected]

The copy constructor.

chroot_loopback::~chroot_loopback ( ) [virtual]

The destructor.

Member Function Documentation

sbuild::chroot::ptr chroot_loopback::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_loopback().

Referenced by clone_source().

sbuild::chroot::ptr chroot_loopback::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_loopback().

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

Create a source chroot.

Returns:: a source chroot.

Implements sbuild::chroot.

References chroot_loopback(), and clone().

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

Get the type of the chroot.

Returns:: the chroot type.

Implements sbuild::chroot.

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

References sbuild::format_detail::add(), file, and get_file().

std::string const & chroot_loopback::get_file ( ) const

Get the file containing the chroot.

Returns:: the file.

References file.

Referenced by get_details(), get_keyfile(), and setup_env().

void chroot_loopback::get_keyfile	(	chroot const &	chroot,
		keyfile &	keyfile
	)			const `[protected, virtual]`

References get_file(), sbuild::chroot::get_keyfile_name(), and sbuild::basic_keyfile< K, P >::set_object_value().

std::string chroot_loopback::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_loopback::get_session_flags ( chroot const & chroot ) const [virtual]

References sbuild::chroot::SESSION_NOFLAGS.

void chroot_loopback::set_file ( std::string const & file )

Set the file containing the chroot.

Parameters:

file

the file.

References sbuild::chroot::FILE_ABS, and sbuild::is_absname().

Referenced by set_keyfile().

void chroot_loopback::set_keyfile	(	chroot &	chroot,
		keyfile const &	keyfile,
		string_list &	used_keys
	)			`[protected, virtual]`

References sbuild::chroot::get_keyfile_name(), sbuild::basic_keyfile< K, P >::get_object_value(), sbuild::keyfile_base::PRIORITY_REQUIRED, and set_file().

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

References sbuild::environment::add(), and get_file().

void chroot_loopback::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).