com.ibm.dse.applsrv.aa
Class Tracer

java.lang.Object
  |
  +--com.ibm.dse.applsrv.aa.Tracer

public class Tracer
extends java.lang.Object

This class controls tracing for each of its instances.


Field Summary
static int DEBUG_ERR
          Constants to define the disposition of a message.
static int DEBUG_OFF
          Constants to define the disposition of a message.
static int DEBUG_OUT
          Constants to define the disposition of a message.
static int DEBUG_STREAM
          Constants to define the disposition of a message.
static int LOG_ALWAYS
          Constants to define the types of messages.
static int LOG_DEBUG
          Constants to define the types of messages.
static int LOG_ENTRY
          Constants to define the types of messages.
static int LOG_ERROR
          Constants to define the types of messages.
static int LOG_EXIT
          Constants to define the types of messages.
static int LOG_INFO
          Constants to define the types of messages.
static int LOG_WALKBACK
          Constants to define the types of messages.
static int LOG_WARNING
          Constants to define the types of messages.
static int LOG_XERROR
          Constants to define the types of messages.
static int MAX_LOG
          Constants to define the types of messages.
 
Constructor Summary
Tracer()
          Return an initialized instance of this trace logger.
 
Method Summary
 void debug(java.lang.String aString)
          Write a debug message to the appropriate log (if any).
 void debug(java.lang.String aString, java.lang.Object[] anArray)
          Write a message and a collection to the appropriate log (if any).
 void debug(java.lang.String aString1, java.lang.String aString2)
          Write a pair of messages to the appropriate log (if any).
 void debug(java.lang.String aString, java.lang.Throwable anException)
          Write a debug message and a debug exception (and possibly its walkback) to the appropriate log (if any).
 void debug(java.lang.Throwable anException)
          Write a debug exception (and possibly its walkback) to the appropriate log (if any).
 void disableAll()
          Disable all types of logging.
 void enableAll()
          Enable all types of logging.
 void error(java.lang.String aString)
          Write a error message to the appropriate log (if any).
 void error(java.lang.String aString, java.lang.Throwable anException)
          Write a error message and a debug exception (and possibly its walkback) to the appropriate log (if any).
 void error(java.lang.Throwable anException)
          Write a error exception (and possibly its walkback) to the appropriate log (if any).
 boolean get(int type)
          Query the status of the specified type of logging.
 boolean getCBTFTracing()
          Return the status of CBTF tracing.
 int getDebug()
          Return the debug mode setting.
 java.lang.String getDebugString()
          Return the debug mode setting as a String.
 boolean getEntryStatus()
          Query the on/off state of entry logging.
 boolean getExitStatus()
          Query the on/off state of exit logging.
 boolean getStatus()
          Query the on/off state of logging.
 java.io.OutputStream getStream()
          Return the stream used for debug output.
 boolean getWalkback()
          Query the status of walkbacks.
 boolean getWarnings()
          Query the status of warning notifications.
 LogHandler handler()
          Return the message log handler.
 void handler(LogHandler logger)
          Set the message log handler.
 void initExceptionTracing(java.lang.String s)
          Enable or disable exception tracing.
 void initTrace(java.lang.String tracing)
          Initialize tracing to the specified value.
 void initTraceFile(java.lang.String file)
          Initialize the tracing file.
 void initTraceNX(java.lang.String tracing)
          Initialize tracing to the specified value.
 void log(int type, boolean aBoolean)
          Write a boolean to the appropriate log (if any).
 void log(int type, byte aByte)
          Write a byte to the appropriate log (if any).
 void log(int type, char aChar)
          Write a character to the appropriate log (if any).
 void log(int type, double aDouble)
          Write a double precision float to the appropriate log (if any).
 void log(int type, float aFloat)
          Write a float to the appropriate log (if any).
 void log(int type, int anInt)
          Write an integer to the appropriate log (if any).
 void log(int type, long aLong)
          Write a long integer to the appropriate log (if any).
 void log(int type, java.lang.Object anObject)
          Write an object to the appropriate log (if any).
 void log(int type, java.lang.Object[] anArray)
          Write a java array to the appropriate log (if any).
 void log(int type, short aShort)
          Write a short integer to the appropriate log (if any).
 void log(int type, java.lang.String aString)
          Write a message to the appropriate log (if any).
 void log(int type, java.lang.String aString, boolean aBoolean)
          Write a string and a boolean to the appropriate log (if any).
 void log(int type, java.lang.String aString, int anInt)
          Write messages to the appropriate log (if any).
 void log(int type, java.lang.String aString1, int int1, java.lang.String aString2, java.lang.Object anObject)
          Write messages to the appropriate log (if any).
 void log(int type, java.lang.String aString1, int int1, java.lang.String aString2, java.lang.String aString3, java.lang.String aString4)
          Write messages to the appropriate log (if any).
 void log(int type, java.lang.String aString, java.lang.Object anObject)
          Log a message and an object.
 void log(int type, java.lang.String aString, java.lang.Object[] anArray)
          Write a message and a collection to the appropriate log (if any).
 void log(int type, java.lang.String aString1, java.lang.Object anObject, java.lang.String aString2)
          Log a message and an object and another message.
 void log(int type, java.lang.String aString1, java.lang.Object anObject1, java.lang.String aString2, java.lang.Object anObject2)
          Log messages and objects.
 void log(int type, java.lang.String aString1, java.lang.Object anObject1, java.lang.String aString2, java.lang.Object anObject2, java.lang.String aString3)
          Log messages and objects.
 void log(int type, java.lang.String aString1, java.lang.Object anObject1, java.lang.String aString2, java.lang.String aString3)
          Log messages and objects.
 void log(int type, java.lang.String aString1, java.lang.String aString2)
          Write a pair of messages to the appropriate log (if any).
 void log(int type, java.lang.String aString1, java.lang.String aString2, Array anArray)
          Write 2 messages and a vector collection to the appropriate log (if any).
 void log(int type, java.lang.String aString1, java.lang.String aString2, java.lang.Object[] anArray)
          Write 2 messages and a vector collection to the appropriate log (if any).
 void log(int type, java.lang.String aString1, java.lang.String aString2, java.lang.String aString3)
          Write three messages to the appropriate log (if any).
 void log(int type, java.lang.String aString1, java.lang.String aString2, java.lang.String aString3, int int1, java.lang.String aString4)
          Write messages to the appropriate log (if any).
 void log(int type, java.lang.String aString1, java.lang.String aString2, java.lang.String aString3, java.util.Vector aVector, java.lang.String aString4)
          Write 4 messages and a vector collection to the appropriate log (if any).
 void log(int type, java.lang.String aString1, java.lang.String aString2, java.util.Vector aVector)
          Write 2 messages and a vector collection to the appropriate log (if any).
 void log(int type, java.lang.String aString, java.lang.Throwable anException)
          Log a message and an exception.
 void log(int type, java.lang.String aString, java.util.Vector aVector)
          Write a message and a vector collection to the appropriate log (if any).
 void log(int type, java.lang.Throwable anException)
          Write an exception (and possibly its walkback) to the appropriate log (if any).
 void log(int type, java.util.Vector aVector)
          Write a vector collection to the appropriate log (if any).
 void log(java.lang.String aString)
          Write a message to the appropriate log (if any).
 void log(java.lang.String aString1, java.lang.String aString2)
          Write a pair of messages to the appropriate log (if any).
 void logServletEnter(java.lang.Object anObject)
          Write an object to the appropriate log (if any) on entry to a servlet.
 void logServletEnter(java.lang.String aString)
          Write a message to the appropriate log (if any) on entry to a servlet.
 void logServletEnter(java.lang.String aString, java.lang.Object anObject)
          Write a message and an object to the appropriate log (if any) on entry to a servlet.
 void logServletEnter(java.lang.String aString, java.lang.Object[] anArray)
          Write a message and a list to the appropriate log (if any) on entry to a servlet.
 void logServletEnter(java.lang.String aString1, java.lang.String aString2)
          Write a pair of messages to the appropriate log (if any) on entry to a servlet.
 void logServletReturn(java.lang.Object anObject)
          Write an object to the appropriate log (if any) on return from a servlet.
 void logServletReturn(java.lang.String aString)
          Write a message to the appropriate log (if any) on return from a servlet.
 void logServletReturn(java.lang.String aString, java.lang.Object anObject)
          Write a message and an object to the appropriate log (if any) on return from a servlet.
 void logServletReturn(java.lang.String aString1, java.lang.String aString2)
          Write a pair of messages to the appropriate log (if any) on return from a servlet.
 void logServletReturn(java.lang.String aString, java.lang.Throwable anException)
          Log a message and an exception to the appropriate log (if any) on return from a servlet.
 void set(int type, boolean status)
          Enable or disable the specified type of logging.
 boolean set(java.lang.String type, boolean status)
          Enable or disable the specified type of logging.
 void setCBTFComponent(java.lang.String component)
          Set the CBTF component id.
 void setCBTFTracing(boolean enableFlag)
          Enable or disable CBTF tracing.
 void setDebug(int mode)
          Set the debug mode.
 void setDebugOff()
          Disable debug tracing.
 void setDebugTo(java.io.OutputStream aStream)
          Enable debug tracing to the output stream.
 void setDebugTo(java.lang.String fileName)
          Enable debug tracing to the specified file (which is openned for appending).
 void setDebugToStdErr()
          Enable debug tracing to standard error output.
 void setDebugToStdOut()
          Enable debug tracing to standard output.
 void setExceptionTracing(boolean enableFlag)
          Enable or disable exception tracing.
 void setStream(java.io.OutputStream aStream)
          Set the stream used for debug output.
 void setWarnings(boolean aBoolean)
          Enable or disable warnings.
 java.lang.String toString()
          Returns a string representation of this logger.
 java.lang.String toString(java.lang.String prefix)
          Returns a string representation of this logger.
 void trace(int type, Array anArray)
          Write a vector collection to the appropriate log (if any).
 void trace(int type, boolean aBoolean)
          Write a boolean to the appropriate log (if any).
 void trace(int type, byte aByte)
          Write a byte to the appropriate log (if any).
 void trace(int type, char aChar)
          Write a character to the appropriate log (if any).
 void trace(int type, double aDouble)
          Write a double precision float to the appropriate log (if any).
 void trace(int type, float aFloat)
          Write a float to the appropriate log (if any).
 void trace(int type, int anInt)
          Write an integer to the appropriate log (if any).
 void trace(int type, long aLong)
          Write a long integer to the appropriate log (if any).
 void trace(int type, java.lang.Object anObject)
          Write an object to the appropriate log (if any).
 void trace(int type, java.lang.Object[] anArray)
          Write a java array to the appropriate log (if any).
 void trace(int type, short aShort)
          Write a short integer to the appropriate log (if any).
 void trace(int type, java.lang.String aString)
          Write a message to the appropriate log (if any).
 void trace(int type, java.lang.String aString, Array anArray)
          Write a message and a vector collection to the appropriate log (if any).
 void trace(int type, java.lang.String aString, boolean aBoolean)
          Write a string and a boolean to the appropriate log (if any).
 void trace(int type, java.lang.String aString, int anInt)
          Write messages to the appropriate log (if any).
 void trace(int type, java.lang.String aString1, int int1, java.lang.String aString2, java.lang.Object anObject)
          Write messages to the appropriate log (if any).
 void trace(int type, java.lang.String aString1, int int1, java.lang.String aString2, java.lang.String aString3, java.lang.String aString4)
          Write messages to the appropriate log (if any).
 void trace(int type, java.lang.String aString, java.lang.Object anObject)
          Log a message and an object.
 void trace(int type, java.lang.String aString, java.lang.Object[] anArray)
          Write a message and a collection to the appropriate log (if any).
 void trace(int type, java.lang.String aString1, java.lang.Object anObject, java.lang.String aString2)
          Log a message and an object and another message.
 void trace(int type, java.lang.String aString1, java.lang.Object anObject1, java.lang.String aString2, java.lang.Object anObject2)
          Log messages and objects.
 void trace(int type, java.lang.String aString1, java.lang.Object anObject1, java.lang.String aString2, java.lang.Object anObject2, java.lang.String aString3)
          Log messages and objects.
 void trace(int type, java.lang.String aString1, java.lang.Object anObject1, java.lang.String aString2, java.lang.String aString3)
          Log messages and objects.
 void trace(int type, java.lang.String aString1, java.lang.String aString2)
          Write a pair of messages to the appropriate log (if any).
 void trace(int type, java.lang.String aString1, java.lang.String aString2, Array anArray)
          Write 2 messages and an array to the appropriate log (if any).
 void trace(int type, java.lang.String aString1, java.lang.String aString2, java.lang.Object[] anArray)
          Write 2 messages and a java array to the appropriate log (if any).
 void trace(int type, java.lang.String aString1, java.lang.String aString2, java.lang.String aString3)
          Log three messages.
 void trace(int type, java.lang.String aString1, java.lang.String aString2, java.lang.String aString3, int int1, java.lang.String aString4)
          Write messages to the appropriate log (if any).
 void trace(int type, java.lang.String aString1, java.lang.String aString2, java.lang.String aString3, java.util.Vector aVector, java.lang.String aString4)
          Write 4 messages and a vector collection to the appropriate log (if any).
 void trace(int type, java.lang.String aString1, java.lang.String aString2, java.util.Vector aVector)
          Write 2 messages and a vector collection to the appropriate log (if any).
 void trace(int type, java.lang.String aString, java.lang.Throwable anException)
          Log a message and an exception.
 void trace(int type, java.lang.String aString, java.util.Vector aVector)
          Write a message and a vector collection to the appropriate log (if any).
 void trace(int type, java.lang.Throwable anException)
          Write an exception (and possibly its walkback) to the appropriate log (if any).
 void trace(int type, java.util.Vector aVector)
          Write a vector collection to the appropriate log (if any).
 void traceServletEntryOff()
          Disable servlet entry tracing.
 void traceServletEntryOn()
          Enable servlet entry tracing.
 void traceServletReturnOff()
          Disable servlet return tracing.
 void traceServletReturnOn()
          Enable servlet return tracing.
 void walkbackOff()
          Disable walkbacks.
 void walkbackOn()
          Enable walkbacks.
 void warning(java.lang.String aString)
          Write a warning message to the appropriate log (if any).
 void warning(java.lang.String aString, java.lang.Throwable anException)
          Write a warning message and a warning exception (and possibly its walkback) to the appropriate log (if any).
 void warning(java.lang.Throwable anException)
          Write a warning exception (and possibly its walkback) to the appropriate log (if any).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEBUG_OFF

