org.torproject.metricsbot.tor

Interface Relay

All Known Implementing Classes:

RelayImpl

public interface Relay

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAllegedFamily() Get a list of relays that are not in an effective, mutual family relationship with this relay.
java.lang.String	getAsName() Get the AS name as found by Onionoo in an AS database by resolving the relay's first onion-routing IP address.
java.lang.String	getAsNumber() Get the AS number as found by Onionoo in an AS database by resolving the relay's first onion-routing IP address.
java.lang.Long	getBandwidthBurst() Get the bandwidth that this relay is willing to sustain in very short intervals.
java.lang.Long	getBandwidthRate() Get the average bandwidth that this relay is willing to sustain over long periods.
java.lang.String	getCityName() Get the city name as found by Onionoo in a GeoIP database by resolving the relay's first onion-routing IP address.
java.lang.Long	getConsensusWeight() Get the weight assigned to this relay by the directory authorities that clients use in their path selection algorithm.
java.lang.Double	getConsensusWeightFraction() Get the fraction of this relay's consensus weight compared to the sum of all consensus weights in the network.
java.lang.String	getContact() Get the contact address of the relay operator as configured by the relay operator.
java.lang.String	getCountry() Get the country code as found by Onionoo in a GeoIP database by resolving the relay's first onion-routing IP address.
java.lang.String	getCountryName() Get the country name as found by Onionoo in a GeoIP database by resolving the relay's first onion-routing IP address.
java.lang.String	getDirAddress() Get the IPv4 address and TCP port where the relay accepts directory connections.
java.util.List<java.lang.String>	getEffectiveFamily() Get a list of relays that are in an effective, mutual family relationship with this relay.
java.util.List<java.lang.String>	getExitAddresses() Get a list of IPv4 or IPv6 addresses that the relay used to exit to the Internet in the past 24 hours.
java.util.List<java.lang.String>	getExitPolicy() Get a list of exit-policy lines.
java.util.Map<java.lang.String,java.lang.String>	getExitPolicySummary() Get a summary version of the relay's exit policy containing a dictionary with either an "accept" or a "reject" element.
java.util.Map<java.lang.String,java.lang.String>	getExitPolicyV6Summary() Get a summary version of the relay's IPv6 exit policy containing a dictionary with either an "accept" or a "reject" element.
java.lang.Double	getExitProbability() Probability of this relay to be selected for the exit position.
java.lang.Double	getGuardProbability() Get the Probability of the relay to be selected for the guard position.
java.lang.String	getHostName() Get the host name as found by Onionoo in a reverse DNS lookup of the relay IP address.
java.util.List<java.lang.String>	getIndirectFamily() Get a list of relays that are not in an effective, mutual family relationship with this relay but that can be reached by following effective, mutual family relationships starting at this relay.
java.time.ZonedDateTime	getLastChangedAddressOrPort() Get the time when the relay last stopped announcing an IPv4 or IPv6 address or TCP port where it previously accepted onion-routing or directory connections.
java.lang.Double	getLatitude() Get the latitude as found by Onionoo in a GeoIP database by resolving the relay's first onion-routing IP address.
java.lang.Double	getLongitude() Get the longitude as found by Onionoo in a GeoIP database by resolving the relay's first onion-routing IP address.
java.lang.Boolean	getMeasured() Get whether or not the consensus weight of this relay is based on a threshold of 3 or more measurements by Tor bandwidth authorities.
java.lang.Double	getMiddleProbability() Get the probability of this relay to be selected for the middle position.
java.lang.Long	getObservedBandwidth() Get the bandwidth estimate of the capacity this relay can handle.
java.lang.String	getRegionName() Get the region name as found by Onionoo in a GeoIP database by resolving the relay's first onion-routing IP address.
java.lang.Boolean	isHibernating() Get whether or not this relay indicated that it is hibernating in its last known server descriptor.
java.lang.Boolean	isRecommendedVersion() Get whether or not the Tor software version of this relay is recommended by the directory authorities.

Method Detail

getExitAddresses

java.util.List<java.lang.String> getExitAddresses()

Get a list of IPv4 or IPv6 addresses that the relay used to exit to the Internet in the past 24 hours. IPv6 hex characters are all lower-case. Only those addresses are listed that are different from onion-routing addresses.

