com.safenetinc.luna

Class LunaLogging

java.lang.Object

java.util.logging.Formatter

com.safenetinc.luna.LunaLogging

public class LunaLogging
extends java.util.logging.Formatter

A JSP logging framework utilizing the java.util.logging package built within any JVM

Constructor Summary

Constructors

Constructor and Description
LunaLogging()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	format(java.util.logging.LogRecord record) Format the raw record data input according to a prescribed MessageFormat above.
static java.lang.String	getCallingClassName(int aInLevel) Gets the name of the class calling the caller of this method.
static java.lang.String	getCallingClassName(java.lang.Throwable aInThrowable, int aInLevel) Gets the name of the class that created the throwable.
static java.util.logging.Logger	getLogger() Gets a logger whose category is the full name of the calling class.
static java.util.logging.Logger	getLogger(java.lang.String aInClassName) Either set the created logger with a new temporary handler and subsequent formatter or override the root logger of the JVM overridesystemlogging - This means that the Luna logging code will explicitly manage the logging handlers and formatters as opposed to the default mechanism.
static void	overrideRootLogger() override the root logger's (the JVM's JUL logger) handlers' log message formatters Don't do this if LunaProvider is being used within a more complex application environment like JBoss or another application server where they are employing more elaborate logging mechanisms.

Methods inherited from class java.util.logging.Formatter

formatMessage, getHead, getTail

Methods inherited from class java.lang.Object

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

Constructor Detail

LunaLogging

public LunaLogging()

Method Detail

format

public java.lang.String format(java.util.logging.LogRecord record)

Format the raw record data input according to a prescribed MessageFormat above.

Specified by:

format in class java.util.logging.Formatter

Parameters:

record - the record record to be formatted

Returns:

a formatted string to be published

overrideRootLogger

public static void overrideRootLogger()

override the root logger's (the JVM's JUL logger) handlers' log message formatters Don't do this if LunaProvider is being used within a more complex application environment like JBoss or another application server where they are employing more elaborate logging mechanisms.

getLogger

public static java.util.logging.Logger getLogger(java.lang.String aInClassName)

Either set the created logger with a new temporary handler and subsequent formatter or override the root logger of the JVM overridesystemlogging - This means that the Luna logging code will explicitly manage the logging handlers and formatters as opposed to the default mechanism. This should only be used if something interferes with the LunaLogging system otherwise leave it alone as basic JUL should work just fine with LunaLogging.

Parameters:

aInClassName - the calling class name

Returns:

Logger for calling class

getCallingClassName

public static java.lang.String getCallingClassName(java.lang.Throwable aInThrowable,
                                   int aInLevel)

Gets the name of the class that created the throwable.

 E.g. for a stack trace as follows:
 A.a()
 B.b()
 C.c()
 LunaLogging.getCallingClassName(new Throwable(), n)
 For n = 0 "C" is returned; for n = 1 "B" is returned.
 

Note that this is a fairly expensive operation!!!

Parameters:

aInThrowable - the exception to process

aInLevel - the number of levels above the caller to extract

Returns:

the caller's class name

getCallingClassName

public static java.lang.String getCallingClassName(int aInLevel)

Gets the name of the class calling the caller of this method.

 E.g. for a stack trace as follows:
 A.a()
 B.b()
 C.c()
 LunaLogging.getCallingClassName(n)
 For n = 0 "B" is returned; for n = 1 "A" is returned.
 

Note that this is a fairly expensive operation!!!

Parameters:

aInLevel - the number of levels above the caller to extract

Returns:

the caller's class name

getLogger

public static java.util.logging.Logger getLogger()

Gets a logger whose category is the full name of the calling class.

 Intended for use as:
 private static final Logger logger = LunaLogging.getLogger();
 

It is an expensive operation to determine the calling class, so avoid creating transient loggers with this.

Returns:

a logger