org.seedstack.seed.core

Class Seed

java.lang.Object

org.seedstack.seed.core.Seed

public class Seed
extends Object

This class is the SeedStack framework entry point, which is used create and dispose kernels. It handles global initialization and cleanup.

Method Summary

Modifier and Type	Method and Description
static Coffig	baseConfiguration() Provides the application base configuration (i.e.
static void	close() Explicitly cleanup SeedStack global state.
static io.nuun.kernel.api.Kernel	createKernel() Create and start a basic kernel without specifying a runtime context, nor a configuration.
static io.nuun.kernel.api.Kernel	createKernel(Object runtimeContext, io.nuun.kernel.api.config.KernelConfiguration kernelConfiguration, boolean autoStart) Create, initialize and optionally start a kernel with the specified runtime context and configuration.
static DiagnosticManager	diagnostic() Provides the default DiagnosticManager instance to dump diagnostics outside a running kernel.
static void	disableLogs() Disable logs globally if a supported SLF4J implementation is used.
static void	disposeKernel(io.nuun.kernel.api.Kernel kernel) Stops and dispose a running Kernel instance.
static SeedLauncher	getLauncher() Discover implementations of SeedLauncher through the ServiceLoader mechanism and if exactly one implementation is available, returns it.
static SeedLauncher	getToolLauncher(String toolName) Returns an instance of the ToolLauncher configured for the specified tool.
static boolean	hasLifecycleExceptionHandler() Returns if a global exception handler for startup and shutdown is present or not.
static void	refresh()
static BaseException	translateException(Exception exception) Translates any exception that occurred in the application using an extensible exception mechanism.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

hasLifecycleExceptionHandler

public static boolean hasLifecycleExceptionHandler()

Returns if a global exception handler for startup and shutdown is present or not.

Returns:

true if a global exception handler is catching all startup/shutdown exceptions, false otherwise.

disableLogs

public static void disableLogs()

Disable logs globally if a supported SLF4J implementation is used. Currently only Logback is supported.

getLauncher

public static SeedLauncher getLauncher()

Discover implementations of SeedLauncher through the ServiceLoader mechanism and if exactly one implementation is available, returns it. Otherwise, throws an exception.

Returns:

an instance of the unique SeedLauncher implementation.

getToolLauncher

public static SeedLauncher getToolLauncher(String toolName)

Returns an instance of the ToolLauncher configured for the specified tool.

Parameters:

toolName - the tool to execute.

Returns:

the ToolLauncher instance.

diagnostic

public static DiagnosticManager diagnostic()

Provides the default DiagnosticManager instance to dump diagnostics outside a running kernel.

Returns:

the default diagnostic manager.

translateException

public static BaseException translateException(Exception exception)

Translates any exception that occurred in the application using an extensible exception mechanism.

Parameters:

exception - the exception to handle.

Returns:

the translated exception.

baseConfiguration

public static Coffig baseConfiguration()

Provides the application base configuration (i.e. not including configuration sources discovered after kernel startup).

Cannot be called from SeedInitializer methods.

Returns:

the Coffig object for application base configuration.

createKernel

public static io.nuun.kernel.api.Kernel createKernel()

Create and start a basic kernel without specifying a runtime context, nor a configuration. SeedStack JVM-global state is automatically initialized before the first time a kernel is created.

Cannot be called from SeedInitializer methods.

Returns:

the Kernel instance.

createKernel

public static io.nuun.kernel.api.Kernel createKernel(Object runtimeContext,
                                                     io.nuun.kernel.api.config.KernelConfiguration kernelConfiguration,
                                                     boolean autoStart)

Create, initialize and optionally start a kernel with the specified runtime context and configuration. Seed JVM-global state is automatically initialized before the first time a kernel is created.

Cannot be called from SeedInitializer methods.

Parameters:

runtimeContext - the runtime context object, which will be accessible from plugins.

kernelConfiguration - the kernel configuration.

autoStart - if true, the kernel is started automatically.

Returns:

the Kernel instance.

disposeKernel

public static void disposeKernel(io.nuun.kernel.api.Kernel kernel)

Stops and dispose a running Kernel instance.

Cannot be called from SeedInitializer methods.

Parameters:

kernel - the kernel to dispose.

close

public static void close()

Explicitly cleanup SeedStack global state. After calling this method, SeedStack is no longer usable in the current classloader and cannot be reinitialized. Only call this method in standalone JVM environments, just before exiting, typically in a shutdown hook.

Has no effect if called from SeedInitializer methods or after the first call.

refresh

public static void refresh()