Class JULConfigurator

java.lang.Object

io.jstach.rainbowgum.jul.JULConfigurator

All Implemented Interfaces:

RainbowGumServiceProvider, RainbowGumServiceProvider.Configurator, AutoCloseable

@ServiceProvider(RainbowGumServiceProvider.class)
public final class JULConfigurator
extends Object
implements RainbowGumServiceProvider.Configurator, AutoCloseable

Will install the JUL handler if the java.logging module is available and is not alreadyi installed.

Nested Class Summary

Nested classes/interfaces inherited from interface RainbowGumServiceProvider

RainbowGumServiceProvider.Configurator, RainbowGumServiceProvider.Pass, RainbowGumServiceProvider.PropertiesProvider, RainbowGumServiceProvider.RainbowGumEagerLoad, RainbowGumServiceProvider.RainbowGumProvider

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 String	JUL_DISABLE_PROPERTY	If true will not install the JUL handler.
static final String	JUL_LEVEL_PROPERTY	Sets the level of the java.util.logging root logger. java.util.logging checks it, and any levels configured in java.util.logging itself, before an event reaches Rainbow Gum, so an event below it is not logged even if Rainbow Gum would log it.

Fields inherited from interface RainbowGumServiceProvider

PASSES

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

Fields inherited from interface RainbowGumServiceProvider.Configurator

CONFIGURATOR_PASSES

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

Constructor Summary

Constructors

Constructor	Description
JULConfigurator()	For service laoder.

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	configure(LogConfig config, RainbowGumServiceProvider.Pass pass)	Do ad-hoc initialization before RainbowGum is fully loaded.
static boolean	install(LogProperties properties)	Will install the JUL handler if not disabled by properties.
static boolean	isInstalled()	Will test if already installed.

Methods inherited from class Object

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

Methods inherited from interface RainbowGumServiceProvider.Configurator

priority

Modifier and Type	Method	Description
default int	priority()	Priority of configurators.

Field Details

JUL_DISABLE_PROPERTY

public static final String JUL_DISABLE_PROPERTY

If true will not install the JUL handler.

Property: logging.jul.disable

See Also:

• Constant Field Values

JUL_LEVEL_PROPERTY

public static final String JUL_LEVEL_PROPERTY

Sets the level of the java.util.logging root logger. java.util.logging checks it, and any levels configured in java.util.logging itself, before an event reaches Rainbow Gum, so an event below it is not logged even if Rainbow Gum would log it. Values (case is ignored):

• sync (default): the root level of Rainbow Gum. Events of a logger configured more verbose than the root, such as logging.level.com.example=debug with an info root, are not logged when they are below the root level.
• none: the level is left as java.util.logging is configured, for example by logging.properties.
• A level such as all, debug or info: that level. With all every event reaches Rainbow Gum, which then applies its own levels, at the cost of a LogRecord for every event including those Rainbow Gum does not log.

Property: logging.jul.level

See Also:

• Constant Field Values

Constructor Details

JULConfigurator

public JULConfigurator()

For service laoder.

Method Details

configure

public boolean configure(LogConfig config,
 RainbowGumServiceProvider.Pass pass)

Description copied from interface: RainbowGumServiceProvider.Configurator

Do ad-hoc initialization before RainbowGum is fully loaded.

Specified by:

configure in interface RainbowGumServiceProvider.Configurator

Parameters:

config - config.

pass - info on what pass this is.

Returns:

true if all dependencies were found.

install

public static boolean install(LogProperties properties)

Will install the JUL handler if not disabled by properties. This method is currently exposed for testing purposes.

Parameters:

properties - properties to check

Returns:

true if enabled.

isInstalled

public static boolean isInstalled()

Will test if already installed. This is mainly for testing purpsoes.

Returns:

true if installed.

close

public void close()

Specified by:

close in interface AutoCloseable