publish::CmdEnter Class Reference

#include <cmd_enter.h>

Inheritance diagram for publish::CmdEnter:

Collaboration diagram for publish::CmdEnter:

Public Member Functions
	CmdEnter ()
virtual std::string	GetName () const
virtual std::string	GetBrief () const
virtual std::string	GetUsage () const
virtual ParameterList	GetParams () const
virtual unsigned	GetMinPlainArgs () const
virtual int	Main (const Options &options)
Public Member Functions inherited from publish::Command
virtual	~Command ()
virtual std::string	GetDescription () const
std::string	GetExamples () const
virtual bool	IsHidden () const
Options	ParseOptions (int argc, char **argv)
std::string	progname () const

Private Member Functions
void	MountOverlayfs ()
void	CreateUnderlay (const std::string &source_dir, const std::string &dest_dir, const std::vector< std::string > &empty_dirs, std::vector< std::string > *new_paths)
void	WriteCvmfsConfig (const std::string &extra_config)
void	MountCvmfs ()
pid_t	RunInteractiveShell ()
std::string	GetCvmfsXattr (const std::string &name)
void	CleanupSession (bool keep_logs, const std::vector< std::string > &new_paths)

Private Attributes
SettingsSpoolArea	settings_spool_area_
std::string	fqrn_
std::string	cvmfs2_binary_
std::string	repo_config_
std::string	overlayfs_binary_
std::string	session_dir_
	In $HOME/.cvmfs/fqrn, container spool area. More...
std::string	env_conf_
	Stores the session directory environment. More...
std::string	rootfs_dir_
	Destination to chroot() to in the namespace. More...
std::string	stdout_path_
	Logs stdout of background commands. More...
std::string	stderr_path_
	Logs stdout of background commands. More...

Additional Inherited Members
Public Types inherited from publish::Command
typedef std::vector< Parameter >	ParameterList
Protected Member Functions inherited from publish::Command
virtual std::vector< std::string >	DoGetExamples () const

Detailed Description

Definition at line 18 of file cmd_enter.h.

Constructor & Destructor Documentation

publish::CmdEnter::CmdEnter ( )

inline

Definition at line 20 of file cmd_enter.h.

Member Function Documentation

void publish::CmdEnter::CleanupSession ( bool  keep_logs, const std::vector< std::string > &  new_paths  )

private

Definition at line 400 of file cmd_enter.cc.

Here is the call graph for this function:

void publish::CmdEnter::CreateUnderlay ( const std::string &  source_dir, const std::string &  dest_dir, const std::vector< std::string > &  empty_dirs, std::vector< std::string > *  new_paths  )

private

Definition at line 156 of file cmd_enter.cc.

Here is the call graph for this function:

virtual std::string publish::CmdEnter::GetBrief ( ) const

inlinevirtual

A one-line explanation of what the command does

Implements publish::Command.

Definition at line 26 of file cmd_enter.h.

std::string publish::CmdEnter::GetCvmfsXattr ( const std::string &  name )

private

Definition at line 388 of file cmd_enter.cc.

Here is the call graph for this function:

virtual unsigned publish::CmdEnter::GetMinPlainArgs ( ) const

inlinevirtual

The command needs at least so many non-parameter arguments (e.g. fqrn)

Reimplemented from publish::Command.

Definition at line 54 of file cmd_enter.h.

virtual std::string publish::CmdEnter::GetName ( ) const

inlinevirtual

Used to call the command as cvmfs_server $GetName() ...

Implements publish::Command.

Definition at line 25 of file cmd_enter.h.

virtual ParameterList publish::CmdEnter::GetParams ( ) const

inlinevirtual

Returns the ordered array of possible parameters to this command

Implements publish::Command.

Definition at line 33 of file cmd_enter.h.

Here is the call graph for this function:

virtual std::string publish::CmdEnter::GetUsage ( ) const

inlinevirtual

Reimplemented from publish::Command.

Definition at line 29 of file cmd_enter.h.

int publish::CmdEnter::Main ( const Options &  options )

virtual

The dictionary of passed arguments can be obtained by a call to ParseOptions()

Implements publish::Command.

Definition at line 469 of file cmd_enter.cc.

Here is the call graph for this function:

void publish::CmdEnter::MountCvmfs ( )

private

Definition at line 290 of file cmd_enter.cc.

Here is the call graph for this function:

void publish::CmdEnter::MountOverlayfs ( )

private

Definition at line 342 of file cmd_enter.cc.

Here is the call graph for this function:

pid_t publish::CmdEnter::RunInteractiveShell ( )

private

void publish::CmdEnter::WriteCvmfsConfig ( const std::string &  extra_config )

private

Definition at line 255 of file cmd_enter.cc.

Here is the call graph for this function:

Member Data Documentation

std::string publish::CmdEnter::cvmfs2_binary_

private

Definition at line 74 of file cmd_enter.h.

std::string publish::CmdEnter::env_conf_

private

Stores the session directory environment.

Definition at line 78 of file cmd_enter.h.

std::string publish::CmdEnter::fqrn_

private

Definition at line 73 of file cmd_enter.h.

std::string publish::CmdEnter::overlayfs_binary_

private

Definition at line 76 of file cmd_enter.h.

std::string publish::CmdEnter::repo_config_

private

Definition at line 75 of file cmd_enter.h.

std::string publish::CmdEnter::rootfs_dir_

private

Destination to chroot() to in the namespace.

Definition at line 79 of file cmd_enter.h.

std::string publish::CmdEnter::session_dir_

private

In $HOME/.cvmfs/fqrn, container spool area.

Definition at line 77 of file cmd_enter.h.

SettingsSpoolArea publish::CmdEnter::settings_spool_area_

private

Definition at line 72 of file cmd_enter.h.

std::string publish::CmdEnter::stderr_path_

private

Logs stdout of background commands.

Definition at line 81 of file cmd_enter.h.

std::string publish::CmdEnter::stdout_path_

private

Logs stdout of background commands.

Definition at line 80 of file cmd_enter.h.

---

The documentation for this class was generated from the following files:

• /home/sftnight/jenkins/workspace/CvmfsDoxygen/label/docker-x86_64/cvmfs/cvmfs/publish/cmd_enter.h
• /home/sftnight/jenkins/workspace/CvmfsDoxygen/label/docker-x86_64/cvmfs/cvmfs/publish/cmd_enter.cc