public static final int DEBUG_OFF
Constants to define the disposition of a message.

DEBUG_OUT

public static final int DEBUG_OUT
Constants to define the disposition of a message.

DEBUG_ERR

public static final int DEBUG_ERR
Constants to define the disposition of a message.

DEBUG_STREAM

public static final int DEBUG_STREAM
Constants to define the disposition of a message.

LOG_ALWAYS

public static final int LOG_ALWAYS
Constants to define the types of messages.

LOG_ERROR

public static final int LOG_ERROR
Constants to define the types of messages.

LOG_WARNING

public static final int LOG_WARNING
Constants to define the types of messages.

LOG_INFO

public static final int LOG_INFO
Constants to define the types of messages.

LOG_DEBUG

public static final int LOG_DEBUG
Constants to define the types of messages.

LOG_ENTRY

public static final int LOG_ENTRY
Constants to define the types of messages.

LOG_EXIT

public static final int LOG_EXIT
Constants to define the types of messages.

LOG_WALKBACK

public static final int LOG_WALKBACK
Constants to define the types of messages.

LOG_XERROR

public static final int LOG_XERROR
Constants to define the types of messages.

MAX_LOG

public static final int MAX_LOG
Constants to define the types of messages.
Constructor Detail

Tracer

public Tracer()
Return an initialized instance of this trace logger.
Method Detail

