org.flywaydb.core.internal.plugin.PluginRegister Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flyway-core Show documentation
There is a newer version: 10.15.2
/*
 * Copyright (C) Red Gate Software Ltd 2010-2024
 *
 * 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 org.flywaydb.core.internal.plugin;

import lombok.CustomLog;
import lombok.NoArgsConstructor;
import org.flywaydb.core.api.configuration.Configuration;
import org.flywaydb.core.extensibility.Plugin;

import java.util.ArrayList;
import java.util.List;
import java.util.ServiceLoader;
import java.util.stream.Collectors;

@SuppressWarnings("unchecked")
@CustomLog
@NoArgsConstructor
public class PluginRegister {
    public final List REGISTERED_PLUGINS = new ArrayList<>();
    private final ClassLoader CLASS_LOADER = this.getClass().getClassLoader();
    private boolean hasRegisteredPlugins = false;

    public  T getPlugin(Class clazz) {
        return (T) getPlugins()
                .stream()
                .filter(p -> p.getClass().getCanonicalName().equals(clazz.getCanonicalName()))
                .findFirst()
                .orElse(null);
    }

    public  List getPlugins(Class clazz) {
        return (List) getPlugins()
                .stream()
                .filter(clazz::isInstance)
                .sorted()
                .collect(Collectors.toList());
    }

    public  List getLicensedPlugins(Class clazz, Configuration configuration) {
        return (List) getPlugins()
                .stream()
                .filter(clazz::isInstance)
                .filter(p -> p.isLicensed(configuration))
                .sorted()
                .collect(Collectors.toList());
    }

    public  T getLicensedPlugin(String className, Configuration configuration) {
        return (T) getPlugins()
                .stream()
                .filter(p -> p.isLicensed(configuration))
                .filter(p -> p.getClass().getSimpleName().equals(className))
                .sorted()
                .findFirst()
                .orElse(null);
    }

    private List getPlugins() {
        registerPlugins();
        return REGISTERED_PLUGINS;
    }

    void registerPlugins() {
        synchronized (REGISTERED_PLUGINS) {
            if (hasRegisteredPlugins) {
                return;
            }

            for (Plugin plugin : ServiceLoader.load(Plugin.class, CLASS_LOADER)) {
                if (plugin.isEnabled()) {
                    REGISTERED_PLUGINS.add(plugin);
                }
            }

            hasRegisteredPlugins = true;
        }
    }

    public PluginRegister getCopy(){
        PluginRegister copy = new PluginRegister();
        copy.setRegisteredPlugins(getPlugins());
        return copy;
    }

    private void setRegisteredPlugins(List plugins) {
        REGISTERED_PLUGINS.clear();
        REGISTERED_PLUGINS.addAll(plugins.stream().map(Plugin::copy).collect(Collectors.toList()));
        hasRegisteredPlugins = true;
    }
}