org.everrest.core.util

Class Tracer

java.lang.Object

org.everrest.core.util.Tracer

public final class Tracer
extends Object

Collector for trace messages. This class designed for internal usage only. Regular users of EverRest framework are not expected to use this class directly.

To turn on the tracing feature client must send query parameter tracing=true. Trace messages added by method trace. All collected messages will be sent to client as headers. Each trace message is represented as separate HTTP header. The name of header has next pattern EverRest-Trace-XXX, where XXX is number of message.

Version:

$Id: $

Author:

Andrey Parfonov

Constructor Summary

Constructors

Constructor and Description
Tracer()

Method Summary

Modifier and Type	Method and Description
static void	addTraceHeaders(GenericContainerResponse response) Add all collected trace messages to specified instance of response as HTTP headers.
static boolean	isTracingEnabled() Check is tracing feature enabled.
static void	trace(String message) Add trace message.

Methods inherited from class java.lang.Object

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

Constructor Detail

Tracer

public Tracer()

Method Detail

isTracingEnabled

public static boolean isTracingEnabled()

Check is tracing feature enabled.

Returns:

true if tracing enabled and false otherwise.

trace

public static void trace(String message)

Add trace message.

Parameters:

message - the trace message

addTraceHeaders

public static void addTraceHeaders(GenericContainerResponse response)

Add all collected trace messages to specified instance of response as HTTP headers. This method must be invoked at the end of request lifecycle.

Parameters:

response - the response for adding headers