de.christofreichardt.diagnosis.QueueTracer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tracelogger Show documentation
Show all versions of tracelogger Show documentation
A trace tool which produces clearly arranged logs by indenting the trace messages depending on the depth of the call stack.
/*
* To change this license header, choose License Headers in Project Properties.
* To change this template file, choose Tools | Templates
* and open the template in the editor.
*/
package de.christofreichardt.diagnosis;
import de.christofreichardt.diagnosis.io.IndentablePrintStream;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathExpressionException;
import org.w3c.dom.Node;
/**
*
* A special tracer intended for the use by a bounded blocking queue. This is an option to retrieve tracer within a multi-threaded environment
* when we cannot control the creation of the threads. An example would be applications within a container that manages a thread pool. This tracer
* honors the contract of an {@link AbstractTracer} but does so by wrapping and delegating to another {@link AbstractTracer}. In particular the
* current tracing context will be automatically cleared when calling {@link #wayout()} and the method stack remains empty afterwards. Thus the tracer
* can be reused for another thread's tracing context without any danger to create a memory leak.
*
*
* @author Christof Reichardt
* @param the wrapped tracer
*/
abstract public class QueueTracer extends AbstractTracer {
private boolean online;
private int level;
/**
* Some tracer.
*/
final protected T tracer;
/**
* Constructor expects the tracer name and the to be wrapped tracer instance.
*
* @param name the name of the tracer
* @param tracer the to be wrapped tracer
*/
public QueueTracer(String name, T tracer) {
super(name);
this.tracer = tracer;
}
/**
* Delegates to the corresponding method of the wrapped tracer.
*
* @return the sync object of the wrapped tracer
*/
@Override
public Object getSyncObject() {
return this.tracer.getSyncObject();
}
/**
* Delegates to the corresponding method of the wrapped tracer.
*
* @return the buffer size of the wrapped tracer
*/
@Override
public int getBufferSize() {
return this.tracer.getBufferSize();
}
/**
* Delegates to the corresponding method of the wrapped tracer.
*
* @return indicates the autoflush mode of the wrapped tracer
*/
@Override
public boolean isAutoflush() {
return this.tracer.isAutoflush();
}
/**
* Delegates to the corresponding method of the wrapped tracer.
*
* @return indicates if the wrapped tracer is openend
*/
@Override
public boolean isOpened() {
return this.tracer.isOpened();
}
// /**
// *
// * @return
// */
// @Override
// public String getName() {
// return this.tracer.getName();
// }
/**
* Sets the buffer size of the wrapped tracer.
*
* @param bufferSize the bufferSize to set
*/
@Override
public void setBufferSize(int bufferSize) {
this.tracer.setBufferSize(bufferSize);
}
/**
* Sets the autoflush mode of the wrapped tracer
* @param autoflush the autoflush to set
*/
@Override
protected void setAutoflush(boolean autoflush) {
this.tracer.setAutoflush(autoflush);
}
@Override
protected void readConfiguration(XPath xpath, Node node) throws XPathExpressionException, AbstractTracer.Exception {
this.online = (boolean) xpath.evaluate("./dns:Online/text()", node, XPathConstants.BOOLEAN);
this.level = Integer.parseInt((String) xpath.evaluate("./dns:DebugLevel/text()", node, XPathConstants.STRING));
setAutoflush((boolean) xpath.evaluate("./dns:TraceLogger/dns:AutoFlush/text()", node, XPathConstants.BOOLEAN));
setBufferSize(Integer.parseInt((String) xpath.evaluate("./dns:TraceLogger/dns:BufSize/text()", node, XPathConstants.STRING)));
}
/**
* Opens the wrapped tracer.
*/
@Override
public void open() {
this.tracer.open();
}
/**
* Closes the wrapped tracer.
*/
@Override
public void close() {
this.tracer.close();
}
/**
* Delegates to the corresponding method of the wrapped tracer by using the config parameter global
* to all queued tracer.
*/
@Override
public void initCurrentTracingContext() {
this.tracer.initCurrentTracingContext(this.level, this.online);
}
/**
* Delegates to the corresponding method of the wrapped tracer.
*
* @param debugLevel controls the extent of the output
* @param online a value of false delivers no output of the current thread at all whereas a value of true delivers output controlled by debugLevel
*/
@Override
public void initCurrentTracingContext(int debugLevel, boolean online) {
this.tracer.initCurrentTracingContext(debugLevel, online);
}
/**
* Delegates to the corresponding method of the wrapped tracer.
*
* @param returnType the return type of the method as string representation
* @param clazz the class to which that method belong
* @param methodSignature the remaining method signature (without return type) inclusive parameter as string representation
* @return the TraceMethod which has been put onto the stack - a mere data object for internal use primarily. May be null.
*/
@Override
public TraceMethod entry(String returnType, Class clazz, String methodSignature) {
return this.tracer.entry(returnType, clazz, methodSignature);
}
/**
* Delegates to the corresponding method of the wrapped tracer.
*
* @param returnType the return type of the method as string representation
* @param object the object that owns the method
* @param methodSignature the remaining method signature (without return type) inclusive parameter as string representation
* @return the TraceMethod which has been put onto the stack - a mere data object for internal use primarily. May be null.
*/
@Override
public TraceMethod entry(String returnType, Object object, String methodSignature) {
return this.tracer.entry(returnType, object, methodSignature);
}
/**
* Delegates to the corresponding method of the wrapped tracer.
*
* @param logLevel one of the predefined levels INFO, WARNING, ERROR, FATAL and SEVERE
* @param message the to be logged message
* @param clazz the originating class
*/
@Override
public void logMessage(LogLevel logLevel, String message, Class clazz, String methodName) {
this.tracer.logMessage(logLevel, message, clazz, methodName);
}
/**
* Delegates to the corresponding method of the wrapped tracer.
*
* @param logLevel one of the predefined levels INFO, WARNING, ERROR, FATAL and SEVERE
* @param throwable the to be logged throwable
* @param clazz the originating class
* @param methodName the name of the relevant method
*/
@Override
public void logException(LogLevel logLevel, Throwable throwable, Class clazz, String methodName) {
this.tracer.logException(logLevel, throwable, clazz, methodName);
}
/**
* Delegates to the corresponding method of the wrapped tracer.
* @return the thread map of the wrapped tracer
*/
@Override
protected AbstractThreadMap getThreadMap() {
return this.tracer.getThreadMap();
}
/**
* Delegates to the corresponding method of the wrapped tracer. Besides it checks if the
* stack size of the current tracing context has decreased to zero. If so then the current tracing context
* will be cleared.
*
* @return the TraceMethod which has been popped from the stack - a mere data object for internal use primarily. May be null.
*/
@Override
public TraceMethod wayout() {
TraceMethod traceMethod = this.tracer.wayout();
if (getThreadMap().getCurrentStackSize() == 0) {
clearCurrentTracingContext();
if (!TracerFactory.getInstance().offerTracer(this))
System.err.printf("WARNING: Offer failed. Possible queue corruption.%n");
}
return traceMethod;
}
/**
* Delegates to the corresponding method of the wrapped tracer.
*
* @return an {@link IndentablePrintStream}
*/
@Override
public IndentablePrintStream out() {
return this.tracer.out();
}
/**
* Delegates to the corresponding method of the wrapped tracer.
* @param level the level of the to be printed data
* @return an {@link IndentablePrintStream}
*/
@Override
protected IndentablePrintStream out(int level) {
return this.tracer.out(level);
}
/**
* Delegates to the corresponding method of the wrapped tracer.
*/
@Override
public void clearCurrentTracingContext() {
this.tracer.clearCurrentTracingContext();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy