com.yahoo.plugin.Plugin Maven / Gradle / Ivy
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.plugin;
/**
* This interface specifies an API for runtime-loadable server
* plugins. The interface is deliberately simple to allow it to be
* used in different servers. Typically, the initPlugin() method
* calls application-specific registration methods to connect the
* plugin to the hosting application.
*
* @author Stig Bakken
*/
public interface Plugin {
/**
* @return a unique and simple name for the plugin
*/
String getPluginName();
/**
* Initialize the plugin.
*
* @param config Config object for this plugin
*/
void initPlugin(Config config);
/**
* Shut down the plugin. Must clean up all resources allocated by
* initPlugin() or any of the handler methods.
*/
void shutdownPlugin();
}