io.kroxylicious.proxy.config.PluginFactory Maven / Gradle / Ivy
/*
* Copyright Kroxylicious Authors.
*
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
*/
package io.kroxylicious.proxy.config;
import io.kroxylicious.proxy.plugin.UnknownPluginInstanceException;
import edu.umd.cs.findbugs.annotations.NonNull;
/**
* A PluginFactory is able to resolve references to a plugin implementation (i.e. a name) to that implementation.
* @param The plugin type
*/
public interface PluginFactory
{
/**
* Resolves a plugin reference to a plugin implementation.
* @param instanceName The name of the plugin implementation
* @return The plugin implementation
* @throws UnknownPluginInstanceException If the plugin implementation with the given name could not be found
*/
@NonNull
P pluginInstance(@NonNull String instanceName);
/**
* Resolves a plugin reference to the plugins config type.
* @param instanceName The name of the plugin implementation
* @return The plugin's config type'
* @throws UnknownPluginInstanceException If the plugin implementation with the given name could not be found
*/
@NonNull
Class configType(@NonNull String instanceName);
}