debug

public void debug(java.lang.String aString)
Write a debug message to the appropriate log (if any).
Parameters:
aString - String - the message to write to the log.

debug

public void debug(java.lang.String aString,
                  java.lang.Object[] anArray)
Write a message and a collection to the appropriate log (if any).
Parameters:
aString - String - the message to write to the log.
anArray - Object[] - the collection to write to the log.

debug

public void debug(java.lang.String aString1,
                  java.lang.String aString2)
Write a pair of messages to the appropriate log (if any).
Parameters:
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.

debug

public void debug(java.lang.String aString,
                  java.lang.Throwable anException)
Write a debug message and a debug exception (and possibly its walkback) to the appropriate log (if any).
Parameters:
aString - String - the message to write to the log.
anException - Throwable - the exception to write to the log.

debug

public void debug(java.lang.Throwable anException)
Write a debug exception (and possibly its walkback) to the appropriate log (if any).
Parameters:
anException - Throwable - the exception to write to the log.

disableAll

public void disableAll()
Disable all types of logging. [except for LOG_ALWAYS]

enableAll

public void enableAll()
Enable all types of logging.

error

public void error(java.lang.String aString)
Write a error message to the appropriate log (if any).
Parameters:
aString - String - the message to write to the log.

error

public void error(java.lang.String aString,
                  java.lang.Throwable anException)
