ipaddress.h

Go to the documentation of this file.

// OSB library ********************************************* -*- C++ -*-
/*
  AUTHOR(S): Lilian Qin Lan (lan)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.35 $

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

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

// + local headers
#include "osberror.h"
#include "resource.h"
#include "resourceitem.h"

// *********************************************************************
// class declarations
namespace OSB_DB {
    class Session;
    class Ip4AddressGw;
    class IpGroupGw;
}

// *********************************************************************
// namespace extensions
namespace OSB_LIB {
    class IpGroup;

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

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

    // *****************************************************************
    // class Ip4Address
    class Ip4Address : public Resource {
        friend class OSB_DB::Ip4AddressGw;
        friend class IpGroup;
    private:
        static const Type typeId_ = rtIp4Address;

    public:
        Ip4Address(const Oid& id = Oid());

        Ip4Address(
            const Number&      rn,
            const Id<Network>& nw
        );



        Type typeId() const;
        const std::string& des() const;
        bool canUpd() const;
        bool canSetGroup() const;

        void setDes(const std::string& des);

        bool isAvailable() const;



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

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

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

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

    private:
        void verify() const;

    private:
        std::string  des_;
    };

    // *****************************************************************
    // struct AssignableIp4
    struct AssignableIp4 {
        Id<Ip4Address> ip4Id_;
        Id2<NetworkElement> neId_;
        bool in_;
        bool out_;

        Id<Resource> resourceId() const
        {
            return Id<Resource>(ip4Id_.id());
        }
        Id<Network> networkId() const
        {
            return Id<Network>(neId_.id1_);
        }
    };

    typedef std::list<AssignableIp4> AssignableIp4s;

    // *****************************************************************
    // class IpGroup
    class IpGroup : public Resource {
        friend class OSB_DB::IpGroupGw;
    private:
        static const Type typeId_ = rtIpGroup;

    public:


        enum Direction {
           dirUnknown = '?',    
           dirIn      = 'i',    
           dirOut     = 'o'     
        };
        static char toChar(Direction dir);
        static Direction direction(char c);

        struct AssignedIp4 {
            Ip4Address ip4_;
            Direction   dir_;
            DateTime   from_;
            DateTime   to_;
        };

        typedef std::list<AssignedIp4> AssignedIp4s;

        IpGroup(const Oid& id = Oid());

        IpGroup(
            const Number&      rn,
            const Id<Network>& nw
        );



        Type typeId() const;
        const std::string& des() const;
        const AssignedIp4s& assignedIp4s() const;
        const AssignedIp4s curAssignedIp4s() const;

        bool addIp4(
            const OSB_DB::Session& session,
            const Date&            start,
                  Ip4Address&      ip4,
                  Direction        dir
        );

        bool delIp4(
            const OSB_DB::Session& session,
                  Ip4Address&      ip4,
                  Direction        dir
        );



        void setDes(const std::string& des);

    private:
        bool assign(
            const AssignedIp4& assignedIp4
        );

        bool deassign(
            const Ip4Address& ip4,
                  Direction   dir
        );

    public:

        bool read(const OSB_DB::Session& session);
        bool insert(const OSB_DB::Session& session);
        void updData(const OSB_DB::Session& session);
        bool remove(const OSB_DB::Session& session);

        void sortIp4sByPriority();

        void sortIp4sByResNum(bool desc = false);

    private:
        std::string des_;
        AssignedIp4s assignedIp4s_;

    private:
        bool changeIp4Status(
            const OSB_DB::Session& session,
                  Ip4Address&      ip4
        ) const;
    };                                  // class IpGroup

    // *****************************************************************
    // class PersIpGroup
    class PersIpGroup : public PersResource {
    public:
        static const Type type_;

        // Documentation from base class.
        typedef std::auto_ptr<PersIpGroup> AutoPtr;

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

        PersIpGroup(const PersIpGroup& rhs);

        PersIpGroup& operator=(const PersIpGroup& rhs);

        ~PersIpGroup();

    public:
        // Documentation from base class.
        Type type() const;
        // Documentation from base class.
        AutoPtr clone() const;

    public:
        bool canConfig() const;

        void assign(const IpGroup& ipg);

        // Documentation from base class.
        const Resource* resource() const;

        const Resource* oldResource() const;

    private:
        // Documentation from base class.
        PersProductItem* clone_() const;

        // Documentation from base class.
        Resource* resource();
        // Documentation from base class.
        Resource* oldResource();

        // Documentation from base class.
        Resource* createResource(
            const Resource::Oid& resourceId
        );


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

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

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

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

    private:
        IpGroup* pIpGroup_;
        IpGroup* pOldIpGroup_;
    };                                  // class PersIpGroup

    // *****************************************************************
    // class IpGroupItem {
    class IpGroupItem : public ResourceItem {
    public:
        static const Type type_;

        // Documentation from base class.
        typedef std::auto_ptr<IpGroupItem> AutoPtr;

        IpGroupItem(
            const Oid&         oid,
            const std::string& name = "",
            const std::string& des  = ""
        );

    public:
        // Documentation from base class.
        Type type() const;
        // Documentation from base class.
        AutoPtr clone() const;

        ProductItem::CfgType canConfigure() const;

        ProductItem::DefPersType canDefPers() const;

        CfgPersType canPersonalize() const;

        const PersProductItem* defPersItem() const;

        std::auto_ptr<PersProductItem> crePersProductItem() const;

    private:
        // Documentation from base class.
        ProductItem* clone_() const;


        bool readSpecific(
            const OSB_DB::Session& session
        );
        bool insSpecific(
            const OSB_DB::Session& session
        );
        bool updSpecific(
            const OSB_DB::Session& session
        );
        bool delSpecific(
            const OSB_DB::Session& session
        );
    };                                  // class IpGroupItem

// *********************************************************************
// inline definitions

}                                       // namespace OSB_LIB
#endif                                  // #ifndef _IPADDRESS_H_

---