freenet.support

Class Logger

java.lang.Object

freenet.support.Logger

Direct Known Subclasses:

LoggerHook, VoidLogger

public abstract class Logger
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Logger.LogLevel These indicate the verbosity levels for calls to log() *
static class	Logger.OSThread

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEBUG Deprecated.
static int	ERROR Deprecated.
static int	INTERNAL Deprecated.
static int	MINOR Deprecated.
static int	NORMAL Deprecated.
static int	WARNING Deprecated.

Constructor Summary

Constructors

Constructor and Description
Logger()

Method Summary

Modifier and Type	Method and Description
static void	debug(java.lang.Class<?> c, java.lang.String s)
static void	debug(java.lang.Class<?> c, java.lang.String s, java.lang.Throwable t)
static void	debug(java.lang.Object o, java.lang.String s)
static void	debug(java.lang.Object o, java.lang.String s, java.lang.Throwable t)
static void	destroyChainIfEmpty() If no logger hooks are registered, destroy the global logger hook chain by replacing it with a VoidLogger, which simply ignores everything logged.
static void	error(java.lang.Class<?> c, java.lang.String s)
static void	error(java.lang.Class<?> c, java.lang.String s, java.lang.Throwable t)
static void	error(java.lang.Object o, java.lang.String s)
static void	error(java.lang.Object o, java.lang.String s, java.lang.Throwable e)
static void	fatal(java.lang.Object cause, int retcode, java.lang.String message) Report a fatal error and exit.
static LoggerHookChain	getChain() Get the global logger hook chain, creating it if necessary.
int	getThreshold() Deprecated.
abstract Logger.LogLevel	getThresholdNew()
static void	globalAddHook(LoggerHook logger2) Add a logger hook to the global logger hook chain.
static int	globalGetThreshold() Deprecated.
static Logger.LogLevel	globalGetThresholdNew() What is the current global logging threshold?
static void	globalRemoveHook(LoggerHook hook) Remove a logger hook from the global logger hook chain.
static void	globalSetThreshold(int i) Deprecated.
static void	globalSetThreshold(Logger.LogLevel i) Set the global threshold.
abstract void	instanceRegisterLogThresholdCallback(LogThresholdCallback ltc) Register a log threshold callback with this specific logger, not with the global logger.
boolean	instanceShouldLog(int priority, java.lang.Class<?> c) Deprecated.
boolean	instanceShouldLog(int prio, java.lang.Object o) Deprecated.
abstract boolean	instanceShouldLog(Logger.LogLevel priority, java.lang.Class<?> c) Should this specific Logger object log a message concerning the given class with the given priority.
abstract boolean	instanceShouldLog(Logger.LogLevel prio, java.lang.Object o) Should this specific Logger object log a message concerning the given object with the given priority.
abstract void	instanceUnregisterLogThresholdCallback(LogThresholdCallback ltc) Unregister a log threshold callback with this specific logger.
void	log(java.lang.Class<?> c, java.lang.String message, int priority) Deprecated.
abstract void	log(java.lang.Class<?> c, java.lang.String message, Logger.LogLevel priority) Log a message from static code.
void	log(java.lang.Class<?> c, java.lang.String message, java.lang.Throwable e, int priority) Deprecated.
abstract void	log(java.lang.Class<?> c, java.lang.String message, java.lang.Throwable e, Logger.LogLevel priority) Log a message from static code.
void	log(java.lang.Object o, java.lang.Class<?> source, java.lang.String message, java.lang.Throwable e, int priority) Deprecated.
abstract void	log(java.lang.Object o, java.lang.Class<?> source, java.lang.String message, java.lang.Throwable e, Logger.LogLevel priority) Log a message
void	log(java.lang.Object source, java.lang.String message, int priority) Deprecated.
abstract void	log(java.lang.Object source, java.lang.String message, Logger.LogLevel priority) Log a message.
void	log(java.lang.Object o, java.lang.String message, java.lang.Throwable e, int priority) Deprecated.
abstract void	log(java.lang.Object o, java.lang.String message, java.lang.Throwable e, Logger.LogLevel priority) Log a message with an exception.
static void	logStatic(java.lang.Object o, java.lang.String s, int prio) Deprecated.
static void	logStatic(java.lang.Object o, java.lang.String s, Logger.LogLevel prio)
static void	logStatic(java.lang.Object o, java.lang.String s, java.lang.Throwable e, Logger.LogLevel prio)
static void	minor(java.lang.Class<?> c, java.lang.String s)
static void	minor(java.lang.Class<?> class1, java.lang.String string, java.lang.Throwable t)
static void	minor(java.lang.Object o, java.lang.String s)
static void	minor(java.lang.Object o, java.lang.String s, java.lang.Throwable t)
static void	normal(java.lang.Class<?> c, java.lang.String s)
static void	normal(java.lang.Class<?> c, java.lang.String s, java.lang.Throwable t)
static void	normal(java.lang.Object o, java.lang.String s)
static void	normal(java.lang.Object o, java.lang.String s, java.lang.Throwable t)
static void	registerClass(java.lang.Class<?> clazz) Register a class so that its logMINOR and logDEBUG fields (the latter is optional) are automatically updated whenever they should be i.e.
static void	registerLogThresholdCallback(LogThresholdCallback ltc) Register a LogThresholdCallback; this callback will be called after registration, and whether the overall threshold or the detailed thresholds change in a way that would affect whether messages for the class registering will be logged.
abstract void	setDetailedThresholds(java.lang.String details) Set the detailed list of thresholds.
void	setThreshold(int thresh) Deprecated.
abstract void	setThreshold(Logger.LogLevel thresh) Changes the priority threshold.
abstract void	setThreshold(java.lang.String symbolicThreshold) Changes the priority threshold.
static void	setupChain() Create a LoggerHookChain and set the global logger to be it.
static FileLoggerHook	setupStdoutLogging(int level, java.lang.String detail) Deprecated.
static FileLoggerHook	setupStdoutLogging(Logger.LogLevel level, java.lang.String detail) Log to standard output.
static boolean	shouldLog(int priority, java.lang.Class<?> c) Deprecated.
static boolean	shouldLog(int priority, java.lang.Object o) Deprecated.
static boolean	shouldLog(Logger.LogLevel priority, java.lang.Class<?> c) Would a message concerning an object of the given class be logged at the given priority by the global logger?
static boolean	shouldLog(Logger.LogLevel priority, java.lang.Object o) Would a message concerning the given object be logged at the given priority by the global logger?
static void	unregisterLogThresholdCallback(LogThresholdCallback ltc) Register a LogThresholdCallback; this callback will be called after registration
static void	warning(java.lang.Class<?> c, java.lang.String s)
static void	warning(java.lang.Class<?> c, java.lang.String s, java.lang.Throwable t)
static void	warning(java.lang.Object o, java.lang.String s)
static void	warning(java.lang.Object o, java.lang.String s, java.lang.Throwable e)

