resource_i.h

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.16 $

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

// ************************************************************************
// included header files
// + standard includes

// + libraries
#include <resourcelists.h>

// + local headers
#include "resourceS.h"
#include "corba_utility.h"
#include "networkmanager_i.h"

// + class declarations

// ************************************************************************
// namespace extensions
namespace OSB_CORBA {

// ************************************************************************
// type definitions
    using CORBA::Boolean;
    using corba::common::Date;

// ************************************************************************
// class definitions
    class Resource_i :
        public virtual POA_corba::res::Resource
    {
    public:
        static const std::string IFC;

        Resource_i(
                  NetworkManager_i&       nmgri,
            const OSB_LIB::Resource::Oid& oid
        );

        ~Resource_i();

    public:


        ResourceTypeId type()
            throw (CORBA::SystemException, OsbCorbaException);

        ResourceId id()
            throw (CORBA::SystemException, OsbCorbaException);

        corba::imgmt::PoolId poolId()
            throw (CORBA::SystemException, OsbCorbaException);

        Boolean isPrepaid()
            throw (CORBA::SystemException, OsbCorbaException);

        Utf8String* resNumber()
            throw (CORBA::SystemException, OsbCorbaException);

        ResourceStatus status()
            throw (CORBA::SystemException, OsbCorbaException);

        Boolean isAvailable()
            throw (CORBA::SystemException, OsbCorbaException);

        Date quarantineEnd()
            throw (CORBA::SystemException, OsbCorbaException);

        NetworkId networkId()
            throw (CORBA::SystemException, OsbCorbaException);

        NetworkElementId networkElementId()
            throw (CORBA::SystemException, OsbCorbaException);

        Date assigned()
            throw (CORBA::SystemException, OsbCorbaException);

        Boolean canUpd()
            throw (CORBA::SystemException, OsbCorbaException);

        Boolean canDel()
            throw (CORBA::SystemException, OsbCorbaException);

    protected:
        typedef OSB_LIB::ResourceList<OSB_LIB::Resource>::Rg ReadGuard;

        virtual ReadGuard lock() const = 0;

    protected:
        NetworkManager_i& nmgri_;

        const OSB_LIB::Resource::Oid resId_;
    };                                  // class Resource_i

    class ResourceWriter_i :
        public virtual POA_corba::res::ResourceWriter,
        public virtual Resource_i
    {
    public:
        static const std::string IFC;

        ResourceWriter_i(
                  NetworkManager_i&       nmgri,
            const OSB_LIB::Resource::Oid& resId
        );

        virtual ~ResourceWriter_i();

    private:
        ResourceWriter_i(const ResourceWriter_i&);
        ResourceWriter_i& operator=(const ResourceWriter_i&);

    public:
        void setLoctKey(const Locators::Key& key);

        void setPool(
          const corba::imgmt::PoolId& poolId
        ) throw (CORBA::SystemException, OsbCorbaException);
        void setStatus(
            ResourceStatus newStatus
        ) throw (OsbCorbaException);

        virtual ResourceId create(
            CORBA::Boolean noWait
        ) throw (CORBA::SystemException, OsbCorbaException);

        virtual void updData(
            CORBA::Boolean noWait
        ) throw (CORBA::SystemException, OsbCorbaException);

        virtual void updStatus(
            CORBA::Boolean noWait
        ) throw (CORBA::SystemException, OsbCorbaException);

        void destroy() throw (CORBA::SystemException);

    protected:
        virtual OSB_LIB::Resource& resource() = 0;

        virtual bool writeToList(bool isNew) const = 0;

    private:
        Locators::Key loctKey_;
    };

// ************************************************************************
// Free functions
    template<typename R>
    const R& getResource(
        const OSB_LIB::ReadGuard<R*>& rg,
              OSB_LIB::Resource::Oid  resId
    ) throw (OsbCorbaException);

    template<typename R>
    R& getResource(
        OSB_LIB::WriteGuard<R*>& wg,
        OSB_LIB::Resource::Oid   resId
    ) throw (OsbCorbaException);

    OSB_LIB::Resource::Status rsStatus(ResourceStatus s);

    ResourceStatus rsStatus(const OSB_LIB::Resource::Status s);
}                                       // namespace OSB_CORBA

// ************************************************************************
// inline definitions
namespace OSB_CORBA {

    template<typename R>
    const R& getResource(
        const OSB_LIB::ReadGuard<R*>& rg,
              OSB_LIB::Resource::Oid  resId
    ) throw (OsbCorbaException)
    {
        // trivial case: everything as is should be
        const R* rc = rg.get();
        if (0 != rc) return *rc;

        // handle the error
        typedef OSB_LIB::ResourceList<R> List;
        typedef typename List::GuardStatus Status;

        using OSB_LIB::OsbError;

        OsbError error;
        switch (Status(rg.status_)) {
          case List::objectNotFound:
            error = OsbError(721);
            error << resId;
            break;

          case List::lockFailed:
            error = OsbError(722);
            error << resId;
            break;

          case List::success:
            if (rg.locked()) error = OsbError(723);
            else             error = OsbError(724);
            break;
        }

        if (error.noError())  {
            error = OsbError(725);
            error << rg.status_;
        }
        throw osbCorbaException(error);
    }

    template<typename R>
    R& getResource(
        OSB_LIB::WriteGuard<R*>& wg,
        OSB_LIB::Resource::Oid   resId
    ) throw (OsbCorbaException)
    {
        // trivial case: everything as is should be
        R* rc = wg.get();
        if (0 != rc) return *rc;

        // handle the error
        typedef OSB_LIB::ResourceList<R> List;
        typedef typename List::GuardStatus Status;

        using OSB_LIB::OsbError;

        OsbError error;
        switch (Status(wg.status_)) {
          case List::objectNotFound:
            error = OsbError(721);
            error << resId;
            break;

          case List::lockFailed:
            error = OsbError(726);
            error << resId;
            break;

          case List::success:
            if (wg.locked()) error = OsbError(723);
            else             error = OsbError(727);
            break;
        }

        if (error.noError())  {
            error = OsbError(728);
            error << wg.status_;
        }
        throw osbCorbaException(error);
    }
}                                       // namespace OSB_CORBA
#endif                                  // #ifndef _RESOURCE_I_H_

---