requestProvider Class Reference

generic provider of copy requests More...

#include <requestProvider.h>

Inheritance diagram for requestProvider:

Collaboration diagram for requestProvider:

Classes
class	factoryClass
class	factoryTemplate
struct	pathMapCmp

Public Member Functions
	requestProvider (decltype(requests) aRequests, decltype(delayedRequests) aDelayedRequests, decltype(parents) aParents, decltype(InputHandler) aInputHandler, decltype(OutputHandler) aOutputHandler)
	! use only the file name part in the destination More...
virtual	~requestProvider ()=default
virtual bool	isFollowMode () const =0
virtual void	prepareMappings (std::vector< std::string > &sources, std::string &destination)
virtual void	printMappings (std::ostream &stream)
virtual void	processSources (const std::vector< std::string > &sources)=0

Static Public Member Functions
static requestProvider *	newProvider (const std::string &choice, decltype(requests) aRequests, decltype(delayedRequests) aDelayedRequests, decltype(parents) aParents, decltype(InputHandler) aInputHandler, decltype(OutputHandler) aOutputHandler)
static void	addAllowedNamesToOption (options::single< std::string > &option)

Protected Member Functions
virtual const singleMap &	getDstPath (const std::string &source, std::string &destination, bool baseNameOnly=false)
	get detstination papth for a given source path More...

Static Protected Member Functions
static std::map< std::string, factoryClass * > &	getFactoryMap ()

Protected Attributes
copyRequest::simpleQueue &	requests
copyRequest::timedQueue &	delayedRequests
bool	parents
inputHandler::base *	InputHandler
outputHandler::base *	OutputHandler

Static Protected Attributes
static options::map< std::string, pathMapType >	pathMap
static singleMap	badMapEntry

Private Types
typedef std::set< singleMap, pathMapCmp >	pathMapType

Detailed Description

generic provider of copy requests

Definition at line 13 of file requestProvider.h.

Member Typedef Documentation

pathMapType

typedef std::set<singleMap, pathMapCmp> requestProvider::pathMapType

private

Definition at line 27 of file requestProvider.h.

Constructor & Destructor Documentation

requestProvider()

requestProvider::requestProvider ( decltype(requests)  aRequests, decltype(delayedRequests)  aDelayedRequests, decltype(parents)  aParents, decltype(InputHandler)  aInputHandler, decltype(OutputHandler)  aOutputHandler  )

inline

! use only the file name part in the destination

Definition at line 74 of file requestProvider.h.

                                                           :
        requests(aRequests),
        delayedRequests(aDelayedRequests),
        parents(aParents),
        InputHandler(aInputHandler),
        OutputHandler(aOutputHandler) {
    };

~requestProvider()

virtual requestProvider::~requestProvider ( )

virtualdefault

Member Function Documentation

addAllowedNamesToOption()

void requestProvider::addAllowedNamesToOption ( options::single< std::string > &  option )

static

Definition at line 24 of file requestProvider.cpp.

                                                                              {
    for (const auto& item : getFactoryMap()) {
        option.fAddToRange(item.first);
    }
}

References options::internal::typed_base< T, forceRangeValueTypeString >::fAddToRange(), and getFactoryMap().

Here is the call graph for this function:

getDstPath()

const singleMap & requestProvider::getDstPath ( const std::string &  source, std::string &  destination, bool  baseNameOnly = false  )

protectedvirtual

get detstination papth for a given source path

Returns

path map entry used in this case

Parameters

destination	! [in] the source path
baseNameOnly	! [ou] the destination path

Reimplemented in cmdLineRequestProvider.

Definition at line 30 of file requestProvider.cpp.

                           {
    for (const auto& item : pathMap) {
        if (item.first.empty() // we have the catchall item
                || source.find(item.first) == 0) { // srcPath starts with this mapped dir
            destination = item.second;
            if (destination.back() != '/') {
                destination += "/";
            }
            auto shortPath = source.substr(item.first.size());
            while (!shortPath.empty() && shortPath.front() == '/') {
                shortPath.erase(0, 1);
            }
            if (parents && !baseNameOnly) {
                if (shortPath.find("./") == 0) {
                    destination += shortPath.substr(2);
                } else {
                    destination += shortPath;
                }
            } else {
                auto disposable_buffer = strdup(shortPath.c_str());
                destination += basename(disposable_buffer);
                free(disposable_buffer);
            }
            return item;
        }
    }
    errMsg::emit(errMsg::level::crit, errMsg::location(),
                 source, "map paths", "no dir mapping found");
    for (const auto& item : pathMap) {
        errMsg::emit(errMsg::level::crit, errMsg::location(),
                     source, "map paths",
                     "candidate: ", item.first, " -> ", item.second);
    }
    throw std::runtime_error("no dir mapping found for " + source);
    return badMapEntry;
}