Methods inherited from class java.lang.Object

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

Field Detail

ERROR

@Deprecated
public static final int ERROR

Deprecated.

WARNING

@Deprecated
public static final int WARNING

Deprecated.

NORMAL

@Deprecated
public static final int NORMAL

Deprecated.

MINOR

@Deprecated
public static final int MINOR

Deprecated.

DEBUG

@Deprecated
public static final int DEBUG

Deprecated.

INTERNAL

@Deprecated
public static final int INTERNAL

Deprecated.

Constructor Detail

Logger

public Logger()

Method Detail

setupStdoutLogging

public static FileLoggerHook setupStdoutLogging(Logger.LogLevel level,
                                                java.lang.String detail)
                                         throws LoggerHook.InvalidThresholdException

Log to standard output.

Throws:

LoggerHook.InvalidThresholdException

setupStdoutLogging

@Deprecated
public static FileLoggerHook setupStdoutLogging(int level,
                                                            java.lang.String detail)
                                                     throws LoggerHook.InvalidThresholdException

Deprecated.

Throws:

LoggerHook.InvalidThresholdException

setupChain

public static void setupChain()

Create a LoggerHookChain and set the global logger to be it.

debug

public static void debug(java.lang.Class<?> c,
                         java.lang.String s)

debug

public static void debug(java.lang.Class<?> c,
                         java.lang.String s,
                         java.lang.Throwable t)

debug

public static void debug(java.lang.Object o,
                         java.lang.String s)

debug

public static void debug(java.lang.Object o,
                         java.lang.String s,
                         java.lang.Throwable t)

error

public static void error(java.lang.Class<?> c,
                         java.lang.String s)

error

public static void error(java.lang.Class<?> c,
                         java.lang.String s,
                         java.lang.Throwable t)

error

public static void error(java.lang.Object o,
                         java.lang.String s)

error

public static void error(java.lang.Object o,
                         java.lang.String s,
                         java.lang.Throwable e)

minor

public static void minor(java.lang.Class<?> c,
                         java.lang.String s)

minor

public static void minor(java.lang.Object o,
                         java.lang.String s)

minor