Returns:

A list of IPv4 or IPv6 addresses.

getDirAddress

java.lang.String getDirAddress()

Get the IPv4 address and TCP port where the relay accepts directory connections.

Returns:

An IPv4 address and TCP port.

getLastChangedAddressOrPort

java.time.ZonedDateTime getLastChangedAddressOrPort()

Get the time when the relay last stopped announcing an IPv4 or IPv6 address or TCP port where it previously accepted onion-routing or directory connections. This timestamp can serve as indicator whether this relay would be a suitable fallback directory.

Returns:

A UTC date and time.

isHibernating

java.lang.Boolean isHibernating()

Get whether or not this relay indicated that it is hibernating in its last known server descriptor. This information may be helpful to decide whether a relay that is not running anymore has reached its accounting limit and has not dropped out of the network for another, unknown reason.

Returns:

True if the relay indicated it is hibernating, otherwise false.

getCountry

java.lang.String getCountry()

Get the country code as found by Onionoo in a GeoIP database by resolving the relay's first onion-routing IP address.

Returns:

A two-letter country code.

See Also:

getCountryName()

getCountryName

java.lang.String getCountryName()

Get the country name as found by Onionoo in a GeoIP database by resolving the relay's first onion-routing IP address.

Returns:

A country name.

See Also:

getRegionName(), getCityName()

getRegionName

java.lang.String getRegionName()

Get the region name as found by Onionoo in a GeoIP database by resolving the relay's first onion-routing IP address.

Returns:

A region name.

See Also:

getCountryName(), getCityName()

getCityName

java.lang.String getCityName()

Get the city name as found by Onionoo in a GeoIP database by resolving the relay's first onion-routing IP address.

Returns:

A city name.

See Also:

getCountryName(), getRegionName()

getLatitude

java.lang.Double getLatitude()

Get the latitude as found by Onionoo in a GeoIP database by resolving the relay's first onion-routing IP address.

Returns:

A latitude.

See Also:

getLongitude()

getLongitude

java.lang.Double getLongitude()

Get the longitude as found by Onionoo in a GeoIP database by resolving the relay's first onion-routing IP address.

Returns:

A longitude.

See Also:

getLatitude()

getAsNumber

java.lang.String getAsNumber()

Get the AS number as found by Onionoo in an AS database by resolving the relay's first onion-routing IP address.

Returns:

An AS number prefixed by "AS".

See Also:

getAsName()

getAsName

java.lang.String getAsName()

Get the AS name as found by Onionoo in an AS database by resolving the relay's first onion-routing IP address.

Returns:

An AS name.

See Also:

getAsNumber()

getConsensusWeight

java.lang.Long getConsensusWeight()

Get the weight assigned to this relay by the directory authorities that clients use in their path selection algorithm.

Returns:

A consensus weight. The unit is arbitrary; currently it's kilobytes per second, but that might change in the future.

See Also:

getConsensusWeightFraction()

getHostName

java.lang.String getHostName()

Get the host name as found by Onionoo in a reverse DNS lookup of the relay IP address. This field is updated at most once in 12 hours, unless the relay IP address changes.

Returns:

A DNS name or IP address.

getBandwidthRate

java.lang.Long getBandwidthRate()

Get the average bandwidth that this relay is willing to sustain over long periods.

Returns:

A bandwidth in bytes per second.

getBandwidthBurst

java.lang.Long getBandwidthBurst()

Get the bandwidth that this relay is willing to sustain in very short intervals.

Returns:

A bandwidth in bytes per second.

getObservedBandwidth

java.lang.Long getObservedBandwidth()

Get the bandwidth estimate of the capacity this relay can handle. The relay remembers the maximum bandwidth sustained output over any ten second period in the past day, and another sustained input. The "observed_bandwidth" value is the lesser of these two numbers.

Returns:

A bandwidth in bytes per second.

getExitPolicy

java.util.List<java.lang.String> getExitPolicy()

Get a list of exit-policy lines. May contradict the "exit_policy_summary" field in a rare edge case: this happens when the relay changes its exit policy after the directory authorities summarized the previous exit policy.

Returns:

