com.entrust.toolkit.tracing

Class OutputStreamTraceLog

java.lang.Object

com.entrust.toolkit.tracing.TraceLog

com.entrust.toolkit.tracing.OutputStreamTraceLog

Direct Known Subclasses:

ConsoleTraceLog

public class OutputStreamTraceLog
extends TraceLog

A TraceLog implementation that writes messages to an OutputStream. The message format is basic. For each log message, the name is printed, followed by the message, and a new line. If an exception is provided then that is also displayed. If the logger was provided with a name, then the name is printed before the message and exception.

The tracing methods defined in this class are thread-safe.

Constructor Summary

Constructors

Constructor and Description
OutputStreamTraceLog(java.lang.String name) Create a named logger.

Method Summary

Modifier and Type	Method and Description
void	entering(java.lang.String className, java.lang.String methodName) Log a message that a given method is being entered.
void	entering(java.lang.String className, java.lang.String methodName, java.lang.Object parameter) Log a message that a given method is being entered, and log the parameter to the method.
void	entering(java.lang.String className, java.lang.String methodName, java.lang.Object[] parameters) Log a message that a given method is being entered, and log the parameters to the method.
void	exiting(java.lang.String className, java.lang.String methodName) Log a message that a given method is being exited, at the FINER level.
void	exiting(java.lang.String className, java.lang.String methodName, java.lang.Object result) Log a message that a given method is being exited, along with the result that is being returned.
void	setStream(java.io.OutputStream stream) Set the stream that will be used to write trace log messages to.
void	trace(java.lang.Object message) Write the given message to the log at the BASIC log level.
void	trace(java.lang.Object message, java.lang.Throwable t) Write a message with an associated error to the log, at the BASIC log level.
void	trace(java.lang.Object message, java.lang.Throwable t, TraceLevel level) Write a message with an associated error to the log, at the given log level.
void	trace(java.lang.Object message, TraceLevel level) Write the given message to the log at the given log level.

Methods inherited from class com.entrust.toolkit.tracing.TraceLog

getTraceLevel, getTraceLogName, isBasicTraceEnabled, isFinerTraceEnabled, isFinestTraceEnabled, isFineTraceEnabled, setTraceLevel, setTraceLogName

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputStreamTraceLog

public OutputStreamTraceLog(java.lang.String name)

Create a named logger.

Parameters:

name - the name that will be displayed in log messages.

Method Detail

setStream

public void setStream(java.io.OutputStream stream)

Set the stream that will be used to write trace log messages to.

Parameters:

stream - the stream that trace information will be sent to.

trace

public void trace(java.lang.Object message)

Write the given message to the log at the BASIC log level.

Specified by:

trace in class TraceLog

Parameters:

message - the message to write to the log.

trace

public void trace(java.lang.Object message,
                  java.lang.Throwable t)

Write a message with an associated error to the log, at the BASIC log level.

Specified by:

trace in class TraceLog

Parameters:

message - the message to write to the log.

t - the cause of the message being logged.

trace

public void trace(java.lang.Object message,
                  TraceLevel level)

Write the given message to the log at the given log level.

Specified by:

trace in class TraceLog

Parameters:

message - the message to write to the log.

level - the trace level at which to log the message.

trace

public void trace(java.lang.Object message,
                  java.lang.Throwable t,
                  TraceLevel level)

Write a message with an associated error to the log, at the given log level.

Specified by:

trace in class TraceLog

Parameters:

message - the message to write to the log.

t - the cause of the message being logged.

level - the trace level at which to log the message.

entering

public void entering(java.lang.String className,
                     java.lang.String methodName)

Log a message that a given method is being entered. The message is logged at the FINER level.

Specified by:

entering in class TraceLog

Parameters:

className - the name of the class whose method is being entered, can be null if this is not to be logged

methodName - the name of the method being entered.

entering

public void entering(java.lang.String className,
                     java.lang.String methodName,
                     java.lang.Object parameter)

Log a message that a given method is being entered, and log the parameter to the method. The message is logged at the FINER level.

Specified by:

entering in class TraceLog

Parameters:

className - the name of the class whose method is being entered, can be null if this is not to be logged

methodName - the name of the method being entered.

parameter - the parameter to the method, may be null if there is no parameter.

entering

public void entering(java.lang.String className,
                     java.lang.String methodName,
                     java.lang.Object[] parameters)

Log a message that a given method is being entered, and log the parameters to the method. The message is logged at the FINER level.

Specified by:

entering in class TraceLog

Parameters:

className - the name of the class whose method is being entered, can be null if this is not to be logged

methodName - the name of the method being entered.

parameters - the parameters to the method, may be null if there are no parameters.

exiting

public void exiting(java.lang.String className,
                    java.lang.String methodName)

Log a message that a given method is being exited, at the FINER level.

Specified by:

exiting in class TraceLog

Parameters:

className - the name of the class whose method is being exited, can be null if this is not to be logged

methodName - the name of the method being exited.

exiting

public void exiting(java.lang.String className,
                    java.lang.String methodName,
                    java.lang.Object result)

Log a message that a given method is being exited, along with the result that is being returned. The message is logged at the FINER level.

Specified by:

exiting in class TraceLog

Parameters:

className - the name of the class whose method is being exited, can be null if this is not to be logged

methodName - the name of the method being exited.

result - the value being returned.