org.elasticsearch.plugins.scanners.StablePluginsRegistry Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation

Elasticsearch subproject :server

There is a newer version: 8.14.0

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.plugins.scanners;

import org.elasticsearch.plugins.PluginBundle;

import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

/**
 * A registry of classes declared by plugins as named components.
 * Named components are classes annotated with @NamedComponent(name) and can be referred later by a name given in this annotation.
 * Named components implement/extend Extensibles (classes/interfaces marked with @Extensible)
 */
public class StablePluginsRegistry {

    /*
    A map of an interface/class name marked (effectively) with @Extensible to NameToPluginInfo map
    effectively means that an interface which extends another interface marked with @Extensible is also extensible
    NameToPluginInfo map is a map of Name to PluginInfo
    i.e.
    org.elasticsearch.plugin.analysis.api.TokenFilterFactory ->
        {"nori" -> {nori, org.elasticserach.plugin.analysis.new_nori.NoriReadingFormFilterFactory, classloaderInstance}
     */
    private final Map namedComponents;
    private final NamedComponentReader namedComponentReader;

    public StablePluginsRegistry() {
        this(new NamedComponentReader(), new HashMap<>());
    }

    // for testing
    public StablePluginsRegistry(NamedComponentReader namedComponentReader, Map namedComponents) {
        this.namedComponentReader = namedComponentReader;
        this.namedComponents = namedComponents;
    }

    public void scanBundleForStablePlugins(PluginBundle bundle, ClassLoader pluginClassLoader) {
        Map namedComponentsFromPlugin = namedComponentReader.findNamedComponents(bundle, pluginClassLoader);
        for (Map.Entry entry : namedComponentsFromPlugin.entrySet()) {
            namedComponents.compute(entry.getKey(), (k, v) -> v != null ? v.put(entry.getValue()) : entry.getValue());
        }
    }

    public Collection getPluginInfosForExtensible(String extensibleClassName) {
        NameToPluginInfo nameToPluginInfo = namedComponents.get(extensibleClassName);
        if (nameToPluginInfo != null) {
            return nameToPluginInfo.nameToPluginInfoMap().values();
        }
        return Collections.emptyList();
    }

}