Module io.jstach.rainbowgum

Package io.jstach.rainbowgum.spi

Interface RainbowGumServiceProvider

All Known Subinterfaces:

PatternConfig, RainbowGumServiceProvider.Configurator, RainbowGumServiceProvider.PropertiesProvider, RainbowGumServiceProvider.RainbowGumEagerLoad, RainbowGumServiceProvider.RainbowGumProvider

All Known Implementing Classes:

AvajePropertiesProvider, DisruptorConfigurator, GelfEncoderConfigurator, JAnsiConfigurator, JULConfigurator, LoggerDecoratorService, PatternConfigurator, PatternKeywordProvider, RabbitMQInitializer

public sealed interface RainbowGumServiceProvider
permits RainbowGumServiceProvider.Configurator, RainbowGumServiceProvider.PropertiesProvider, RainbowGumServiceProvider.RainbowGumProvider, RainbowGumServiceProvider.RainbowGumEagerLoad

RainbowGum SPI. The Rainbow Gum SPI uses the ServiceLoader with the registration of this class and NOT the non-sealed subclasses! Read the ServiceLoader doc to understand how to register a service loader class. A common option is to use an annotation processor to generate the META-INF/services registration. There are several libraries that can do this:

• Pistachio SVC
• Avaje SPI
• metainf-services

However if your application is fully modularized (has a module-info.java) you will need to use the module-info syntax:

provides io.jstach.rainbowgum.spi.RainbowGumServiceProvider with com.mycompany.SomeService;

Initialization Order:

1. RainbowGumServiceProvider.PropertiesProvider
2. RainbowGumServiceProvider.Configurator
3. RainbowGumServiceProvider.RainbowGumProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RainbowGumServiceProvider.Configurator	Called after LogConfig has been loaded to do various custom initialization like registering LogOutput.OutputProviders.
static enum	RainbowGumServiceProvider.Pass	Providers sometimes need multiple passes to support dependencies without using true dependency injection.
static interface	RainbowGumServiceProvider.PropertiesProvider	Provides properties and or register services.
static interface	RainbowGumServiceProvider.RainbowGumEagerLoad	This is a marker interface that indicates that a facade implementation will do the eager loading of RainbowGum.
static interface	RainbowGumServiceProvider.RainbowGumProvider	Implement to create a custom RainbowGum.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	PASSES	The default amount of passes made to resolve registrators or configurators.

Method Summary

Static Methods

Modifier and Type	Method	Description
static <T extends RainbowGumServiceProvider> Stream<T>	findProviders(ServiceLoader<RainbowGumServiceProvider> loader, Class<T> providerType)	Finds service providers based on type.
static RainbowGum	provide()	Will load all RainbowGum SPI to create a RainbowGum powered from the ServiceLoader using the current thread context class loader if avaiable otherwise the system classloader.
static RainbowGum	provide(ServiceLoader<RainbowGumServiceProvider> loader)	Will load all RainbowGum SPI to create a RainbowGum powered from the ServiceLoader.
static LogConfig	provideConfig(ServiceLoader<RainbowGumServiceProvider> loader)	Creates config from service loader.

Field Details

PASSES

static final int PASSES

The default amount of passes made to resolve registrators or configurators.

See Also:

• Constant Field Values

Method Details

findProviders

static <T extends RainbowGumServiceProvider>
Stream<T> findProviders(ServiceLoader<RainbowGumServiceProvider> loader,
 Class<T> providerType)

Finds service providers based on type.

Type Parameters:

T - provider interface type.

Parameters:

loader - service loader to use.

providerType - provider class.

Returns:

stream containing only provider of the given type.

provideConfig

static LogConfig provideConfig(ServiceLoader<RainbowGumServiceProvider> loader)

Creates config from service loader.

Parameters:

loader - service loader.

Returns:

config.

provide

static RainbowGum provide(ServiceLoader<RainbowGumServiceProvider> loader)

Will load all RainbowGum SPI to create a RainbowGum powered from the ServiceLoader.

Parameters:

loader - service loader to use.

Returns:

Rainbow Gum.

provide

static RainbowGum provide()

Will load all RainbowGum SPI to create a RainbowGum powered from the ServiceLoader using the current thread context class loader if avaiable otherwise the system classloader.

Returns:

Rainbow Gum.