eventd.java

opennms得相关源码 请大家看看

//
// This file is part of the OpenNMS(R) Application.
//
// OpenNMS(R) is Copyright (C) 2002-2003 The OpenNMS Group, Inc.  All rights reserved.
// OpenNMS(R) is a derivative work, containing both original code, included code and modified
// code that was published under the GNU General Public License. Copyrights for modified 
// and included code are below.
//
// OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
//
// Modifications:
//
// 2003 Jan 31: Cleaned up some unused imports.
// 2002 Nov 14: Used non-blocking socket class to speed up capsd and pollerd.
//
// Original code base Copyright (C) 1999-2001 Oculan Corp.  All rights reserved.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program 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.                                                            
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//       
// For more information contact: 
//      OpenNMS Licensing       <[e-mail]>
//      http://www.opennms.org/
//      http://www.opennms.com/
//
// Tab Size = 8
//

package org.opennms.netmgt.eventd;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.lang.reflect.UndeclaredThrowableException;
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

import org.apache.log4j.Category;
import org.exolab.castor.xml.MarshalException;
import org.exolab.castor.xml.ValidationException;
import org.opennms.core.fiber.PausableFiber;
import org.opennms.core.utils.ThreadCategory;
import org.opennms.netmgt.ConfigFileConstants;
import org.opennms.netmgt.config.DatabaseConnectionFactory;
import org.opennms.netmgt.config.EventdConfigFactory;
import org.opennms.netmgt.eventd.adaptors.EventReceiver;
import org.opennms.netmgt.eventd.adaptors.tcp.TcpEventReceiver;
import org.opennms.netmgt.eventd.adaptors.udp.UdpEventReceiver;
import org.opennms.netmgt.xml.event.Event;
import org.opennms.netmgt.xml.event.EventReceipt;

/**
 * <p>
 * Eventd listens for events from the discovery, capsd, trapd processes and
 * sends events to the Master Station when queried for.
 * </p>
 * 
 * <p>
 * Eventd receives events sent in as XML, looks up the event.conf and adds
 * information to these events and stores them to the db. It also reconverts
 * them back to XML to be sent to other processes like 'actiond'
 * </p>
 * 
 * <p>
 * Process like trapd, capsd etc. that are local to the distributed poller send
 * events to the eventd. Events can also be sent via TCP or UDP to eventd.
 * </p>
 * 
 * <p>
 * Eventd listens for incoming events, loads info from the 'event.conf', adds
 * events to the database and sends the events added to the database to
 * subscribed listeners. It also maintains a servicename to serviceid mapping
 * from the services table so as to prevent a database lookup for each incoming
 * event
 * </P>
 * 
 * <P>
 * The number of threads that processes events is configurable via the eventd
 * configuration xml
 * </P>
 * 
 * @author <A HREF="mailto:[e-mail]">Sowmya Nataraj </A>
 * @author <A HREF="http://www.opennms.org">OpenNMS.org </A>
 */
public final class Eventd implements PausableFiber, org.opennms.netmgt.eventd.adaptors.EventHandler {
    /**
     * The log4j category used to log debug messsages and statements.
     */
    public static final String LOG4J_CATEGORY = "OpenNMS.Eventd";

    /**
     * Singleton instance of this class
     */
    private static final Eventd m_singleton = new Eventd();

    /**
     * The service table map
     */
    private static Map m_serviceTableMap;

    /**
     * The handler for events coming in through TCP
     */
    private EventReceiver m_tcpReceiver;

    /**
     * The handler for events coming in through UDP
     */
    private EventReceiver m_udpReceiver;

    /**
     * <P>
     * Contains dotted-decimal representation of the IP address where Eventd is
     * running. Used when eventd sends events out
     * </P>
     */
    private String m_address = null;

    /**
     * The current status of this fiber
     */
    private int m_status;

    static {
        // map of service names to service identifer
        m_serviceTableMap = Collections.synchronizedMap(new HashMap());
    }