Write a error message and a debug exception (and possibly its walkback) to the appropriate log (if any).
Parameters:
aString - String - the message to write to the log.
anException - Throwable - the exception to write to the log.

error

public void error(java.lang.Throwable anException)
Write a error exception (and possibly its walkback) to the appropriate log (if any).
Parameters:
anException - Throwable - the exception to write to the log.

get

public boolean get(int type)
Query the status of the specified type of logging.
Parameters:
type - int - the index of the specified type of logging.
Returns:
boolean - true if the specified type of logging is enabled else false.
Throws:
ArrayIndexOutOfBoundsException - - if type is less than 0 or greater than or equal to MAX_LOG.

getCBTFTracing

public boolean getCBTFTracing()
Return the status of CBTF tracing.
Returns:
boolean - true if CBTF tracing is enabled else false.

getDebug

public int getDebug()
Return the debug mode setting.
Returns:
int - the debug mode setting.

getDebugString

public java.lang.String getDebugString()
Return the debug mode setting as a String.
Returns:
String - the debug mode setting.

getEntryStatus

public boolean getEntryStatus()
Query the on/off state of entry logging.
Returns:
boolean - true if entry logging is enabled else false.

getExitStatus

public boolean getExitStatus()
Query the on/off state of exit logging.
Returns:
boolean - true if exit logging is enabled else false.

getStatus

public boolean getStatus()
Query the on/off state of logging.
Returns:
boolean - true if logging is enabled else false.

getStream

public java.io.OutputStream getStream()
Return the stream used for debug output.
Returns:
OutputStream - the debug output stream.

getWalkback

public boolean getWalkback()
Query the status of walkbacks.
Returns:
boolean - true if walkbacks are logged else false.

getWarnings

public boolean getWarnings()
Query the status of warning notifications.
Returns:
boolean - true if warning messages are logged else false.

handler

public LogHandler handler()
Return the message log handler.
Returns:
LogHandler - the message log handler.

handler

public void handler(LogHandler logger)
Set the message log handler. If null then use the default logging.
Parameters:
logger - LogHandler - the message log handler.

initExceptionTracing

public void initExceptionTracing(java.lang.String s)
Enable or disable exception tracing.
Parameters:
s - String - the boolean string to parse.

initTrace

public void initTrace(java.lang.String tracing)
Initialize tracing to the specified value.
Parameters:
tracing - String - the the specified value.
Throws:
java.lang.IllegalArgumentException - - Invalid trace setting.

initTraceFile

public void initTraceFile(java.lang.String file)
                   throws java.io.IOException
Initialize the tracing file.
Parameters:
file - String - the name of the tracing file.
Throws:
java.io.IOException - - error in opening trace file.

initTraceNX

public void initTraceNX(java.lang.String tracing)
Initialize tracing to the specified value. If the option is invalid then display it rather than throwing an exception.
Parameters:
tracing - String - the the specified value.

log

public void log(int type,
                java.lang.Object[] anArray)
Write a java array to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
anArray - Object[] - the collection to write to the log.

log

public void log(int type,
                byte aByte)
Write a byte to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aByte - byte - the byte to write to the log.

log

public void log(int type,
                char aChar)
Write a character to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aChar - char - the character to write to the log.

log

public void log(int type,
                double aDouble)
