Elements  5.12.0
A C++ base framework for the Euclid Software.
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
ElementsServices::DataSync::ConnectionConfiguration Class Reference

The connection configuration mainly holds: More...

#include <ConnectionConfiguration.h>

Collaboration diagram for ElementsServices::DataSync::ConnectionConfiguration:
[legend]

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:

Definition at line 75 of file ConnectionConfiguration.h.

Constructor & Destructor Documentation

◆ ~ConnectionConfiguration()

virtual ElementsServices::DataSync::ConnectionConfiguration::~ConnectionConfiguration ( )
virtualdefault

◆ ConnectionConfiguration()

ElementsServices::DataSync::ConnectionConfiguration::ConnectionConfiguration ( const path configFile)
explicit

Create a dependency configuration by reading a configuration file.

Definition at line 31 of file ConnectionConfiguration.cpp.

References parseConfigurationFile().

Here is the call graph for this function:

Member Function Documentation

◆ overwritingAllowed()

bool ElementsServices::DataSync::ConnectionConfiguration::overwritingAllowed ( ) const

Check whether existing local files can be overwritten.

Definition at line 35 of file ConnectionConfiguration.cpp.

References ElementsServices::DataSync::OVERWRITE, and overwritingPolicy.

Referenced by ElementsServices::DataSync::DataSynchronizer::fileShouldBeWritten().

◆ parseConfigurationFile()

void ElementsServices::DataSync::ConnectionConfiguration::parseConfigurationFile ( const path filename)
protected

Definition at line 39 of file ConnectionConfiguration.cpp.

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

Referenced by ConnectionConfiguration().

Here is the call graph for this function:

◆ parseHost()

void ElementsServices::DataSync::ConnectionConfiguration::parseHost ( const std::string name)
protected

Definition at line 88 of file ConnectionConfiguration.cpp.

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

Referenced by parseConfigurationFile().

Here is the call graph for this function:

◆ parseOverwritingPolicy()

void ElementsServices::DataSync::ConnectionConfiguration::parseOverwritingPolicy ( const std::string policy)
protected

Definition at line 99 of file ConnectionConfiguration.cpp.

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

Referenced by parseConfigurationFile().

Here is the call graph for this function:

Member Data Documentation

◆ distantRoot

path ElementsServices::DataSync::ConnectionConfiguration::distantRoot

Definition at line 107 of file ConnectionConfiguration.h.

Referenced by parseConfigurationFile().

◆ host

DataHost ElementsServices::DataSync::ConnectionConfiguration::host

◆ hostUrl

std::string ElementsServices::DataSync::ConnectionConfiguration::hostUrl

◆ localRoot

path ElementsServices::DataSync::ConnectionConfiguration::localRoot

Definition at line 108 of file ConnectionConfiguration.h.

Referenced by parseConfigurationFile().

◆ overwritingPolicy

OverwritingPolicy ElementsServices::DataSync::ConnectionConfiguration::overwritingPolicy

Definition at line 105 of file ConnectionConfiguration.h.

Referenced by overwritingAllowed(), and parseOverwritingPolicy().

◆ password

std::string ElementsServices::DataSync::ConnectionConfiguration::password

◆ tries

size_t ElementsServices::DataSync::ConnectionConfiguration::tries

◆ user

std::string ElementsServices::DataSync::ConnectionConfiguration::user

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