com.prosyst.mprm.debug

Class LogCommunicator

java.lang.Object

com.prosyst.mprm.debug.LogCommunicator

Direct Known Subclasses:

com.prosyst.mprm.debug.ext.MonitoredCommunicator, StdoutCommunicator

public abstract class LogCommunicator
extends java.lang.Object

The subclasses of this abstract class are responsible for the actual output of the debug information. This class is used by the Log class, and is not intended for direct usage by the applications.

Since:

20.11.2002

Version:

1.0

Author:

Ivailo Duevski

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEBUG_ALL
static int	DEBUG_OFF
static int	DEBUG_ON_CAT
static int	DEBUG_ON_DEVICE
protected byte	detailLevel
static java.lang.String[]	LOG_LEVELS_EXT
protected boolean	perThread

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LogCommunicator(boolean $perThread)

Method Summary

Modifier and Type	Method and Description
void	close() Close the stream.
protected void	debugStateChanged(java.lang.String category, byte detailLevel)
void	flush() Flush the stream.
protected void	formatHeader(java.lang.String cat, java.lang.String deviceType, java.lang.String deviceId, int level, boolean supressAnonMode, java.lang.StringBuffer sb)
protected void	formatHeader(java.lang.String cat, java.lang.String deviceType, java.lang.String deviceId, int level, boolean supressAnonMode, java.io.StringWriter sw)
protected LogCommunicator	getBackup()
protected LogCommunicator	getDeviceBackup()
protected LogCommunicator	getMain()
protected boolean	isDebugOff(java.lang.String category) Returns state of debug for a category.
protected boolean	isDebugOff(java.lang.String category, java.lang.String deviceType, java.lang.String deviceId)
protected boolean	isDebugOn(java.lang.String category, int level, int detailLevel) Returns state of debug for a category.
protected int	isDebugOn(java.lang.String category, java.lang.String deviceType, java.lang.String deviceId, int level, int detailLevel)
protected static java.lang.String	replace(java.lang.String str, java.lang.String toReplace, java.lang.String replacement)
protected abstract void	sendLog(java.lang.String category, int level, java.lang.String message, java.lang.Throwable exc) Sends message to log.
abstract void	sendLog(java.lang.String category, java.lang.String deviceType, java.lang.String deviceId, int level, java.lang.String message, java.lang.Throwable exc, int debugOnType)
protected void	sendLog1(java.lang.String category, int level, int detailLevel, java.lang.String message, java.lang.Throwable exc)
protected void	sendLog1(java.lang.String category, java.lang.String deviceType, java.lang.String deviceId, int level, int detailLevel, java.lang.String message, java.lang.Throwable exc)
protected void	sendLog2(java.lang.String category, int level, int detailLevel, java.lang.Object m1, java.lang.Object m2)
protected void	sendLog2(java.lang.String category, java.lang.String deviceType, java.lang.String deviceId, int level, int detailLevel, java.lang.Object m1, java.lang.Object m2)
protected void	sendLog3(java.lang.String category, int level, int detailLevel, java.lang.Object m1, java.lang.Object m2, java.lang.Object m3)
protected void	sendLog3(java.lang.String category, java.lang.String deviceType, java.lang.String deviceId, int level, int detailLevel, java.lang.Object m1, java.lang.Object m2, java.lang.Object m3)
protected void	sendLog4(java.lang.String category, int level, int detailLevel, java.lang.Object m1, java.lang.Object m2, java.lang.Object m3, java.lang.Object m4)
protected void	sendLog4(java.lang.String category, java.lang.String deviceType, java.lang.String deviceId, int level, int detailLevel, java.lang.Object m1, java.lang.Object m2, java.lang.Object m3, java.lang.Object m4)
protected void	sendLog5(java.lang.String category, int level, int detailLevel, java.lang.Object m1, java.lang.Object m2, java.lang.Object m3, java.lang.Object m4, java.lang.Object m5)
protected void	sendLog5(java.lang.String category, java.lang.String deviceType, java.lang.String deviceId, int level, int detailLevel, java.lang.Object m1, java.lang.Object m2, java.lang.Object m3, java.lang.Object m4, java.lang.Object m5)
protected void	sendLog6(java.lang.String category, int level, int detailLevel, java.lang.Object m1, java.lang.Object m2, java.lang.Object m3, java.lang.Object m4, java.lang.Object m5, java.lang.Object m6)
protected void	sendLog6(java.lang.String category, java.lang.String deviceType, java.lang.String deviceId, int level, int detailLevel, java.lang.Object m1, java.lang.Object m2, java.lang.Object m3, java.lang.Object m4, java.lang.Object m5, java.lang.Object m6)
protected void	sendLog7(java.lang.String category, int level, int detailLevel, java.lang.Object m1, java.lang.Object m2, java.lang.Object m3, java.lang.Object m4, java.lang.Object m5, java.lang.Object m6, java.lang.Object m7)
protected void	sendLog7(java.lang.String category, java.lang.String deviceType, java.lang.String deviceId, int level, int detailLevel, java.lang.Object m1, java.lang.Object m2, java.lang.Object m3, java.lang.Object m4, java.lang.Object m5, java.lang.Object m6, java.lang.Object m7)
protected void	sendLog8(java.lang.String category, int level, int detailLevel, java.lang.Object m1, java.lang.Object m2, java.lang.Object m3, java.lang.Object m4, java.lang.Object m5, java.lang.Object m6, java.lang.Object m7, java.lang.Object m8)
protected void	sendLog8(java.lang.String category, java.lang.String deviceType, java.lang.String deviceId, int level, int detailLevel, java.lang.Object m1, java.lang.Object m2, java.lang.Object m3, java.lang.Object m4, java.lang.Object m5, java.lang.Object m6, java.lang.Object m7, java.lang.Object m8)
protected void	setBackup(LogCommunicator backup)
protected void	setDeviceBackup(LogCommunicator backup)
protected void	setDeviceMain(LogCommunicator main)
protected void	setMain(LogCommunicator main)