Write a double precision float to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aDouble - double - the double precision float to write to the log.

log

public void log(int type,
                float aFloat)
Write a float to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aFloat - float - the float to write to the log.

log

public void log(int type,
                int anInt)
Write an integer to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
anInt - int - the integer to write to the log.

log

public void log(int type,
                long aLong)
Write a long integer to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aLong - long - the long integer to write to the log.

log

public void log(int type,
                java.lang.Object anObject)
Write an object to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
anObject - Object - the object to write to the log.

log

public void log(int type,
                java.lang.String aString)
Write a message to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString - String - the message to write to the log.

log

public void log(int type,
                java.lang.String aString,
                java.lang.Object[] anArray)
Write a message and a collection to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString - String - the message to write to the log.
anArray - Object[] - the collection to write to the log.

log

public void log(int type,
                java.lang.String aString,
                int anInt)
Write messages to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString - String - the message to write to the log.
anInt - int - the integer to write to the log.

log

public void log(int type,
                java.lang.String aString1,
                int int1,
                java.lang.String aString2,
                java.lang.Object anObject)
Write messages to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
int1 - int - the integer to write to the log.
aString2 - String - the second message to write to the log.
anObject - Object - the object to write to the log.

log

public void log(int type,
                java.lang.String aString1,
                int int1,
                java.lang.String aString2,
                java.lang.String aString3,
                java.lang.String aString4)
Write messages to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
int1 - int - the integer to write to the log.
aString2 - String - the second message to write to the log.
aString3 - String - the third message to write to the log.
aString4 - String - the fourth message to write to the log.

log

public void log(int type,
                java.lang.String aString,
                java.lang.Object anObject)
Log a message and an object.
Parameters:
type - int - the type of message being logged.
aString - String - the message to write to the log.
anObject - Object - the object to write to the log.

log

public void log(int type,
                java.lang.String aString1,
                java.lang.Object anObject,
                java.lang.String aString2)
Log a message and an object and another message.
Parameters:
type - int - the type of message being logged.
aString1 - String - the message to write to the log.
anObject - Object - the object to write to the log.
aString1 - String - the message to write to the log.

log

public void log(int type,
                java.lang.String aString1,
                java.lang.Object anObject1,
                java.lang.String aString2,
                java.lang.Object anObject2)
Log messages and objects.
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
anObject1 - Object - the first object to write to the log.
aString2 - String - the second message to write to the log.
anObject2 - Object - the second object to write to the log.

log

public void log(int type,
                java.lang.String aString1,
                java.lang.Object anObject1,
                java.lang.String aString2,
                java.lang.Object anObject2,
                java.lang.String aString3)
Log messages and objects.
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
anObject1 - Object - the first object to write to the log.
aString2 - String - the second message to write to the log.
anObject2 - Object - the second object to write to the log.
aString3 - String - the third message to write to the log.

log

public void log(int type,
                java.lang.String aString1,
                java.lang.Object anObject1,
                java.lang.String aString2,
                java.lang.String aString3)
Log messages and objects.
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
anObject1 - Object - the first object to write to the log.
aString2 - String - the second message to write to the log.
aString3 - String - the third message to write to the log.

log

public void log(int type,
                java.lang.String aString1,
                java.lang.String aString2)
Write a pair of messages to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.

log

public void log(int type,
                java.lang.String aString1,
                java.lang.String aString2,
                java.lang.Object[] anArray)
Write 2 messages and a vector collection to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.
anArray - Object[] - the collection to write to the log.

log

public void log(int type,
                java.lang.String aString1,
                java.lang.String aString2,
                Array anArray)
Write 2 messages and a vector collection to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.
anArray - Array - the collection to write to the log.

log

public void log(int type,
                java.lang.String aString1,
                java.lang.String aString2,
                java.lang.String aString3)
Write three messages to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.
aString3 - String - the third message to write to the log.

log

public void log(int type,
                java.lang.String aString1,
                java.lang.String aString2,
                java.lang.String aString3,
                int int1,
                java.lang.String aString4)
Write messages to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.
aString3 - String - the third message to write to the log.
int1 - int - the integer to write to the log.
aString4 - String - the fourth message to write to the log.

log

public void log(int type,
                java.lang.String aString1,
                java.lang.String aString2,
                java.lang.String aString3,
                java.util.Vector aVector,
                java.lang.String aString4)
Write 4 messages and a vector collection to the appropriate log (if any). This method is needed because of a bug in Vector's toString() method.
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.
aString3 - String - the third message to write to the log.
aVector - Vector - the collection to write to the log.
aString4 - String - the fourth message to write to the log.

log

public void log(int type,
                java.lang.String aString1,
                java.lang.String aString2,
                java.util.Vector aVector)
Write 2 messages and a vector collection to the appropriate log (if any). This method is needed because of a bug in Vector's toString() method.
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.
aVector - Vector - the collection to write to the log.

log

public void log(int type,
                java.lang.String aString,
                java.lang.Throwable anException)
Log a message and an exception.
Parameters:
type - int - the type of message being logged.
aString - String - the message to write to the log.
anException - Throwable - the exception to write to the log.

log

public void log(int type,
                java.lang.String aString,
                java.util.Vector aVector)
