Main Interface Class to work with the File Catalog of the experiment Throws runtime_exception if a critical error occurrs while the constructor Error Codes: -1 - sending command via CURL failed, -401 - unauthorized request, -403 - token invalid or expired, -404 - data not found, -409 - incorrect database request (e.g. More...

#include <FileCatalogue.h>

Public Member Functions
	FileCatalogue ()
virtual	~FileCatalogue ()
int	GetFileList (vector< unique_ptr< FileCondition > > file_conditions, vector< string > &filepaths)
	Function for searching for file metadata in the File Catalog using specified conditions.
int	GetFileInfo (string LFN, FileInfo &file_info)
	Function to get metadata of the file stored at the given location.
int	GetDirectoryInfo (string path, string &directory_info)
	Function to get metadata of the directory at the given path.
int	GetConsistencyCheckStatus ()
	Function to get status of the last successful consistency check.
int	GetConsistencyCheckResults (int &eos_missing_count, int &fc_missing_count, vector< string > &eos_missing, vector< string > &fc_missing)
	Function to get result of the last successful consistency check.
int	GetFile (string LFN, string save_path)
	Function to download file from the CICC (Dirac FC).
int	GetPFNs (string LFN, vector< string > &PFNs)
	Function to get file PFN (Physical File Name).
int	AddFileInfo (string LFN, FileInfo file_metadata)
	Function to add metadata for the file with specific LFN.
int	AddFileInfo (string json_file_path)
	Function to add file metadata to the File Catalog using input JSON file path.
int	AddDirectoryInfo (string json_file_path)
	Function to add directory metadata to the File Catalog using input JSON directory path.
int	AddMetadataField (string field_name, string field_type, bool isDirectoryType=true)
	Function to add new metadata field to the File Catalog.
int	AddFile (string input_path, string LFN)
	Function to add file to the File Catalog and upload to CICC.
int	UpdateFileInfo (string LFN, FileInfo file_metadata)
	Function to update metadata for the file with specific LFN.
int	DeleteFileInfo (string LFN)
	Function to delete metadata for the file with specific LFN.
int	DeleteDirectoryInfo (string path)
	Function to delete metadata for the directory at specific path.
int	DeleteMetadataField (string metadatafield_name)
	Function to delete metadata field from the File Catalog.
int	DeleteFile (string LFN)
	Function to delete file from the File Catalog and CICC.
int	CheckFileInfo (string LFN)
	Function to check metadata for the file with specific LFN.
int	CheckFileExist (string LFN)
	Function to check whether file exist or not.
int	PrintFileInfo (string LFN)
	Function to print metadata for the file stored at the given location.
int	PrintMetadataFields ()
	Function to print current metadata fields.
int	FileCatalogRequest (string rest_api_request, vector< string > &filepaths)
	Function for searching for files matching specific metadata in the File Catalog using REST API request as an HTTP(s) string.
int	FileCatalogConsistencyCheck ()
	Function to perform a consistency check in the File Catalog.
int	FileCatalogStats (int &files_count, int &files_without_replicas, int &replicas_count, int &replicas_without_files)
	Function to collect summary statistics on the File Catalog.
void	SetVerbose (int verbose_level=0)
	Setting Verbose level: 0 - only errors, 1 - normal output, 2 - detailed output, 3 - all with debug info.
	FileCatalogue ()
virtual	~FileCatalogue ()
int	GetFileList (vector< unique_ptr< FileCondition > > file_conditions, vector< string > &filepaths)
	Function for searching for file metadata in the File Catalog using specified conditions.
int	GetFileInfo (string LFN, FileInfo &file_info)
	Function to get metadata of the file stored at the given location.
int	GetDirectoryInfo (string path, string &directory_info)
	Function to get metadata of the directory at the given path.
int	GetConsistencyCheckStatus ()
	Function to get status of the last successful consistency check.
int	GetConsistencyCheckResults (int &eos_missing_count, int &fc_missing_count, vector< string > &eos_missing, vector< string > &fc_missing)
	Function to get result of the last successful consistency check.
int	GetFile (string LFN, string save_path)
	Function to download file from the CICC (Dirac FC).
int	GetPFNs (string LFN, vector< string > &PFNs)
	Function to get file PFN (Physical File Name).
int	AddFileInfo (string LFN, FileInfo file_metadata)
	Function to add metadata for the file with specific LFN.
int	AddFileInfo (string json_file_path)
	Function to add file metadata to the File Catalog using input JSON file path.
int	AddDirectoryInfo (string json_file_path)
	Function to add directory metadata to the File Catalog using input JSON directory path.
int	AddMetadataField (string field_name, string field_type, bool isDirectoryType=true)
	Function to add new metadata field to the File Catalog.
int	AddFile (string input_path, string LFN)
	Function to add file to the File Catalog and upload to CICC.
int	UpdateFileInfo (string LFN, FileInfo file_metadata)
	Function to update metadata for the file with specific LFN.
int	DeleteFileInfo (string LFN)
	Function to delete metadata for the file with specific LFN.
int	DeleteDirectoryInfo (string path)
	Function to delete metadata for the directory at specific path.
int	DeleteMetadataField (string metadatafield_name)
	Function to delete metadata field from the File Catalog.
int	DeleteFile (string LFN)
	Function to delete file from the File Catalog and CICC.
int	CheckFileInfo (string LFN)
	Function to check metadata for the file with specific LFN.
int	CheckFileExist (string LFN)
	Function to check whether file exist or not.
int	PrintFileInfo (string LFN)
	Function to print metadata for the file stored at the given location.
int	PrintMetadataFields ()
	Function to print current metadata fields.
int	FileCatalogRequest (string rest_api_request, vector< string > &filepaths)
	Function for searching for files matching specific metadata in the File Catalog using REST API request as an HTTP(s) string.
int	FileCatalogConsistencyCheck ()
	Function to perform a consistency check in the File Catalog.
int	FileCatalogStats (int &files_count, int &files_without_replicas, int &replicas_count, int &replicas_without_files)
	Function to collect summary statistics on the File Catalog.
void	SetVerbose (int verbose_level=0)
	Setting Verbose level: 0 - only errors, 1 - normal output, 2 - detailed output, 3 - all with debug info.

Private Member Functions
string	performRequest (string conditions, string json_content, string qType)
	Perfrom common curl read/write shenanigans.
int	DownloadFile (string conditions, string savePath)
int	UploadFile (string conditions, string filepath)
string	performRequest (string conditions, string json_content, string qType)
	Perfrom common curl read/write shenanigans.
int	DownloadFile (string conditions, string savePath)
int	UploadFile (string conditions, string filepath)

Private Attributes
CURL *	curlInstance
string	ServiceUrl
string	ServiceAccount
int	VerboseLevel = 0

Detailed Description

violating constraints), -422 - incorrect input request, -500 - internal server error, -503 - service unavaialble, -504 - gateway timeout

