osbuser.h

Go to the documentation of this file.

// OSB library ********************************************* -*- C++ -*-
/*
  AUTHOR(S): Elangovan Angannan (aen)
             Stephan Broennimann (vb)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.27.2.1 $

  License
   OSB rating and billing library for communication networks
   Copyright (C) 2004, 2005, 2006  OSB systems

   This file may be distributed and/or modify under the terms of the
   GNU General Public License (GPL) as published by the Free Software
   Foundation which is provided in the file LICENSE.GPL included in the
   packaging of this file.

   The file is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   for more details.

   Holders of a OSB Commercial License may use this file under the terms
   and conditions of this commercial license.
 */
#ifndef _OSB_USER_H_
#define _OSB_USER_H_

// *********************************************************************
// included header files
// + standard includes
#include <string>
#include <list>
#include <map>

// + local headers
#include "osbid.h"
#include "osbconst.h"

// *********************************************************************
// class declarations
namespace OSB_LIB {
    class UserMgmtCfg;
    class UserGroup;
}
namespace OSB_DB {
    class OsbUserGw;
    class Session;
};

// *********************************************************************
// namespace extensions
namespace OSB_LIB {

// *********************************************************************
// class declarations

// *********************************************************************
// type definitions

// *********************************************************************
// class definitions

    class OsbUser {
        friend class OSB_DB::OsbUserGw;
        friend class UserMgmtCfg;

    public:                             // Type definitions
        typedef Id<OsbUser> Oid;
        typedef std::map< ModuleId, Id<UserGroup> > Grants;

    public:
        OsbUser(const Oid& oid = Oid());

        explicit OsbUser(
            const std::string& login,
            const std::string& password = ""
        );


        const Oid&         oid()       const { return oid_;       }
        const long         objVs()     const { return objVs_;     }
        const std::string& loginName() const { return loginName_; }
        const std::string& password()  const { return password_;  }
        const std::string& name()      const { return name_;      }
        const std::string& email()     const { return email_;     }
        ModuleId defModule() const
        {
            return defModule_;
        }
        const Grants& grants() const;
        Id<UserGroup> userGroup(ModuleId module) const;



        void setLoginName(const std::string& loginName);
        void setName(const std::string& name);
        void setEmail(const std::string& email);
        void setPassword(
            const std::string& newPw,
            const std::string& oldPw
        );



        void grant(const UserGroup& grp);

        bool setDefModule(const ModuleId module);

        void revoke(const ModuleId module);

        void revokeAll();

    private:
        void setPw(const std::string& pw);
        bool checkPw(const std::string& password);



        void read(const OSB_DB::Session& session);

        bool login(const OSB_DB::Session& session);

        void insert(const OSB_DB::Session& session);

        void update(const OSB_DB::Session& session);

        void remove(const OSB_DB::Session& session);

    private:
        Oid oid_;
        long objVs_;
        std::string loginName_;
        std::string password_;
        std::string name_;
        std::string email_;
        Grants grants_;
        ModuleId defModule_;
    };                                  // class OsbUser

    class Users {
        friend class UserMgmtCfg;
        friend class OSB_DB::OsbUserGw;
    public:
        typedef std::list<OsbUser> Cont;
        typedef Cont::const_iterator ConstIter;

    public:
        Users();
    public:
        bool empty() const;
        size_t size() const;
        ConstIter begin() const;
        ConstIter end() const;

        const OsbUser& get(const OsbUser::Oid usrId) const;

        void read(const OSB_DB::Session& session);
        bool usersRead() const;

    private:
        void insert(const OsbUser& usr);

        void remove(Cont::iterator usrIter);

        Cont::iterator find(const OsbUser::Oid usrId);

    private:
        Cont users_;
        bool usersRead_;
    };                                  // class Users
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _OSB_USER_H_

---