org.torproject.metricsbot

Class RelayLocationTweetGenerator

java.lang.Object

org.torproject.metricsbot.RelayLocationTweetGenerator

public class RelayLocationTweetGenerator
extends java.lang.Object

Tweet generator functions for location (Country or AS) specific tweets.

Author:

Iain R. Learmonth <irl@torproject.org>

Constructor Summary

Constructors

Constructor and Description
RelayLocationTweetGenerator()

Method Summary

Modifier and Type	Method and Description
static MicroblogStatus	generateAsBandwidthTweet(java.util.List<RelayImpl> relays) Returns a tweet about how much bandwidth relays in a certain AS are contributing to the Tor network.
static MicroblogStatus	generateCountryBandwidthTweet(java.util.List<RelayImpl> relays) Returns a tweet about how much bandwidth relays in a certain country are contributing to the Tor network.
static java.lang.String	generateLocationTweetText(java.lang.String location, java.util.List<RelayImpl> relays, java.lang.String searchQuery) Helper to produce bandwidth contribution tweets for locations.

Methods inherited from class java.lang.Object

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

Constructor Detail

RelayLocationTweetGenerator

public RelayLocationTweetGenerator()

Method Detail

generateCountryBandwidthTweet

public static MicroblogStatus generateCountryBandwidthTweet(java.util.List<RelayImpl> relays)
                                                     throws MissingInformationException

Returns a tweet about how much bandwidth relays in a certain country are contributing to the Tor network.

An example tweet looks like:

16 relays in Vietnam are contributing 7.0MiB/s bandwidth to the #Tor network. https://atlas.torproject.org/#search/country:vn

This function requires that all the relays passed in the relays list are already filtered to be from the same country. The country code and country name are both determined from the first relay in the list.

Parameters:

relays - A list of RelayDetails objects for the country to have a tweet generated.

Returns:

A tweet about how how much bandwidth relays in a certain country are contributing to the Tor network.

Throws:

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

generateAsBandwidthTweet

public static MicroblogStatus generateAsBandwidthTweet(java.util.List<RelayImpl> relays)
                                                throws MissingInformationException

Returns a tweet about how much bandwidth relays in a certain AS are contributing to the Tor network.

An example tweet looks like:

5 relays in EE Limited (AS12576) are contributing 2.4MiB/s bandwidth to the #Tor network. https://atlas.torproject.org/#search/as:12576

This function requires that all the relays passed in the relays list are already filtered to be from the same AS. The AS number and AS name are both determined from the first relay in the list.

Parameters:

relays - A list of RelayDetails objects for the AS to have a tweet generated.

Returns:

A tweet about how how much bandwidth relays in a certain AS are contributing to the Tor network.

Throws:

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

generateLocationTweetText

public static java.lang.String generateLocationTweetText(java.lang.String location,
                                                         java.util.List<RelayImpl> relays,
                                                         java.lang.String searchQuery)

Helper to produce bandwidth contribution tweets for locations. This is intended to be called from a wrapper class and only performs counting of relays, summing of bandwidth and formatting the final tweet using the provided information.

Parameters:

location - The human readable location for the tweet.

relays - A list of relays that match the location for the tweet.

searchQuery - The Atlas search query to search for relays matching the location.

Returns:

A formatted tweet.