CredentialManager.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef ZYPP_MEDIA_CREDENTIALMANAGER_H
#define ZYPP_MEDIA_CREDENTIALMANAGER_H

#include <set>

#include "zypp/Pathname.h"
#include "zypp/media/MediaUserAuth.h"

namespace zypp
{ 

  class Url;

  namespace media
  { 


  //
  // CLASS NAME : CredManagerOptions
  //
  struct CredManagerOptions
  {
    CredManagerOptions(const Pathname & rootdir = "");

    Pathname globalCredFilePath;
    Pathname userCredFilePath;
    Pathname customCredFileDir;
  };

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

  //
  // CLASS NAME : CredentialManager
  //
  class CredentialManager
  {
  public:
    typedef std::set<AuthData_Ptr, AuthDataComparator> CredentialSet;
    typedef CredentialSet::size_type                   CredentialSize;
    typedef CredentialSet::const_iterator              CredentialIterator;


    CredentialManager(const 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);


    CredentialIterator credsGlobalBegin() const;
    CredentialIterator credsGlobalEnd()   const;
    CredentialSize     credsGlobalSize()  const;
    bool               credsGlobalEmpty() const;

    CredentialIterator credsUserBegin() const;
    CredentialIterator credsUserEnd()   const;
    CredentialSize     credsUserSize()  const;
    bool               credsUserEmpty() const;

    class Impl;
  private:
    RW_pointer<Impl> _pimpl;
  };


  } // media
} // zypp

#endif /* ZYPP_MEDIA_CREDENTIALMANAGER_H */