Methods inherited from class java.lang.Object

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

Field Detail

LOG_LEVELS_EXT

public static final java.lang.String[] LOG_LEVELS_EXT

detailLevel

protected volatile byte detailLevel

perThread

protected volatile boolean perThread

DEBUG_OFF

public static final int DEBUG_OFF

See Also:

Constant Field Values

DEBUG_ON_CAT

public static final int DEBUG_ON_CAT

See Also:

Constant Field Values

DEBUG_ON_DEVICE

public static final int DEBUG_ON_DEVICE

See Also:

Constant Field Values

DEBUG_ALL

public static final int DEBUG_ALL

See Also:

Constant Field Values

Constructor Detail

LogCommunicator

protected LogCommunicator(boolean $perThread)

Method Detail

getMain

protected LogCommunicator getMain()

setMain

protected void setMain(LogCommunicator main)

getBackup

protected LogCommunicator getBackup()

setBackup

protected void setBackup(LogCommunicator backup)

debugStateChanged

protected void debugStateChanged(java.lang.String category,
                                 byte detailLevel)

setDeviceMain

protected void setDeviceMain(LogCommunicator main)

getDeviceBackup

protected LogCommunicator getDeviceBackup()

setDeviceBackup

protected void setDeviceBackup(LogCommunicator backup)

sendLog

protected abstract void sendLog(java.lang.String category,
                                int level,
                                java.lang.String message,
                                java.lang.Throwable exc)

Sends message to log. Does not perform filtering. NOT TO BE CALLED FROM Log class!!!

Parameters:

category - name of message category.

level - debug level.

message - message.

exc - exception back-trace.

debugOnType - DEBUG_ON_CAT or DEBUG_ON_DEVICE

sendLog

public abstract void sendLog(java.lang.String category,
                             java.lang.String deviceType,
                             java.lang.String deviceId,
                             int level,
                             java.lang.String message,
                             java.lang.Throwable exc,
                             int debugOnType)

sendLog1

protected void sendLog1(java.lang.String category,
                        int level,
                        int detailLevel,
                        java.lang.String message,
                        java.lang.Throwable exc)

sendLog1

protected void sendLog1(java.lang.String category,
                        java.lang.String deviceType,
                        java.lang.String deviceId,
                        int level,
                        int detailLevel,
                        java.lang.String message,
                        java.lang.Throwable exc)

sendLog2

protected void sendLog2(java.lang.String category,
                        int level,
                        int detailLevel,
                        java.lang.Object m1,
                        java.lang.Object m2)

sendLog2

protected void sendLog2(java.lang.String category,
                        java.lang.String deviceType,
                        java.lang.String deviceId,
                        int level,
                        int detailLevel,
                        java.lang.Object m1,
                        java.lang.Object m2)

sendLog3

protected void sendLog3(java.lang.String category,
                        int level,
                        int detailLevel,
                        java.lang.Object m1,
                        java.lang.Object m2,
                        java.lang.Object m3)

sendLog3

protected void sendLog3(java.lang.String category,
                        java.lang.String deviceType,
                        java.lang.String deviceId,
                        int level,
                        int detailLevel,
                        java.lang.Object m1,
                        java.lang.Object m2,
                        java.lang.Object m3)

sendLog4

