/*******************************************************************************
* This file is part of OpenNMS(R).
*
* Copyright (C) 2009-2011 The OpenNMS Group, Inc.
* OpenNMS(R) is Copyright (C) 1999-2011 The OpenNMS Group, Inc.
*
* OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
*
* OpenNMS(R) 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 3 of the License,
* or (at your option) any later version.
*
* OpenNMS(R) 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 OpenNMS(R). If not, see:
* http://www.gnu.org/licenses/
*
* For more information contact:
* OpenNMS(R) Licensing <license@opennms.org>
* http://www.opennms.org/
* http://www.opennms.com/
*******************************************************************************/
/*
* OCA CONTRIBUTION ACKNOWLEDGEMENT - NOT PART OF LEGAL BOILERPLATE
* DO NOT DUPLICATE THIS COMMENT BLOCK WHEN CREATING NEW FILES!
*
* This file was contributed to the OpenNMS(R) project under the
* terms of the OpenNMS Contributor Agreement (OCA). For details on
* the OCA, see http://www.opennms.org/index.php/Contributor_Agreement
*
* Contributed under the terms of the OCA by:
*
* Bobby Krupczak <rdk@krupczak.org>
* THE KRUPCZAK ORGANIZATION, LLC
* http://www.krupczak.org/
*/
/**
*
* OpenNMS Xmp config factory for kicking off parsing of the
* xmp-config config file for protocol specific options.
* @author <a href="mailto:rdk@krupczak.org">Bobby Krupczak</a>
* @version $Id: XmpConfigFactory.java 38 2008-07-24 13:39:32Z rdk $
*/
package org.opennms.netmgt.protocols.xmp.config;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import org.exolab.castor.xml.MarshalException;
import org.exolab.castor.xml.Unmarshaller;
import org.exolab.castor.xml.ValidationException;
import org.opennms.core.utils.ConfigFileConstants;
import org.opennms.netmgt.config.xmpConfig.XmpConfig;
public class XmpConfigFactory {
/* class variables and methods *********************** */
private static XmpConfigFactory instance;
private XmpConfig config = null;
// initialize our class for the creation of instances
/**
* <p>init</p>
*
* @throws java.io.IOException if any.
* @throws java.io.FileNotFoundException if any.
* @throws org.exolab.castor.xml.MarshalException if any.
* @throws org.exolab.castor.xml.ValidationException if any.
*/
public static void init() throws IOException, FileNotFoundException, MarshalException, ValidationException
{
if (instance == null) {
File cfgFile = ConfigFileConstants.getFile(ConfigFileConstants.XMP_CONFIG_FILE_NAME);
// create instance of ourselves and that causes
// config file to be read and XmpConfig to be instantiated
instance = new XmpConfigFactory(cfgFile.getPath());
}
}
/**
* <p>getXmpConfig</p>
*
* @return a {@link org.opennms.netmgt.config.xmpConfig.XmpConfig} object.
*/
public XmpConfig getXmpConfig() { return config; }
/**
* <p>Getter for the field <code>instance</code>.</p>
*
* @return a {@link org.opennms.netmgt.protocols.xmp.config.XmpConfigFactory} object.
*/
public static XmpConfigFactory getInstance() { return instance; }
/* instance variables ******************************** */
/* constructors ************************************* */
/**
* <p>Constructor for XmpConfigFactory.</p>
*
* @param configFile a {@link java.lang.String} object.
* @throws org.exolab.castor.xml.MarshalException if any.
* @throws org.exolab.castor.xml.ValidationException if any.
* @throws java.io.IOException if any.
*/
public XmpConfigFactory(String configFile)
throws MarshalException, ValidationException, IOException
{
InputStream cfgIn = new FileInputStream(configFile);
config = (XmpConfig)Unmarshaller.unmarshal(XmpConfig.class,
new InputStreamReader(cfgIn, "UTF-8"));
cfgIn.close();
return;
}
/**
* <p>Constructor for XmpConfigFactory.</p>
*
* @param rdr a {@link java.io.Reader} object.
* @throws org.exolab.castor.xml.MarshalException if any.
* @throws org.exolab.castor.xml.ValidationException if any.
* @throws java.io.IOException if any.
*/
public XmpConfigFactory(Reader rdr)
throws MarshalException, ValidationException, IOException
{
config = (XmpConfig)Unmarshaller.unmarshal(XmpConfig.class,rdr);
}
/* private methods *********************************** */
/* public methods ************************************ */
} /* class XmpConfigFactory */