public static void minor(java.lang.Object o,
                         java.lang.String s,
                         java.lang.Throwable t)

minor

public static void minor(java.lang.Class<?> class1,
                         java.lang.String string,
                         java.lang.Throwable t)

normal

public static void normal(java.lang.Object o,
                          java.lang.String s)

normal

public static void normal(java.lang.Object o,
                          java.lang.String s,
                          java.lang.Throwable t)

normal

public static void normal(java.lang.Class<?> c,
                          java.lang.String s)

normal

public static void normal(java.lang.Class<?> c,
                          java.lang.String s,
                          java.lang.Throwable t)

warning

public static void warning(java.lang.Class<?> c,
                           java.lang.String s)

warning

public static void warning(java.lang.Class<?> c,
                           java.lang.String s,
                           java.lang.Throwable t)

warning

public static void warning(java.lang.Object o,
                           java.lang.String s)

warning

public static void warning(java.lang.Object o,
                           java.lang.String s,
                           java.lang.Throwable e)

logStatic

public static void logStatic(java.lang.Object o,
                             java.lang.String s,
                             Logger.LogLevel prio)

logStatic

public static void logStatic(java.lang.Object o,
                             java.lang.String s,
                             java.lang.Throwable e,
                             Logger.LogLevel prio)

logStatic

@Deprecated
public static void logStatic(java.lang.Object o,
                                         java.lang.String s,
                                         int prio)

Deprecated.

log

public abstract void log(java.lang.Object o,
                         java.lang.Class<?> source,
                         java.lang.String message,
                         java.lang.Throwable e,
                         Logger.LogLevel priority)

Log a message

Parameters:

o - The object where this message was generated.

source - The class where this message was generated.

message - A clear and verbose message describing the event

e - Logs this exception with the message.

priority - The priority of the mesage, one of LogLevel.ERROR, LogLevel.NORMAL, LogLevel.MINOR, or LogLevel.DEBUG.

log

@Deprecated
public void log(java.lang.Object o,
                            java.lang.Class<?> source,
                            java.lang.String message,
                            java.lang.Throwable e,
                            int priority)

Deprecated.

log

public abstract void log(java.lang.Object source,
                         java.lang.String message,
                         Logger.LogLevel priority)

Log a message.

Parameters:

source - The source object where this message was generated

message - A clear and verbose message describing the event

priority - The priority of the mesage, one of LogLevel.ERROR, LogLevel.NORMAL, LogLevel.MINOR, or LogLevel.DEBUG.

log

@Deprecated
public void log(java.lang.Object source,
                            java.lang.String message,
                            int priority)

Deprecated.

log

public abstract void log(java.lang.Object o,
                         java.lang.String message,
                         java.lang.Throwable e,
                         Logger.LogLevel priority)

Log a message with an exception.

Parameters:

o - The source object where this message was generated.

message - A clear and verbose message describing the event.

e - Logs this exception with the message.

priority - The priority of the mesage, one of LogLevel.ERROR, LogLevel.NORMAL, LogLevel.MINOR, or LogLevel.DEBUG.

See Also:

log(Object o, String message, int priority)

log

@Deprecated
public void log(java.lang.Object o,
                            java.lang.String message,
                            java.lang.Throwable e,
                            int priority)

Deprecated.

log

public abstract void log(java.lang.Class<?> c,
                         java.lang.String message,
                         Logger.LogLevel priority)

Log a message from static code.

Parameters:

c - The class where this message was generated.

message - A clear and verbose message describing the event

priority - The priority of the mesage, one of LogLevel.ERROR, LogLevel.NORMAL, LogLevel.MINOR, or LogLevel.DEBUG.

log

@Deprecated
public void log(java.lang.Class<?> c,
                            java.lang.String message,
                            int priority)

Deprecated.

log

public abstract void log(java.lang.Class<?> c,
                         java.lang.String message,
                         java.lang.Throwable e,
                         Logger.LogLevel priority)

Log a message from static code.

Parameters:

c - The class where this message was generated.

message - A clear and verbose message describing the event

e - Logs this exception with the message.

priority - The priority of the mesage, one of LogLevel.ERROR, LogLevel.NORMAL, LogLevel.MINOR, or LogLevel.DEBUG.

log

@Deprecated
public void log(java.lang.Class<?> c,
                            java.lang.String message,
                            java.lang.Throwable e,
                            int priority)

Deprecated.

instanceShouldLog

public abstract boolean instanceShouldLog(Logger.LogLevel priority,
                                          java.lang.Class<?> c)

Should this specific Logger object log a message concerning the given class with the given priority.

