intradoc.common
Class Log

java.lang.Object
  |
  +--intradoc.common.Log

All Implemented Interfaces:

IdcComparator

public class Log

extends java.lang.Object

implements IdcComparator

Field Summary

static int	m_attemptingSystemErrorCount Sees how much contention there is to the log.
static LogDirInfo	m_defaultInfo Default directory where log files will be written.
static int	m_errorType
static int	m_fatalType
static int	m_infoType
protected static java.util.Hashtable	m_logDirInfos Table of current available log directories as mapped to applications
protected static int	m_maxFiles Maximum number of log files.
static boolean[]	m_syncObject Synchronization object.
static int	m_warningType

Constructor Summary

Log()

Method Summary

protected static void	addMessage(int messageType, java.lang.String msg, LogDirInfo logDirInfo, java.lang.Throwable t)
protected static void	addMessage(int messageType, java.lang.String msg, java.lang.String app, java.lang.Throwable t) Protected services that handle adding messages.
int	compare(java.lang.Object obj1, java.lang.Object obj2) Implementation of service gotten from IdcComparator interface.
static void	error(java.lang.String msg) Adds a system error message.
static void	errorEx(java.lang.String msg, java.lang.String app) Adds an error message for a particular application context.
static void	errorEx2(java.lang.String msg, java.lang.String app, java.lang.Throwable t) Adds an error message for a particular application context.
static void	fatal(java.lang.String msg) Adds an fatal sytem message.
static void	fatalEx(java.lang.String msg, java.lang.String app) Adds an fatal message for a particular application context.
static void	fatalEx2(java.lang.String msg, java.lang.String app, java.lang.Throwable t) Adds an fatal message for a particular application context.
static LogDirInfo	getDefaultLogDirInfo() Provides some defaults if application does not provide this information.
static java.lang.String	getRawDesc(int messageType)
static void	info(java.lang.String msg) Puts out an info message at the system level.
static void	infoEx(java.lang.String msg, java.lang.String app) Puts out an info message for a particular application context (such as Archiver).
static void	infoEx2(java.lang.String msg, java.lang.String app, java.lang.Throwable t) Puts out an info message for a particular application context (such as Archiver).
static void	setDefaultLogInfo(java.lang.String dir, java.lang.String indexPage, java.lang.String prefix, java.lang.String header) Set the default log defaults.
static void	setLogDirectory(java.lang.String dir) Sets default log directory where system level logs messages will go.
static void	setLogInfo(java.lang.String app, java.lang.String dir, java.lang.String indexPage, java.lang.String prefix, java.lang.String header) Adds or replaces configuration information about a particular application log context.
static void	warn(java.lang.String msg) Adds a system warning message
static void	warnEx(java.lang.String msg, java.lang.String app) Adds a warning message for a particular application context.
static void	warnEx2(java.lang.String msg, java.lang.String app, java.lang.Throwable t) Adds a warning message for a particular application context.

Methods inherited from class java.lang.Object

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

Field Detail

m_infoType

public static final int m_infoType

See Also:

Constant Field Values

m_warningType

public static final int m_warningType

See Also:

Constant Field Values

m_errorType

public static final int m_errorType

See Also:

Constant Field Values

m_fatalType

public static final int m_fatalType

See Also:

Constant Field Values

m_logDirInfos

protected static java.util.Hashtable m_logDirInfos

Table of current available log directories as mapped to applications

m_maxFiles

protected static final int m_maxFiles

Maximum number of log files.

See Also:

Constant Field Values

m_defaultInfo

public static LogDirInfo m_defaultInfo

Default directory where log files will be written.

m_attemptingSystemErrorCount

public static int m_attemptingSystemErrorCount

Sees how much contention there is to the log.

m_syncObject

public static boolean[] m_syncObject

Synchronization object.

Constructor Detail

Log

public Log()

Method Detail

setLogDirectory

public static void setLogDirectory(java.lang.String dir)
                            throws ServiceException

Sets default log directory where system level logs messages will go.

ServiceException

setLogInfo

public static void setLogInfo(java.lang.String app,
                              java.lang.String dir,
                              java.lang.String indexPage,
                              java.lang.String prefix,
                              java.lang.String header)
                       throws ServiceException

Adds or replaces configuration information about a particular application log context.

ServiceException

setDefaultLogInfo

public static void setDefaultLogInfo(java.lang.String dir,
                                     java.lang.String indexPage,
                                     java.lang.String prefix,
                                     java.lang.String header)
                              throws ServiceException

Set the default log defaults.

ServiceException

getDefaultLogDirInfo

public static LogDirInfo getDefaultLogDirInfo()

Provides some defaults if application does not provide this information.

info

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

Puts out an info message at the system level. Almost all messages are at the system level.

infoEx

public static void infoEx(java.lang.String msg,
                          java.lang.String app)

Puts out an info message for a particular application context (such as Archiver).

infoEx2

public static void infoEx2(java.lang.String msg,
                           java.lang.String app,
                           java.lang.Throwable t)

Puts out an info message for a particular application context (such as Archiver).

warn

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

Adds a system warning message

warnEx

public static void warnEx(java.lang.String msg,
                          java.lang.String app)

Adds a warning message for a particular application context.

warnEx2

public static void warnEx2(java.lang.String msg,
                           java.lang.String app,
                           java.lang.Throwable t)

Adds a warning message for a particular application context.

error

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

Adds a system error message.

errorEx

public static void errorEx(java.lang.String msg,
                           java.lang.String app)

Adds an error message for a particular application context.

errorEx2

public static void errorEx2(java.lang.String msg,
                            java.lang.String app,
                            java.lang.Throwable t)

Adds an error message for a particular application context.

fatal

public static void fatal(java.lang.String msg)

Adds an fatal sytem message. The application usually terminates shortly after calling this service.

fatalEx

public static void fatalEx(java.lang.String msg,
                           java.lang.String app)

Adds an fatal message for a particular application context. The application usually terminates shortly after calling this service.

fatalEx2

public static void fatalEx2(java.lang.String msg,
                            java.lang.String app,
                            java.lang.Throwable t)

Adds an fatal message for a particular application context. The application usually terminates shortly after calling this service.

addMessage

protected static void addMessage(int messageType,
                                 java.lang.String msg,
                                 java.lang.String app,
                                 java.lang.Throwable t)

Protected services that handle adding messages.

addMessage

protected static void addMessage(int messageType,
                                 java.lang.String msg,
                                 LogDirInfo logDirInfo,
                                 java.lang.Throwable t)

compare

public int compare(java.lang.Object obj1,
                   java.lang.Object obj2)

Implementation of service gotten from IdcComparator interface.

Specified by:

compare in interface IdcComparator

See Also:

IdcComparator

getRawDesc

public static java.lang.String getRawDesc(int messageType)