credentialmanager.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef ZYPP_MEDIA_AUTH_CREDENTIALMANAGER_H
#define ZYPP_MEDIA_AUTH_CREDENTIALMANAGER_H
 
#include <set>
 
#include <zypp-core/Globals.h>
#include <zypp-core/Pathname.h>
#include <zypp-media/auth/AuthData>

namespace zypp
{ 
 
  class Url;

  namespace media
  { 
 

  //
  // CLASS NAME : CredManagerOptions
  //
  struct ZYPP_API CredManagerOptions
  {
    CredManagerOptions(const Pathname & rootdir = "");
 
    Pathname globalCredFilePath;
    Pathname userCredFilePath;
    Pathname customCredFileDir;
  };

 
  // comparator for CredentialSet
  struct ZYPP_API AuthDataComparator
  {
    bool operator()(const AuthData_Ptr & lhs, const AuthData_Ptr & rhs) const;
  };

  //
  // CLASS NAME : CredentialManager
  //
  class ZYPP_API CredentialManager
  {
  public:
    using CredentialSet = std::set<AuthData_Ptr, AuthDataComparator>;
    using CredentialSize = CredentialSet::size_type;
    using CredentialIterator = CredentialSet::const_iterator;
 
 
    CredentialManager(CredManagerOptions opts = CredManagerOptions());
 
    ~CredentialManager()
    {}
 
  public:
    AuthData_Ptr getCred(const Url & url);

    AuthData_Ptr getCredFromFile(const Pathname & file);

    void addGlobalCred(const AuthData & cred);

    void addUserCred(const AuthData & cred);

    void addCred(const AuthData & cred);

    void save();

    void saveInGlobal(const AuthData & cred);

    void saveInUser(const AuthData & cred);

    void saveInFile(const AuthData &, const Pathname & credFile);

    void clearAll(bool global = false);

    static AuthData_Ptr findIn( const CredentialManager::CredentialSet & set,  const Url & url, url::ViewOption vopt );

    time_t timestampForCredDatabase ( const zypp::Url &url );
 
    CredentialIterator credsGlobalBegin() const;
    CredentialIterator credsGlobalEnd()   const;
    CredentialSize     credsGlobalSize()  const;
    bool               credsGlobalEmpty() const;
 
    CredentialIterator credsUserBegin() const;
    CredentialIterator credsUserEnd()   const;
    CredentialSize     credsUserSize()  const;
    bool               credsUserEmpty() const;
 
    struct Impl;
  private:
    RW_pointer<Impl> _pimpl;
  };

 

  } // media
} // zypp
 
#endif /* ZYPP_MEDIA_AUTH_CREDENTIALMANAGER_H */