    /**
     * Constuctor creates the localhost address(to be used eventually when
     * eventd originates events during correlation) and the broadcast queue
     */
    public Eventd() {
        try {
            m_address = InetAddress.getLocalHost().getHostAddress();
        } catch (UnknownHostException uhE) {
            Category log = ThreadCategory.getInstance(getClass());

            m_address = "localhost";
            log.warn("Could not lookup the host name for the local host machine, address set to localhost", uhE);
        }

        m_status = START_PENDING;
    }

    /**
     * Stops all the eventd threads
     */
    public void stop() {
        m_status = STOP_PENDING;

        Category log = ThreadCategory.getInstance();
        if (log.isDebugEnabled())
            log.debug("Beginning shutdown process");

        //
        // Stop listener threads
        //
        if (log.isDebugEnabled())
            log.debug("calling shutdown on tcp/udp listener threads");

        m_tcpReceiver.stop();
        m_udpReceiver.stop();

        if (log.isDebugEnabled())
            log.debug("shutdown on tcp/udp listener threads returned");

        m_status = STOPPED;

        if (log.isDebugEnabled())
            log.debug("Eventd shutdown complete");
    }

    /**
     * Returns a name/id for this process
     */
    public String getName() {
        return "OpenNMS.Eventd";
    }

    /**
     * Returns the current status
     */
    public synchronized int getStatus() {
        return m_status;
    }

    public void init() {
        ThreadCategory.setPrefix(LOG4J_CATEGORY);
        Category log = ThreadCategory.getInstance();

        // load the eventd configuration
        EventdConfigFactory eFactory = null;
        try {
            EventdConfigFactory.reload();
            eFactory = EventdConfigFactory.getInstance();
        } catch (FileNotFoundException ex) {
            log.error("Failed to load eventd configuration. File Not Found:", ex);
            throw new UndeclaredThrowableException(ex);
        } catch (MarshalException ex) {
            log.error("Failed to load eventd configuration", ex);
            throw new UndeclaredThrowableException(ex);
        } catch (ValidationException ex) {
            log.error("Failed to load eventd configuration", ex);
            throw new UndeclaredThrowableException(ex);
        } catch (IOException ex) {
            log.error("Failed to load eventd configuration", ex);
            throw new UndeclaredThrowableException(ex);
        }

        // Get a database connection and create the service table map
        //
        java.sql.Connection tempConn = null;
        try {
            DatabaseConnectionFactory.init();
            tempConn = DatabaseConnectionFactory.getInstance().getConnection();

            // create the service table map
            //
            PreparedStatement stmt = tempConn.prepareStatement(EventdConstants.SQL_DB_SVC_TABLE_READ);
            ResultSet rset = stmt.executeQuery();
            while (rset.next()) {
                int svcid = rset.getInt(1);
                String svcname = rset.getString(2);

                m_serviceTableMap.put(svcname, new Integer(svcid));
            }

            rset.close();
            stmt.close();
        } catch (IOException ie) {
            log.fatal("IOException getting database connection", ie);
            throw new UndeclaredThrowableException(ie);
        } catch (MarshalException me) {
            log.fatal("Marshall Exception getting database connection", me);
            throw new UndeclaredThrowableException(me);
        } catch (ValidationException ve) {
            log.fatal("Validation Exception getting database connection", ve);
            throw new UndeclaredThrowableException(ve);
        } catch (SQLException sqlE) {
            throw new UndeclaredThrowableException(sqlE);
        } catch (ClassNotFoundException cnfE) {
            throw new UndeclaredThrowableException(cnfE);
        } finally {
            try {
                if (tempConn != null)
                    tempConn.close();
            } catch (SQLException sqlE) {
                log.warn("An error occured closing the database connection, ignoring", sqlE);
            }
        }

        // load configuration(eventconf)
        //
        try {
            File configFile = ConfigFileConstants.getFile(ConfigFileConstants.EVENT_CONF_FILE_NAME);
            EventConfigurationManager.loadConfiguration(configFile.getPath());
        } catch (MarshalException ex) {
            log.error("Failed to load eventd configuration", ex);
            throw new UndeclaredThrowableException(ex);
        } catch (ValidationException ex) {
            log.error("Failed to load eventd configuration", ex);
            throw new UndeclaredThrowableException(ex);
        } catch (IOException ex) {
            log.error("Failed to load events configuration", ex);
            throw new UndeclaredThrowableException(ex);
        }

        //
        // Create all the threads
        //

        m_tcpReceiver = null;
        m_udpReceiver = null;
        try {
            String timeoutReq = eFactory.getSocketSoTimeoutRequired();
            m_tcpReceiver = new TcpEventReceiver(eFactory.getTCPPort());
            m_udpReceiver = new UdpEventReceiver(eFactory.getUDPPort());

            m_tcpReceiver.addEventHandler(this);
            m_udpReceiver.addEventHandler(this);

        } catch (IOException e) {
            log.error("Error starting up the TCP/UDP threads of eventd", e);
            throw new UndeclaredThrowableException(e);
        }

        //
        // Start all the threads
        //

        if (log.isDebugEnabled())
            log.debug("EventIpcManagerFactory init");

        EventIpcManagerFactory.init();
    }

