org.openl.spring.env.PropertySourcesLoader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.openl.spring Show documentation
Common components for Spring integration
The newest version!
package org.openl.spring.env;

import java.util.HashMap;
import java.util.Map;
import jakarta.servlet.ServletContext;

import org.springframework.context.ApplicationContextInitializer;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.MutablePropertySources;
import org.springframework.jndi.JndiLocatorDelegate;
import org.springframework.jndi.JndiPropertySource;

/**
 * Allows to combine environment properties, default application properties and external application properties. This
 * class can be used in the following ways:
 * 
 * In the web.xml, using {@linkplain org.springframework.web.context.ContextLoader#CONTEXT_INITIALIZER_CLASSES_PARAM
 * "contextInitializerClasses"} context parameter.
 * In Spring java configuration like new PropertySourcesLoader().initialize(applicationContext)
 * 
 * Resolving order (next resource overrides previous):
 * OpenL default properties. {@link DefaultPropertySource}
 * Java preferences. {@link PreferencePropertySource}
 * Application externalized configuration. {@link ApplicationPropertySource} 

 * 
Application modifiable configuration. {@link DynamicPropertySource} 

 * 
OS environment variables. {@link System#getenv()}
 * Java System properties. {@link System#getProperties()}
 * JNDI attributes from {@code java:comp/env}
 * Servlet context loadProperties parameters from
 * {@link javax.servlet.ServletContext#getInitParameter(java.lang.String)}
 * 
 *
 * @author Yury Molchan
 * @see org.springframework.context.support.PropertySourcesPlaceholderConfigurer
 * @see org.springframework.beans.factory.config.PlaceholderConfigurerSupport
 * @see org.springframework.context.ApplicationContextInitializer
 * @see ApplicationPropertySource
 */
public class PropertySourcesLoader implements ApplicationContextInitializer {

    @Override
    public void initialize(ConfigurableApplicationContext appContext) {
        ConfigLog.LOG
                .info("The initialization of properties from 'contextInitializerClasses' context-param in web.xml");
        ConfigurableEnvironment oldEnv = appContext.getEnvironment();
        FirewallEnvironment env = new FirewallEnvironment(oldEnv.getPropertySources());
        appContext.setEnvironment(env);
        String appName = normalizeAppName(appContext.getApplicationName());
        loadEnvironment(appContext, env, appName, null);
    }

    public void initialize(ConfigurableApplicationContext appContext, ServletContext servletContext) {
        ConfigLog.LOG.info("The initialization of properties");
        FirewallEnvironment env = new FirewallEnvironment(new MutablePropertySources());
        appContext.setEnvironment(env);
        String appName = normalizeAppName(servletContext.getContextPath());
        loadEnvironment(appContext, env, appName, servletContext);
    }

    private void loadEnvironment(ConfigurableApplicationContext appContext,
                                 FirewallEnvironment env,
                                 String appName,
                                 ServletContext servletContext) {
        FirewallPropertyResolver props = env.getRawPropertyResolver();
        MutablePropertySources propertySources = env.getPropertySources();

        ConfigLog.LOG.info("Loading OpenL System Info properties...");
        propertySources.addFirst(new SysInfoPropertySource());

        if (servletContext != null) {
            propertySources.addLast(new ServletContextPropertySource("ServletContext init parameters", servletContext));
            // Assuming that there is org.springframework.core.env.StandardEnvironment
            if (JndiLocatorDelegate.isDefaultJndiEnvironmentAvailable()) {
                ConfigLog.LOG.info("Loading JNDI properties...");
                propertySources.addLast(new JndiPropertySource("JNDI properties"));
            }
        }
        propertySources.addLast(new SysPropPropertySource(env.getSystemProperties()));
        propertySources.addLast(new SysEnvRefPropertySource(env.getSystemEnvironment()));

        ConfigLog.LOG.info("Loading Random properties...");
        propertySources.addLast(new RandomValuePropertySource());

        ConfigLog.LOG.info("Loading preference properties...");
        PreferencePropertySource preferencePropertySource = new PreferencePropertySource(appName);
        PreferencePropertySource.THE = preferencePropertySource;
        propertySources.addLast(preferencePropertySource);

        ConfigLog.LOG.info("Loading default properties...");
        DefaultPropertySource defaultPropertySource = new DefaultPropertySource();
        propertySources.addLast(defaultPropertySource);

        ConfigLog.LOG.info("Loading application properties...");
        String[] profiles = env.getActiveProfiles();
        propertySources.addBefore(PreferencePropertySource.PROPS_NAME,
                new ApplicationPropertySource(props, appName, profiles));

        ConfigLog.LOG.info("Loading reconfigurable properties...");
        DynamicPropertySource propertySource = new DynamicPropertySource(appName, props);
        DynamicPropertySource.THE = propertySource;
        propertySources.addBefore(ApplicationPropertySource.PROPS_NAME, propertySource);

        propertySources.addBefore(DynamicPropertySource.PROPS_NAME, new DisablePropertySource(propertySources));

        ConfigLog.LOG.info("Register reference property processor...");
        propertySources.addLast(new RefPropertySource(props, propertySources));

        ConfigLog.LOG.info("Activating a firewall against insecure properties keys...");
        props.initFirewall();
        registerPropertyBean(appContext, defaultPropertySource, props);
        ConfigLog.LOG.info("Loading of the properties has been finished.");
    }

    private void registerPropertyBean(ConfigurableApplicationContext appContext,
                                      DefaultPropertySource defaultPropertySource,
                                      FirewallPropertyResolver props) {
        Map propertyMap = new HashMap<>();
        for (String key : defaultPropertySource.getPropertyNames()) {
            propertyMap.put(key, props.getRawProperty(key));
        }
        appContext.addBeanFactoryPostProcessor(bf -> bf.registerSingleton("PropertyBean",
                new PropertyBean(defaultPropertySource.getSource(), propertyMap)));
    }

    private static String normalizeAppName(String appName) {
        if (appName.isEmpty()) {
            return "";
        }
        return appName.replace('/', ' ').replace('\\', ' ').trim().replace(' ', '-');
    }

}