com.sap.tc.logging

Class LoggingManager

java.lang.Object
  com.sap.tc.logging.ExceptionHandling
      com.sap.tc.logging.LoggingManager

All Implemented Interfaces:

EventDispatcher

public class LoggingManager
extends com.sap.tc.logging.ExceptionHandling
implements EventDispatcher

Field Summary

protected static IClassLoadRuntimeInfoProvider	classLoadInfoProvider
static Formatter	DEFAULT_FORMATTER
protected static IDeployRuntimeInfoProvider	deployInfoProvider
protected static IThreadRuntimeInfoProvider	threadInfoProvider

Fields inherited from class com.sap.tc.logging.ExceptionHandling

EX_NO_FILTER_EMSG, EX_NO_FORMATTER_EMSG, EX_NO_INSTANCE_EMSG

Method Summary

void	addListener(EventListener listener) To add a listener to the logging tool
Collection	getAllLogs()
static IClassLoadRuntimeInfoProvider	getClassLoadRuntimeInfoProvider()
static IDeployRuntimeInfoProvider	getDeployRuntimeInfoProvider()
boolean	getIncludeStackTraceForEachRecord()
String[]	getListOfLocationIncludeStackTrace()
static LoggingManager	getLoggingManager()
static IThreadRuntimeInfoProvider	getThreadRuntimeInfoProvider()
static boolean	includeStackTrace(String locationName)
protected boolean	isBeingAttached(Log aLog)
protected void	notifyAddLog(Log newLog)
protected void	notifyCreateLogfile(String filename, int limit, int cnt)
protected void	notifyLogControllerReset(LogController logController, boolean isResetTree)
protected void	notifyOverwriteLogfile(FileLog fileLog)
protected void	notifyReleaseLogfile(FileLog fileLog)
protected void	notifyRemoveLog(Log removeLog)
protected void	notifyWriteMessage(LogRecord record)
static void	registerClassLoadRuntimeInfoProvider(IClassLoadRuntimeInfoProvider aClassLoadRuntimeInfoProvider)
static void	registerDeployRuntimeInfoProvider(IDeployRuntimeInfoProvider aDeployRuntimeInfoProvider)
static void	registerRuntimePropertiesPublisher(com.sap.tc.logging.interfaces.IRPPublisher runPropPublisher) To add a publisher of the runtime properies
static void	registerThreadRuntimeInfoProvider(IThreadRuntimeInfoProvider aThreadRuntimeInfoProvider)
void	removeListener(EventListener listener) To remove a listener from the logging tool.
void	reset()
void	setIncludeStackTraceForEachRecord(boolean aIncludeStackTraceForEachRecord)
void	setListOfLocationsIncludeStackTrace(String listOfLocationsIncludeStackTrace)

Methods inherited from class com.sap.tc.logging.ExceptionHandling

getException, getExceptions, handleException, handleException, resetException, throwException

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FORMATTER

public static final Formatter DEFAULT_FORMATTER

classLoadInfoProvider

protected static IClassLoadRuntimeInfoProvider classLoadInfoProvider

threadInfoProvider

protected static IThreadRuntimeInfoProvider threadInfoProvider

deployInfoProvider

protected static IDeployRuntimeInfoProvider deployInfoProvider

Method Detail

getLoggingManager

public static LoggingManager getLoggingManager()

registerRuntimePropertiesPublisher

public static void registerRuntimePropertiesPublisher(com.sap.tc.logging.interfaces.IRPPublisher runPropPublisher)

To add a publisher of the runtime properies

Parameters:

IRPPublisher - Instance of Runtime properties publisher

addListener

public void addListener(EventListener listener)
                 throws IllegalArgumentException

To add a listener to the logging tool

Specified by:

addListener in interface EventDispatcher

Parameters:

listener - The event listener to be added

Throws:

IllegalArgumentException - Invalid listener type. Current valid types: NewLogListener, RemoveLogListener, OverwriteLogfileListener, CreateLogfileListener, ResetLogControllerListener.

removeListener

public void removeListener(EventListener listener)
                    throws IllegalArgumentException

To remove a listener from the logging tool. If the listener does not exist at all, do nothing.

Specified by:

removeListener in interface EventDispatcher

Parameters:

listener - The event listener to be removed

Throws:

IllegalArgumentException - Invalid listener type Current valid types: NewLogListener, RemoveLogListener, OverwriteLogfileListener, CreateLogfileListener, ResetLogControllerListener.

getAllLogs

public Collection getAllLogs()

reset

public void reset()

notifyWriteMessage

protected void notifyWriteMessage(LogRecord record)

notifyAddLog

protected void notifyAddLog(Log newLog)

notifyRemoveLog

protected void notifyRemoveLog(Log removeLog)

notifyOverwriteLogfile

protected void notifyOverwriteLogfile(FileLog fileLog)

notifyReleaseLogfile

protected void notifyReleaseLogfile(FileLog fileLog)

notifyCreateLogfile

protected void notifyCreateLogfile(String filename,
                                   int limit,
                                   int cnt)

notifyLogControllerReset

protected void notifyLogControllerReset(LogController logController,
                                        boolean isResetTree)

isBeingAttached

protected boolean isBeingAttached(Log aLog)

setIncludeStackTraceForEachRecord

public void setIncludeStackTraceForEachRecord(boolean aIncludeStackTraceForEachRecord)

getIncludeStackTraceForEachRecord

public boolean getIncludeStackTraceForEachRecord()

setListOfLocationsIncludeStackTrace

public void setListOfLocationsIncludeStackTrace(String listOfLocationsIncludeStackTrace)

getListOfLocationIncludeStackTrace

public String[] getListOfLocationIncludeStackTrace()

includeStackTrace

public static boolean includeStackTrace(String locationName)

registerClassLoadRuntimeInfoProvider

public static void registerClassLoadRuntimeInfoProvider(IClassLoadRuntimeInfoProvider aClassLoadRuntimeInfoProvider)

registerThreadRuntimeInfoProvider

public static void registerThreadRuntimeInfoProvider(IThreadRuntimeInfoProvider aThreadRuntimeInfoProvider)

registerDeployRuntimeInfoProvider

public static void registerDeployRuntimeInfoProvider(IDeployRuntimeInfoProvider aDeployRuntimeInfoProvider)

getClassLoadRuntimeInfoProvider

public static IClassLoadRuntimeInfoProvider getClassLoadRuntimeInfoProvider()

getThreadRuntimeInfoProvider

public static IThreadRuntimeInfoProvider getThreadRuntimeInfoProvider()

getDeployRuntimeInfoProvider

public static IDeployRuntimeInfoProvider getDeployRuntimeInfoProvider()

Access Rights

This class can be accessed from:

SC	DC
[sap.com] FRAMEWORK	[sap.com] tc/ddic/ddicruntime
[sap.com] ENGINEAPI	[sap.com] tc/logging
[sap.com] ENGFACADE	[sap.com] tc/bl/logging/api
[sap.com] CORE-TOOLS	[sap.com] com.sap.engine.client.lib
[sap.com] BRMS-FACADE	[sap.com] tc/brms/facade