    /**
     * Read the eventd configuration xml, create and start all the subthreads
     */
    public void start() {
        m_status = STARTING;

        ThreadCategory.setPrefix(LOG4J_CATEGORY);
        Category log = ThreadCategory.getInstance();

        m_tcpReceiver.start();
        m_udpReceiver.start();

        if (log.isDebugEnabled()) {
            log.debug("Listener threads started");
        }

        if (log.isDebugEnabled()) {
            log.debug("Eventd running");
        }

        m_status = RUNNING;
    }

    /**
     * Pauses all the threads
     */
    public void pause() {
        if (m_status != RUNNING)
            return;

        m_status = PAUSE_PENDING;

        Category log = ThreadCategory.getInstance();

        // pause the listening threads
        //
        // if(log.isDebugEnabled())
        // log.debug("Calling pause thread on tcp/udp listeners");

        // m_tcpReceiver.pause();
        // m_udpReceiver.pause();

        // if(log.isDebugEnabled())
        // log.debug("tcp/udp listeners paused");

        if (log.isDebugEnabled())
            log.debug("Finished pausing all threads");

        m_status = PAUSED;
    }

    /**
     * Resumes all the threads
     */
    public void resume() {
        if (m_status != PAUSED)
            return;

        m_status = RESUME_PENDING;

        Category log = ThreadCategory.getInstance();

        // if(log.isDebugEnabled())
        // log.debug("Calling resume thread on tcp/udp listeners");

        // m_tcpReceiver.resume();
        // m_udpReceiver.resume();

        // if(log.isDebugEnabled())
        // log.debug("TCP/UDP Listener threads resumed");

        // if(log.isDebugEnabled())
        // log.debug("Event handlers resumed");

        if (log.isDebugEnabled())
            log.debug("Finished resuming ");

        m_status = RUNNING;
    }

    /**
     * Used to retrieve the local host address. The address of the machine on
     * which Eventd is running.
     * 
     * @return The local machines hostname.
     */
    public String getLocalHostAddress() {
        return m_address;
    }

    /**
     * Return the service id for the name passed
     * 
     * @param svcname
     *            the service name whose service id is required
     * 
     * @return the service id for the name passed, -1 if not found
     */
    public static synchronized int getServiceID(String svcname) {
        Integer i = (Integer) m_serviceTableMap.get(svcname);
        if (i != null) {
            return i.intValue();
        } else {
            return -1;
        }
    }

    /**
     * Add the svcname/svcid mapping to the servicetable map
     */
    public static synchronized void addServiceMapping(String svcname, int serviceid) {
        m_serviceTableMap.put(svcname, new Integer(serviceid));
    }

    public static Eventd getInstance() {
        return m_singleton;
    }

    public boolean processEvent(Event event) {
        EventIpcManagerFactory.getInstance().getManager().sendNow(event);
        return true;
    }

    public void receiptSent(EventReceipt event) {
        // do nothing
    }
}