atom.content.XmlResourceBundleControl Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2013 Geeoz, and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Research Projects is dual-licensed under the GNU General Public
 * License, version 2.0 (GPLv2) and the Geeoz Commercial License.
 *
 * Solely for non-commercial purposes. A purpose is non-commercial only if
 * it is in no manner primarily intended for or directed toward commercial
 * advantage or private monetary compensation.
 *
 * This Geeoz Software is supplied to you by Geeoz in consideration of your
 * agreement to the following terms, and your use, installation, modification
 * or redistribution of this Geeoz Software constitutes acceptance of these
 * terms. If you do not agree with these terms, please do not use, install,
 * modify or redistribute this Geeoz Software.
 *
 * Neither the name, trademarks, service marks or logos of Geeoz may be used
 * to endorse or promote products derived from the Geeoz Software without
 * specific prior written permission from Geeoz.
 *
 * The Geeoz Software is provided by Geeoz on an "AS IS" basis. GEEOZ MAKES NO
 * WARRANTIES, EXPRESS  OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE, REGARDING THE GEEOZ SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
 * COMBINATION WITH YOUR PRODUCTS.
 *
 * IN NO EVENT SHALL GEEOZ BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
 * AND/OR DISTRIBUTION OF THE GEEOZ SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
 * THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
 * OTHERWISE, EVEN IF GEEOZ HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * A copy of the GNU General Public License is included in the distribution in
 * the file LICENSE and at
 *
 *     http://www.gnu.org/licenses/gpl-2.0.html
 *
 * If you are using the Research Projects for commercial purposes, we
 * encourage you to visit
 *
 *     http://products.geeoz.com/license
 *
 * for more details.
 *
 * This software or hardware and documentation may provide access to
 * or information on content, products, and services from third parties.
 * Geeoz and its affiliates are not responsible for and expressly disclaim
 * all warranties of any kind with respect to third-party content, products,
 * and services. Geeoz and its affiliates will not be responsible for any loss,
 * costs, or damages incurred due to your access to or use of third-party
 * content, products, or services. If a third-party content exists, the
 * additional copyright notices and license terms applicable to portions of the
 * software are set forth in the THIRD_PARTY_LICENSE_README file.
 *
 * Please contact Geeoz or visit www.geeoz.com if you need additional
 * information or have any questions.
 */

package atom.content;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Unmarshaller;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElements;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlValue;
import java.io.IOException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Enumeration;
import java.util.List;
import java.util.Locale;
import java.util.Properties;
import java.util.ResourceBundle;

/**
 * Resource bundle control for accessing an application's xml resources.
 *
 * @author Alex Voloshyn
 * @version 1.0 11/24/13
 */
public final class XmlResourceBundleControl extends ResourceBundle.Control {
    /**
     * XML file format name.
     */
    private static final String XML = "xml";
    /**
     * The XML-only format List containing
     * "file.xml". This List is {@linkplain
     * Collections#unmodifiableList(List) unmodifiable}.
     *
     * @see #getFormats(String)
     */
    private static final List FORMAT_XML
            = Collections.unmodifiableList(Arrays.asList(XML));

    @Override
    public List getFormats(final String baseName) {
        return FORMAT_XML;
    }

    @Override
    public ResourceBundle newBundle(final String baseName,
                                    final Locale locale,
                                    final String format,
                                    final ClassLoader loader,
                                    final boolean reload)
            throws IllegalAccessException, InstantiationException, IOException {
        if (baseName == null || locale == null
                || format == null || loader == null) {
            throw new NullPointerException();
        }
        final ResourceBundle bundle;
        if (XML.equals(format)) {
            final String bundleName = toBundleName(baseName, locale);
            final String resourceName = toResourceName(bundleName, XML);
            final Enumeration urls = Thread.currentThread()
                    .getContextClassLoader().getResources(resourceName);

            if (!urls.hasMoreElements()) {
                return null;
            }
            bundle = new XmlResourceBundle(urls);
        } else {
            throw new IllegalArgumentException("unknown format: " + format);
        }
        return bundle;
    }

    /**
     * Resource bundle implementation that based on XML resources.
     */
    private static class XmlResourceBundle extends ResourceBundle {
        /**
         * Properties container.
         */
        private final Properties properties;

        /**
         * Default constructor with initial URL's.
         *
         * @param urls resources URL's
         */
        public XmlResourceBundle(final Enumeration urls) {
            properties = new Properties();
            final JAXBContext context;
            try {
                context = JAXBContext.newInstance(XmlResource.class);
                final Unmarshaller unmarshaller = context.createUnmarshaller();
                while (urls.hasMoreElements()) {
                    final URL xml = urls.nextElement();
                    final XmlResource file =
                            (XmlResource) unmarshaller.unmarshal(xml);
                    for (Object object : file.resources) {
                        if (object instanceof StringResource) {
                            final StringResource str = (StringResource) object;
                            properties.put(str.name, str.value);
                        } else if (object instanceof StringArrayResource) {
                            final StringArrayResource array =
                                    (StringArrayResource) object;
                            properties.put(array.name, array.list);
                        }
                    }
                }
            } catch (JAXBException e) {
                e.printStackTrace();
            }
        }

        @Override
        protected Object handleGetObject(final String key) {
            return properties.get(key);
        }

        @Override
        public Enumeration getKeys() {
            return Collections.enumeration(properties.stringPropertyNames());
        }
    }

    /**
     * XML resources container.
     */
    @XmlRootElement(name = "resources")
    @XmlAccessorType(XmlAccessType.FIELD)
    private static final class XmlResource {
        /**
         * A container for all resources.
         */
        @XmlElements({
                @XmlElement(name = "string", type = StringResource.class),
                @XmlElement(name = "string-array",
                        type = StringArrayResource.class)
        })
        private final List