org.cesecore.jndi.JndiHelper Maven / Gradle / Ivy

/*************************************************************************
 *                                                                       *
 *  CESeCore: CE Security Core                                           *
 *                                                                       *
 *  This software 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 any later version.                    *
 *                                                                       *
 *  See terms of license at gnu.org.                                     *
 *                                                                       *
 *************************************************************************/

package org.cesecore.jndi;

import javax.naming.Context;
import javax.naming.InitialContext;
import javax.naming.NamingException;

import org.apache.log4j.Logger;

/**
 * The sole purpose of this class is to standardize mapping in JNDI of our Stateless Session Beans.
 * 
 * Use like this:
 * Stateless(mappedName=(JndiConstants.APP_JNDI_PREFIX + RemoteInterfaceClass.class.getSimpleName()))
 * 
 * @version $Id: JndiHelper.java 28613 2018-04-03 10:53:27Z aminkh $
 */
public abstract class JndiHelper {

	private static final Logger log = Logger.getLogger(JndiHelper.class);
	
	private static Context context = null;

	// By default try the first lookup as JEE5 name, is that fails try JEE6
	// We can probably do this more clever by using reflection or something?
	private static boolean isJEE6 = false;
	
	private static Context getContext() throws NamingException {
		if (context == null) {
		    context = new InitialContext();
		}
		return context;
	}
	
	/**
	 * Helper method to get a reference to a Remote SSB interface.
	 * 
	 * Example usage: CAAdminSessionRemote caadminsession = JndiHelper.getRemoteSession(CAAdminSessionRemote.class);
	 * 
	 * @param 
     * @param module the module where the bean is deployed, i.e. ejbca-ejb or systemtests-ejb.
	 * @param remoteInterface
	 * @return
	 */
    @SuppressWarnings("unchecked")
	public static  T getRemoteSession(final Class remoteInterface, final String module) {
		// JEE5, JBoss 5 and 6 and Glassfish 2
        final String jndiNameJEE5 = JndiConstants.APP_JNDI_PREFIX + remoteInterface.getSimpleName();
		// JEE6, JBoss 7
	    final String viewClassName = remoteInterface.getName();
	    // Get the remote interface class, GlobalConfigurationSessionRemote, and return GlobalConfigurationSessionBean
	    // This works when we follow our own naming standard
	    final String beanName = remoteInterface.getSimpleName().replace("Remote", "Bean");
	    final String jndiNameJEE6 = "ejb:ejbca" + "/" + module + "//"  + beanName + "!" + viewClassName;
        String jndiName = isJEE6 ? jndiNameJEE6 : jndiNameJEE5;
        T ret = null;
        try {
            try {
                ret = (T) getContext().lookup(jndiName);
            } catch (NamingException e) {
                if (!isJEE6) {
                    // If that did not work and we are trying with JEE5 jndi names, try with JEE6 naming
                    try {
                        ret = (T) getContext().lookup(jndiNameJEE6);
                        if (ret != null) {
                            // The JEE6 jndi name worked, use JEE6 naming in the future
                            isJEE6 = true;
                        }
                    } catch (NamingException ne) {
                        // Log the original error, i.e. e not ne
                        log.error("JNDI name lookup error", e);
                    }
                } else {
                    // Log the original error, i.e. e not ne
                    log.error("JNDI name lookup error", e);
                }
            }            
        } catch (ClassCastException e) {
            log.error("JNDI object " + jndiName + " is not of type " + remoteInterface.getName());
        }        
		return ret;
	}
}