Definition at line 134 of file FileCatalogue.h.

Constructor & Destructor Documentation

◆ FileCatalogue() [1/2]

FileCatalogue::FileCatalogue ( )

Definition at line 104 of file FileCatalogue.cxx.

References curlInstance, FILE_API_HOST, FILE_API_NAME, FILE_API_PASSWORD, FILE_API_USERNAME, ServiceAccount, ServiceUrl, and FileInfo::Version.

◆ ~FileCatalogue() [1/2]

FileCatalogue::~FileCatalogue ( )

virtual

Definition at line 119 of file FileCatalogue.cxx.

References curlInstance.

◆ FileCatalogue() [2/2]

FileCatalogue::FileCatalogue ( )

◆ ~FileCatalogue() [2/2]

virtual FileCatalogue::~FileCatalogue ( )

virtual

Member Function Documentation

◆ AddDirectoryInfo() [1/2]

int FileCatalogue::AddDirectoryInfo ( string json_file_path )

dir_path field for path to directory

Parameters

[in] json_file_path path of the JSON file containing a set of directory metadata to be stored

Returns: 0 - if successful, error_code (<0) in case of failures

Definition at line 486 of file FileCatalogue.cxx.

References performRequest().

Here is the call graph for this function:

◆ AddDirectoryInfo() [2/2]

int FileCatalogue::AddDirectoryInfo ( string json_file_path )

dir_path field for path to directory

Parameters

