Package com.priint.pubserver.tracing

Class SessionTracer

java.lang.Object

com.priint.pubserver.tracing.SessionTracer

public class SessionTracer
extends java.lang.Object

Tracer for writing session specific trace messages into a persistent data store.

Create a tracer only once in a class.

 Tracer tracer = new Tracer("MyDataFunctions"); 

Use simple or extended signature of methods. You are strongly advised to use message as a template with "{}" for replacement. Add replacements in open argument list, so that they only get evaluated, when trace is really written and not e.g. for sessions that do not log.

 tracer.info("my message {} {} {}", "eins", new Integer(2), Float.parse("3.0"));
 tracer.warnExtended("mysource", "my message for something: {}", "my hint", someObject);
 

Constructor Summary

Constructors

Constructor	Description
SessionTracer(java.lang.String source)	Create a tracer object.

Method Summary

Modifier and Type	Method	Description
void	error(java.lang.String message, java.lang.Object... argArray)	Write error to session trace.
void	errorAndLog(java.lang.String message, java.lang.Object... argArray)	Write error to session trace and server log.
void	errorExtended(java.lang.String source, java.lang.String message, java.lang.String hint, boolean log, java.lang.Object... argArray)	Write an ERROR trace message for a session.
void	info(java.lang.String message, java.lang.Object... argArray)	Write info to session trace.
void	infoAndLog(java.lang.String message, java.lang.Object... argArray)	Write info to session trace and to server log.
void	infoExtended(java.lang.String source, java.lang.String message, java.lang.String hint, boolean log, java.lang.Object... argArray)	Write an INFO trace message for a session.
boolean	isActive()	Returns true if trace mode is active for the current session.
void	logAndTrace(TracerMessage.MessageType messageType, java.lang.String source, java.lang.String message, java.lang.String hint, java.lang.Object... argArray)	writes a message to the server log and additionally - if tracing is enabled - writes a trace too.
void	warn(java.lang.String message, java.lang.Object... argArray)	Write warning to session trace.
void	warnAndLog(java.lang.String message, java.lang.Object... argArray)	Write warning to session trace and server log.
void	warnExtended(java.lang.String source, java.lang.String message, java.lang.String hint, boolean log, java.lang.Object... argArray)	Write an WARNING trace message for a session.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionTracer

public SessionTracer(java.lang.String source)

Create a tracer object.

Parameters:

source - Source of tracer (like plugin name and / or method name)

Method Detail

info

public void info(java.lang.String message,
                 java.lang.Object... argArray)

Write info to session trace.

Parameters:

message - text for trace and log

argArray - arguments to be used for replacement in message string

See Also:

infoExtended(String, String, String, boolean, Object...)

infoAndLog

public void infoAndLog(java.lang.String message,
                       java.lang.Object... argArray)

Write info to session trace and to server log.

Parameters:

message - text for trace and log

argArray - arguments to be used for replacement in message string

See Also:

infoExtended(String, String, String, boolean, Object...)

error

public void error(java.lang.String message,
                  java.lang.Object... argArray)

Write error to session trace.

Parameters:

message - text for trace and log

argArray - arguments to be used for replacement in message string

See Also:

errorExtended(String, String, String, boolean, Object...)

errorAndLog

public void errorAndLog(java.lang.String message,
                        java.lang.Object... argArray)

Write error to session trace and server log.

Parameters:

message - text for trace and log

argArray - arguments to be used for replacement in message string

See Also:

errorExtended(String, String, String, boolean, Object...)

warn

public void warn(java.lang.String message,
                 java.lang.Object... argArray)

Write warning to session trace.

Parameters:

message - text for trace and log

argArray - arguments to be used for replacement in message string

See Also:

warnExtended(String, String, String, boolean, Object...)

warnAndLog

public void warnAndLog(java.lang.String message,
                       java.lang.Object... argArray)

Write warning to session trace and server log.

Parameters:

message - text for trace and log

argArray - arguments to be used for replacement in message string

See Also:

warnExtended(String, String, String, boolean, Object...)

infoExtended

public void infoExtended(java.lang.String source,
                         java.lang.String message,
                         java.lang.String hint,
                         boolean log,
                         java.lang.Object... argArray)

Write an INFO trace message for a session. Analogous to a call to logger.info().

For information on the arguments see TracerMessage.

Parameters:

source - optional module or class and method name

message - text for trace and log

hint - optional information to user what to she can do

log - if true then SessionTracer will also write this message into the server log - at debug level

argArray - arguments to be used for replacement in message string

errorExtended

public void errorExtended(java.lang.String source,
                          java.lang.String message,
                          java.lang.String hint,
                          boolean log,
                          java.lang.Object... argArray)

Write an ERROR trace message for a session. Analogous to a call to logger.error().

For information on the arguments see TracerMessage.

Parameters:

source - optional module or class and method name

message - text for trace and log

hint - optional information to user what to she can do

log - if true then SessionTracer will also write this message into the server log - at debug level

argArray - arguments to be used for replacement in message string

warnExtended

public void warnExtended(java.lang.String source,
                         java.lang.String message,
                         java.lang.String hint,
                         boolean log,
                         java.lang.Object... argArray)

Write an WARNING trace message for a session. Analogous to a call to logger.warn().

For information on the arguments see TracerMessage.

Parameters:

source - optional module or class and method name

message - text for trace and log

hint - optional information to user what to she can do

log - if true then SessionTracer will also write this message into the server log - at debug level

argArray - arguments to be used for replacement in message string

isActive

public boolean isActive()

Returns true if trace mode is active for the current session.

logAndTrace

public void logAndTrace(TracerMessage.MessageType messageType,
                        java.lang.String source,
                        java.lang.String message,
                        java.lang.String hint,
                        java.lang.Object... argArray)

writes a message to the server log and additionally - if tracing is enabled - writes a trace too.

log level is tracing level - 1, e.g. trace error = log warn, trace warning = log info, trace info = log debug

Parameters:

messageType -

source -

message -

hint -

argArray -