notification_originator.h

Go to the documentation of this file.

/*_############################################################################
  _## 
  _##  AGENT++ 4.0 - notification_originator.h  
  _## 
  _##  Copyright (C) 2000-2013  Frank Fock and Jochen Katz (agentpp.com)
  _##  
  _##  Licensed under the Apache License, Version 2.0 (the "License");
  _##  you may not use this file except in compliance with the License.
  _##  You may obtain a copy of the License at
  _##  
  _##      http://www.apache.org/licenses/LICENSE-2.0
  _##  
  _##  Unless required by applicable law or agreed to in writing, software
  _##  distributed under the License is distributed on an "AS IS" BASIS,
  _##  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  _##  See the License for the specific language governing permissions and
  _##  limitations under the License.
  _##  
  _##########################################################################*/

#ifndef _notification_originator_h_
#define _notification_originator_h_

#include <agent_pp/agent++.h>
#include <agent_pp/mib.h>

#define mpV1  0
#define mpV2c 1
#define mpV3  3

#ifdef AGENTPP_NAMESPACE
namespace Agentpp {
#endif


/*--------------------- class NotificationOriginator ---------------------*/

class AGENTPP_DECL NotificationOriginator: public NotificationSender {

 public:
        NotificationOriginator();

        virtual ~NotificationOriginator();

        void    generate(Vbx*, int, const Oidx&, const Oidx&, const NS_SNMP OctetStr&);

        void    generate(Vbx*, int, const Oidx&, 
                         unsigned int, const NS_SNMP OctetStr&);

        virtual int             notify(const NS_SNMP OctetStr&, const Oidx&,
                                       Vbx*, int, unsigned int=0); 
        
        virtual bool add_v1_trap_destination(const NS_SNMP UdpAddress& addr,
                                             const NS_SNMP OctetStr &name,
                                             const NS_SNMP OctetStr &tag,
                                             const NS_SNMP OctetStr &community);
        virtual bool add_v2_trap_destination(const NS_SNMP UdpAddress& addr,
                                             const NS_SNMP OctetStr &name,
                                             const NS_SNMP OctetStr &tag,
                                             const NS_SNMP OctetStr &community);
        virtual bool add_v3_trap_destination(const NS_SNMP UdpAddress& addr,
                                             const NS_SNMP OctetStr &name,
                                             const NS_SNMP OctetStr &tag,
                                             const NS_SNMP OctetStr &secName,
                                             const int secLevel);
#ifdef _SNMPv3

        void            set_local_engine_id(const NS_SNMP OctetStr& id)
            { if (localEngineID) { delete localEngineID; } 
              localEngineID = new NS_SNMP OctetStr(id); }
#endif

 protected:
        
        class NotificationOriginatorParams {
        public:
                NotificationOriginatorParams(Vbx* _vbs, int _size, const Oidx& _id,
                                unsigned int _timestamp,
                                const Oidx& _enterprise, 
                                const NS_SNMP OctetStr& _contextName) :
                                vbs(_vbs), size(_size), id(_id), timestamp(_timestamp),
                                enterprise(_enterprise), contextName(_contextName)
                                { target = 0; }

                Vbx* vbs;
                int size;
                Oidx id;
                unsigned int timestamp;
                Oidx enterprise;
                NS_SNMP OctetStr contextName;
                NS_SNMP OctetStr securityName;
                int securityModel;
                int securityLevel;
                int mpModel;
#ifdef _SNMPv3
                NS_SNMP UTarget* target;
#else
                NS_SNMP CTarget* target;
#endif

        private:
                NotificationOriginatorParams();
        };

        int    generate(Vbx*, int, const Oidx&, unsigned int, 
                        const Oidx&, const NS_SNMP OctetStr&);

        bool check_access(ListCursor<MibTableRow>& cur, NotificationOriginatorParams& nop);

        int send_notify(ListCursor<MibTableRow>& cur, NotificationOriginatorParams& nop, int notify);

#ifdef _SNMPv3
        NS_SNMP OctetStr*       localEngineID;
#endif
};
#ifdef AGENTPP_NAMESPACE
}
#endif
#endif