eu.binjr.common.plugins.ServiceLoaderHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of binjr-core Show documentation
A Time Series Data Browser
There is a newer version: 3.20.1
/*
 *    Copyright 2019-2021 Frederic Thevenet
 *
 *    Licensed 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 eu.binjr.common.plugins;

import eu.binjr.common.logging.Logger;

import java.io.IOException;
import java.net.URL;
import java.net.URLClassLoader;
import java.nio.file.*;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.*;

/**
 * A collection of helper methods to work with {@link ServiceLoader}
 *
 * @author Frederic Thevenet
 */
public final class ServiceLoaderHelper {
    private static final Logger logger = Logger.create(ServiceLoaderHelper.class);

    /**
     * A helper method to load and return service implementations from the classpath and external jars
     *
     * @param clazz          the type of service to load and return
     * @param loadedServices a set of services to witch the loaded services should be added.
     * @param             the type of service to load and return
     */
    public static  void loadFromClasspath(Class clazz, Set loadedServices) {
        // Load plugins from classpath
        loadFromServiceLoader(ServiceLoader.load(clazz), loadedServices);
    }

    /**
     * A helper method to load and return service implementations from the classpath and/or external jars
     *
     * @param clazz             the type of service to load and return
     * @param loadedServices    a set of services to witch the loaded services should be added.
     * @param externalLocations file system paths specifying where to look for external jar to load services from
     * @param                the type of service to load and return
     * @return the class loader used to load jars from the external paths
     */
    public static  ClassLoader loadFromPaths(Class clazz, Set loadedServices, Collection externalLocations) {
        return loadFromPaths(clazz, loadedServices, externalLocations.toArray(Path[]::new));
    }

    /**
     * A helper method to load and return service implementations from the classpath and/or external jars
     *
     * @param clazz             the type of service to load and return
     * @param loadedServices    a set of services to witch the loaded services should be added.
     * @param externalLocations file system paths specifying where to look for external jar to load services from
     * @param                the type of service to load and return
     * @return the class loader used to load jars from the external paths
     */
    public static  ClassLoader loadFromPaths(Class clazz, Set loadedServices, Path... externalLocations) {
        Objects.requireNonNull(externalLocations);
        //Load plugin from external folder
        List urls = new ArrayList<>();
        for (var externalLocation : externalLocations) {
            if (externalLocation != null && Files.exists(externalLocation)) {
                logger.info(() -> "Looking for services of type " + clazz.getName() + " in " + externalLocation);
                PathMatcher jarMatcher = FileSystems.getDefault().getPathMatcher("glob:**.jar");
                try {
                    Files.walkFileTree(externalLocation,
                            EnumSet.noneOf(FileVisitOption.class),
                            1,
                            new SimpleFileVisitor() {
                                @Override
                                public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
                                    if (jarMatcher.matches(file)) {
                                        logger.debug(() -> "Inspecting " + file.getFileName() +
                                                " for " + clazz.getName() + " service implementations");
                                        urls.add(file.toUri().toURL());
                                    }
                                    return FileVisitResult.CONTINUE;
                                }
                            });
                } catch (IOException e) {
                    logger.error("Error while scanning for services: " + e.getMessage());
                    if (logger.isDebugEnabled()) {
                        logger.debug("Stack trace", e);
                    }
                }
            } else {
                logger.warn("External location " + externalLocation + " does not exist.");
            }
        }
        var ucl = new URLClassLoader(urls.toArray(URL[]::new));
        loadFromServiceLoader(ServiceLoader.load(clazz, ucl), loadedServices);
        return ucl;
    }

    private static  void loadFromServiceLoader(ServiceLoader sl, Set loadedServices) {
        for (Iterator iterator = sl.iterator(); iterator.hasNext(); ) {
            try {
                T res = iterator.next();
                loadedServices.add(res);
                logger.debug(() -> "Successfully registered resource " + res.toString() + " from external JAR.");
            } catch (ServiceConfigurationError sce) {
                logger.error("Failed to load resource", sce);
            } catch (Exception e) {
                logger.error("Unexpected error while loading resource", e);
            }
        }
    }

}