[in] json_file_path path of the JSON file containing a set of directory metadata to be stored

Returns: 0 - if successful, error_code (<0) in case of failures

◆ AddFile() [1/2]

int FileCatalogue::AddFile	(	string	input_path,
		string	LFN )

Parameters

[in]	input_path	local path to the file
[in]	LFN	LFN of the output file on the CICC and FileCatalogue

Returns: 0 - if successfully added, error_code (<0) in case of failures

Definition at line 508 of file FileCatalogue.cxx.

References UploadFile().

Here is the call graph for this function:

◆ AddFile() [2/2]

int FileCatalogue::AddFile	(	string	input_path,
		string	LFN )

Parameters

[in]	input_path	local path to the file
[in]	LFN	LFN of the output file on the CICC and FileCatalogue

Returns: 0 - if successfully added, error_code (<0) in case of failures

◆ AddFileInfo() [1/4]

int FileCatalogue::AddFileInfo ( string json_file_path )

Parameters

[in] json_file_path path of the JSON file containing a set of file metadata to be stored

Returns: 0 - if successful, error_code (<0) in case of failures

Definition at line 463 of file FileCatalogue.cxx.

References performRequest().

Here is the call graph for this function:

◆ AddFileInfo() [2/4]

int FileCatalogue::AddFileInfo ( string json_file_path )

Parameters

[in] json_file_path path of the JSON file containing a set of file metadata to be stored

Returns: 0 - if successful, error_code (<0) in case of failures

◆ AddFileInfo() [3/4]

int FileCatalogue::AddFileInfo	(	string	LFN,
		FileInfo	file_metadata )

Parameters

[in]	LFN	Logical File Name of the file
[in]	file_metadata	'FileInfo' object containing file metadata

Returns: 0 - if successful, error_code (<0) in case of failures

Definition at line 401 of file FileCatalogue.cxx.

References FileInfo::BeamParticle, FileInfo::EndDateTime, FileInfo::EndEvent, FileInfo::Energy, FileInfo::EventCount, FileInfo::FieldVoltage, FileInfo::FileSize, performRequest(), FileInfo::RunNumber, FileInfo::RunType, FileInfo::StartDateTime, FileInfo::StartEvent, and FileInfo::TargetParticle.

Referenced by UpdateFileInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddFileInfo() [4/4]

int FileCatalogue::AddFileInfo	(	string	LFN,
		FileInfo	file_metadata )

Parameters

[in]	LFN	Logical File Name of the file
[in]	file_metadata	'FileInfo' object containing file metadata

Returns: 0 - if successful, error_code (<0) in case of failures

◆ AddMetadataField() [1/2]

int FileCatalogue::AddMetadataField	(	string	field_name,
		string	field_type,
		bool	isDirectoryType = true )

Parameters

[in]	field_name	metadata field name to be added
[in]	field_type	metadata field type (INT, DATETIME, FLOAT, VARCHAR(128))
[in]	isDirectoryType	which type of field is needed. Directory or file

Returns: 0 - if successfully added, error_code (<0) in case of failures

Definition at line 427 of file FileCatalogue.cxx.

References performRequest().

Here is the call graph for this function:

◆ AddMetadataField() [2/2]

int FileCatalogue::AddMetadataField	(	string	field_name,
		string	field_type,
		bool	isDirectoryType = true )

Parameters

[in]	field_name	metadata field name to be added
[in]	field_type	metadata field type (INT, DATETIME, FLOAT, VARCHAR(128))
[in]	isDirectoryType	which type of field is needed. Directory or file

Returns: 0 - if successfully added, error_code (<0) in case of failures

◆ CheckFileExist() [1/2]

int FileCatalogue::CheckFileExist ( string LFN )

Parameters

[in] LFN Logical File Name of the file

Returns: 1 - if file exist, 0 - if not, <0 - an error occured

Definition at line 585 of file FileCatalogue.cxx.

References performRequest().

Here is the call graph for this function:

◆ CheckFileExist() [2/2]

int FileCatalogue::CheckFileExist ( string LFN )

Parameters

[in] LFN Logical File Name of the file

Returns: 1 - if file exist, 0 - if not, <0 - an error occured

◆ CheckFileInfo() [1/2]