A list of exit-policy lines.

getExitPolicySummary

java.util.Map<java.lang.String,java.lang.String> getExitPolicySummary()

Get a summary version of the relay's exit policy containing a dictionary with either an "accept" or a "reject" element. If there is an "accept" ("reject") element, the relay accepts (rejects) all TCP ports or port ranges in the given list for most IP addresses and rejects (accepts) all other ports. May contradict the "exit_policy" field in a rare edge case: this happens when the relay changes its exit policy after the directory authorities summarized the previous exit policy.

Returns:

A list of summary exit-policy lines.

getExitPolicyV6Summary

java.util.Map<java.lang.String,java.lang.String> getExitPolicyV6Summary()

Get a summary version of the relay's IPv6 exit policy containing a dictionary with either an "accept" or a "reject" element. If there is an "accept" ("reject") element, the relay accepts (rejects) all TCP ports or port ranges in the given list for most IP addresses and rejects (accepts) all other ports. May contradict the "exit_p)olicy_summary" field in a rare edge case: this happens when the relay changes its exit policy after the directory authorities summarized the previous exit policy.

Returns:

A list of summary exit-policy lines.

getContact

java.lang.String getContact()

Get the contact address of the relay operator as configured by the relay operator.

Returns:

An arbitrarily formated string.

isRecommendedVersion

java.lang.Boolean isRecommendedVersion()

Get whether or not the Tor software version of this relay is recommended by the directory authorities.

Returns:

True if the version is a recommended version, otherwise false.

See Also:

BaseRelay.getPlatform()

getEffectiveFamily

java.util.List<java.lang.String> getEffectiveFamily()

Get a list of relays that are in an effective, mutual family relationship with this relay. These relays are part of this relay's family and they consider this relay to be part of their family.

Returns:

A list of relay fingerprints.

See Also:

getAllegedFamily(), getIndirectFamily()

getAllegedFamily

java.util.List<java.lang.String> getAllegedFamily()

Get a list of relays that are not in an effective, mutual family relationship with this relay. These relays are part of this relay's family but they don't consider this relay to be part of their family.

Returns:

A list of relay fingerprints.

See Also:

getEffectiveFamily(), getIndirectFamily()

getIndirectFamily

java.util.List<java.lang.String> getIndirectFamily()

Get a list of relays that are not in an effective, mutual family relationship with this relay but that can be reached by following effective, mutual family relationships starting at this relay.

Returns:

A list of relay fingerprints.

See Also:

getEffectiveFamily(), getAllegedFamily()

getConsensusWeightFraction

java.lang.Double getConsensusWeightFraction()

Get the fraction of this relay's consensus weight compared to the sum of all consensus weights in the network. This fraction is a very rough approximation of the probability of this relay to be selected by clients.

Returns:

A decimal fraction.

See Also:

getConsensusWeight()

getGuardProbability

java.lang.Double getGuardProbability()

Get the Probability of the relay to be selected for the guard position. This probability is calculated based on consensus weights, relay flags, and bandwidth weights in the consensus. Path selection depends on more factors, so that this probability can only be an approximation.

Returns:

A decimal fraction.

See Also:

getMiddleProbability(), getExitProbability()

getMiddleProbability

java.lang.Double getMiddleProbability()

Get the probability of this relay to be selected for the middle position. This probability is calculated based on consensus weights, relay flags, and bandwidth weights in the consensus. Path selection depends on more factors, so that this probability can only be an approximation.

Returns:

A decimal fraction.

See Also:

getGuardProbability(), getExitProbability()

getExitProbability

java.lang.Double getExitProbability()

Probability of this relay to be selected for the exit position. This probability is calculated based on consensus weights, relay flags, and bandwidth weights in the consensus. Path selection depends on more factors, so that this probability can only be an approximation.

Returns:

A decimal fraction.

See Also:

getGuardProbability(), getMiddleProbability()

getMeasured

java.lang.Boolean getMeasured()

Get whether or not the consensus weight of this relay is based on a threshold of 3 or more measurements by Tor bandwidth authorities.

Returns:

True if the relay has been measured by 3 or more measurements by Tor bandwidth authorities, otherwise false.

See Also:

getConsensusWeight()