eventconfigurationmanager.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 Oct 23: Added include files to eventconf.xml.
//
// 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.FileInputStream;
import java.io.FileReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.util.Enumeration;

import org.apache.log4j.Category;
import org.exolab.castor.xml.MarshalException;
import org.exolab.castor.xml.Unmarshaller;
import org.exolab.castor.xml.ValidationException;
import org.opennms.core.utils.ThreadCategory;
import org.opennms.netmgt.eventd.datablock.EventConfData;
import org.opennms.netmgt.xml.eventconf.Event;
import org.opennms.netmgt.xml.eventconf.Events;

/**
 * <p>
 * This is the singleton class used to manage the event configuration. When the
 * class is loaded an attempt is made to read and load the file named
 * <tt>eventconf.xml</tt>. The file must be in the applications searched
 * classpaths in order to be loaded when the class is loaded.
 * </p>
 * 
 * <p>
 * Once the class is constructed it is possible to reconfigure or merge
 * additional events into the configuration by using the methods provided by the
 * class.
 * </p>
 * 
 * @author <a href="mailto:[e-mail]">Brian Weaver </a>
 * @author <a href="mailto:[e-mail]">Sowmya Nataraj </a>
 * @author <a href="http://www.opennms.org/">OpenNMS </a>
 */
public final class EventConfigurationManager {
    /**
     * The mapping of all the Event Configuration objects
     */
    private static EventConfData m_eventConf;

    /**
     * This member is set to true if the configuration file has been loaded.
     */
    private static volatile boolean m_loaded;

    /**
     * The list of secure tags.
     */
    private static volatile String[] m_secureTags;

    //
    // Attempts to load the configuration by default if
    // it's named eventconf.xml and in the classpath.
    //
    static {
        m_loaded = false;
        m_eventConf = new EventConfData();
    }

    /**
     * Returns true if the configuration has been loaded.
     * 
     * @return True if the configuration is loaded.
     */
    public static boolean isConfigured() {
        return m_loaded;
    }

    /**
     * This method is used to load the passed configuration into the currently
     * managed configuration instance. Any events that previously existed are
     * cleared.
     * 
     * @param file
     *            The file to load.
     * 
     * @exception org.exolab.castor.xml.MarshalException
     *                Thrown if the file does not conform to the schema.
     * @exception org.exolab.castor.xml.ValidationException
     *                Thrown if the contents do not match the required schema.
     * @exception java.lang.IOException
     *                Thrown if the file cannot be opened for reading.
     */
    public static void loadConfiguration(String file) throws IOException, MarshalException, ValidationException {
        InputStream cfgIn = new FileInputStream(file);
        if (cfgIn == null) {
            throw new IOException("Failed to load/locate events conf file: " + file);
        }

        Reader rdr = new InputStreamReader(cfgIn);
        loadConfiguration(rdr);
    }

    /**
     * This method is used to load the passed configuration into the currently
     * managed configuration instance. Any events that previously existed are
     * cleared. After the contents of the reader stream is loaded the stream is
     * closed.
     * 
     * @param rdr
     *            The reader used to load the configuration.
     * 
     * @exception org.exolab.castor.xml.MarshalException
     *                Thrown if the file does not conform to the schema.
     * @exception org.exolab.castor.xml.ValidationException
     *                Thrown if the contents do not match the required schema.
     */
    public static void loadConfiguration(Reader rdr) throws IOException, MarshalException, ValidationException {
        Category log = ThreadCategory.getInstance();
        synchronized (m_eventConf) {
            Events toplevel = null;
            toplevel = (Events) Unmarshaller.unmarshal(Events.class, rdr);

            m_eventConf.clear();

            Enumeration e = toplevel.enumerateEvent();
            while (e.hasMoreElements()) {
                Event event = (Event) e.nextElement();
                m_eventConf.put(event);
            }

            m_secureTags = toplevel.getGlobal().getSecurity().getDoNotOverride();

            Enumeration e2 = toplevel.enumerateEventFile();
            while (e2.hasMoreElements()) {
                String eventfile = (String) e2.nextElement();
                InputStream fileIn = new FileInputStream(eventfile);
                if (fileIn == null) {
                    throw new IOException("Eventconf: Failed to load/locate events file: " + eventfile);
                }

                if (log.isDebugEnabled())
                    log.debug("Eventconf: Loading event file: " + eventfile);

                Reader filerdr = new InputStreamReader(fileIn);
                Events filelevel = null;
                filelevel = (Events) Unmarshaller.unmarshal(Events.class, filerdr);
                Enumeration efile = filelevel.enumerateEvent();
                while (efile.hasMoreElements()) {
                    Event event = (Event) efile.nextElement();
                    m_eventConf.put(event);
                }
            }

            try {
                rdr.close();
            } catch (Throwable t) {
            }
        }
        m_loaded = true;
    }