Write a message and a vector collection to the appropriate log (if any). This method is needed because of a bug in Vector's toString() method.
Parameters:
type - int - the type of message being logged.
aString - String - the message to write to the log.
aVector - Vector - the collection to write to the log.

log

public void log(int type,
                java.lang.String aString,
                boolean aBoolean)
Write a string and a boolean to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString - String - the string to write to the log.
aBoolean - boolean - the boolean to write to the log.

log

public void log(int type,
                java.lang.Throwable anException)
Write an exception (and possibly its walkback) to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
anException - Throwable - the exception to write to the log.

log

public void log(int type,
                java.util.Vector aVector)
Write a vector collection to the appropriate log (if any). This method is needed because of a bug in Vector's toString() method.
Parameters:
type - int - the type of message being logged.
aVector - Vector - the collection to write to the log.

log

public void log(int type,
                short aShort)
Write a short integer to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aShort - short - the short integer to write to the log.

log

public void log(int type,
                boolean aBoolean)
Write a boolean to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aBoolean - boolean - the boolean to write to the log.

log

public void log(java.lang.String aString)
Write a message to the appropriate log (if any).
Parameters:
aString - String - the message to write to the log.

log

public void log(java.lang.String aString1,
                java.lang.String aString2)
Write a pair of messages to the appropriate log (if any).
Parameters:
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.

logServletEnter

public void logServletEnter(java.lang.Object anObject)
Write an object to the appropriate log (if any) on entry to a servlet.
Parameters:
anObject - Object - the object to write to the log.

logServletEnter

public void logServletEnter(java.lang.String aString)
Write a message to the appropriate log (if any) on entry to a servlet.
Parameters:
aString - String - the message to write to the log.

logServletEnter

public void logServletEnter(java.lang.String aString,
                            java.lang.Object[] anArray)
Write a message and a list to the appropriate log (if any) on entry to a servlet.
Parameters:
aString - String - the message to write to the log.
anArray - Object[] - the collection to write to the log.

logServletEnter

public void logServletEnter(java.lang.String aString,
                            java.lang.Object anObject)
Write a message and an object to the appropriate log (if any) on entry to a servlet.
Parameters:
aString - String - the message to write to the log.
anObject - Object - the object to write to the log.

logServletEnter

public void logServletEnter(java.lang.String aString1,
                            java.lang.String aString2)
Write a pair of messages to the appropriate log (if any) on entry to a servlet.
Parameters:
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.

logServletReturn

public void logServletReturn(java.lang.Object anObject)
Write an object to the appropriate log (if any) on return from a servlet.
Parameters:
anObject - Object - the object to write to the log.

logServletReturn

public void logServletReturn(java.lang.String aString)
Write a message to the appropriate log (if any) on return from a servlet.
Parameters:
aString - String - the message to write to the log.

logServletReturn

public void logServletReturn(java.lang.String aString,
                             java.lang.Object anObject)
Write a message and an object to the appropriate log (if any) on return from a servlet.
Parameters:
aString - String - the message to write to the log.
anObject - Object - the object to write to the log.

logServletReturn

public void logServletReturn(java.lang.String aString1,
                             java.lang.String aString2)
Write a pair of messages to the appropriate log (if any) on return from a servlet.
Parameters:
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.

logServletReturn

public void logServletReturn(java.lang.String aString,
                             java.lang.Throwable anException)
Log a message and an exception to the appropriate log (if any) on return from a servlet.
Parameters:
aString - String - the message to write to the log.
anException - Throwable - the exception to write to the log.

set

public void set(int type,
                boolean status)
Enable or disable the specified type of logging.
Parameters:
type - int - the index of the specified type of logging.
status - boolean - true to enable this type of logging, false to disable it.

set

public boolean set(java.lang.String type,
                   boolean status)
Enable or disable the specified type of logging.
Parameters:
type - String - the name of the specified type of logging.
status - boolean - true to enable this type of logging, false to disable it.
Returns:
boolean - true if the named type was set else false.

setCBTFComponent

public void setCBTFComponent(java.lang.String component)
Set the CBTF component id.
Parameters:
component - String - the CBTF component id.

setCBTFTracing

public void setCBTFTracing(boolean enableFlag)
Enable or disable CBTF tracing.
Parameters:
enableFlag - boolean - true to enable CBTF tracing, false to disable it.

setDebug

public void setDebug(int mode)
Set the debug mode.
Parameters:
mode - int - new debug mode.

setDebugOff

public void setDebugOff()
Disable debug tracing.

setDebugTo

public void setDebugTo(java.io.OutputStream aStream)
Enable debug tracing to the output stream.
Parameters:
aStream - OutputStream - the debug output stream.

setDebugTo

public void setDebugTo(java.lang.String fileName)
Enable debug tracing to the specified file (which is openned for appending).
Parameters:
fileName - String - the name of the log file.

setDebugToStdErr

public void setDebugToStdErr()
Enable debug tracing to standard error output.

setDebugToStdOut

public void setDebugToStdOut()
Enable debug tracing to standard output.

setExceptionTracing

public void setExceptionTracing(boolean enableFlag)
Enable or disable exception tracing.
Parameters:
enableFlag - boolean - true to enable exception tracing, false to disable it.

