001/*
002 * jPOS Project [http://jpos.org]
003 * Copyright (C) 2000-2026 jPOS Software SRL
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jpos.q2.qbean;
020
021import org.jdom2.Element;
022import org.jpos.core.XmlConfigurable;
023import org.jpos.q2.QBeanSupport;
024import org.jpos.util.NameRegistrar;
025
026/**
027 * QBean that registers its raw XML configuration element under {@link NameRegistrar}
028 * so other beans can look it up at runtime.
029 */
030@SuppressWarnings("unused")
031public class QXmlConfig extends QBeanSupport implements XmlConfigurable {
032    /** Default constructor; no instance state to initialise. */
033    public QXmlConfig() {}
034    /** Prefix used when registering the configuration element in {@link NameRegistrar}. */
035    public static final String XML_PREFIX = "config.xml.";
036
037    @Override
038    protected void destroyService() {
039        NameRegistrar.unregister (XML_PREFIX + getName());
040    }
041    /**
042     * @param e Configuration element
043     */
044    @Override
045    public void setConfiguration(Element e) {
046        NameRegistrar.register(XML_PREFIX + getName(), e);
047    }
048    /**
049     * Looks up the configuration element registered under {@code name}.
050     *
051     * @param name configuration name (without the {@link #XML_PREFIX} prefix)
052     * @return the registered configuration element
053     * @throws NameRegistrar.NotFoundException if no configuration is registered under that name
054     */
055    public static Element getConfiguration (String name)
056            throws NameRegistrar.NotFoundException
057    {
058        return (Element) NameRegistrar.get(XML_PREFIX + name);
059    }
060
061    /**
062     * Looks up the configuration element registered under {@code name}, waiting up to {@code timeout}.
063     *
064     * @param name configuration name
065     * @param timeout in millis
066     * @return Configuration Element or null
067     */
068    public static Element getConfiguration (String name, long timeout) {
069        return (Element) NameRegistrar.get(XML_PREFIX + name, timeout);
070    }
071}