com.entrust.toolkit.tracing

Class TraceLog

java.lang.Object

com.entrust.toolkit.tracing.TraceLog

Direct Known Subclasses:

NoOpTraceLog, OutputStreamTraceLog

public abstract class TraceLog
extends java.lang.Object

This abstract class defines the interface for any classes that are to be used for logging, and some common operations. It has two constructors, one that accepts a String so that logs can be named, and a no-argument constructor for anonymous logs, or logs that wish to provide another naming mechanism.

See the documentation for the TraceLogFactory class for details on how trace logging is configured.

See Also:

TraceLogFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TraceLog() Simple constructor.
protected	TraceLog(java.lang.String traceLogName) Constructor to create a named log instance.

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	entering(java.lang.String className, java.lang.String methodName) Log a message that a given method is being entered.
abstract 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 a single parameter to the method.
abstract 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.
abstract void	exiting(java.lang.String className, java.lang.String methodName) Log a message that a given method is being exited.
abstract 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.
TraceLevel	getTraceLevel() Returns the the finest verbosity level at which messages will be logged.
protected java.lang.String	getTraceLogName() Returns the name of the logger, which could be displayed in log messages to distinguish the source of a log message.
boolean	isBasicTraceEnabled() Returns whether or not BASIC tracing is enabled.
boolean	isFinerTraceEnabled() Returns whether or not FINER tracing is enabled.
boolean	isFinestTraceEnabled() Returns whether or not FINEST tracing is enabled.
boolean	isFineTraceEnabled() Returns whether or not FINE tracing is enabled.
protected void	setTraceLevel(TraceLevel level) Set the finest verbosity level at which messages will be logged.
protected void	setTraceLogName(java.lang.String traceLogName) Sets the name of the logger.
abstract void	trace(java.lang.Object message) Write the given message to the log at the BASIC log level.
abstract void	trace(java.lang.Object message, java.lang.Throwable cause) Write a message with an associated error to the log, at the BASIC log level.
abstract void	trace(java.lang.Object message, java.lang.Throwable cause, TraceLevel level) Write a message with an associated error to the log, at the given log level.
abstract void	trace(java.lang.Object message, TraceLevel level) Write the given message to the log at the given log level.

Methods inherited from class java.lang.Object

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

Constructor Detail

TraceLog

protected TraceLog()

Simple constructor. Creates an unnamed log instance.

TraceLog

protected TraceLog(java.lang.String traceLogName)

Constructor to create a named log instance.

Parameters:

traceLogName - the name of the trace log, which could be displayed in log messages to help distinguish the source of a message.

Method Detail

isBasicTraceEnabled

public boolean isBasicTraceEnabled()

Returns whether or not BASIC tracing is enabled.

Returns:

whether or not BASIC tracing is enabled.

isFineTraceEnabled

public boolean isFineTraceEnabled()

Returns whether or not FINE tracing is enabled.

Returns:

whether or not FINE tracing is enabled.

isFinerTraceEnabled

public boolean isFinerTraceEnabled()

Returns whether or not FINER tracing is enabled.

Returns:

whether or not FINER tracing is enabled.

isFinestTraceEnabled

public boolean isFinestTraceEnabled()

Returns whether or not FINEST tracing is enabled.

Returns:

whether or not FINEST tracing is enabled.

setTraceLevel

protected void setTraceLevel(TraceLevel level)

Set the finest verbosity level at which messages will be logged. Any message logged at a level finer than this will be discarded.

Parameters:

level - the trace verbosity level.

getTraceLevel

public TraceLevel getTraceLevel()

Returns the the finest verbosity level at which messages will be logged.

Returns:

the the finest verbosity level at which messages will be logged.

setTraceLogName

protected void setTraceLogName(java.lang.String traceLogName)

Sets the name of the logger.

Parameters:

traceLogName - the name of the logger

getTraceLogName

protected java.lang.String getTraceLogName()

Returns the name of the logger, which could be displayed in log messages to distinguish the source of a log message.

Returns:

the name of the logger

trace

public abstract void trace(java.lang.Object message)

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

Parameters:

message - the message to write to the log.

trace

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

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

Parameters:

message - the message to write to the log.

cause - the cause of the message being logged.

trace

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

Write the given message to the log at the given log level. If the given level is finer than the level of tracing enabled for this class, it should be ignored.

Parameters:

message - the message to write to the log.

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

trace

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

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

Parameters:

message - the message to write to the log.

cause - the cause of the message being logged.

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

entering

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

Log a message that a given method is being entered.

The message should be logged at the FINER level.

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 abstract 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 a single parameter to the method.

The message should be logged at the FINER level.

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 parameters.

entering

public abstract 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 should be logged at the FINER level.

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 abstract void exiting(java.lang.String className,
           java.lang.String methodName)

Log a message that a given method is being exited.

The message should be logged at the FINER level.

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 abstract 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 should be logged at the FINER level.

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.