referencelistconfig.java

OPIAM stands for Open Identity and Access Management. This Suite will provide modules for user & rig

/*
 * OPIAM Suite
 *
 * Distributable under LGPL license.
 * See terms of license at gnu.org.
 */

package opiam.admin.faare.config;

import opiam.admin.faare.config.javabeans.JBReferenceMap;

import org.apache.commons.digester.Digester;

import org.apache.log4j.Logger;

import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;

import java.io.IOException;
import java.io.InputStream;


/**
 * Reference lists service configuration loading from the XML file.
 *
 * The XML file must contain the following lines :
 * <!DOCTYPE mapping PUBLIC
 *         "-//OPIAM ADMIN//DTD Reference List Service Configuration 1.0//EN"
 *         "http://www.opiam.org/admin/dtd/profiles_conf.dtd">
 *
 * The second line is registered to the digester (it does not need to be an actual URL).
 *
 */
public final class ReferenceListConfig implements ErrorHandler
{
    /** Log4J. */
    private static Logger _logger = Logger.getLogger(ReferenceListConfig.class.getName());

    /** DOCTYPE key. */
    public static final String REFLIST_CONFIG_DTD_KEY =
                                    "-//OPIAM ADMIN//DTD Reference List Service Configuration 1.0//EN";

    /** DOCTYPE URL. */
    public static final String REFLIST_CONFIG_DTD_URL = "/config/service/references/references_conf.dtd";

    /** XML Parser. */
    private static Digester _digester = null;

    /** Current instance. */
    private static ReferenceListConfig _instance = null;

    /** Parser exception. */
    private static SAXParseException _saxParseException = null;

    /**
     * Constructor for ProfilesDigester.
     */
    private ReferenceListConfig()
    {
        super();
    }

    /**
     * Digester initialization with DTD fields.
     */
    private static void initProfileDigester()
    {
        _saxParseException = null;
        _digester = new Digester();

        _digester.setErrorHandler(_instance);
        _digester.setValidating(true);

        _digester.register(REFLIST_CONFIG_DTD_KEY,
            ReferenceListConfig.class.getResource(REFLIST_CONFIG_DTD_URL)
                                     .toString());

        _digester.addObjectCreate("references",
            "opiam.admin.faare.config.javabeans.JBReferenceMap");

        _digester.addObjectCreate("references/base-reference",
            "opiam.admin.faare.config.javabeans.JBBaseReferenceListDescriptor");
        _digester.addSetNext("references/base-reference",
            "addBaseReferenceDesc",
            "opiam.admin.faare.config.javabeans.JBBaseReferenceListDescriptor");
        _digester.addSetProperties("references/base-reference");

        _digester.addObjectCreate("references/search-reference",
            "opiam.admin.faare.config.javabeans.JBSearchReferenceListDescriptor");
        _digester.addSetNext("references/search-reference",
            "addSearchReferenceDesc",
            "opiam.admin.faare.config.javabeans.JBSearchReferenceListDescriptor");
        _digester.addSetProperties("references/search-reference");
    }

    /**
     * Gets ReferenceListConfig instance.
     *
     * @return ReferenceListConfig instance
     */
    public static ReferenceListConfig getInstance()
    {
        if (_instance == null)
        {
            _instance = new ReferenceListConfig();
            initProfileDigester();
        }

        return _instance;
    }

    /**
     * Gets reference lists config.
     *
     * @param in configuration stream
     *
     * @return reference lists config
     *
     * @throws IOException exception while reading stream.
     * @throws SAXException exception while parsing data.
     */
    public JBReferenceMap readConfig(InputStream in)
        throws IOException, SAXException
    {
        JBReferenceMap result = null;
        result = (JBReferenceMap) _digester.parse(in);

        if (_saxParseException != null)
        {
            _logger.debug("Exception : " + _saxParseException.getMessage());
            throw new SAXException(_saxParseException.getMessage());
        }

        return result;
    }

    /**
     * Parsing error callback.
     *
     * @param saxParseException parsing exception
     */
    public void error(SAXParseException saxParseException)
    {
        _logger.debug(" error exception!!!!!!!!!!!!!!!");
        _saxParseException = saxParseException;
    }

    /**
     * Parsing fatal error callback.
     *
     * @param saxParseException parsing exception
     */
    public void fatalError(SAXParseException saxParseException)
    {
        _logger.debug("fatalError exception!!!!!!!!!!!!!!!");
        _saxParseException = saxParseException;
    }

    /**
     * Parsing warning callback.
     *
     * @param saxParseException parsing exception
     */
    public void warning(SAXParseException saxParseException)
    {
        _logger.debug("warning : " + saxParseException.getMessage());
    }
}