publish::SettingsTransaction Class Reference

#include <settings.h>

Collaboration diagram for publish::SettingsTransaction:

Public Member Functions
	SettingsTransaction (const std::string &fqrn)
void	SetLayoutRevision (const unsigned revision)
void	SetInEnterSession (const bool value)
void	SetBaseHash (const shash::Any &hash)
void	SetUnionFsType (const std::string &union_fs)
void	SetHashAlgorithm (const std::string &algorithm)
void	SetCompressionAlgorithm (const std::string &algorithm)
void	SetEnforceLimits (bool value)
void	SetEnableMtimeNs (bool value)
void	SetLimitNestedCatalogKentries (unsigned value)
void	SetLimitRootCatalogKentries (unsigned value)
void	SetLimitFileSizeMb (unsigned value)
void	SetUseCatalogAutobalance (bool value)
void	SetAutobalanceMaxWeight (unsigned value)
void	SetAutobalanceMinWeight (unsigned value)
void	SetPrintChangeset (bool value)
void	SetDryRun (bool value)
void	SetTimeout (unsigned seconds)
void	SetLeasePath (const std::string &path)
void	SetTemplate (const std::string &from, const std::string &to)
void	DetectUnionFsType ()
int	GetTimeoutS () const
unsigned	layout_revision () const
bool	in_enter_session () const
shash::Any	base_hash () const
shash::Algorithms	hash_algorithm () const
zlib::Algorithms	compression_algorithm () const
uint32_t	ttl_second () const
bool	is_garbage_collectable () const
bool	is_volatile () const
bool	enforce_limits () const
bool	enable_mtime_ns () const
unsigned	limit_nested_catalog_kentries () const
unsigned	limit_root_catalog_kentries () const
unsigned	limit_file_size_mb () const
bool	use_catalog_autobalance () const
unsigned	autobalance_max_weight () const
unsigned	autobalance_min_weight () const
bool	print_changeset () const
bool	dry_run () const
std::string	voms_authz () const
UnionFsType	union_fs () const
std::string	lease_path () const
std::string	template_from () const
std::string	template_to () const
const SettingsSpoolArea &	spool_area () const
SettingsSpoolArea *	GetSpoolArea ()
bool	HasTemplate () const

Private Member Functions
bool	ValidateUnionFs ()

Private Attributes
Setting< unsigned >	layout_revision_
Setting< bool >	in_enter_session_
Setting< shash::Any >	base_hash_
Setting< shash::Algorithms >	hash_algorithm_
Setting< zlib::Algorithms >	compression_algorithm_
Setting< uint32_t >	ttl_second_
Setting< bool >	is_garbage_collectable_
Setting< bool >	is_volatile_
Setting< bool >	enforce_limits_
Setting< bool >	enable_mtime_ns_
Setting< unsigned >	limit_nested_catalog_kentries_
Setting< unsigned >	limit_root_catalog_kentries_
Setting< unsigned >	limit_file_size_mb_
Setting< bool >	use_catalog_autobalance_
Setting< unsigned >	autobalance_max_weight_
Setting< unsigned >	autobalance_min_weight_
Setting< bool >	print_changeset_
Setting< bool >	dry_run_
Setting< std::string >	voms_authz_
Setting< UnionFsType >	union_fs_
Setting< unsigned >	timeout_s_
Setting< std::string >	lease_path_
Setting< std::string >	template_from_
Setting< std::string >	template_to_
SettingsSpoolArea	spool_area_

Detailed Description

Definition at line 133 of file settings.h.

Constructor & Destructor Documentation

publish::SettingsTransaction::SettingsTransaction ( const std::string &  fqrn )

inlineexplicit

Definition at line 135 of file settings.h.

Member Function Documentation

unsigned publish::SettingsTransaction::autobalance_max_weight ( ) const

inline

Definition at line 209 of file settings.h.

unsigned publish::SettingsTransaction::autobalance_min_weight ( ) const

inline

Definition at line 210 of file settings.h.

shash::Any publish::SettingsTransaction::base_hash ( ) const

inline

Definition at line 191 of file settings.h.

zlib::Algorithms publish::SettingsTransaction::compression_algorithm ( ) const

inline

Definition at line 193 of file settings.h.