instanceShouldLog

@Deprecated
public boolean instanceShouldLog(int priority,
                                             java.lang.Class<?> c)

Deprecated.

shouldLog

public static boolean shouldLog(Logger.LogLevel priority,
                                java.lang.Class<?> c)

Would a message concerning an object of the given class be logged at the given priority by the global logger?

shouldLog

@Deprecated
public static boolean shouldLog(int priority,
                                            java.lang.Class<?> c)

Deprecated.

shouldLog

public static boolean shouldLog(Logger.LogLevel priority,
                                java.lang.Object o)

Would a message concerning the given object be logged at the given priority by the global logger?

shouldLog

@Deprecated
public static boolean shouldLog(int priority,
                                            java.lang.Object o)

Deprecated.

instanceShouldLog

public abstract boolean instanceShouldLog(Logger.LogLevel prio,
                                          java.lang.Object o)

Should this specific Logger object log a message concerning the given object with the given priority.

instanceShouldLog

@Deprecated
public boolean instanceShouldLog(int prio,
                                             java.lang.Object o)

Deprecated.

setThreshold

public abstract void setThreshold(Logger.LogLevel thresh)

Changes the priority threshold.

Parameters:

thresh - The new threshhold

setThreshold

@Deprecated
public void setThreshold(int thresh)

Deprecated.

setThreshold

public abstract void setThreshold(java.lang.String symbolicThreshold)
                           throws LoggerHook.InvalidThresholdException

Changes the priority threshold.

Parameters:

symbolicThreshold - The new threshhold, must be one of ERROR,NORMAL etc..

Throws:

LoggerHook.InvalidThresholdException

getThresholdNew

public abstract Logger.LogLevel getThresholdNew()

Returns:

The currently used logging threshold

getThreshold

@Deprecated
public int getThreshold()

Deprecated.

setDetailedThresholds

public abstract void setDetailedThresholds(java.lang.String details)
                                    throws LoggerHook.InvalidThresholdException

Set the detailed list of thresholds. This allows to specify that we are interested in debug level logging for one class but are only interested in errors for another, which can be very useful for debugging. Format is classname:threshold,classname:threshold...

Throws:

LoggerHook.InvalidThresholdException

registerLogThresholdCallback

public static void registerLogThresholdCallback(LogThresholdCallback ltc)

Register a LogThresholdCallback; this callback will be called after registration, and whether the overall threshold or the detailed thresholds change in a way that would affect whether messages for the class registering will be logged.

instanceRegisterLogThresholdCallback

public abstract void instanceRegisterLogThresholdCallback(LogThresholdCallback ltc)

Register a log threshold callback with this specific logger, not with the global logger.

unregisterLogThresholdCallback

public static void unregisterLogThresholdCallback(LogThresholdCallback ltc)

Register a LogThresholdCallback; this callback will be called after registration

instanceUnregisterLogThresholdCallback

public abstract void instanceUnregisterLogThresholdCallback(LogThresholdCallback ltc)

Unregister a log threshold callback with this specific logger.

registerClass

public static void registerClass(java.lang.Class<?> clazz)

Register a class so that its logMINOR and logDEBUG fields (the latter is optional) are automatically updated whenever they should be i.e. whenever shouldLog(classname, MINOR) or ,DEBUG would change.

fatal

public static void fatal(java.lang.Object cause,
                         int retcode,
                         java.lang.String message)

Report a fatal error and exit.

Parameters:

cause - the object or class involved

retcode - the return code

message - the reason why

globalAddHook

public static void globalAddHook(LoggerHook logger2)

Add a logger hook to the global logger hook chain. Messages which are not filtered out by the global logger hook chain's thresholds will be passed to this logger.

globalSetThreshold

public static void globalSetThreshold(Logger.LogLevel i)

Set the global threshold. The global logger will ignore messages less significant than the given threshold.

globalSetThreshold

@Deprecated
public static void globalSetThreshold(int i)

Deprecated.

globalGetThresholdNew

public static Logger.LogLevel globalGetThresholdNew()

What is the current global logging threshold?

globalGetThreshold

@Deprecated
public static int globalGetThreshold()

Deprecated.

globalRemoveHook

public static void globalRemoveHook(LoggerHook hook)

Remove a logger hook from the global logger hook chain.

destroyChainIfEmpty

public static void destroyChainIfEmpty()

If no logger hooks are registered, destroy the global logger hook chain by replacing it with a VoidLogger, which simply ignores everything logged.

getChain

public static LoggerHookChain getChain()

Get the global logger hook chain, creating it if necessary.