int FileCatalogue::CheckFileInfo ( string LFN )

Parameters

[in] LFN Logical File Name of the file

Returns: 0 - if file metadata is avaialble, -1 - if file metadata is not set, error_code (<0) in case of failures

Definition at line 570 of file FileCatalogue.cxx.

References performRequest().

Here is the call graph for this function:

◆ CheckFileInfo() [2/2]

int FileCatalogue::CheckFileInfo ( string LFN )

Parameters

[in] LFN Logical File Name of the file

Returns: 0 - if file metadata is avaialble, -1 - if file metadata is not set, error_code (<0) in case of failures

◆ DeleteDirectoryInfo() [1/2]

int FileCatalogue::DeleteDirectoryInfo ( string path )

Parameters

[in] path Path to the directory inside File Catalog

Returns: 0 - if successfully deleted, <0 - an error occured

Definition at line 533 of file FileCatalogue.cxx.

References performRequest().

Here is the call graph for this function:

◆ DeleteDirectoryInfo() [2/2]

int FileCatalogue::DeleteDirectoryInfo ( string path )

Parameters

[in] path Path to the directory inside File Catalog

Returns: 0 - if successfully deleted, <0 - an error occured

◆ DeleteFile() [1/2]

int FileCatalogue::DeleteFile ( string LFN )

Parameters

[in] LFN Logical File Name of the file

Returns: 0 - if successfully deleted, error_code (<0) in case of failures

Definition at line 558 of file FileCatalogue.cxx.

References performRequest().

Here is the call graph for this function:

◆ DeleteFile() [2/2]

int FileCatalogue::DeleteFile ( string LFN )

Parameters

[in] LFN Logical File Name of the file

Returns: 0 - if successfully deleted, error_code (<0) in case of failures

◆ DeleteFileInfo() [1/2]

int FileCatalogue::DeleteFileInfo ( string LFN )

Parameters

[in] LFN Logical File Name of the file

Returns: 0 - if successfully deleted, <0 - an error occured

Definition at line 520 of file FileCatalogue.cxx.

References performRequest().

Here is the call graph for this function:

◆ DeleteFileInfo() [2/2]

int FileCatalogue::DeleteFileInfo ( string LFN )

Parameters

[in] LFN Logical File Name of the file

Returns: 0 - if successfully deleted, <0 - an error occured

◆ DeleteMetadataField() [1/2]

int FileCatalogue::DeleteMetadataField ( string metadatafield_name )

Either for file or directory

Parameters

[in] metadatafield_name Metadatafield name which you want to delete

Returns: 0 - if successfully deleted, <0 - an error occured

Definition at line 546 of file FileCatalogue.cxx.

References performRequest().

Here is the call graph for this function:

◆ DeleteMetadataField() [2/2]

int FileCatalogue::DeleteMetadataField ( string metadatafield_name )

Either for file or directory

Parameters

[in] metadatafield_name Metadatafield name which you want to delete

Returns: 0 - if successfully deleted, <0 - an error occured

◆ DownloadFile() [1/2]

int FileCatalogue::DownloadFile	(	string	conditions,
		string	savePath )

private

Definition at line 845 of file FileCatalogue.cxx.

References curlInstance, WriteData::error_detected, WriteData::error_msg, WriteData::file, FILE_API_PASSWORD, FILE_API_USERNAME, ServiceUrl, and WriteCallback().

Referenced by GetFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DownloadFile() [2/2]

int FileCatalogue::DownloadFile	(	string	conditions,
		string	savePath )

private

◆ FileCatalogConsistencyCheck() [1/2]

int FileCatalogue::FileCatalogConsistencyCheck ( )

Returns: check ID if successfull, <0 - an error occured

Definition at line 683 of file FileCatalogue.cxx.

References performRequest().

Here is the call graph for this function:

◆ FileCatalogConsistencyCheck() [2/2]

int FileCatalogue::FileCatalogConsistencyCheck ( )

Returns: check ID if successfull, <0 - an error occured

◆ FileCatalogRequest() [1/2]

int FileCatalogue::FileCatalogRequest	(	string	rest_api_request,
		vector< string > &	filepaths )

Parameters