void publish::SettingsTransaction::DetectUnionFsType

(

)

Definition at line 138 of file settings.cc.

Referenced by publish::CmdMkfs::Main().

Here is the call graph for this function:

Here is the caller graph for this function:

bool publish::SettingsTransaction::dry_run ( ) const

inline

Definition at line 212 of file settings.h.

bool publish::SettingsTransaction::enable_mtime_ns ( ) const

inline

Definition at line 200 of file settings.h.

bool publish::SettingsTransaction::enforce_limits ( ) const

inline

Definition at line 199 of file settings.h.

SettingsSpoolArea* publish::SettingsTransaction::GetSpoolArea ( )

inline

Definition at line 220 of file settings.h.

Referenced by publish::SettingsBuilder::ApplyOptionsFromServerPath(), and publish::CmdMkfs::Main().

Here is the caller graph for this function:

int publish::SettingsTransaction::GetTimeoutS

(

)

const

0 - wait infinitely <0: unset, fail immediately

Definition at line 162 of file settings.cc.

Here is the call graph for this function:

shash::Algorithms publish::SettingsTransaction::hash_algorithm ( ) const

inline

Definition at line 192 of file settings.h.

bool publish::SettingsTransaction::HasTemplate ( ) const

inline

Definition at line 222 of file settings.h.

Here is the call graph for this function:

bool publish::SettingsTransaction::in_enter_session ( ) const

inline

Definition at line 190 of file settings.h.

Referenced by publish::Publisher().

Here is the caller graph for this function:

bool publish::SettingsTransaction::is_garbage_collectable ( ) const

inline

Definition at line 197 of file settings.h.

bool publish::SettingsTransaction::is_volatile ( ) const

inline

Definition at line 198 of file settings.h.

unsigned publish::SettingsTransaction::layout_revision ( ) const

inline

Definition at line 189 of file settings.h.

Referenced by publish::Publisher().

Here is the caller graph for this function:

std::string publish::SettingsTransaction::lease_path ( ) const

inline

Definition at line 215 of file settings.h.

unsigned publish::SettingsTransaction::limit_file_size_mb ( ) const

inline

Definition at line 207 of file settings.h.

unsigned publish::SettingsTransaction::limit_nested_catalog_kentries ( ) const

inline

Definition at line 201 of file settings.h.

unsigned publish::SettingsTransaction::limit_root_catalog_kentries ( ) const

inline

Definition at line 204 of file settings.h.

bool publish::SettingsTransaction::print_changeset ( ) const

inline

Definition at line 211 of file settings.h.

void publish::SettingsTransaction::SetAutobalanceMaxWeight

(

unsigned

value

)

Definition at line 110 of file settings.cc.

Referenced by publish::SettingsBuilder::ApplyOptionsFromServerPath().

Here is the caller graph for this function:

void publish::SettingsTransaction::SetAutobalanceMinWeight

(

unsigned

value

)

Definition at line 114 of file settings.cc.

Referenced by publish::SettingsBuilder::ApplyOptionsFromServerPath().

Here is the caller graph for this function:

void publish::SettingsTransaction::SetBaseHash

(

const shash::Any &

hash

)

Definition at line 73 of file settings.cc.

void publish::SettingsTransaction::SetCompressionAlgorithm

(

const std::string &

algorithm

)

Definition at line 81 of file settings.cc.

Referenced by publish::SettingsBuilder::ApplyOptionsFromServerPath().

Here is the call graph for this function:

Here is the caller graph for this function:

void publish::SettingsTransaction::SetDryRun

(

bool

value

)

Definition at line 122 of file settings.cc.

void publish::SettingsTransaction::SetEnableMtimeNs

(

bool

value

)

Definition at line 90 of file settings.cc.

Referenced by publish::SettingsBuilder::ApplyOptionsFromServerPath().

Here is the caller graph for this function:

void publish::SettingsTransaction::SetEnforceLimits

(

bool

value

)

Definition at line 86 of file settings.cc.

Referenced by publish::SettingsBuilder::ApplyOptionsFromServerPath().

Here is the caller graph for this function:

void publish::SettingsTransaction::SetHashAlgorithm

(

const std::string &

algorithm

)

Definition at line 77 of file settings.cc.

