Module org.glassfish.main.jul

Package org.glassfish.main.jul

Class GlassFishLogManager

java.lang.Object

java.util.logging.LogManager

org.glassfish.main.jul.GlassFishLogManager

public class GlassFishLogManager
extends LogManager

The custom LogManager implementation. Main differences:

• Customized lifecycle allowing deferred or phased configuration, see GlassFishLoggingStatus
• reset() method is not available except internal usage.
• You can use reconfigure(GlassFishLogManagerConfiguration) method instead.
• Or you can use reconfigure(GlassFishLogManagerConfiguration, Action, Action) method, which provides a way to add programatical extension points.

Note: Some methods have complicated implementation, the reason is that JDK LogManager is not an example of well usable and well extensible class at all.

Author:

David Matejcek

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GlassFishLogManager.Action	Action to be performed when client calls reconfigure(GlassFishLogManagerConfiguration, Action, Action)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROOT_LOGGER_NAME	Empty string - standard root logger name

Fields inherited from class java.util.logging.LogManager

LOGGING_MXBEAN_NAME

Constructor Summary

Constructors

Constructor	Description
GlassFishLogManager()	Deprecated. Don't call this constructor directly.

Method Summary

Modifier and Type	Method	Description
boolean	addLogger(Logger logger)
void	closeAllExternallyManagedLogHandlers()	Closes all ExternallyManagedLogHandler instances managed by this log manager.
List<Handler>	getAllHandlers()
List<GlassFishLogger>	getAllLoggers()
GlassFishLogManagerConfiguration	getConfiguration()
GlassFishLogger	getLogger(String name)
GlassFishLoggingStatus	getLoggingStatus()
static GlassFishLogManager	getLogManager()	Returns current GlassFishLogManager instance.
String	getProperty(String name)
GlassFishLogger	getRootLogger()
static boolean	isGlassFishLogManager()
void	readConfiguration()	Deprecated.
void	readConfiguration(InputStream input)	Deprecated.
void	reconfigure(GlassFishLogManagerConfiguration cfg)	Reconfigures the logging system.
void	reconfigure(GlassFishLogManagerConfiguration cfg, GlassFishLogManager.Action reconfigureAction, GlassFishLogManager.Action flushAction)	Reconfigures the logging system.
void	reset()	Deprecated.
void	updateConfiguration(InputStream ins, Function<String,BiFunction<String,String,String>> mapper)	Deprecated.
void	updateConfiguration(Function<String,BiFunction<String,String,String>> mapper)	Deprecated.

Methods inherited from class java.util.logging.LogManager

addConfigurationListener, checkAccess, getLoggerNames, getLoggingMXBean, removeConfigurationListener

Methods inherited from class java.lang.Object

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

Field Details

ROOT_LOGGER_NAME

public static final String ROOT_LOGGER_NAME

Empty string - standard root logger name

See Also:

• Constant Field Values

Constructor Details

GlassFishLogManager

@Deprecated
public GlassFishLogManager()

Deprecated.

Don't call this constructor directly. Use LogManager.getLogManager() instead. See LogManager javadoc for more.

Method Details

isGlassFishLogManager

public static boolean isGlassFishLogManager()

Returns:

true if GlassFishLogManager is configured as the JVM log manager.

getLogManager

public static GlassFishLogManager getLogManager()

Returns current GlassFishLogManager instance.

If it is not initialized yet, starts the initialization.

Returns:

null if the current LogManager is not an instance of this class.

getProperty

public String getProperty(String name)

Overrides:

getProperty in class LogManager

getConfiguration

public GlassFishLogManagerConfiguration getConfiguration()

Returns:

clone of internal configuration properties

addLogger

public boolean addLogger(Logger logger)

Overrides:

addLogger in class LogManager

Returns:

false to force caller to refind the new logger, true to inform him that we did not add it.

getLogger

public GlassFishLogger getLogger(String name)

Overrides:

getLogger in class LogManager

reset

@Deprecated
public void reset()

Deprecated.

Don't use this method, it will not do anything in most cases. It is used just by the LogManager on startup and removes all handlers.

Overrides:

reset in class LogManager

readConfiguration

@Deprecated
public void readConfiguration()
                       throws SecurityException,
IOException

Deprecated.

Does nothing! (Except it can lock caller thread)

Overrides:

readConfiguration in class LogManager

Throws:

SecurityException

IOException

readConfiguration

@Deprecated
public void readConfiguration(InputStream input)
                       throws SecurityException,
IOException

Deprecated.

Don't use this method, it is here just for the LogManager. Use reconfigure(GlassFishLogManagerConfiguration) instead.

Overrides:

readConfiguration in class LogManager

Throws:

SecurityException

IOException

updateConfiguration

@Deprecated
public void updateConfiguration(Function<String,BiFunction<String,String,String>> mapper)
                         throws IOException

Deprecated.

Does nothing!

Overrides:

updateConfiguration in class LogManager

Throws:

IOException

updateConfiguration

@Deprecated
public void updateConfiguration(InputStream ins,
 Function<String,BiFunction<String,String,String>> mapper)
                         throws IOException

Deprecated.

Does nothing!

Overrides:

updateConfiguration in class LogManager

Throws:

IOException

getLoggingStatus

public GlassFishLoggingStatus getLoggingStatus()

Returns:

GlassFishLoggingStatus, never null

getAllLoggers

public List<GlassFishLogger> getAllLoggers()

Returns:

all loggers currently managed by thus log manager (only from user context)

getAllHandlers

public List<Handler> getAllHandlers()

Returns:

all handlers currently managed by this log manager (only from user context)

getRootLogger

public GlassFishLogger getRootLogger()

Returns:

can be null only when LogManager does initialization.

reconfigure

public void reconfigure(GlassFishLogManagerConfiguration cfg)

Reconfigures the logging system.

Parameters:

cfg -

reconfigure

public void reconfigure(GlassFishLogManagerConfiguration cfg,
 GlassFishLogManager.Action reconfigureAction,
 GlassFishLogManager.Action flushAction)

Reconfigures the logging system.

Parameters:

cfg -

reconfigureAction - - a callback executed after the reconfiguration of logger levels is finished. This action may perform some programmatic configuration.

flushAction - - a callback executed after reconfigureAction to flush program's LogRecord buffers waiting until the reconfiguration is completed.

closeAllExternallyManagedLogHandlers

public void closeAllExternallyManagedLogHandlers()

Closes all ExternallyManagedLogHandler instances managed by this log manager. Should be called ie. by shutdown hooks to release all injected dependencies. Handlers must stop processing records after that.