modules.h

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.17 $

  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 _MODULES_H_
#define _MODULES_H_

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

// + libraries

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

// + class declarations
namespace OSB_LIB {
    class UserMgmtCfg;
    class ModAccessMap;
}

namespace OSB_DB {
    class Session;                      // dbsession.h
    class ModuleGw;                     // modules-gw.h
}

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

// ************************************************************************
// forward declarations

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

// ************************************************************************
// class definitions
    class Module {
        friend class UserMgmtCfg;
        friend class OSB_DB::ModuleGw;

    public:
        typedef Id<ModuleId> Oid;

    public:
        explicit Module(const Oid& oid);
        ~Module();
        Module(const Module& rhs);
        Module& operator=(const Module& rhs);

    public:
        Oid oid() const;
        ModuleId modId() const;
        const std::string& name() const;
        const std::string appType() const;
        const ModAccessMap& accessMap() const;

    private:

        void lock(
            const OSB_DB::Session& session,
                  bool             noWait
        ) const;
        static void handleObjectStatus(
                  ObjectStatus os,
            const Oid&         id
        );
        void incObjVs(const OSB_DB::Session& session);

    private:
        Oid oid_;
        long objVs_;
        std::string name_;
        std::string appType_;
        ModAccessMap* accessMap_;
    };                                  // class Module

    class Modules {
        friend class UserMgmtCfg;

    public:
        typedef std::list<Module> Cont;
        typedef Cont::const_iterator ConstIter;

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

        const Module& get(ModuleId id) const;

        ConstIter begin() const;
        ConstIter end() const;
        bool empty() const;

        const Cont& cont() const;

    private:                            // UserMgmtCfg only
        Module& get(ModuleId id);

    private:
        Cont cont_;
    };                                  // class Modules
}                                       // namespace OSB_LIB

// ************************************************************************
// inline definitions
namespace OSB_LIB {
}                                       // namespace OSB_LIB

#endif                                  // #ifndef _MODULES_H_

---