References badMapEntry, errMsg::crit, errMsg::emit(), parents, and pathMap.

Referenced by followInotifyWatchRequestProvider::followStream(), cmdLineRequestProvider::getDstPath(), followJsonRequestProvider::processJson(), policyRunRequestProvider::processSource(), and followBeeGfsRequestProvider::processSources().

Here is the call graph for this function:

Here is the caller graph for this function:

getFactoryMap()

static std::map<std::string, factoryClass*>& requestProvider::getFactoryMap ( )

staticprotected

Referenced by addAllowedNamesToOption(), requestProvider::factoryClass::factoryClass(), and newProvider().

Here is the caller graph for this function:

isFollowMode()

virtual bool requestProvider::isFollowMode ( ) const

pure virtual

Implemented in followRequestProvider, cmdLineRequestProvider, and noFollowRequestProvider.

newProvider()

requestProvider * requestProvider::newProvider ( const std::string &  choice, decltype(requests)  aRequests, decltype(delayedRequests)  aDelayedRequests, decltype(parents)  aParents, decltype(InputHandler)  aInputHandler, decltype(OutputHandler)  aOutputHandler  )

static

Definition at line 16 of file requestProvider.cpp.

                                                {
    return getFactoryMap()[choice]->create(aRequests, aDelayedRequests, aParents, aInputHandler, aOutputHandler);
}

References getFactoryMap().

Here is the call graph for this function:

prepareMappings()

void requestProvider::prepareMappings ( std::vector< std::string > &  sources, std::string &  destination  )

virtual

Reimplemented in cmdLineRequestProvider, listingRequestProvider, and checksumTestRequestProvider.

Definition at line 70 of file requestProvider.cpp.

                                                              {
    if (!destination.empty()) { // last arg (destination) is also a source
        sources.push_back(destination);
        destination.clear();
    }
    if (pathMap.empty()) {
        throw std::runtime_error("no mapping given");
    }
}

References pathMap.

printMappings()

void requestProvider::printMappings ( std::ostream &  stream )

virtual

Reimplemented in cmdLineRequestProvider.

Definition at line 81 of file requestProvider.cpp.

                                                      {
    stream << "Path mapping:\n";
    stream << "There are " << pathMap.size() << " directory mappings:\n";
    for (const auto& item : pathMap) {
        stream << "'" << item.first << "' -> '" << item.second << "'\n";
    }
}

References pathMap.

Referenced by cmdLineRequestProvider::printMappings().

Here is the caller graph for this function:

processSources()

virtual void requestProvider::processSources ( const std::vector< std::string > &  sources )

pure virtual

Implemented in followRequestProvider, noFollowRequestProvider, moveRequestProvider, followBeeGfsRequestProvider, and followKafkaRequestProvider.

Member Data Documentation

badMapEntry

singleMap requestProvider::badMapEntry

staticprotected

Definition at line 30 of file requestProvider.h.

Referenced by getDstPath().

delayedRequests

copyRequest::timedQueue& requestProvider::delayedRequests

protected

Definition at line 32 of file requestProvider.h.

Referenced by followRequestProvider::enqueueOrAppend().

InputHandler

inputHandler::base* requestProvider::InputHandler

protected

Definition at line 34 of file requestProvider.h.

Referenced by moveRequestProvider::addDirContent(), cmdLineRequestProvider::addDirContent(), followRequestProvider::enqueueOrAppend(), cmdLineRequestProvider::prepareMappings(), moveRequestProvider::processSource(), checksumTestRequestProvider::processSource(), policyRunRequestProvider::processSource(), and cmdLineRequestProvider::processSource().

OutputHandler

outputHandler::base* requestProvider::OutputHandler

protected

Definition at line 35 of file requestProvider.h.

Referenced by cmdLineRequestProvider::prepareMappings().

parents

bool requestProvider::parents

protected

Definition at line 33 of file requestProvider.h.

Referenced by getDstPath(), and cmdLineRequestProvider::processSource().

pathMap

options::map<std::string, pathMapType> requestProvider::pathMap

staticprotected

Definition at line 29 of file requestProvider.h.

Referenced by getDstPath(), cmdLineRequestProvider::prepareMappings(), prepareMappings(), and printMappings().

requests

copyRequest::simpleQueue& requestProvider::requests

protected

Definition at line 31 of file requestProvider.h.

Referenced by followRequestProvider::enqueueOrAppend(), moveRequestProvider::processSources(), and noFollowRequestProvider::processSources().

---

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

• src/requestProvider.h (v0.19-24-g0617ca1 with changes)
• src/requestProvider.cpp (v0.19-24-g0617ca1 with changes)