    /**
     * This method is used to load the passed configuration into the currently
     * managed configuration instance. Any events that previously existed are
     * overwritten by the new events in this configuration. This call will
     * replace the current override settings.
     * 
     * @param file
     *            The configuration file name.
     * 
     * @exception org.exolab.castor.xml.MarshalException
     *                Thrown if the file does not conform to the schema.
     * @exception org.exolab.castor.xml.ValidationException
     *                Thrown if the contents do not match the required schema.
     * @exception java.lang.IOException
     *                Thrown if the file cannot be opened for reading.
     */
    public static void mergeConfiguration(String file) throws IOException, MarshalException, ValidationException {
        Reader rdr = new FileReader(file);
        mergeConfiguration(rdr);
    }

    /**
     * This method is used to load the passed configuration into the currently
     * managed configuration instance. Any events that previously existed are
     * overwritten by the new events in this configuration. This call will
     * replace the current override settings. After the contents of the reader
     * stream is loaded, the reader is closed.
     * 
     * @param rdr
     *            The reader used to load the configuration.
     * 
     * @exception org.exolab.castor.xml.MarshalException
     *                Thrown if the file does not conform to the schema.
     * @exception org.exolab.castor.xml.ValidationException
     *                Thrown if the contents do not match the required schema.
     * 
     */
    public static void mergeConfiguration(Reader rdr) throws MarshalException, ValidationException {
        synchronized (m_eventConf) {
            Events toplevel = null;
            toplevel = (Events) Unmarshaller.unmarshal(Events.class, rdr);

            Enumeration e = toplevel.enumerateEvent();
            while (e.hasMoreElements()) {
                Event event = (Event) e.nextElement();
                m_eventConf.put(event);
            }

            m_secureTags = toplevel.getGlobal().getSecurity().getDoNotOverride();

            try {
                rdr.close();
            } catch (Throwable t) {
            }
        }
        m_loaded = true;
    }

    /**
     * Returns the matching event configuration instance that is indexed by the
     * passed UEI. This is an instance of the <code>Event</code> that was
     * loaded from the event configuration file.
     * 
     * @return The loaded event matching the UEI
     */
    public static Event getByUei(String uei) {
        return (Event) m_eventConf.getEventByUEI(uei);
    }

    /**
     * Returns the matching event configuration instance that is indexed by the
     * SNMP enterprise identifier. This is an instance of the <code>Event</code>
     * that was loaded from the event configuration file.
     * 
     * @return The loaded event matching the EID.
     */
    public static Event getBySnmpEid(String eid) {
        return (Event) m_eventConf.getEventBySnmp(eid);
    }

    /**
     * Returns the matching event configuration instance for the event that just
     * came in. This is an instance of the <code>Event</code> that was loaded
     * from the event configuration file.
     * 
     * @return The loaded event matching the event.
     */
    public static Event get(org.opennms.netmgt.xml.event.Event event) {
        return (Event) m_eventConf.getEvent(event);
    }

    /**
     * Returns true if the tag is marked as secure.
     */
    public static boolean isSecureTag(String name) {
        for (int i = 0; i < m_secureTags.length; i++)
            if (m_secureTags[i].equals(name))
                return true;

        return false;
    }

}