Referenced by publish::SettingsBuilder::ApplyOptionsFromServerPath().

Here is the call graph for this function:

Here is the caller graph for this function:

void publish::SettingsTransaction::SetInEnterSession

(

const bool

value

)

Definition at line 69 of file settings.cc.

void publish::SettingsTransaction::SetLayoutRevision

(

const unsigned

revision

)

Definition at line 65 of file settings.cc.

Referenced by publish::SettingsBuilder::ApplyOptionsFromServerPath().

Here is the caller graph for this function:

void publish::SettingsTransaction::SetLeasePath

(

const std::string &

path

)

Definition at line 168 of file settings.cc.

void publish::SettingsTransaction::SetLimitFileSizeMb

(

unsigned

value

)

Definition at line 102 of file settings.cc.

Referenced by publish::SettingsBuilder::ApplyOptionsFromServerPath().

Here is the caller graph for this function:

void publish::SettingsTransaction::SetLimitNestedCatalogKentries

(

unsigned

value

)

Definition at line 94 of file settings.cc.

Referenced by publish::SettingsBuilder::ApplyOptionsFromServerPath().

Here is the caller graph for this function:

void publish::SettingsTransaction::SetLimitRootCatalogKentries

(

unsigned

value

)

Definition at line 98 of file settings.cc.

Referenced by publish::SettingsBuilder::ApplyOptionsFromServerPath().

Here is the caller graph for this function:

void publish::SettingsTransaction::SetPrintChangeset

(

bool

value

)

Definition at line 118 of file settings.cc.

void publish::SettingsTransaction::SetTemplate	(	const std::string &	from,
		const std::string &	to
	)

Definition at line 172 of file settings.cc.

void publish::SettingsTransaction::SetTimeout

(

unsigned

seconds

)

Definition at line 158 of file settings.cc.

void publish::SettingsTransaction::SetUnionFsType

(

const std::string &

union_fs

)

Definition at line 126 of file settings.cc.

Referenced by publish::SettingsBuilder::ApplyOptionsFromServerPath(), and publish::CmdMkfs::Main().

Here is the caller graph for this function:

void publish::SettingsTransaction::SetUseCatalogAutobalance

(

bool

value

)

Definition at line 106 of file settings.cc.

Referenced by publish::SettingsBuilder::ApplyOptionsFromServerPath().

Here is the caller graph for this function:

const SettingsSpoolArea& publish::SettingsTransaction::spool_area ( ) const

inline

Definition at line 219 of file settings.h.

Referenced by publish::CmdMkfs::Main().

Here is the caller graph for this function:

std::string publish::SettingsTransaction::template_from ( ) const

inline

Definition at line 216 of file settings.h.

std::string publish::SettingsTransaction::template_to ( ) const

inline

Definition at line 217 of file settings.h.

Referenced by HasTemplate().

Here is the caller graph for this function:

uint32_t publish::SettingsTransaction::ttl_second ( ) const

inline

Definition at line 196 of file settings.h.

UnionFsType publish::SettingsTransaction::union_fs ( ) const

inline

Definition at line 214 of file settings.h.

bool publish::SettingsTransaction::use_catalog_autobalance ( ) const

inline

Definition at line 208 of file settings.h.

bool publish::SettingsTransaction::ValidateUnionFs ( )

private

Definition at line 153 of file settings.cc.

std::string publish::SettingsTransaction::voms_authz ( ) const

inline

Definition at line 213 of file settings.h.

Member Data Documentation

Setting<unsigned> publish::SettingsTransaction::autobalance_max_weight_

private

Definition at line 255 of file settings.h.

Referenced by autobalance_max_weight(), and SetAutobalanceMaxWeight().

Setting<unsigned> publish::SettingsTransaction::autobalance_min_weight_

private

Definition at line 256 of file settings.h.

Referenced by autobalance_min_weight(), and SetAutobalanceMinWeight().

Setting<shash::Any> publish::SettingsTransaction::base_hash_

private

The root catalog hash based on which the transaction takes place. Usually the current root catalog from the manifest, which should be equal to the root hash of the mounted read-only volume. In some cases, this can be different though, e.g. for checked out branches or after silent transactions such as template transactions.

Definition at line 243 of file settings.h.

Referenced by base_hash(), and SetBaseHash().

