ServiceFinder.java

208 lines | 7.439 kB Blame History Raw Download
/*
 * Copyright 2010-2011 Ning, Inc.
 *
 * Ning licenses this file to you 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.ning.billing.beatrix.lifecycle;


import com.ning.billing.lifecycle.KillbillService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.*;
import java.util.jar.JarFile;

public class ServiceFinder {

    private static final Logger log = LoggerFactory.getLogger(ServiceFinder.class);

	private final ClassLoader loader;
	private final Set<Class<? extends KillbillService>> servicesTypes;

	public ServiceFinder(ClassLoader loader) {
		this.loader = loader;
		this.servicesTypes = initialize();
		Iterator<Class<? extends KillbillService>> it = servicesTypes.iterator();
		while (it.hasNext()) {
		    Class<? extends KillbillService> svc = it.next();
			log.debug("Found IService classes {}", svc.getName());
		}
	}

	public Set<Class<? extends KillbillService>> getServices() {
	    return servicesTypes;
	}

	private Set<Class<? extends KillbillService>> initialize() {
		try {

		    final Set<String> packageFilter = new HashSet<String>();
		    packageFilter.add("com.ning.billing");
		    final String jarFilter = "killbill";
			return findClasses(loader, KillbillService.class.getName().toString(), jarFilter, packageFilter);
		} catch (ClassNotFoundException nfe) {
			throw new RuntimeException("Failed to initialize ClassFinder", nfe);
		}
	}

    /*
     *  Code originally from Kris Dover <krisdover@hotmail.com> and adapted for my purpose.
     *
     */
	private static Set<Class<? extends KillbillService>> findClasses(ClassLoader classLoader,
	        String interfaceFilter,
	        String jarFilter,
	        Set<String> packageFilter)
	        throws ClassNotFoundException {

	    final Set<Class<? extends KillbillService>> result = new HashSet<Class<? extends KillbillService>>();

	    Object[] classPaths;
	    try {
	        classPaths = ((java.net.URLClassLoader) classLoader).getURLs();
	    } catch(ClassCastException cce){
	        classPaths = System.getProperty("java.class.path", "").split(File.pathSeparator);
	    }

	    for (int h = 0; h < classPaths.length; h++) {


	        Enumeration<?> files = null;
	        JarFile module = null;
	        File classPath = new File( (URL.class).isInstance(classPaths[h]) ?
	                ((URL)classPaths[h]).getFile() : classPaths[h].toString());
	        if (classPath.isDirectory()) {

                log.debug("DIR : " + classPath);

	            List<String> dirListing = new ArrayList<String>();
	            recursivelyListDir(dirListing, classPath, new StringBuffer() );
	            files = Collections.enumeration( dirListing );
	        } else if (classPath.getName().endsWith(".jar")) {

	            log.debug("JAR : " + classPath);

	            String [] jarParts = classPath.getName().split("/");
	            String jarName = jarParts[jarParts.length - 1];
	            if (jarFilter != null && jarName != null && ! jarName.startsWith(jarFilter)) {
	                continue;
	            }
	            boolean failed = true;
	            try {
	                module = new JarFile(classPath);
	                failed = false;
	            } catch (MalformedURLException mue){
	                throw new ClassNotFoundException("Bad classpath. Error: " + mue.getMessage());
	            } catch (IOException io){
	                throw new ClassNotFoundException("jar file '" + classPath.getName() +
	                        "' could not be instantiate from file path. Error: " + io.getMessage());
	            }
	            if (! failed) {
	                files = module.entries();
	            }
	        }

	        while( files != null && files.hasMoreElements() ){
	            String fileName = files.nextElement().toString();

	            if( fileName.endsWith(".class") ){
	                String className = fileName.replaceAll("/", ".").substring(0, fileName.length() - 6);
	                if (packageFilter != null) {
	                    boolean skip = true;
	                    Iterator<String> it = packageFilter.iterator();
	                    while (it.hasNext()) {
	                        String filter = it.next() + ".";
	                        if (className.startsWith(filter)) {
	                            skip = false;
	                            break;
	                        }
	                    }
	                    if (skip) {
	                        continue;
	                    }
	                }
	                Class<?> theClass = null;
	                try {
	                    theClass = Class.forName(className, false, classLoader);
	                } catch(NoClassDefFoundError e) {
	                    continue;
	                }
	                if ( theClass.isInterface() ) {
	                    continue;
	                }
	                Class<?> [] classInterfaces = getAllInterfaces(theClass);
	                String interfaceName = null;
	                for (int i = 0; i < classInterfaces.length; i++) {

	                    interfaceName = classInterfaces[i].getName();
	                    if (!interfaceFilter.equals(interfaceName) ) {
	                        continue;
	                    }
	                    result.add((Class<? extends KillbillService>) theClass);
	                    break;
	                }

	            }
	        }
	        if (module != null) {
	            try {
	                module.close();
	            } catch(IOException ioe) {
	                throw new ClassNotFoundException("The module jar file '" + classPath.getName() +
	                        "' could not be closed. Error: " + ioe.getMessage());
	            }
	        }
	    }
	    return result;
	}

	private static Class<?> [] getAllInterfaces(Class<?> theClass) {
	    Set<Class<?>> superInterfaces = new HashSet<Class<?>>();
	    Class<?> [] classInterfaces = theClass.getInterfaces();
	    for (Class<?> cur : classInterfaces) {
	        getSuperInterfaces(superInterfaces, cur);
	    }
	    return superInterfaces.toArray(new Class<?>[superInterfaces.size()]);
	}

	private static void getSuperInterfaces(Set<Class<?>> superInterfaces, Class<?> theInterface) {

	    superInterfaces.add(theInterface);
	    Class<?> [] classInterfaces = theInterface.getInterfaces();
	    for (Class<?> cur : classInterfaces) {
	        getSuperInterfaces(superInterfaces, cur);
	    }
	}

	private static void recursivelyListDir(List<String> dirListing, File dir, StringBuffer relativePath){
	    int prevLen;
	    if (dir.isDirectory()) {
	        File[] files = dir.listFiles();
	        for(int i = 0; i < files.length; i++){
	            prevLen = relativePath.length();
	            recursivelyListDir(dirListing, files[i],
	                    relativePath.append(prevLen == 0 ? "" : "/" ).append( files[i].getName()));
	            relativePath.delete(prevLen, relativePath.length());
	        }
	    } else {
	        dirListing.add(relativePath.toString());
	    }
	}
}