Package com.linecorp.centraldogma.server.plugin

Interface Plugin

All Known Implementing Classes:

AllReplicasPlugin, XdsKubernetesEndpointFetchingPlugin

public interface Plugin

An interface which defines callbacks for a plug-in. If you want to initialize a Plugin by configuring the Central Dogma server (e.g. adding a service for your plugin), use AllReplicasPlugin.

Method Summary

Modifier and Type	Method	Description
Class<?>	configType()	Returns the type of the configuration for this Plugin.
default boolean	isEnabled(CentralDogmaConfig config)	Returns true if this Plugin is enabled.
CompletionStage<Void>	start(PluginContext context)	Invoked when this Plugin is supposed to be started.
CompletionStage<Void>	stop(PluginContext context)	Invoked when this Plugin is supposed to be stopped.
PluginTarget	target(CentralDogmaConfig config)	Returns the PluginTarget which specifies the replicas that this Plugin is applied to.

Method Details

target

PluginTarget target(CentralDogmaConfig config)

Returns the PluginTarget which specifies the replicas that this Plugin is applied to.

start

CompletionStage<Void> start(PluginContext context)

Invoked when this Plugin is supposed to be started.

Parameters:

context - the context which consists of the objects required to execute this Plugin

stop

CompletionStage<Void> stop(PluginContext context)

Invoked when this Plugin is supposed to be stopped.

Parameters:

context - the context which consists of the objects required to execute this Plugin

isEnabled

default boolean isEnabled(CentralDogmaConfig config)

Returns true if this Plugin is enabled.

configType

Class<?> configType()

Returns the type of the configuration for this Plugin.