[in]	rest_api_request	String HTTP command representing a request using REST API format
[out]	filepaths	Vector of the filepath containing selected file metadata (empty if not found or some errors occured)

Returns: 0 - if succesfull, <0 - an error occured

Definition at line 655 of file FileCatalogue.cxx.

References exec().

Here is the call graph for this function:

◆ FileCatalogRequest() [2/2]

int FileCatalogue::FileCatalogRequest	(	string	rest_api_request,
		vector< string > &	filepaths )

Parameters

[in]	rest_api_request	String HTTP command representing a request using REST API format
[out]	filepaths	Vector of the filepath containing selected file metadata (empty if not found or some errors occured)

Returns: 0 - if succesfull, <0 - an error occured

◆ FileCatalogStats() [1/2]

int FileCatalogue::FileCatalogStats	(	int &	files_count,
		int &	files_without_replicas,
		int &	replicas_count,
		int &	replicas_without_files )

Parameters

[out]	files_count	Number of files in the File Catalog
[out]	files_without_replicas	Number of files without replicas
[out]	replicas_count	Number of replicas in the File Catalog
[out]	replicas_without_files	Number of replicas without files in the File Catalog

Returns: 0 - if successfull, <0 - an error occured

Definition at line 699 of file FileCatalogue.cxx.

References performRequest().

Here is the call graph for this function:

◆ FileCatalogStats() [2/2]

int FileCatalogue::FileCatalogStats	(	int &	files_count,
		int &	files_without_replicas,
		int &	replicas_count,
		int &	replicas_without_files )

Parameters

[out]	files_count	Number of files in the File Catalog
[out]	files_without_replicas	Number of files without replicas
[out]	replicas_count	Number of replicas in the File Catalog
[out]	replicas_without_files	Number of replicas without files in the File Catalog

Returns: 0 - if successfull, <0 - an error occured

◆ GetConsistencyCheckResults() [1/2]

int FileCatalogue::GetConsistencyCheckResults	(	int &	eos_missing_count,
		int &	fc_missing_count,
		vector< string > &	eos_missing,
		vector< string > &	fc_missing )

Presumably up to hundreds megabytes of data

Parameters

[out]	eos_missing_count	number of files that exist in File Catalog but missing on EOS
[out]	fc_missing_count	number of files that exist in EOS but missing from File Catalog
[out]	eos_missing	paths to files (lfns) in File Catalog that are missing from EOS
[out]	fc_missing	paths to files in EOS that are missing from File Catalog

Returns: 0 - if successful, error_code (<0) in case of failures

Definition at line 319 of file FileCatalogue.cxx.

References performRequest().

Here is the call graph for this function:

◆ GetConsistencyCheckResults() [2/2]

int FileCatalogue::GetConsistencyCheckResults	(	int &	eos_missing_count,
		int &	fc_missing_count,
		vector< string > &	eos_missing,
		vector< string > &	fc_missing )

Presumably up to hundreds megabytes of data

Parameters

[out]	eos_missing_count	number of files that exist in File Catalog but missing on EOS
[out]	fc_missing_count	number of files that exist in EOS but missing from File Catalog
[out]	eos_missing	paths to files (lfns) in File Catalog that are missing from EOS
[out]	fc_missing	paths to files in EOS that are missing from File Catalog

Returns: 0 - if successful, error_code (<0) in case of failures

◆ GetConsistencyCheckStatus() [1/2]

int FileCatalogue::GetConsistencyCheckStatus ( )

Date and ID.

Returns: ID (>=0) or error_code (<0) in case of failures

Definition at line 307 of file FileCatalogue.cxx.

References performRequest().

Here is the call graph for this function:

◆ GetConsistencyCheckStatus() [2/2]

int FileCatalogue::GetConsistencyCheckStatus ( )

Date and ID.

Returns: ID (>=0) or error_code (<0) in case of failures

◆ GetDirectoryInfo() [1/2]

int FileCatalogue::GetDirectoryInfo	(	string	path,
		string &	directory_info )

Parameters

[in]	path	Path to the directory in the File Catalog
[out]	directory_info	String containing metadata fields and it's values

Returns: 0 - if successful, error_code (<0) in case of failures

Definition at line 285 of file FileCatalogue.cxx.

