org.torproject.metricsbot

Class Onionoo

java.lang.Object

org.torproject.metricsbot.Onionoo

public class Onionoo
extends java.lang.Object

An Onionoo client implementation. This is not intended to be a full implementation of the Onionoo protocol, just enough to satisfy the needs of MetricsBot.

Author:

Iain R. Learmonth <irl@torproject.org>

Constructor Summary

Constructors

Constructor and Description
Onionoo(java.lang.String baseUrl) Create a new Onionoo client.

Method Summary

Modifier and Type	Method and Description
java.util.List<BridgeImpl>	getBridgeDetails()
java.util.List<RelayImpl>	getRelayDetails() Fetch a list of all known relays.

Methods inherited from class java.lang.Object

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

Constructor Detail

Onionoo

public Onionoo(java.lang.String baseUrl)

Create a new Onionoo client.

Parameters:

baseUrl - the base URL to use, for example "https://onionoo.torproject.org/" (this should include the trailing slash)"

Method Detail

getRelayDetails

public java.util.List<RelayImpl> getRelayDetails()
                                          throws OnionooNotUpdatedException

Fetch a list of all known relays.

Returns:

a list of all relays currently known to Onionoo (this does not include bridge relays)

Throws:

OnionooNotUpdatedException - Thrown if it was not possible to fetch a list of relays.

getBridgeDetails

public java.util.List<BridgeImpl> getBridgeDetails()
                                            throws OnionooNotUpdatedException

Throws:

OnionooNotUpdatedException