com.github.shepherdviolet.glaciion.Glaciion Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of glaciion-core Show documentation
An implementation of Java Service Provider Interface
There is a newer version: 2.0.5
/*
 * Copyright (C) 2019-2019 S.Violet
 *
 * 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.
 *
 * Project GitHub: https://github.com/shepherdviolet/glaciion
 * Email: [email protected]
 */

package com.github.shepherdviolet.glaciion;

import com.github.shepherdviolet.glaciion.core.MultipleServiceLoader;
import com.github.shepherdviolet.glaciion.core.PreLoader;
import com.github.shepherdviolet.glaciion.core.SingleServiceLoader;

import java.util.Map;

/**
 * Glaciion: An implementation of Java Service Provider Interface
 *
 * @author S.Violet
 */
public class Glaciion {

    public static final String CLASS_NAME = Glaciion.class.getName();

    /**
     * Load single service by DEFAULT classloader.
     * single-service mode is used when only one service implementation is required.
     * @param interfaceClass Interface type to load
     * @return SingleServiceLoader (Cached)
     */
    public static  SingleServiceLoader loadSingleService(Class interfaceClass){
        return SingleServiceLoader.load(interfaceClass);
    }

    /**
     * Load single service by custom classloader.
     * single-service mode is used when only one service implementation is required.
     * @param interfaceClass Interface type to load
     * @param classLoader Custom classloader
     * @return SingleServiceLoader (Cached)
     */
    public static  SingleServiceLoader loadSingleService(Class interfaceClass, ClassLoader classLoader){
        return SingleServiceLoader.load(interfaceClass, classLoader);
    }

    /**
     * Load multiple services by DEFAULT classloader.
     * multiple-service mode is used to load multiple services (has name and ordered).
     * @param interfaceClass Interface type to load
     * @return MultipleServiceLoader (Cached)
     */
    public static  MultipleServiceLoader loadMultipleService(Class interfaceClass){
        return MultipleServiceLoader.load(interfaceClass);
    }

    /**
     * Load multiple services by custom classloader.
     * multiple-service mode is used to load multiple services (has name and ordered).
     * @param interfaceClass Interface type to load
     * @param classLoader Custom classloader
     * @return MultipleServiceLoader (Cached)
     */
    public static  MultipleServiceLoader loadMultipleService(Class interfaceClass, ClassLoader classLoader){
        return MultipleServiceLoader.load(interfaceClass, classLoader);
    }

    /**
     * Remove all loaders of specified classloader from cache. If you want to get the loader being uninstalled,
     * invoke SingleServiceLoader#uninstall & MultipleServiceLoader#uninstall instead.
     * @param classLoader classloader
     */
    public static void uninstall(ClassLoader classLoader) {
        SingleServiceLoader.uninstall(classLoader);
        MultipleServiceLoader.uninstall(classLoader);
    }

    /**
     * Remove all loaders of DEFAULT classloader from cache. If you want to get the loader being uninstalled,
     * invoke SingleServiceLoader#uninstall & MultipleServiceLoader#uninstall instead.
     */
    public static void uninstallDefaultClassloader() {
        SingleServiceLoader.uninstallDefaultClassloader();
        MultipleServiceLoader.uninstallDefaultClassloader();
    }

    /**
     * Preload all services from specified classloader.
     * For server applications, used to discover definition errors in advance.
     * NOTICE: Preloading automatically in the Spring environment or set -Dglaciion.conf.preload.auto=true.
     *
     * @param classLoader classloader
     */
    public static void preload(ClassLoader classLoader) {
        PreLoader.preload(classLoader);
    }

    /**
     * Preload all services from DEFAULT classloader.
     * For server applications, used to discover definition errors in advance.
     * NOTICE: Preloading automatically in the Spring environment or set -Dglaciion.conf.preload.auto=true.
     */
    public static void preload() {
        PreLoader.preload();
    }

    /**
     * Get all preload checksums.
     * Used to determine if the definition has been changed (Someone added or deleted the service without knowing it.)
     */
    public static Map getPreloadCheckSums() {
        return PreLoader.getCheckSums();
    }

    /**
     * Get preload checksum of specified classloader.
     * Used to determine if the definition has been changed (Someone added or deleted the service without knowing it.)
     */
    public static Integer getPreloadCheckSum(ClassLoader classLoader) {
        return PreLoader.getCheckSum(classLoader);
    }

    /**
     * Get preload checksum of DEFAULT classloader.
     * Used to determine if the definition has been changed (Someone added or deleted the service without knowing it.)
     */
    public static Integer getPreloadCheckSum() {
        return PreLoader.getCheckSum();
    }

    private Glaciion() {
    }

}