eu.eidas.node.utils.PropertiesUtil.java Source code

Introduction

Here is the source code for eu.eidas.node.utils.PropertiesUtil.java

Source

/*
 * Copyright (c) 2015 by European Commission
 *
 * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 * http://www.osor.eu/eupl/european-union-public-licence-eupl-v.1.1
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and
 * limitations under the Licence.
 *
 * This product combines work with different licenses. See the "NOTICE" text
 * file for details on the various modules and licenses.
 * The "NOTICE" text file is part of the distribution. Any derivative works
 * that you distribute must include a readable copy of the "NOTICE" text file.
 *
 */

package eu.eidas.node.utils;

import eu.eidas.auth.commons.*;
import eu.eidas.auth.commons.exceptions.EidasNodeException;
import eu.eidas.node.ApplicationContextProvider;
import eu.eidas.node.auth.connector.AUCONNECTORUtil;
import eu.eidas.node.logging.LoggingMarkerMDC;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.config.PropertyPlaceholderConfigurer;
import org.springframework.core.io.Resource;

import java.io.IOException;
import java.util.*;

/**
 * Util to retrieve a property value. Contains the properties loaded by the placeholderConfig
 * bean on spring initialization
 */
public class PropertiesUtil extends PropertyPlaceholderConfigurer implements IEIDASConfigurationProxy {
    /**
     * Logger object.
     */
    private static final Logger LOG = LoggerFactory.getLogger(PropertiesUtil.class.getName());
    private static Map propertiesMap;
    private List<Resource> locations;
    private static String eidasXmlLocation = null;
    private static final String MASTER_CONF_FILE = "eidas.xml";
    private static final String MASTER_CONF_FILE_PARAM = "eidas.engine.repo";

    @Override
    public void setLocations(Resource... locations) {
        super.setLocations(locations);
        this.locations = new ArrayList<Resource>();
        for (Resource location : locations) {
            this.locations.add(location);
            try {
                if (location.getURL() != null && location.getFilename() != null
                        && MASTER_CONF_FILE.equalsIgnoreCase(location.getFilename())) {
                    PropertiesUtil.setEidasXmlLocation(location.getURL().toString());
                }
            } catch (IOException ioe) {
                LOG.error("cannot retrieve the url of " + MASTER_CONF_FILE + " {}", ioe);
            }
        }
    }

    private static void setEidasXmlLocation(String location) {
        eidasXmlLocation = location;
    }

    public List<Resource> getPropertyLocations() {
        return locations;
    }

    private static void initProps(Properties props) {
        LOG.info(LoggingMarkerMDC.SYSTEM_EVENT, "Loading properties");
        propertiesMap = new HashMap<String, String>();
        for (Object key : props.keySet()) {
            String keyStr = key.toString();
            propertiesMap.put(keyStr, props.getProperty(keyStr));
        }
        if (eidasXmlLocation != null && !props.containsKey(MASTER_CONF_FILE_PARAM)) {
            String fileRepositoryDir = eidasXmlLocation.substring(0,
                    eidasXmlLocation.length() - MASTER_CONF_FILE.length());
            propertiesMap.put(MASTER_CONF_FILE_PARAM, fileRepositoryDir);
            props.put(MASTER_CONF_FILE_PARAM, fileRepositoryDir);
        }

    }

    @Override
    protected void processProperties(ConfigurableListableBeanFactory beanFactory, Properties props)
            throws BeansException {
        super.processProperties(beanFactory, props);
        PropertiesUtil.initProps(props);

    }

    public static String getProperty(String name) {
        return (String) propertiesMap.get(name);
    }

    public String getEidasParameterValue(String parameterName) {
        return PropertiesUtil.getProperty(parameterName);
    }

    private static String getConfigParameter(String parameterName) {
        AUCONNECTORUtil util = ApplicationContextProvider.getApplicationContext() == null ? null
                : ApplicationContextProvider.getApplicationContext().getBean(AUCONNECTORUtil.class);
        String value = null;
        if (util != null && util.getConfigs() != null) {
            value = util.getConfigs().getProperty(parameterName);
        }
        return value;
    }

    public static void checkConnectorActive() {
        String active = getConfigParameter(EIDASParameters.EIDAS_CONNECTOR_ACTIVE.toString());
        if (active != null && !Boolean.valueOf(active)) {
            String msg = "Connector module is inactive by configuration setting";
            LOG.warn(msg);
            throw new EidasNodeException(EIDASUtil.getConfig(EIDASErrors.SP_COUNTRY_SELECTOR_INVALID.errorCode()),
                    EIDASUtil.getConfig(EIDASErrors.SP_COUNTRY_SELECTOR_INVALID.errorMessage()));
        }
    }

    public static void checkProxyServiceActive() {
        String active = getConfigParameter(EIDASParameters.EIDAS_SERVICE_ACTIVE.toString());
        if (active != null && !Boolean.valueOf(active)) {
            String msg = "ProxyService module is inactive by configuration setting";
            LOG.warn(msg);
            throw new EidasNodeException(EIDASUtil.getConfig(EIDASErrors.SP_COUNTRY_SELECTOR_INVALID.errorCode()),
                    EIDASUtil.getConfig(EIDASErrors.SP_COUNTRY_SELECTOR_INVALID.errorMessage()));
        }
    }

    public static boolean isMetadataEnabled() {
        return isMetadataEnabled(EIDASValues.METADATA_ACTIVE.toString());
    }

    private static boolean isMetadataEnabled(String paramName) {
        String active = getConfigParameter(paramName);
        if (active != null && Boolean.parseBoolean(active) == false) {
            return false;
        }
        return true;
    }

    public static String getEidasXmlLocation() {
        if (propertiesMap.containsKey(MASTER_CONF_FILE_PARAM)) {
            return propertiesMap.get(MASTER_CONF_FILE_PARAM).toString();
        }
        return null;
    }

}