org.sonatype.aether
Interface RequestTrace

All Known Implementing Classes:
DefaultRequestTrace

public interface RequestTrace

A trace of nested requests that are performed by the repository system. This trace information can be used to correlate repository events with higher level operations in the application code that eventually caused the events. A single trace can carry an arbitrary object as data which is meant to describe a request/operation that is currently executed. For call hierarchies within the repository system itself, this data will usually be the *Request object that is currently processed. When invoking methods on the repository system, client code may provide a request trace that has been prepopulated with whatever data is useful for the application to indicate its state for later evaluation when processing the repository events.

Author:
Benjamin Bentmann
See Also:
RepositoryEvent.getTrace()

Method Summary
 Object getData()
          Gets the data associated with this trace.
 RequestTrace getParent()
          Gets the parent of this trace.
 RequestTrace newChild(Object data)
          Creates a new child of this trace.
 

Method Detail

getData

Object getData()
Gets the data associated with this trace.

Returns:
The data associated with this trace or null.

getParent

RequestTrace getParent()
Gets the parent of this trace.

Returns:
The parent of this trace or null if this is the root of the trace stack.

newChild

RequestTrace newChild(Object data)
Creates a new child of this trace.

Parameters:
data - The data to associate with the child, may be null.
Returns:
The child trace, never null.


Copyright © 2010-2011 Sonatype, Inc.. All Rights Reserved.