Interfaces and essential classes for obtaining and processing Tor descriptors.
Tor Metrics Library API, which is provided and supported by Tor's Metrics Team, is a library to obtain and process descriptors containing Tor network data. It is the main Java tool for processing Tor descriptors and provides a standard API consisting of interfaces and a reference implementation for all of them.
Most Tor descriptors understood by this library are specified in the Tor directory protocol, version 3 or in the earlier version 2 or version 1 of that document. Other descriptors are specified on the CollecTor website.
The interfaces in
as well as their implementations in the
org.torproject.descriptor.impl package were driven by two main
goals originating from the primary use case to make Tor network data
accessible for statistical analysis:
At the same time the current design and implementation were done with a number of non-goals in mind, even though some of these might turn into goals in the future:
Hints about using Tor Metrics Library can be found in the
org.torproject.descriptor package description.
Contact and further information: