org.jtalks.poulpe.model.utils.JndiAwarePropertyPlaceholderConfigurer.java Source code

Introduction

Here is the source code for org.jtalks.poulpe.model.utils.JndiAwarePropertyPlaceholderConfigurer.java

Source

/**
 * Copyright (C) 2011  JTalks.org Team
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package org.jtalks.poulpe.model.utils;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.config.PropertyPlaceholderConfigurer;

import javax.naming.Context;
import javax.naming.InitialContext;
import javax.naming.NamingException;
import java.util.Properties;

/**
 * <p>Extended version of the usual Spring's {@link PropertyPlaceholderConfigurer} that looks into Tomcat JNDI first.
 * Note, that JNDI is the highest priority and if property was found there, then nothing can override it. If property
 * wasn't found there, then usual algorithm of {@link PropertyPlaceholderConfigurer} is used.</p> <b>Justification</b>:
 * in order to simplify the deployment in different environment like DEV, UAT, we'd like to change Tomcat's {@code
 * $CATALINA_HOME/Catalina/localhost[jtalks_app.xml]} file rather than unzip the war file and change properties there.
 * We certainly don't want to use OS env vars because they are shared between different applications, moreover keeping
 * them there is not that secure.
 *
 * @author stanislav bashkirtsev
 */
public class JndiAwarePropertyPlaceholderConfigurer extends PropertyPlaceholderConfigurer {
    /** Tomcat places its own JNDI context into {@link InitialContext} with this key. So we can look it up. */
    private static final String TOMCAT_CONTEXT_NAME = "java:/comp/env";

    /** 
     * Intentionally didn't want to use Spring's logger from super class, slf4j is more powerful. 
     * <p><b>Caution!</b> Do not make it "static", because the class is used to configure logger on startup and thus
     * it will initialize a logger instance before we actually configured it.</p>
     */
    private final Logger logger = LoggerFactory.getLogger(getClass());

    /**
     * <p>Looks for Tomcat JNDI environment first to get variables from there and returns if the value was found, if
     * nothing found then it works as usual configurer: </p> {@inheritDoc}
     */
    @Override
    protected String resolvePlaceholder(String placeholder, Properties props, int systemPropertiesMode) {
        String propValue = resolveJndiPropertyAndLog(placeholder);
        if (propValue == null) {
            propValue = super.resolvePlaceholder(placeholder, props, systemPropertiesMode);
        }
        return propValue;
    }

    /**
     * Takes a look at Tomcat JNDI environment ({@code java:/comp/env}) and tries to find the placeholder there. Returns
     * {@code null} if nothing found there, otherwise found value is returned as a string.
     *
     * @param placeholder the property key to find its values
     * @return the value of the property from Tomcat JNDI or {@code null} if nothing found there
     */
    private String resolveJndiPropertyAndLog(String placeholder) {
        String propValue = resolveJndiProperty(placeholder);
        if (propValue == null) {
            logger.info("Property {} taken from JNDI.", placeholder, propValue);
        } else {
            logger.info(
                    "Could not resolve JNDI property [{}]. Will be trying file properties, then System ones and "
                            + "if not found anywhere, then defaults will be taken",
                    placeholder);
        }
        return propValue;
    }

    /**
     * Takes a look at Tomcat JNDI environment ({@code java:/comp/env}) and tries to find the placeholder there. Returns
     * {@code null} if nothing found there, otherwise found value is returned as a string.
     *
     * <p>Method is public, so that it can be used in initialization phase of web app out of Spring IoC. Also it also
     * doesn't use any logging, which is particularly useful when it comes to initializing of the logger itself.</p>
     *
     * @param placeholder the property key to find its values
     * @return the value of the property from Tomcat JNDI or {@code null} if nothing found there
     */
    public static String resolveJndiProperty(String placeholder) {
        try {
            Context initContext = new InitialContext();
            Context envContext = (Context) initContext.lookup(TOMCAT_CONTEXT_NAME);
            return (String) envContext.lookup(placeholder);
        } catch (NamingException e) {
            return null;
        }
    }

}