setStream

public void setStream(java.io.OutputStream aStream)
Set the stream used for debug output.
Parameters:
aStream - OutputStream - the debug output stream.

setWarnings

public void setWarnings(boolean aBoolean)
Enable or disable warnings.
Parameters:
aBoolean - boolean - the boolean to write to the log.

toString

public java.lang.String toString()
Returns a string representation of this logger.
Overrides:
toString in class java.lang.Object
Returns:
String - a string representation of this logger.

toString

public java.lang.String toString(java.lang.String prefix)
Returns a string representation of this logger.
Parameters:
prefix - String - prefix the result with this string.
Returns:
String - a string representation of this logger.

trace

public void trace(int type,
                  java.lang.Object[] anArray)
           throws java.lang.Exception
Write a java array to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
anArray - Object[] - the collection to write to the log.

trace

public void trace(int type,
                  byte aByte)
           throws java.lang.Exception
Write a byte to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aByte - byte - the byte to write to the log.

trace

public void trace(int type,
                  char aChar)
           throws java.lang.Exception
Write a character to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aChar - char - the character to write to the log.

trace

public void trace(int type,
                  double aDouble)
           throws java.lang.Exception
Write a double precision float to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aDouble - double - the double precision float to write to the log.

trace

public void trace(int type,
                  float aFloat)
           throws java.lang.Exception
Write a float to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aFloat - float - the float to write to the log.

trace

public void trace(int type,
                  int anInt)
           throws java.lang.Exception
Write an integer to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
anInt - int - the integer to write to the log.

trace

public void trace(int type,
                  long aLong)
           throws java.lang.Exception
Write a long integer to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aLong - long - the long integer to write to the log.

trace

public void trace(int type,
                  Array anArray)
           throws java.lang.Exception
Write a vector collection to the appropriate log (if any). This method is needed because of a bug in Vector's toString() method.
Parameters:
type - int - the type of message being logged.
anArray - Array - the collection to write to the log.

trace

public void trace(int type,
                  java.lang.Object anObject)
           throws java.lang.Exception
Write an object to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
anObject - Object - the object to write to the log.

trace

public void trace(int type,
                  java.lang.String aString)
           throws java.lang.Exception
Write a message to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString - String - the message to write to the log.

trace

public void trace(int type,
                  java.lang.String aString,
                  java.lang.Object[] anArray)
           throws java.lang.Exception
Write a message and a collection to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString - String - the message to write to the log.
anArray - Object[] - the collection to write to the log.

trace

public void trace(int type,
                  java.lang.String aString,
                  int anInt)
           throws java.lang.Exception
Write messages to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString - String - the message to write to the log.
anInt - int - the integer to write to the log.

trace

public void trace(int type,
                  java.lang.String aString1,
                  int int1,
                  java.lang.String aString2,
                  java.lang.Object anObject)
           throws java.lang.Exception
Write messages to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
int1 - int - the integer to write to the log.
aString2 - String - the second message to write to the log.
anObject - Object - the object to write to the log.

trace

public void trace(int type,
                  java.lang.String aString1,
                  int int1,
                  java.lang.String aString2,
                  java.lang.String aString3,
                  java.lang.String aString4)
           throws java.lang.Exception
Write messages to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
int1 - int - the integer to write to the log.
aString2 - String - the second message to write to the log.
aString3 - String - the third message to write to the log.
aString4 - String - the fourth message to write to the log.

trace

public void trace(int type,
                  java.lang.String aString,
                  Array anArray)
           throws java.lang.Exception
Write a message and a vector collection to the appropriate log (if any). This method is needed because of a bug in Vector's toString() method.
Parameters:
type - int - the type of message being logged.
aString - String - the message to write to the log.
anArray - Array - the collection to write to the log.

trace

public void trace(int type,
                  java.lang.String aString,
                  java.lang.Object anObject)
           throws java.lang.Exception
Log a message and an object.
Parameters:
type - int - the type of message being logged.
aString - String - the message to write to the log.
anObject - Object - the object to write to the log.

trace

public void trace(int type,
                  java.lang.String aString1,
                  java.lang.Object anObject,
                  java.lang.String aString2)
           throws java.lang.Exception
Log a message and an object and another message.
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
anObject - Object - the object to write to the log.
aString2 - String - the second message to write to the log.

trace

public void trace(int type,
                  java.lang.String aString1,
                  java.lang.Object anObject1,
                  java.lang.String aString2,
                  java.lang.Object anObject2)
           throws java.lang.Exception
Log messages and objects.
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
anObject1 - Object - the first object to write to the log.
aString2 - String - the second message to write to the log.
anObject2 - Object - the second object to write to the log.

trace

public void trace(int type,
                  java.lang.String aString1,
                  java.lang.Object anObject1,
                  java.lang.String aString2,
                  java.lang.Object anObject2,
                  java.lang.String aString3)
           throws java.lang.Exception
Log messages and objects.
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
anObject1 - Object - the first object to write to the log.
aString2 - String - the second message to write to the log.
anObject2 - Object - the second object to write to the log.
aString3 - String - the third message to write to the log.

trace

public void trace(int type,
                  java.lang.String aString1,
                  java.lang.Object anObject1,
                  java.lang.String aString2,
                  java.lang.String aString3)
           throws java.lang.Exception
