org.torproject.metricsbot

Class TorNetwork

java.lang.Object

org.torproject.metricsbot.TorNetwork

public class TorNetwork
extends java.lang.Object

A representation of the Tor network to query relay and bridge relay details. Methods are provided for selecting relays and groups of relays at random.

Author:

Iain R. Learmonth <irl@torproject.org>

Constructor Summary

Constructors

Constructor and Description
TorNetwork()

Method Summary

Modifier and Type	Method and Description
MicroblogStatus	getNetworkTweet() Returns a tweet using a random template with a random running relay or group of running relays.
java.lang.String	getRandomAs() Get a random AS number that has at least one relay running in the Tor network.
java.lang.String	getRandomCountry() Get a random 2-letter country code that has at least one relay running in the Tor network.
BridgeImpl	getRandomRunningBridge() Get a random relay from the Tor network.
RelayImpl	getRandomRunningRelay() Get a random relay from the Tor network.
MicroblogStatus	getRelayTweet() Returns a tweet using a random template with a random running relay or group of running relays.
java.util.List<RelayImpl>	getRunningRelays()
java.util.List<RelayImpl>	getRunningRelaysForAs() Returns a list of running relay details for a random AS.
java.util.List<RelayImpl>	getRunningRelaysForAs(java.lang.String as)
java.util.List<RelayImpl>	getRunningRelaysForCountry() Returns a list of relay details for a random country.
java.util.List<RelayImpl>	getRunningRelaysForCountry(java.lang.String country)
void	update()

Methods inherited from class java.lang.Object

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

Constructor Detail

TorNetwork

public TorNetwork()

Method Detail

update

public void update()

getRandomRunningRelay

public RelayImpl getRandomRunningRelay()

Get a random relay from the Tor network.

Returns:

Details about the relay from the last Onionoo details document fetched.

getRandomRunningBridge

public BridgeImpl getRandomRunningBridge()

Get a random relay from the Tor network.

Returns:

Details about the relay from the last Onionoo details document fetched.

getRandomCountry

public java.lang.String getRandomCountry()

Get a random 2-letter country code that has at least one relay running in the Tor network. This can be used as input to getRunningRelaysForCountry(String).

Returns:

A 2-letter country code.

See Also:

getRunningRelaysForCountry(), getRunningRelaysForCountry(String)

getRandomAs

public java.lang.String getRandomAs()

Get a random AS number that has at least one relay running in the Tor network. This can be used as input to getRunningRelaysForAs(String).

Returns:

An AS number prefixed by "AS".

See Also:

getRunningRelaysForAs(), getRunningRelaysForAs(String)

getRunningRelaysForAs

public java.util.List<RelayImpl> getRunningRelaysForAs()

Returns a list of running relay details for a random AS. This is a wrapper for getRunningRelaysForAs(String).

Returns:

A list of relay details.

See Also:

getRunningRelaysForAs(String)

getRunningRelaysForAs

public java.util.List<RelayImpl> getRunningRelaysForAs(java.lang.String as)

getRunningRelaysForCountry

public java.util.List<RelayImpl> getRunningRelaysForCountry()

Returns a list of relay details for a random country. This is a wrapper for getRunningRelaysForCountry(String).

Returns:

A list of relay details.

See Also:

getRunningRelaysForCountry(String)

getRunningRelaysForCountry

public java.util.List<RelayImpl> getRunningRelaysForCountry(java.lang.String country)

getNetworkTweet

public MicroblogStatus getNetworkTweet()
                                throws MissingInformationException

Returns a tweet using a random template with a random running relay or group of running relays.

The following functions may be called to generate the tweets:

• RelayTweetGenerator.generateAgeTweet(RelayImpl)
• RelayTweetGenerator.generateBandwidthTweet(RelayImpl)
• RelayLocationTweetGenerator.generateAsBandwidthTweet(List)
• RelayLocationTweetGenerator.generateCountryBandwidthTweet(List)
• BridgeTweetGenerator.generateAgeTweet(BridgeImpl)
• BridgeTweetGenerator.generateBandwidthTweet(BridgeImpl)

Returns:

A formatted Tweet.

Throws:

MissingInformationException - when information required to generate the tweet is missing from the RelayDetails object (probably because Onionoo did not have it)

getRelayTweet

public MicroblogStatus getRelayTweet()
                              throws MissingInformationException

Returns a tweet using a random template with a random running relay or group of running relays.

The following functions may be called to generate the tweets:

• RelayTweetGenerator.generateAgeTweet(RelayImpl)
• RelayTweetGenerator.generateBandwidthTweet(RelayImpl)
• RelayLocationTweetGenerator.generateAsBandwidthTweet(List)
• RelayLocationTweetGenerator.generateCountryBandwidthTweet(List)
• BridgeTweetGenerator.generateAgeTweet(BridgeImpl)
• BridgeTweetGenerator.generateBandwidthTweet(BridgeImpl)

Returns:

A formatted Tweet.

Throws:

MissingInformationException - when information required to generate the tweet is missing from the RelayDetails object (probably because Onionoo did not have it)

getRunningRelays

public java.util.List<RelayImpl> getRunningRelays()