oracle.ifs.core.runtime

Class LogManager

java.lang.Object

oracle.ifs.core.runtime.LogManager

public class LogManager
extends Object

A LogManager manages the logging subsystem.

Author:

Dave Long

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOGGING_FRAMEWORK_JUL Constant used to indicate the logging framework should be java.util.logging (JUL).
static String	LOGGING_FRAMEWORK_SLF4J Constant used to indicate the logging framework should use the SLF4J APIs.
static String	TEXT_FORMAT Deprecated. 9.3.6.0 use same constant on LogConfiguration
static String	XML_FORMAT Deprecated. 9.3.6.0 use same constant on LogConfiguration

Method Summary

Modifier and Type	Method and Description
void	addLogger(IfsLogger logger) Add a logger.
void	applyLogLevelOverride(String logEntry) Apply a log level overrides.
void	applyLogLevelOverrides(String[] logEntries) Apply a set of log level overrides.
void	clearAllLogLevelOverrides() Clear all log level overrides.
void	configure(AttributeValueTable config) Configure this LogManager.
AttributeValueTable	getConfiguration() Gets the configuration for this LogManager.
Level	getEffectiveLevel(IfsLogger logger) Deprecated. 9.3.6.0 call directly on IfsLogger
static LogManager	getInstance() Get the singleton instance of LogManager.
IfsLogger	getLogger(String loggerName) Get the IfsLogger by name.
String	getRootLoggerName() Gets the root logger name, established during configuration.
boolean	isInitialized() Returns indication as to whether logging has been initialized.
boolean	isJulFrameworkEnabled() Returns indication as to whether if the java.util.logging (JUL) logging framework is enabled.
boolean	isSlf4jFrameworkEnabled() Returns indication as to whether if the SLF4J logging facade framework is enabled.
void	setLogLevel(String loggerName, Level level) Sets a log level.

Methods inherited from class java.lang.Object

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

Field Detail

TEXT_FORMAT

@Deprecated
public static final String TEXT_FORMAT

Deprecated. 9.3.6.0 use same constant on LogConfiguration

Constant used to specify the simple text formatting of log output.

See Also:

Constant Field Values

(Unpublished)

XML_FORMAT

@Deprecated
public static final String XML_FORMAT

Deprecated. 9.3.6.0 use same constant on LogConfiguration

Constant used to specify the XML formatting of log output.

See Also:

Constant Field Values

(Unpublished)

LOGGING_FRAMEWORK_JUL

public static final String LOGGING_FRAMEWORK_JUL

Constant used to indicate the logging framework should be java.util.logging (JUL).

See Also:

Constant Field Values

(Published)

LOGGING_FRAMEWORK_SLF4J

public static final String LOGGING_FRAMEWORK_SLF4J

Constant used to indicate the logging framework should use the SLF4J APIs.

See Also:

Constant Field Values

(Published)

Method Detail

getInstance

public static LogManager getInstance()

Get the singleton instance of LogManager.

Returns:

the LogManager singleton

isInitialized

public boolean isInitialized()

Returns indication as to whether logging has been initialized.

Returns:

true if logging has been initialized

isJulFrameworkEnabled

public boolean isJulFrameworkEnabled()

Returns indication as to whether if the java.util.logging (JUL) logging framework is enabled.

Returns:

true if the JUL logging framework is enabled

isSlf4jFrameworkEnabled

public boolean isSlf4jFrameworkEnabled()

Returns indication as to whether if the SLF4J logging facade framework is enabled.

Returns:

true if the SLF4J logging facade framework is enabled

getConfiguration

public AttributeValueTable getConfiguration()
                                     throws IfsException

Gets the configuration for this LogManager.

This will include an entry for the complete set of log-level overrides in effect.

Returns:

the table of logging configuration parameters

Throws:

IfsException - if the operation fails

(Published)

getRootLoggerName

public String getRootLoggerName()

Gets the root logger name, established during configuration.

Returns:

the root logger name

(Published)

configure

public void configure(AttributeValueTable config)
               throws IfsException

Configure this LogManager.

Parameters:

config - the table of logging configuration parameters

Throws:

IfsException - if the operation fails

(Published)

clearAllLogLevelOverrides

public void clearAllLogLevelOverrides()

Clear all log level overrides.

applyLogLevelOverrides

public void applyLogLevelOverrides(String[] logEntries)

Apply a set of log level overrides.

Parameters:

logEntries - the log override entries

applyLogLevelOverride

public void applyLogLevelOverride(String logEntry)

Apply a log level overrides.

Parameters:

logEntry - the log override entry

setLogLevel

public void setLogLevel(String loggerName,
                        Level level)

Sets a log level.

The specified loggerName can be the name of a specific class or a package name.

Parameters:

loggerName - The logger name

level - the effective log level for this logger name

(Published)

getEffectiveLevel

@Deprecated
public Level getEffectiveLevel(IfsLogger logger)

Deprecated. 9.3.6.0 call directly on IfsLogger

Get the effective level for the specified Logger.

Now just delegates to IfsLogger, which can figure it out by checking isLoggable() calls.

Parameters:

logger - The IfsLogger to check

Returns:

the effective log level

(Published)

addLogger

public void addLogger(IfsLogger logger)

Add a logger.

Parameters:

logger - The IfsLogger to add.

(Unpublished)

getLogger

public IfsLogger getLogger(String loggerName)

Get the IfsLogger by name.

Parameters:

loggerName - name of the logger.

Returns:

The IfsLogger, or null if not yet registered

(Published)