Logging (MMBase 1.9-SNAPSHOT

java.lang.Object
- org.mmbase.util.logging.Logging

public class Logging
extends Object

With this class the logging is configured, and it supplies the `Logger' objects.

For example:

 
 import org.mmbase.util.logging.Logging;
 import org.mmbase.util.logging.Logger;
 import org.mmbase.util.logging.Level;

 public class test {

     static {
         Logging.configure("log.xml");
     }

     static Logger log = Logging.getLoggerInstance(test.class);

     public static void main(String[] args) {
         log.debug("start");
         log.info("Entering application.");

         log.setLevel(Level.TRACE);
         if (log.isDebugEnabled()) {
             log.debug("debug een");
             log.trace("trace twee");
         }
         log.info("info");
         log.service("service");


         Logging.shutdown();
     }
 }

Version:: $Id$
Author:: Michiel Meeuwissen

Field Summary

Fields
Modifier and Type Field and Description

static String PAGE_CATEGORY
The category for logging info about pages (like stop / start).

Fields
Modifier and Type	Field and Description
`static String`	`PAGE_CATEGORY` The category for logging info about pages (like stop / start).

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`applicationStacktrace()`
`static String`	`applicationStacktrace(Throwable e)`
`static void`	`configure(ResourceLoader rl, String configFile)` Configure the logging system.
`static void`	`configureClass(String configuration)` Calls the 'configure' static method of the used logging class, or does nothing if it doesn't exist.
`static Map<String,String>`	`getInitParameters()`
`static Logger`	`getLoggerInstance(Class<?> cl)` Most Logger categories in MMBase are based on class name.
`static Logger`	`getLoggerInstance(String s)` After configuring the logging system, you can get Logger instances to log with.
`static String`	`getMachineName()`
`static MDC`	`getMDC()` MDC stands for mapped diagnostic contexts See also log4j.MDC
`static ResourceLoader`	`getResourceLoader()` Logging is configured with a log file.
`static boolean`	`isEnabled(Level l, Logger log)` Utility method for dynamicly checking the 'enabled'ness of a logger on a given level.
`static void`	`log(Level l, Logger log, String mes)` Utility method for dynamicly determin the level of logging.
`static void`	`setMachineName(String mn)`
`static void`	`shutdown()` If the configured Logger implements a shutdown static method, it will be called.
`static String`	`stackTrace()` Returns the stacktrace of the current call.
`static String`	`stackTrace(int max)`
`static String`	`stackTrace(Throwable e)` Returns the stacktrace of an exception as a string, which can be logged handy.
`static String`	`stackTrace(Throwable e, int max)` Also returns a stringified stack trace to log, but no deeper than given max.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PAGE_CATEGORY
```
public static final String PAGE_CATEGORY
```
    The category for logging info about pages (like stop / start). Also if pages take the initiative for logging themselves they should log below this category.
    
    Since:
    
    MMBase-1.7
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getMachineName
```
public static String getMachineName()
```
    Since:
    
    MMBase-1.8
  - setMachineName
```
public static void setMachineName(String mn)
```
    Since:
    
    MMBase-1.8
  - getInitParameters
```
public static Map<String,String> getInitParameters()
```
    Since:
    
    MMBase-1.8.5
  - configure
```
public static void configure(ResourceLoader rl,
                             String configFile)
```
    Configure the logging system.
    
    Parameters:
    
    configFile - Path to an xml-file in which is described which class must be used for logging, and how this will be configured (typically the name of another configuration file).
  - configureClass
```
public static void configureClass(String configuration)
```
    Calls the 'configure' static method of the used logging class, or does nothing if it doesn't exist. You could call this method if you want to avoid using 'configure', which parses an XML file.
  - getResourceLoader
```
public static ResourceLoader getResourceLoader()
```
    Logging is configured with a log file. This method returns the File which was used.
  - getLoggerInstance
```
public static Logger getLoggerInstance(String s)
```
    After configuring the logging system, you can get Logger instances to log with.
    
    Parameters:
    
    s - A string describing the `category' of the Logger. This is a log4j concept.
  - getMDC
```
public static MDC getMDC()
```
    MDC stands for mapped diagnostic contexts See also log4j.MDC
    
    Since:
    
    MMBase-1.9.2
  - getLoggerInstance
```
public static Logger getLoggerInstance(Class<?> cl)
```
    Most Logger categories in MMBase are based on class name.
    
    Since:
    
    MMBase-1.6.4
  - shutdown
```
public static void shutdown()
```
    If the configured Logger implements a shutdown static method, it will be called. (the log4j Category does).
  - stackTrace
```
public static String stackTrace()
```
    Returns the stacktrace of the current call. This can be used to get a stacktrace when no exception was thrown and my help determine the root cause of an error message (what class called the method that gave the error message.
    
    Since:
    
    MMBase-1.7
  - stackTrace
```
public static String stackTrace(int max)
```
    Since:
    
    MMBase-1.7
  - stackTrace
```
public static String stackTrace(Throwable e)
```
    Returns the stacktrace of an exception as a string, which can be logged handy. Doing simply e.printStackTrace() would dump the stack trace to standard error, which with the log4j implementation will appear in the log file too, but this is a little nicer. It is also possible to call 'error' or 'fatal' with an extra argument.
    
    Parameters:
    
    e - the Throwable from which the stack trace must be stringified.
  - stackTrace
```
public static String stackTrace(Throwable e,
                                int max)
```
    Also returns a stringified stack trace to log, but no deeper than given max.
    
    Since:
    
    MMBase-1.7
  - applicationStacktrace
```
public static String applicationStacktrace()
```
    Since:
    
    MMBase-1.8
  - applicationStacktrace
```
public static String applicationStacktrace(Throwable e)
```
    Since:
    
    MMBase-1.8
  - log
```
public static void log(Level l,
                       Logger log,
                       String mes)
```
    Utility method for dynamicly determin the level of logging.
    
    Since:
    
    MMBase-1.9
  - isEnabled
```
public static boolean isEnabled(Level l,
                                Logger log)
```
    Utility method for dynamicly checking the 'enabled'ness of a logger on a given level.
    
    Since:
    
    MMBase-1.9

Class Logging

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PAGE_CATEGORY

Method Detail

getMachineName

setMachineName

getInitParameters

configure

configureClass

getResourceLoader

getLoggerInstance

getMDC

getLoggerInstance

shutdown

stackTrace

stackTrace

stackTrace

stackTrace

applicationStacktrace

applicationStacktrace

log

isEnabled