Jive Forums API (5.5.20.2-oracle) Core Javadocs

com.jivesoftware.base
Class Log

java.lang.Object
  extended by com.jivesoftware.base.Log

public class Log
extends java.lang.Object

Simple wrapper to the JDK logger.


Method Summary
static void debug(java.lang.String s)
           
static void debug(java.lang.String s, java.lang.Throwable throwable)
           
static void debug(java.lang.Throwable throwable)
           
static void error(java.lang.String s)
           
static void error(java.lang.String s, java.lang.Throwable throwable)
           
static void error(java.lang.Throwable throwable)
           
static void fine(java.lang.String s, java.lang.Throwable throwable)
           
static void fine(java.lang.Throwable throwable)
           
protected static void flushLogs()
          This method is used to shutdown the Log class.
static java.lang.String getLogDirectory()
          Returns the directory that log files exist in.
static void info(java.lang.String s)
           
static void info(java.lang.String s, java.lang.Throwable throwable)
           
static void info(java.lang.Throwable throwable)
           
static void initLog()
          This method is used to initialize the Log class.
static boolean isDebugEnabled()
           
static boolean isErrorEnabled()
           
static boolean isInfoEnabled()
           
static boolean isWarnEnabled()
           
static void markDebugLogFile(User user)
           
static void markErrorLogFile(User user)
           
static void markInfoLogFile(User user)
           
static void markWarnLogFile(User user)
           
static void rotateDebugLogFile()
           
static void rotateErrorLogFile()
           
static void rotateInfoLogFile()
           
static void rotateWarnLogFile()
           
static void setDebugEnabled(boolean enabled)
           
static void warn(java.lang.String s)
           
static void warn(java.lang.String s, java.lang.Throwable throwable)
           
static void warn(java.lang.Throwable throwable)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

initLog

public static void initLog()
This method is used to initialize the Log class. For normal operations this method should never be called, rather it's only publically available so that the class can be reset by the setup process once the jiveHome directory has been specified.


flushLogs

protected static void flushLogs()
This method is used to shutdown the Log class.


isDebugEnabled

public static boolean isDebugEnabled()

isInfoEnabled

public static boolean isInfoEnabled()

isWarnEnabled

public static boolean isWarnEnabled()

isErrorEnabled

public static boolean isErrorEnabled()

setDebugEnabled

public static void setDebugEnabled(boolean enabled)

debug

public static void debug(java.lang.String s)

debug

public static void debug(java.lang.Throwable throwable)

debug

public static void debug(java.lang.String s,
                         java.lang.Throwable throwable)

fine

public static void fine(java.lang.Throwable throwable)

fine

public static void fine(java.lang.String s,
                        java.lang.Throwable throwable)

markDebugLogFile

public static void markDebugLogFile(User user)

rotateDebugLogFile

public static void rotateDebugLogFile()

info

public static void info(java.lang.String s)

info

public static void info(java.lang.Throwable throwable)

info

public static void info(java.lang.String s,
                        java.lang.Throwable throwable)

markInfoLogFile

public static void markInfoLogFile(User user)

rotateInfoLogFile

public static void rotateInfoLogFile()

warn

public static void warn(java.lang.String s)

warn

public static void warn(java.lang.Throwable throwable)

warn

public static void warn(java.lang.String s,
                        java.lang.Throwable throwable)

markWarnLogFile

public static void markWarnLogFile(User user)

rotateWarnLogFile

public static void rotateWarnLogFile()

error

public static void error(java.lang.String s)

error

public static void error(java.lang.Throwable throwable)

error

public static void error(java.lang.String s,
                         java.lang.Throwable throwable)

markErrorLogFile

public static void markErrorLogFile(User user)

rotateErrorLogFile

public static void rotateErrorLogFile()

getLogDirectory

public static java.lang.String getLogDirectory()
Returns the directory that log files exist in. The directory name will have a File.separator as the last character in the string.

Returns:
the directory that log files exist in.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.