All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.vectorprint.configuration.cdi.PropertyResolver Maven / Gradle / Ivy

Go to download

This project is about configuration of applications and about parameterization of Objects. This library offers annotations (and annotation processors), parsers, typing, observing changes, serialization, cloning and more when working with settings and/or object parameters. Settings and its features can be declared using an xml format. The library offers syntax support for settings and parameters in a loosely coupled manner. You are not restricted to built in syntax, you can provide your own. At runtime this library tracks keys for which a default is used because they are not found in settings. Also it tracks unused keys. You can stack features for settings such as caching, preparing keys and values, readonlyness, threadsafety, helpsupport, reading / parsing from input. You can easily develop your own features for settings.

There is a newer version: 12.2
Show newest version
/*
 * Copyright 2018 Fryske Akademy.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.vectorprint.configuration.cdi;

import com.vectorprint.StringConverter;
import com.vectorprint.VectorPrintException;
import com.vectorprint.configuration.EnhancedMap;
import com.vectorprint.configuration.Settings;
import com.vectorprint.configuration.decoration.CachingProperties;
import com.vectorprint.configuration.decoration.ObservableProperties;
import com.vectorprint.configuration.decoration.ParsingProperties;
import com.vectorprint.configuration.decoration.ReloadableProperties;
import com.vectorprint.configuration.generated.jaxb.Settingstype;
import com.vectorprint.configuration.generated.parser.PropertiesParser;
import com.vectorprint.configuration.jaxb.SettingsFromJAXB;
import com.vectorprint.configuration.jaxb.SettingsXMLHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xml.sax.SAXException;

import javax.enterprise.context.ApplicationScoped;
import javax.enterprise.inject.Produces;
import javax.xml.bind.JAXBException;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;

/**
 * Application scoped CDI bean responsible for providing {@link CDIProperties} with properties read from a Url. CDIProperties is
 * in its turn responsible for injecting properties based on @Inject and @Property. This Resolver needs an Application scoped bean that
 * produces urls, a boolean fromJar and a boolean autoReload, it is up to users of this library to provide that bean. The bean can for example use System properties that are set in the environment to produce the values.
 * @author eduard
 */
@ApplicationScoped
public class PropertyResolver {

    private static final Logger LOGGER = LoggerFactory.getLogger(PropertyResolver.class.getName());

    /**
     * Load properties from jar or url, needs a CDI producer for its arguments
     *
     * @param configFileUrls create an application scoped bean to produce this
     * argument, pointing to a configfile
     * @param fromJar create an application scoped bean to produce this
     * argument, when true read from jar in classpath
     * @param autoReload create an application scoped bean to produce this
     * argument, when true autoreload properties
     * @see StringConverter.URLParser
     * @see SettingsXMLHelper#XSD
     * @throws Exception
     */
    @Produces
    @PropertyProducer
    public EnhancedMap initSettings(@FromJar Boolean fromJar, @AutoReload boolean autoReload, @ConfigFileUrls String... configFileUrls) throws Exception {
        return readAsSettingsOrProperties(fromJar, autoReload, configFileUrls);
    }

    private Reader getReader(String configFileUrl, boolean fromJar) throws IOException {
        InputStream is = fromJar
                        ? Thread.currentThread().getContextClassLoader().getResourceAsStream(configFileUrl)
                        : StringConverter.URL_PARSER.convert(configFileUrl).openStream();
        if (is == null) {
            throw new IllegalArgumentException(String.format("%s not readable, reading from jar: %s", configFileUrl, fromJar));
        }
        return new InputStreamReader(is);
    }

    /**
     *
     * Try to read as either a {@link Settingstype xml configuration file} or
     * {@link PropertiesParser a property file} holding settings. Either {@link SettingsFromJAXB#fromJaxb(Reader)
     * } or {@link ParsingProperties#ParsingProperties(EnhancedMap, String...)
     * }
     * will be called. By default properties will be {@link CachingProperties cached} and {@link com.vectorprint.configuration.decoration.ReadonlyProperties read only}.
     *
     * @param urls
     * @param fromJar when true read from jar in classpath
     * @param autoReload
     * @return
     * @throws JAXBException
     * @throws VectorPrintException
     * @throws IOException
     */
    private EnhancedMap readAsSettingsOrProperties(boolean fromJar, boolean autoReload, String... urls) throws Exception {
        if (urls.length==1) {
            String url = urls[0];
            try {
                try (Reader in = getReader(url, fromJar)) {
                    SettingsXMLHelper.validateXml(in);
                }
                try (Reader in = getReader(url, fromJar)) {
                    return new SettingsFromJAXB().fromJaxb(getReader(url, fromJar));
                }
            } catch (SAXException sAXException) {
                LOGGER.warn(String.format("%s does not contain settings xml, trying to parse settings directly", url));
            }
        }
        return fromJar || !autoReload ?
                new CachingProperties(new ParsingProperties(new Settings(), urls)) :
                new CachingProperties(
                    new ReloadableProperties(new ObservableProperties(new Settings()), urls));
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy