HTraceTracerContext (Apache CXF JavaDoc 3.1.3 API)

java.lang.Object
- org.apache.cxf.tracing.htrace.HTraceTracerContext

All Implemented Interfaces:: TracerContext

public class HTraceTracerContext
extends Object
implements TracerContext

Constructor Summary

Constructors
Constructor and Description
`HTraceTracerContext(org.apache.htrace.Sampler<?> sampler)`
`HTraceTracerContext(org.apache.htrace.Sampler<?> sampler, org.apache.htrace.Span continuationSpan)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`annotate(String key, String value)` Adds a key/value pair to the currently active span.
`<T> T`	`continueSpan(Traceable<T> traceable)` Picks up an currently detached span from another thread.
`org.apache.htrace.TraceScope`	`startSpan(String description)` Starts a new span in the current thread.
`void`	`timeline(String message)` Adds a timeline to the currently active span.
`<T> Callable<T>`	`wrap(String desription, Traceable<T> traceable)` Wraps the traceable into a new span, preserving the current span as a parent.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HTraceTracerContext
```
public HTraceTracerContext(org.apache.htrace.Sampler<?> sampler)
```
  - HTraceTracerContext
```
public HTraceTracerContext(org.apache.htrace.Sampler<?> sampler,
                   org.apache.htrace.Span continuationSpan)
```
- Method Detail
  - startSpan
```
public org.apache.htrace.TraceScope startSpan(String description)
```
    Description copied from interface: TracerContext
    
    Starts a new span in the current thread.
    
    Specified by:
    
    startSpan in interface TracerContext
    
    Parameters:
    description - span description
    
    Returns:
    span instance object
  - continueSpan
```
public <T> T continueSpan(Traceable<T> traceable)
               throws Exception
```
    Description copied from interface: TracerContext
    
    Picks up an currently detached span from another thread. This method is intended to be used in the context of JAX-RS asynchronous invocations, where request and response are effectively executed by different threads.
    
    Specified by:
    
    continueSpan in interface TracerContext
    
    Parameters:
    traceable - traceable implementation to be executed
    
    Returns:
    the result of the execution
    
    Throws:
    
    Exception - any exception being thrown by the traceable implementation
  - wrap
```
public <T> Callable<T> wrap(String desription,
                   Traceable<T> traceable)
```
    Description copied from interface: TracerContext
    
    Wraps the traceable into a new span, preserving the current span as a parent.
    
    Specified by:
    
    wrap in interface TracerContext
    
    Parameters:
    desription - span description
    traceable - traceable implementation to be wrapped
    
    Returns:
    callable to be executed (in current thread or any other thread pool)
  - annotate
```
public void annotate(String key,
            String value)
```
    Description copied from interface: TracerContext
    
    Adds a key/value pair to the currently active span.
    
    Specified by:
    
    annotate in interface TracerContext
    
    Parameters:
    key - key to add
    value - value to add
  - timeline
```
public void timeline(String message)
```
    Description copied from interface: TracerContext
    
    Adds a timeline to the currently active span.
    
    Specified by:
    
    timeline in interface TracerContext
    
    Parameters:
    message - timeline message

Class HTraceTracerContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HTraceTracerContext

HTraceTracerContext

Method Detail

startSpan

continueSpan

wrap

annotate

timeline