org.seedstack.seed.spi

Interface SeedTool

All Superinterfaces:

Callable<Integer>, io.nuun.kernel.api.Plugin

public interface SeedTool
extends Callable<Integer>, io.nuun.kernel.api.Plugin

This interface can be implemented by a Nuun Plugin to declare itself as providing a SeedStack tool. Implementations must be declared as a ServiceLoader service in META-INF/services to be detected.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SeedTool.StartMode The start mode of a SeedStack tool.

Method Summary

Modifier and Type	Method and Description
Collection<Class<?>>	pluginsToLoad() Returns the plugins to load.
SeedTool.StartMode	startMode() Determines the start mode.
String	toolName() Returns the unique name of the tool.

Methods inherited from interface java.util.concurrent.Callable

call

Methods inherited from interface io.nuun.kernel.api.Plugin

bindingRequests, classpathScanRequests, computeAdditionalClasspathScan, dependencyInjectionProvider, dependentPlugins, description, init, kernelParametersAliases, kernelParamsRequests, name, overridingUnitModule, pluginPackageRoot, pluginPropertiesPrefix, provideContainerContext, provideRound, requiredPlugins, rootPackages, start, stop, unitModule

Method Detail

toolName

String toolName()

Returns the unique name of the tool.

Returns:

the unique name of the tool.

startMode

SeedTool.StartMode startMode()

Determines the start mode.

• MINIMAL will disable plugin auto-detection and only enable plugins returned by the pluginsToLoad() method.
• FULL will start the application normally with plugin auto-detection enabled. Plugins returned by the pluginsToLoad() method will also be loaded.

Returns:

the start mode of the tool.

pluginsToLoad

Collection<Class<?>> pluginsToLoad()

Returns the plugins to load.

Returns:

a collection of plugins to explicitly load for this tool.