Log messages and objects.
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
anObject1 - Object - the first object to write to the log.
aString2 - String - the second message to write to the log.
aString3 - String - the third message to write to the log.

trace

public void trace(int type,
                  java.lang.String aString1,
                  java.lang.String aString2)
           throws java.lang.Exception
Write a pair of messages to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.

trace

public void trace(int type,
                  java.lang.String aString1,
                  java.lang.String aString2,
                  java.lang.Object[] anArray)
           throws java.lang.Exception
Write 2 messages and a java array to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.
anArray - Object[] - the collection to write to the log.

trace

public void trace(int type,
                  java.lang.String aString1,
                  java.lang.String aString2,
                  Array anArray)
           throws java.lang.Exception
Write 2 messages and an array to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.
anArray - Array - the collection to write to the log.

trace

public void trace(int type,
                  java.lang.String aString1,
                  java.lang.String aString2,
                  java.lang.String aString3)
           throws java.lang.Exception
Log three messages.
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.
aString3 - String - the third message to write to the log.

trace

public void trace(int type,
                  java.lang.String aString1,
                  java.lang.String aString2,
                  java.lang.String aString3,
                  int int1,
                  java.lang.String aString4)
           throws java.lang.Exception
Write messages to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.
aString3 - String - the third message to write to the log.
int1 - int - the integer to write to the log.
aString4 - String - the fourth message to write to the log.

trace

public void trace(int type,
                  java.lang.String aString1,
                  java.lang.String aString2,
                  java.lang.String aString3,
                  java.util.Vector aVector,
                  java.lang.String aString4)
           throws java.lang.Exception
Write 4 messages and a vector collection to the appropriate log (if any). This method is needed because of a bug in Vector's toString() method.
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.
aString3 - String - the third message to write to the log.
aVector - Vector - the collection to write to the log.
aString4 - String - the fourth message to write to the log.

trace

public void trace(int type,
                  java.lang.String aString1,
                  java.lang.String aString2,
                  java.util.Vector aVector)
           throws java.lang.Exception
Write 2 messages and a vector collection to the appropriate log (if any). This method is needed because of a bug in Vector's toString() method.
Parameters:
type - int - the type of message being logged.
aString1 - String - the first message to write to the log.
aString2 - String - the second message to write to the log.
aVector - Vector - the collection to write to the log.

trace

public void trace(int type,
                  java.lang.String aString,
                  java.lang.Throwable anException)
           throws java.lang.Exception
Log a message and an exception.
Parameters:
type - int - the type of message being logged.
aString - String - the message to write to the log.
anException - Throwable - the exception to write to the log.

trace

public void trace(int type,
                  java.lang.String aString,
                  java.util.Vector aVector)
           throws java.lang.Exception
Write a message and a vector collection to the appropriate log (if any). This method is needed because of a bug in Vector's toString() method.
Parameters:
type - int - the type of message being logged.
aString - String - the message to write to the log.
aVector - Vector - the collection to write to the log.

trace

public void trace(int type,
                  java.lang.String aString,
                  boolean aBoolean)
           throws java.lang.Exception
Write a string and a boolean to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aString - String - the string to write to the log.
aBoolean - boolean - the boolean to write to the log.

trace

public void trace(int type,
                  java.lang.Throwable anException)
           throws java.lang.Exception
Write an exception (and possibly its walkback) to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
anException - Throwable - the exception to write to the log.

trace

public void trace(int type,
                  java.util.Vector aVector)
           throws java.lang.Exception
Write a vector collection to the appropriate log (if any). This method is needed because of a bug in Vector's toString() method.
Parameters:
type - int - the type of message being logged.
aVector - Vector - the collection to write to the log.

trace

public void trace(int type,
                  short aShort)
           throws java.lang.Exception
Write a short integer to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aShort - short - the short integer to write to the log.

trace

public void trace(int type,
                  boolean aBoolean)
           throws java.lang.Exception
Write a boolean to the appropriate log (if any).
Parameters:
type - int - the type of message being logged.
aBoolean - boolean - the boolean to write to the log.

traceServletEntryOff

public void traceServletEntryOff()
Disable servlet entry tracing.

traceServletEntryOn

public void traceServletEntryOn()
Enable servlet entry tracing.

traceServletReturnOff

public void traceServletReturnOff()
Disable servlet return tracing.

traceServletReturnOn

public void traceServletReturnOn()
Enable servlet return tracing.

walkbackOff

public void walkbackOff()
Disable walkbacks.

walkbackOn

public void walkbackOn()
Enable walkbacks.

warning

public void warning(java.lang.String aString)
Write a warning message to the appropriate log (if any).
Parameters:
aString - String - the message to write to the log.

warning

public void warning(java.lang.String aString,
                    java.lang.Throwable anException)
Write a warning message and a warning exception (and possibly its walkback) to the appropriate log (if any).
Parameters:
aString - String - the message to write to the log.
anException - Throwable - the exception to write to the log.

warning

public void warning(java.lang.Throwable anException)
Write a warning exception (and possibly its walkback) to the appropriate log (if any).
Parameters:
anException - Throwable - the exception to write to the log.