Collaboration API Documentation

com.filenet.bso.api.util
Class BsoLog

java.lang.Object
  |
  +--com.filenet.bso.api.util.BsoLog

public class BsoLog
extends java.lang.Object

Utility class that wraps a log4j Logger instance with static methods. Has methods that allow callers to examine logging setup (getLevel()), but not modify it. Use log4j.properties for that.

Methods that take a loggerName parameter use the specified logger if it is configured and logging at the given level. Otherwise, they're no-ops. Other methods use the default logger.

See log4j javadoc for more information.


Field Summary
static java.lang.String DEFAULT_ADO_QRY_RESULT_LOGGER_NAME
           
static java.lang.String DEFAULT_LOGGER_PROPERTY
           
static java.lang.String DEFAULT_PERF_LOGGER_NAME
           
static java.lang.String DEFAULT_QRY_STRING_LOGGER_NAME
           
static java.lang.String DEFAULT_XML_QRY_RESULT_LOGGER_NAME
           
static int LEVEL_ALL
           
static int LEVEL_DEBUG
           
static int LEVEL_ERROR
           
static int LEVEL_FATAL
           
static int LEVEL_INFO
           
static int LEVEL_OFF
           
static int LEVEL_WARN
           
protected static org.apache.log4j.Logger logger
          Global logger object.
 
Constructor Summary
BsoLog()
           
 
Method Summary
static void assertLog(boolean assertion, java.lang.String msg)
           
static void debug(java.lang.Object o)
           
static void debug(java.lang.Object o, java.lang.String loggerName)
           
static void debug(java.lang.Object o, java.lang.Throwable t)
           
static void debug(java.lang.Object o, java.lang.Throwable t, java.lang.String loggerName)
           
protected static void dispatch(java.lang.Object o, java.lang.String loggerName, int level)
           
protected static void dispatch(java.lang.Object o, java.lang.Throwable t, java.lang.String loggerName, int level)
           
static void error(java.lang.Object o)
           
static void error(java.lang.Object o, java.lang.String loggerName)
           
static void error(java.lang.Object o, java.lang.Throwable t)
           
static void error(java.lang.Object o, java.lang.Throwable t, java.lang.String loggerName)
           
static void fatal(java.lang.Object o)
           
static void fatal(java.lang.Object o, java.lang.Throwable t)
           
static int getLevel()
           
static int getLevel(java.lang.String loggerName)
           
static void info(java.lang.Object o)
           
static void info(java.lang.Object o, java.lang.String loggerName)
           
static void info(java.lang.Object o, java.lang.Throwable t)
           
static boolean isEnabledFor(int priority)
           
static boolean isEnabledFor(int priority, java.lang.String loggerName)
           
static void log(int priority, java.lang.Object o)
           
static void log(int priority, java.lang.Object o, java.lang.String loggerName)
           
static void log(int priority, java.lang.Object o, java.lang.Throwable t)
           
static void log(int priority, java.lang.Object o, java.lang.Throwable t, java.lang.String loggerName)
           
static long perfStart(java.lang.String msg)
           
static void perfStop(java.lang.String msg, long startTime)
           
static void warn(java.lang.Object o)
           
static void warn(java.lang.Object o, java.lang.String loggerName)
           
static void warn(java.lang.Object o, java.lang.Throwable t)
           
static void warn(java.lang.Object o, java.lang.Throwable t, java.lang.String loggerName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LEVEL_ALL

public static final int LEVEL_ALL

LEVEL_DEBUG

public static final int LEVEL_DEBUG

LEVEL_INFO

public static final int LEVEL_INFO

LEVEL_WARN

public static final int LEVEL_WARN

LEVEL_ERROR

public static final int LEVEL_ERROR

LEVEL_FATAL

public static final int LEVEL_FATAL

LEVEL_OFF

public static final int LEVEL_OFF

DEFAULT_LOGGER_PROPERTY

public static final java.lang.String DEFAULT_LOGGER_PROPERTY

DEFAULT_PERF_LOGGER_NAME

public static final java.lang.String DEFAULT_PERF_LOGGER_NAME

DEFAULT_QRY_STRING_LOGGER_NAME

public static final java.lang.String DEFAULT_QRY_STRING_LOGGER_NAME

DEFAULT_ADO_QRY_RESULT_LOGGER_NAME

public static final java.lang.String DEFAULT_ADO_QRY_RESULT_LOGGER_NAME

DEFAULT_XML_QRY_RESULT_LOGGER_NAME

public static final java.lang.String DEFAULT_XML_QRY_RESULT_LOGGER_NAME

logger

protected static org.apache.log4j.Logger logger
Global logger object. If system property BsoLog.defaultLogger exists and names a correctly configured logger, uses it. Otherwise, uses the root logger.
Constructor Detail

BsoLog

public BsoLog()
Method Detail

dispatch

protected static void dispatch(java.lang.Object o,
                               java.lang.String loggerName,
                               int level)

dispatch

protected static void dispatch(java.lang.Object o,
                               java.lang.Throwable t,
                               java.lang.String loggerName,
                               int level)

debug

public static void debug(java.lang.Object o)

debug

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

debug

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

debug

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

error

public static void error(java.lang.Object o)

error

public static void error(java.lang.Object o,
                         java.lang.Throwable t)

error

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

error

public static void error(java.lang.Object o,
                         java.lang.Throwable t,
                         java.lang.String loggerName)

fatal

public static void fatal(java.lang.Object o)

fatal

public static void fatal(java.lang.Object o,
                         java.lang.Throwable t)

info

public static void info(java.lang.Object o)

info

public static void info(java.lang.Object o,
                        java.lang.String loggerName)

info

public static void info(java.lang.Object o,
                        java.lang.Throwable t)

warn

public static void warn(java.lang.Object o)

warn

public static void warn(java.lang.Object o,
                        java.lang.Throwable t)

warn

public static void warn(java.lang.Object o,
                        java.lang.String loggerName)

warn

public static void warn(java.lang.Object o,
                        java.lang.Throwable t,
                        java.lang.String loggerName)

assertLog

public static void assertLog(boolean assertion,
                             java.lang.String msg)

log

public static void log(int priority,
                       java.lang.Object o)

log

public static void log(int priority,
                       java.lang.Object o,
                       java.lang.Throwable t)

log

public static void log(int priority,
                       java.lang.Object o,
                       java.lang.String loggerName)

log

public static void log(int priority,
                       java.lang.Object o,
                       java.lang.Throwable t,
                       java.lang.String loggerName)

getLevel

public static int getLevel()

isEnabledFor

public static boolean isEnabledFor(int priority)

getLevel

public static int getLevel(java.lang.String loggerName)

isEnabledFor

public static boolean isEnabledFor(int priority,
                                   java.lang.String loggerName)

perfStart

public static long perfStart(java.lang.String msg)

perfStop

public static void perfStop(java.lang.String msg,
                            long startTime)

Collaboration API Documentation

Copyright © 2002 - 2004 FileNet Corporation. All rights reserved.