Logger hierarchies are stored at the Class level. Log4j will be used if the Log4j system (not necessarily config files) are found in the runtime classpath. Otherwise, java.util.logging will be used.
This is pretty safe because for use cases where multiple hierarchies are desired, classloader hierarchies will effectively isolate multiple class-level Logger hierarchies.
Sad as it is, the java.util.logging facility lacks the most basic developer-side and configuration-side capabilities. Besides having a non-scalable discovery system, the designers didn't comprehend the need for a level between WARNING and SEVERE! Since we don't want to require log4j in Classpath, we have to live with these constraints.
As with all the popular logging frameworks, if you want to capture a stack trace, you must use the two-parameters logging methods. I.e., you must also pass a String, or only toString() from your throwable will be captured.
Usage example:
private static FrameworkLogger logger =
FrameworkLogger.getLog(SqlTool.class);
...
logger.finer("Doing something log-worthy");
The system level property hsqldb.reconfig_logging=false
is
required to avoid configuration of java.util.logging. Otherwise
configuration takes place.
- Since:
- 1.9.0
- Author:
- Blaine Simpson (blaine dot simpson at admc dot com)
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
clearLoggers
(String prefixToZap) Frees Logger(s), if any, with the specified category, or that begins with the specified prefix + dot.void
enduserlog
(Level level, String message) void
This is just a wrapper for FrameworkLogger.warning(), because java.util.logging lacks a method for this critical purpose.void
Just like FrameworkLogger.error(String), but also logs a stack trace.void
void
Just like FrameworkLogger.finer(String), but also logs a stack trace.void
void
Just like FrameworkLogger.finest(String), but also logs a stack trace.static FrameworkLogger
User's entry-point into this logging system.static FrameworkLogger
This method just defers to the getLog(Class) method unless default (no local configuration) JDK logging is being used; In that case, this method assures that the returned logger has an associated FileHander using the supplied String identifier.static FrameworkLogger
Alternative entry-point into this logging system, for cases where you want to share a single logger instance among multiple classes, or you want to use multiple logger instances from a single class.static FrameworkLogger
This method just defers to the getLog(String) method unless default (no local configuration) JDK logging is being used; In that case, this method assures that the returned logger has an associated FileHander using the supplied String identifier.void
void
Just like FrameworkLogger.info(String), but also logs a stack trace.void
void
Just like FrameworkLogger.log(Level, String), but also logs a stack trace.void
The "priv" prefix is historical.static String
report()
Utility method for integrators.void
void
Just like FrameworkLogger.severe(String), but also logs a stack trace.void
void
Just like FrameworkLogger.warning(String), but also logs a stack trace.
-
Method Details
-
report
Utility method for integrators. Returns a string representation of the active Logger instance keys.Not named similar to 'toString' to avoid ambiguity with instance method toString.
- Returns:
- String
-
clearLoggers
Frees Logger(s), if any, with the specified category, or that begins with the specified prefix + dot.Note that as of today, this depends on the underlying logging framework implementation to release the underlying Logger instances. JUL in Sun's JVM uses weak references, so that should be fine. Log4j as of today seems to use strong references (and no API hooks to free anything), so this method will probably have little benefit for Log4j.
- Parameters:
prefixToZap
- String
-
getLog
User's entry-point into this logging system.You normally want to work with static (class-level) pointers to logger instances, for performance efficiency. See the class-level JavaDoc for a usage example.
- Parameters:
c
- Class- Returns:
- FrameworkLogger
-
getLog
This method just defers to the getLog(Class) method unless default (no local configuration) JDK logging is being used; In that case, this method assures that the returned logger has an associated FileHander using the supplied String identifier.- Parameters:
c
- ClasscontextId
- String- Returns:
- FrameworkLogger
-
getLog
This method just defers to the getLog(String) method unless default (no local configuration) JDK logging is being used; In that case, this method assures that the returned logger has an associated FileHander using the supplied String identifier.- Parameters:
baseId
- StringcontextId
- String- Returns:
- FrameworkLogger
-
getLog
Alternative entry-point into this logging system, for cases where you want to share a single logger instance among multiple classes, or you want to use multiple logger instances from a single class.- Parameters:
s
- String- Returns:
- FrameworkLogger
- See Also:
-
log
Just like FrameworkLogger.log(Level, String), but also logs a stack trace.- Parameters:
level
- java.util.logging.Level level to filter and log atmessage
- Message to be loggedt
- Throwable whose stack trace will be logged.- See Also:
-
privlog
The "priv" prefix is historical. This is for special usage when you need to modify the reported call stack. If you don't know that you want to do this, then you should not use this method.- Parameters:
level
- Levelmessage
- Stringt
- ThrowablerevertMethods
- intskipClass
- Class
-
enduserlog
-
log
- Parameters:
level
- java.util.logging.Level level to filter and log atmessage
- Message to be logged- See Also:
-
finer
- Parameters:
message
- Message to be logged- See Also:
-
warning
- Parameters:
message
- Message to be logged- See Also:
-
severe
- Parameters:
message
- Message to be logged- See Also:
-
info
- Parameters:
message
- Message to be logged- See Also:
-
finest
- Parameters:
message
- Message to be logged- See Also:
-
error
This is just a wrapper for FrameworkLogger.warning(), because java.util.logging lacks a method for this critical purpose.- Parameters:
message
- Message to be logged- See Also:
-
finer
Just like FrameworkLogger.finer(String), but also logs a stack trace.- Parameters:
message
- Stringt
- Throwable whose stack trace will be logged.- See Also:
-
warning
Just like FrameworkLogger.warning(String), but also logs a stack trace.- Parameters:
message
- Stringt
- Throwable whose stack trace will be logged.- See Also:
-
severe
Just like FrameworkLogger.severe(String), but also logs a stack trace.- Parameters:
message
- Stringt
- Throwable whose stack trace will be logged.- See Also:
-
info
Just like FrameworkLogger.info(String), but also logs a stack trace.- Parameters:
message
- Stringt
- Throwable whose stack trace will be logged.- See Also:
-
finest
Just like FrameworkLogger.finest(String), but also logs a stack trace.- Parameters:
message
- Stringt
- Throwable whose stack trace will be logged.- See Also:
-
error
Just like FrameworkLogger.error(String), but also logs a stack trace.- Parameters:
message
- Stringt
- Throwable whose stack trace will be logged.- See Also:
-