References performRequest().

Here is the call graph for this function:

◆ GetDirectoryInfo() [2/2]

int FileCatalogue::GetDirectoryInfo	(	string	path,
		string &	directory_info )

Parameters

[in]	path	Path to the directory in the File Catalog
[out]	directory_info	String containing metadata fields and it's values

Returns: 0 - if successful, error_code (<0) in case of failures

◆ GetFile() [1/2]

int FileCatalogue::GetFile	(	string	LFN,
		string	save_path )

Parameters

[in]	LFN	LFN of the downloaded file
[in]	save_path	path to place where you want to save it. locally or by xrootd URL

Returns: 0 - if successful, error_code (<0) in case of failures

Definition at line 353 of file FileCatalogue.cxx.

References DownloadFile(), and performRequest().

Referenced by get_file().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFile() [2/2]

int FileCatalogue::GetFile	(	string	LFN,
		string	save_path )

Parameters

[in]	LFN	LFN of the downloaded file
[in]	save_path	path to place where you want to save it. locally or by xrootd URL

Returns: 0 - if successful, error_code (<0) in case of failures

◆ GetFileInfo() [1/2]

int FileCatalogue::GetFileInfo	(	string	LFN,
		FileInfo &	file_info )

Parameters

[in]	LFN	Logical File Name of the file
[out]	file_info	FileInfo object containing file metadata

Returns: 0 - if successful, error_code (<0) in case of failures

Definition at line 227 of file FileCatalogue.cxx.

References FileInfo::BeamParticle, FileInfo::EndDateTime, FileInfo::EndEvent, FileInfo::Energy, FileInfo::EventCount, FileInfo::FieldVoltage, FileInfo::FileSize, performRequest(), FileInfo::PeriodNumber, FileInfo::RunNumber, FileInfo::RunType, FileInfo::StartDateTime, FileInfo::StartEvent, and FileInfo::TargetParticle.

Referenced by get_file_metadata().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFileInfo() [2/2]

int FileCatalogue::GetFileInfo	(	string	LFN,
		FileInfo &	file_info )

Parameters

[in]	LFN	Logical File Name of the file
[out]	file_info	FileInfo object containing file metadata

Returns: 0 - if successful, error_code (<0) in case of failures

◆ GetFileList() [1/2]

int FileCatalogue::GetFileList	(	vector< unique_ptr< FileCondition > >	file_conditions,
		vector< string > &	filepaths )

Parameters

