Elements::Services::DataSync::ConnectionConfiguration Class Reference

The connection configuration mainly holds: More...

#include <ConnectionConfiguration.h>

Collaboration diagram for Elements::Services::DataSync::ConnectionConfiguration:

Public Member Functions
virtual	~ConnectionConfiguration ()=default
	ConnectionConfiguration (const path &configFile)
	Create a dependency configuration by reading a configuration file. More...
bool	overwritingAllowed () const
	Check whether existing local files can be overwritten. More...

Public Attributes
DataHost	host
std::string	hostUrl
std::string	user
std::string	password
OverwritingPolicy	overwritingPolicy
size_t	tries
path	distantRoot
path	localRoot

Protected Member Functions
void	parseConfigurationFile (const path &filename)
void	parseHost (const std::string &name)
void	parseOverwritingPolicy (const std::string &policy)

Detailed Description

The connection configuration mainly holds:

• the host type and URL,
• the user name and password,
• the overwriting policy.

Definition at line 75 of file ConnectionConfiguration.h.

Constructor & Destructor Documentation

~ConnectionConfiguration()

virtual Elements::Services::DataSync::ConnectionConfiguration::~ConnectionConfiguration ( )

virtualdefault

ConnectionConfiguration()

Elements::Services::DataSync::ConnectionConfiguration::ConnectionConfiguration ( const path &  configFile )

explicit

Create a dependency configuration by reading a configuration file.

Definition at line 32 of file ConnectionConfiguration.cpp.

References parseConfigurationFile().

Here is the call graph for this function:

Member Function Documentation

overwritingAllowed()

bool Elements::Services::DataSync::ConnectionConfiguration::overwritingAllowed

(

)

const

Check whether existing local files can be overwritten.

Definition at line 36 of file ConnectionConfiguration.cpp.

References Elements::Services::DataSync::OVERWRITE, and overwritingPolicy.

Referenced by Elements::Services::DataSync::DataSynchronizer::fileShouldBeWritten().

parseConfigurationFile()

void Elements::Services::DataSync::ConnectionConfiguration::parseConfigurationFile ( const path &  filename )

protected

Definition at line 40 of file ConnectionConfiguration.cpp.

References Elements::Services::DataSync::confFilePath(), distantRoot, Elements::Kernel::Units::e, hostUrl, localRoot, Elements::Services::DataSync::localWorkspacePrefix(), parseHost(), parseOverwritingPolicy(), password, tries, and user.

Referenced by ConnectionConfiguration().

Here is the call graph for this function:

parseHost()

void Elements::Services::DataSync::ConnectionConfiguration::parseHost ( const std::string &  name )

protected

Definition at line 79 of file ConnectionConfiguration.cpp.

References host, Elements::Services::DataSync::IRODS, Elements::Services::DataSync::lower(), and Elements::Services::DataSync::WEBDAV.

Referenced by parseConfigurationFile().

Here is the call graph for this function:

parseOverwritingPolicy()

void Elements::Services::DataSync::ConnectionConfiguration::parseOverwritingPolicy ( const std::string &  policy )

protected

Definition at line 90 of file ConnectionConfiguration.cpp.

References Elements::Services::DataSync::ABORT, Elements::Services::DataSync::lower(), Elements::Services::DataSync::OVERWRITE, overwritingPolicy, and Elements::Services::DataSync::valueIsListed().

Referenced by parseConfigurationFile().

Here is the call graph for this function:

Member Data Documentation

distantRoot

path Elements::Services::DataSync::ConnectionConfiguration::distantRoot

Definition at line 104 of file ConnectionConfiguration.h.

Referenced by parseConfigurationFile().

host

DataHost Elements::Services::DataSync::ConnectionConfiguration::host

Definition at line 98 of file ConnectionConfiguration.h.

Referenced by Elements::Services::DataSync::createSynchronizer(), and parseHost().

hostUrl

std::string Elements::Services::DataSync::ConnectionConfiguration::hostUrl

Definition at line 99 of file ConnectionConfiguration.h.

Referenced by Elements::Services::DataSync::WebdavSynchronizer::createDownloadCommand(), and parseConfigurationFile().

localRoot

path Elements::Services::DataSync::ConnectionConfiguration::localRoot

Definition at line 105 of file ConnectionConfiguration.h.

Referenced by parseConfigurationFile().

overwritingPolicy

OverwritingPolicy Elements::Services::DataSync::ConnectionConfiguration::overwritingPolicy

Definition at line 102 of file ConnectionConfiguration.h.

Referenced by overwritingAllowed(), and parseOverwritingPolicy().

password

std::string Elements::Services::DataSync::ConnectionConfiguration::password

Definition at line 101 of file ConnectionConfiguration.h.

Referenced by Elements::Services::DataSync::WebdavSynchronizer::createDownloadCommand(), and parseConfigurationFile().

tries

size_t Elements::Services::DataSync::ConnectionConfiguration::tries

Definition at line 103 of file ConnectionConfiguration.h.

Referenced by Elements::Services::DataSync::WebdavSynchronizer::createDownloadCommand(), and parseConfigurationFile().

user

std::string Elements::Services::DataSync::ConnectionConfiguration::user

Definition at line 100 of file ConnectionConfiguration.h.

Referenced by Elements::Services::DataSync::WebdavSynchronizer::createDownloadCommand(), and parseConfigurationFile().

---

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

• ElementsServices/ElementsServices/DataSync/ConnectionConfiguration.h
• ElementsServices/src/lib/DataSync/ConnectionConfiguration.cpp