Setting<zlib::Algorithms> publish::SettingsTransaction::compression_algorithm_

private

Definition at line 245 of file settings.h.

Referenced by compression_algorithm(), and SetCompressionAlgorithm().

Setting<bool> publish::SettingsTransaction::dry_run_

private

Definition at line 258 of file settings.h.

Referenced by dry_run(), and SetDryRun().

Setting<bool> publish::SettingsTransaction::enable_mtime_ns_

private

Definition at line 250 of file settings.h.

Referenced by enable_mtime_ns(), and SetEnableMtimeNs().

Setting<bool> publish::SettingsTransaction::enforce_limits_

private

Definition at line 249 of file settings.h.

Referenced by enforce_limits(), and SetEnforceLimits().

Setting<shash::Algorithms> publish::SettingsTransaction::hash_algorithm_

private

Definition at line 244 of file settings.h.

Referenced by hash_algorithm(), and SetHashAlgorithm().

Setting<bool> publish::SettingsTransaction::in_enter_session_

private

Set to true if the settings have been created from the environment of the ephemeral writable shell (cvmfs_server enter command).

Definition at line 235 of file settings.h.

Referenced by in_enter_session(), and SetInEnterSession().

Setting<bool> publish::SettingsTransaction::is_garbage_collectable_

private

Definition at line 247 of file settings.h.

Referenced by is_garbage_collectable().

Setting<bool> publish::SettingsTransaction::is_volatile_

private

Definition at line 248 of file settings.h.

Referenced by is_volatile().

Setting<unsigned> publish::SettingsTransaction::layout_revision_

private

See CVMFS_CREATOR_VERSION

Definition at line 230 of file settings.h.

Referenced by layout_revision(), and SetLayoutRevision().

Setting<std::string> publish::SettingsTransaction::lease_path_

private

Definition at line 265 of file settings.h.

Referenced by lease_path(), and SetLeasePath().

Setting<unsigned> publish::SettingsTransaction::limit_file_size_mb_

private

Definition at line 253 of file settings.h.

Referenced by limit_file_size_mb(), and SetLimitFileSizeMb().

Setting<unsigned> publish::SettingsTransaction::limit_nested_catalog_kentries_

private

Definition at line 251 of file settings.h.

Referenced by limit_nested_catalog_kentries(), and SetLimitNestedCatalogKentries().

Setting<unsigned> publish::SettingsTransaction::limit_root_catalog_kentries_

private

Definition at line 252 of file settings.h.

Referenced by limit_root_catalog_kentries(), and SetLimitRootCatalogKentries().

Setting<bool> publish::SettingsTransaction::print_changeset_

private

Definition at line 257 of file settings.h.

Referenced by print_changeset(), and SetPrintChangeset().

SettingsSpoolArea publish::SettingsTransaction::spool_area_

private

Definition at line 273 of file settings.h.

Referenced by GetSpoolArea(), and spool_area().

Setting<std::string> publish::SettingsTransaction::template_from_

private

Used for template transactions where a directory tree gets cloned (from –> to) as part of opening the transaction

Definition at line 270 of file settings.h.

Referenced by SetTemplate(), and template_from().

Setting<std::string> publish::SettingsTransaction::template_to_

private

Definition at line 271 of file settings.h.

Referenced by SetTemplate(), and template_to().

Setting<unsigned> publish::SettingsTransaction::timeout_s_

private

How long to retry taking a lease before giving up

Definition at line 264 of file settings.h.

Referenced by GetTimeoutS(), and SetTimeout().

Setting<uint32_t> publish::SettingsTransaction::ttl_second_

private

Definition at line 246 of file settings.h.

Referenced by ttl_second().

Setting<UnionFsType> publish::SettingsTransaction::union_fs_

private

Definition at line 260 of file settings.h.

Referenced by DetectUnionFsType(), SetUnionFsType(), and union_fs().

Setting<bool> publish::SettingsTransaction::use_catalog_autobalance_

private

Definition at line 254 of file settings.h.

Referenced by SetUseCatalogAutobalance(), and use_catalog_autobalance().

Setting<std::string> publish::SettingsTransaction::voms_authz_

private

Definition at line 259 of file settings.h.

Referenced by voms_authz().

---

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

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