[in]	file_conditions	A set of conditions to specify criteria for file metadata search
[out]	filepaths	Vector of the filepaths to files containing selected file metadata (empty if not found or some errors occured

Returns: 0 - if successful, error_code (<0) in case of failures

Definition at line 135 of file FileCatalogue.cxx.

References FileCondition::kBeamParticle, FileCondition::kEndDateTime, FileCondition::kEndEvent, FileCondition::kEnergy, FileCondition::kEqual, FileCondition::kError, FileCondition::kEventCount, FileCondition::kFieldVoltage, FileCondition::kFileSize, FileCondition::kGreaterOrEqual, FileCondition::kLessOrEqual, FileCondition::kLike, FileCondition::kNotEqual, FileCondition::kPeriodNumber, FileCondition::kRunNumber, FileCondition::kRunType, FileCondition::kStartDateTime, FileCondition::kStartEvent, FileCondition::kTargetParticle, performRequest(), and ReplaceAll().

Referenced by get_file_list().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFileList() [2/2]

int FileCatalogue::GetFileList	(	vector< unique_ptr< FileCondition > >	file_conditions,
		vector< string > &	filepaths )

Parameters

[in]	file_conditions	A set of conditions to specify criteria for file metadata search
[out]	filepaths	Vector of the filepaths to files containing selected file metadata (empty if not found or some errors occured

Returns: 0 - if successful, error_code (<0) in case of failures

◆ GetPFNs() [1/2]

int FileCatalogue::GetPFNs	(	string	LFN,
		vector< string > &	PFNs )

Parameters

[in]	LFN	LFN of the file
[out]	PFNs	Vector of PFNs of the file

Returns: 0 - if successful, error_code (<0) in case of failures

Definition at line 372 of file FileCatalogue.cxx.

References performRequest().

Here is the call graph for this function:

◆ GetPFNs() [2/2]

int FileCatalogue::GetPFNs	(	string	LFN,
		vector< string > &	PFNs )

Parameters

[in]	LFN	LFN of the file
[out]	PFNs	Vector of PFNs of the file

Returns: 0 - if successful, error_code (<0) in case of failures

◆ performRequest() [1/2]

string FileCatalogue::performRequest	(	string	conditions,
		string	json_content,
		string	qType )

private

Parameters

[in]	conditions	String of conditions/path/commands which goes after URL when perfrorming API request
[in]	json_content	String containing json with request as append content
[in]	qType	type of request

Returns: Response string from the API server

Definition at line 723 of file FileCatalogue.cxx.

References appendData(), curlInstance, FILE_API_PASSWORD, FILE_API_USERNAME, ServiceUrl, and VerboseLevel.

Referenced by AddDirectoryInfo(), AddFileInfo(), AddFileInfo(), AddMetadataField(), CheckFileExist(), CheckFileInfo(), DeleteDirectoryInfo(), DeleteFile(), DeleteFileInfo(), DeleteMetadataField(), FileCatalogConsistencyCheck(), FileCatalogStats(), GetConsistencyCheckResults(), GetConsistencyCheckStatus(), GetDirectoryInfo(), GetFile(), GetFileInfo(), GetFileList(), GetPFNs(), PrintFileInfo(), and PrintMetadataFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ performRequest() [2/2]

string FileCatalogue::performRequest	(	string	conditions,
		string	json_content,
		string	qType )

private

Parameters

[in]	conditions	String of conditions/path/commands which goes after URL when perfrorming API request
[in]	json_content	String containing json with request as append content
[in]	qType	type of request

Returns: Response string from the API server

◆ PrintFileInfo() [1/2]

int FileCatalogue::PrintFileInfo ( string LFN )

Parameters

[in] LFN Logical File Name of the file

Returns: 0 - if successfull, -2 - if file was not found at the location, error_code (<0) in case of failures

Definition at line 600 of file FileCatalogue.cxx.

References performRequest().

Here is the call graph for this function:

◆ PrintFileInfo() [2/2]

int FileCatalogue::PrintFileInfo ( string LFN )

Parameters

[in] LFN Logical File Name of the file

Returns: 0 - if successfull, -2 - if file was not found at the location, error_code (<0) in case of failures

◆ PrintMetadataFields() [1/2]

int FileCatalogue::PrintMetadataFields ( )

Returns: 0 - if succesfull, <0 - an error occured

Definition at line 624 of file FileCatalogue.cxx.

References performRequest().

Here is the call graph for this function:

◆ PrintMetadataFields() [2/2]

int FileCatalogue::PrintMetadataFields ( )

Returns: 0 - if succesfull, <0 - an error occured

◆ SetVerbose() [1/2]

void FileCatalogue::SetVerbose ( int verbose_level = 0 )

inline

Parameters

[in] verbose_level Verbose level for output information

Definition at line 339 of file FileCatalogue.h.

References VerboseLevel.

◆ SetVerbose() [2/2]

void FileCatalogue::SetVerbose ( int verbose_level = 0 )

inline

Parameters

[in] verbose_level Verbose level for output information

Definition at line 339 of file FileCatalogue.h.

References VerboseLevel.

◆ UpdateFileInfo() [1/2]

int FileCatalogue::UpdateFileInfo	(	string	LFN,
		FileInfo	file_metadata )

Parameters

[in]	LFN	Logical File Name of the file
[in]	file_metadata	'FileInfo' object containing file metadata

Returns: 0 - if successfully updated, <0 - an error occured

Definition at line 515 of file FileCatalogue.cxx.

References AddFileInfo().

Here is the call graph for this function:

◆ UpdateFileInfo() [2/2]

int FileCatalogue::UpdateFileInfo	(	string	LFN,
		FileInfo	file_metadata )

Parameters

[in]	LFN	Logical File Name of the file
[in]	file_metadata	'FileInfo' object containing file metadata

Returns: 0 - if successfully updated, <0 - an error occured

◆ UploadFile() [1/2]

int FileCatalogue::UploadFile	(	string	conditions,
		string	filepath )

private

Definition at line 908 of file FileCatalogue.cxx.

References appendData(), curlInstance, FILE_API_PASSWORD, FILE_API_USERNAME, progressCallback(), and ServiceUrl.

Referenced by AddFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UploadFile() [2/2]

int FileCatalogue::UploadFile	(	string	conditions,
		string	filepath )

private

Member Data Documentation

◆ curlInstance

CURL * FileCatalogue::curlInstance

private

Definition at line 342 of file FileCatalogue.h.

Referenced by FileCatalogue(), ~FileCatalogue(), DownloadFile(), performRequest(), and UploadFile().

◆ ServiceAccount

string FileCatalogue::ServiceAccount

private

Definition at line 344 of file FileCatalogue.h.

Referenced by FileCatalogue().

◆ ServiceUrl

string FileCatalogue::ServiceUrl

private

Definition at line 343 of file FileCatalogue.h.

Referenced by FileCatalogue(), DownloadFile(), performRequest(), and UploadFile().

◆ VerboseLevel

int FileCatalogue::VerboseLevel = 0

private

Definition at line 346 of file FileCatalogue.h.

Referenced by performRequest(), and SetVerbose().

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

database/file_db/FileCatalogue.h
install/include/FileCatalogue.h
database/file_db/FileCatalogue.cxx

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FileCatalogue() [1/2]

◆ ~FileCatalogue() [1/2]

◆ FileCatalogue() [2/2]

◆ ~FileCatalogue() [2/2]

Member Function Documentation

◆ AddDirectoryInfo() [1/2]

◆ AddDirectoryInfo() [2/2]

◆ AddFile() [1/2]

◆ AddFile() [2/2]

◆ AddFileInfo() [1/4]

◆ AddFileInfo() [2/4]

◆ AddFileInfo() [3/4]

◆ AddFileInfo() [4/4]

◆ AddMetadataField() [1/2]

◆ AddMetadataField() [2/2]

◆ CheckFileExist() [1/2]

◆ CheckFileExist() [2/2]

◆ CheckFileInfo() [1/2]

◆ CheckFileInfo() [2/2]

◆ DeleteDirectoryInfo() [1/2]

◆ DeleteDirectoryInfo() [2/2]

◆ DeleteFile() [1/2]

◆ DeleteFile() [2/2]

◆ DeleteFileInfo() [1/2]

◆ DeleteFileInfo() [2/2]

◆ DeleteMetadataField() [1/2]

◆ DeleteMetadataField() [2/2]

◆ DownloadFile() [1/2]

◆ DownloadFile() [2/2]

◆ FileCatalogConsistencyCheck() [1/2]

◆ FileCatalogConsistencyCheck() [2/2]

◆ FileCatalogRequest() [1/2]

◆ FileCatalogRequest() [2/2]

◆ FileCatalogStats() [1/2]

◆ FileCatalogStats() [2/2]

◆ GetConsistencyCheckResults() [1/2]

◆ GetConsistencyCheckResults() [2/2]

◆ GetConsistencyCheckStatus() [1/2]

◆ GetConsistencyCheckStatus() [2/2]

◆ GetDirectoryInfo() [1/2]

◆ GetDirectoryInfo() [2/2]

◆ GetFile() [1/2]

◆ GetFile() [2/2]

◆ GetFileInfo() [1/2]

◆ GetFileInfo() [2/2]

◆ GetFileList() [1/2]

◆ GetFileList() [2/2]

◆ GetPFNs() [1/2]

◆ GetPFNs() [2/2]

◆ performRequest() [1/2]

◆ performRequest() [2/2]

◆ PrintFileInfo() [1/2]

◆ PrintFileInfo() [2/2]

◆ PrintMetadataFields() [1/2]

◆ PrintMetadataFields() [2/2]

◆ SetVerbose() [1/2]

◆ SetVerbose() [2/2]

◆ UpdateFileInfo() [1/2]

◆ UpdateFileInfo() [2/2]

◆ UploadFile() [1/2]

◆ UploadFile() [2/2]

Member Data Documentation

◆ curlInstance

◆ ServiceAccount

◆ ServiceUrl

◆ VerboseLevel