org.deegree.framework.log
Class LoggerService

java.lang.Object
  org.deegree.framework.log.LoggerService

All Implemented Interfaces:

ILogger

Direct Known Subclasses:

JavaLogger, JBossLogger, Log4JLogger

abstract class LoggerService
extends Object
implements ILogger

The Logger is used to log messages to files. This service will use a logging service provided by the application server or a 3rd party logging service such as Apache Log4J to enable asychronous call of the method log(). The log server is configured by a set of Properties which are provided to the class init.

There are some global properties as well:

• log.class : the logging class.
• log.active : to enable or disabel the logging service
• log.mail.active : to activate the email notification
• log.mail.to : the mail address
• log.mail.session : the mail session used to send mail

Messages are logged using log(). If an error occurs during creation or logging, the message will be written to the server BootLogger.

Version:

$Revision: 7597 $, $Date: 2007-06-19 15:29:49 +0200 (Di, 19 Jun 2007) $

Author:

Torsten Friebe , last edited by: UID=$Author: mschneider $

See Also:

LoggerFactory, BootLogger

Field Summary

protected static String

defaultChannelName

Fields inherited from interface org.deegree.framework.log.ILogger

LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_WARNING

Constructor Summary

protected

LoggerService() Create logger instance

Method Summary

void	entering() Log a method entry.
void	entering(String sourceClass, String sourceMethod) Log a method entry.
void	entering(String sourceClass, String sourceMethod, Object[] arguments) Log a method entry with parameters.
void	exiting() Log a method return.
void	exiting(String sourceClass, String sourceMethod) Log a method return.
void	exiting(String sourceClass, String sourceMethod, Object[] arguments) Log a method return with parameters.
void	init(Properties props)
abstract void	logDebug(String message) Log debug message
abstract void	logDebug(String message, Throwable e) Log debug message.
void	logDebugBinaryFile(File file, byte[] data) Logs the given binary data to the specified file if log level is set to LOG_DEBUG.
void	logDebugBinaryFile(String filePrefix, String fileSuffix, byte[] data) Logs the given binary data to a temporary file (created from specified prefix and suffix) if log level is set to LOG_DEBUG.
void	logDebugFile(File file, String content) Logs the given text to the specified file if log level is set to LOG_DEBUG.
void	logDebugFile(String filePrefix, String fileSuffix, String content) Logs the given text to a temporary file (created from specified prefix and suffix) if log level is set to LOG_DEBUG.
void	logDebugXMLFile(String filePrefix, XMLFragment fragment) Logs the given XMLFragment to a temporary file (created from specified prefix and suffix ".xml") if log level is set to LOG_DEBUG.
void	logError(String message, Throwable e, Map properties) Log error with exception
abstract void	logInfo(String message) Log info message
abstract void	logInfo(String message, Throwable e) Log info message
abstract void	logWarning(String message) Log warning message
abstract void	logWarning(String message, Throwable e) Log warning message with exception
protected void	sendMail(String message, Throwable ex, Map properties) Sends email with exception string.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.deegree.framework.log.ILogger

bindClass, bindClass, getLevel, isDebug, log, log, logDebug, logError, logError, logInfo, setLevel

Field Detail

defaultChannelName

protected static String defaultChannelName

Constructor Detail

LoggerService

protected LoggerService()

Create logger instance

Method Detail

init

public void init(Properties props)

Specified by:

init in interface ILogger

logError

public final void logError(String message,
                           Throwable e,
                           Map properties)

Log error with exception

Parameters:

message - the log message

e - the exception to be logged

properties - a given Property file in which specific email notification possibilities are saved.

logWarning

public abstract void logWarning(String message)

Log warning message

Specified by:

logWarning in interface ILogger

Parameters:

message - the log message

logWarning

public abstract void logWarning(String message,
                                Throwable e)

Log warning message with exception

Specified by:

logWarning in interface ILogger

Parameters:

message - the log message

e - the exception to be logged

logInfo

public abstract void logInfo(String message)

Log info message

Specified by:

logInfo in interface ILogger

Parameters:

message - the log message

logInfo

public abstract void logInfo(String message,
                             Throwable e)

Log info message

Specified by:

logInfo in interface ILogger

Parameters:

message - the log message

e - the exception to be logged

logDebug

public abstract void logDebug(String message)

Log debug message

Specified by:

logDebug in interface ILogger

Parameters:

message - the log message

logDebug

public abstract void logDebug(String message,
                              Throwable e)

Log debug message.

Specified by:

logDebug in interface ILogger

Parameters:

message - the log message

e - the exception to be logged

logDebugFile

public void logDebugFile(File file,
                         String content)

Logs the given text to the specified file if log level is set to LOG_DEBUG.

Specified by:

logDebugFile in interface ILogger

Parameters:

file - file to log to

content - text to be logged

logDebugFile

public void logDebugFile(String filePrefix,
                         String fileSuffix,
                         String content)

Logs the given text to a temporary file (created from specified prefix and suffix) if log level is set to LOG_DEBUG.

Specified by:

logDebugFile in interface ILogger

Parameters:

filePrefix - prefix for the temp file name

fileSuffix - suffix for the temp file name, can be null (then ".tmp" is used)

content - text to be logged

See Also:

File.createTempFile(String, String)

logDebugXMLFile

public void logDebugXMLFile(String filePrefix,
                            XMLFragment fragment)

Logs the given XMLFragment to a temporary file (created from specified prefix and suffix ".xml") if log level is set to LOG_DEBUG.

Specified by:

logDebugXMLFile in interface ILogger

Parameters:

filePrefix - prefix for the temp file name

fragment - XMLFragment to be logged (will be pretty-printed)

logDebugBinaryFile

public void logDebugBinaryFile(File file,
                               byte[] data)

Logs the given binary data to the specified file if log level is set to LOG_DEBUG.

Specified by:

logDebugBinaryFile in interface ILogger

Parameters:

file - file to log to

data - binary data to be logged

logDebugBinaryFile

public void logDebugBinaryFile(String filePrefix,
                               String fileSuffix,
                               byte[] data)

Logs the given binary data to a temporary file (created from specified prefix and suffix) if log level is set to LOG_DEBUG.

Specified by:

logDebugBinaryFile in interface ILogger

Parameters:

filePrefix - prefix for the temp file name

fileSuffix - suffix for the temp file name, can be null (then ".tmp" is used)

data - binary data to be logged

See Also:

File.createTempFile(String, String)

entering

public void entering()

Log a method entry.

Specified by:

entering in interface ILogger

entering

public void entering(String sourceClass,
                     String sourceMethod,
                     Object[] arguments)

Log a method entry with parameters.

Specified by:

entering in interface ILogger

arguments - the parameters to be given

entering

public void entering(String sourceClass,
                     String sourceMethod)

Description copied from interface: ILogger

Log a method entry.

Specified by:

entering in interface ILogger

exiting

public void exiting(String sourceClass,
                    String sourceMethod,
                    Object[] arguments)

Description copied from interface: ILogger

Log a method return with parameters.

Specified by:

exiting in interface ILogger

exiting

public void exiting()

Log a method return.

Specified by:

exiting in interface ILogger

exiting

public void exiting(String sourceClass,
                    String sourceMethod)

Log a method return.

Specified by:

exiting in interface ILogger

sendMail

protected void sendMail(String message,
                        Throwable ex,
                        Map properties)

Sends email with exception string. If mail session or mail notification address is null no email is send.

Parameters:

message - message is in mail subject

ex - full exception is displayed in body

properties - list of properties listed in body