protected void sendLog4(java.lang.String category,
                        int level,
                        int detailLevel,
                        java.lang.Object m1,
                        java.lang.Object m2,
                        java.lang.Object m3,
                        java.lang.Object m4)

sendLog4

protected void sendLog4(java.lang.String category,
                        java.lang.String deviceType,
                        java.lang.String deviceId,
                        int level,
                        int detailLevel,
                        java.lang.Object m1,
                        java.lang.Object m2,
                        java.lang.Object m3,
                        java.lang.Object m4)

sendLog5

protected void sendLog5(java.lang.String category,
                        int level,
                        int detailLevel,
                        java.lang.Object m1,
                        java.lang.Object m2,
                        java.lang.Object m3,
                        java.lang.Object m4,
                        java.lang.Object m5)

sendLog5

protected void sendLog5(java.lang.String category,
                        java.lang.String deviceType,
                        java.lang.String deviceId,
                        int level,
                        int detailLevel,
                        java.lang.Object m1,
                        java.lang.Object m2,
                        java.lang.Object m3,
                        java.lang.Object m4,
                        java.lang.Object m5)

sendLog6

protected void sendLog6(java.lang.String category,
                        int level,
                        int detailLevel,
                        java.lang.Object m1,
                        java.lang.Object m2,
                        java.lang.Object m3,
                        java.lang.Object m4,
                        java.lang.Object m5,
                        java.lang.Object m6)

sendLog6

protected void sendLog6(java.lang.String category,
                        java.lang.String deviceType,
                        java.lang.String deviceId,
                        int level,
                        int detailLevel,
                        java.lang.Object m1,
                        java.lang.Object m2,
                        java.lang.Object m3,
                        java.lang.Object m4,
                        java.lang.Object m5,
                        java.lang.Object m6)

sendLog7

protected void sendLog7(java.lang.String category,
                        int level,
                        int detailLevel,
                        java.lang.Object m1,
                        java.lang.Object m2,
                        java.lang.Object m3,
                        java.lang.Object m4,
                        java.lang.Object m5,
                        java.lang.Object m6,
                        java.lang.Object m7)

sendLog7

protected void sendLog7(java.lang.String category,
                        java.lang.String deviceType,
                        java.lang.String deviceId,
                        int level,
                        int detailLevel,
                        java.lang.Object m1,
                        java.lang.Object m2,
                        java.lang.Object m3,
                        java.lang.Object m4,
                        java.lang.Object m5,
                        java.lang.Object m6,
                        java.lang.Object m7)

sendLog8

protected void sendLog8(java.lang.String category,
                        int level,
                        int detailLevel,
                        java.lang.Object m1,
                        java.lang.Object m2,
                        java.lang.Object m3,
                        java.lang.Object m4,
                        java.lang.Object m5,
                        java.lang.Object m6,
                        java.lang.Object m7,
                        java.lang.Object m8)

sendLog8

protected void sendLog8(java.lang.String category,
                        java.lang.String deviceType,
                        java.lang.String deviceId,
                        int level,
                        int detailLevel,
                        java.lang.Object m1,
                        java.lang.Object m2,
                        java.lang.Object m3,
                        java.lang.Object m4,
                        java.lang.Object m5,
                        java.lang.Object m6,
                        java.lang.Object m7,
                        java.lang.Object m8)

isDebugOn

protected boolean isDebugOn(java.lang.String category,
                            int level,
                            int detailLevel)

Returns state of debug for a category.

Parameters:

category - name of debug category.

level - debug level.

detailLevel - detail level of message.

Returns:

true

isDebugOn

protected int isDebugOn(java.lang.String category,
                        java.lang.String deviceType,
                        java.lang.String deviceId,
                        int level,
                        int detailLevel)

isDebugOff

protected boolean isDebugOff(java.lang.String category)

Returns state of debug for a category.

Parameters:

category - name of debug category.

Returns:

true false

isDebugOff

protected boolean isDebugOff(java.lang.String category,
                             java.lang.String deviceType,
                             java.lang.String deviceId)

flush

public void flush()

Flush the stream.

close

public void close()

Close the stream.

replace

protected static java.lang.String replace(java.lang.String str,
                                          java.lang.String toReplace,
                                          java.lang.String replacement)

formatHeader

protected void formatHeader(java.lang.String cat,
                            java.lang.String deviceType,
                            java.lang.String deviceId,
                            int level,
                            boolean supressAnonMode,
                            java.io.StringWriter sw)

formatHeader

protected void formatHeader(java.lang.String cat,
                            java.lang.String deviceType,
                            java.lang.String deviceId,
                            int level,
                            boolean supressAnonMode,
                            java.lang.StringBuffer sb)