org.torproject.metricsbot.tor

Interface BaseRelay

All Known Subinterfaces:

Bridge

All Known Implementing Classes:

BaseRelayImpl, BridgeImpl, RelayImpl

public interface BaseRelay

Method Summary

Modifier and Type	Method and Description
java.awt.image.RenderedImage	generateBadge()
java.lang.Long	getAdvertisedBandwidth() Bandwidth that this relay is willing and capable to provide.
java.lang.String	getFingerprint() Get the relay's fingerprint.
java.time.ZonedDateTime	getFirstSeen() Get the time the relay was first seen in a network status consensus.
java.util.List<RelayFlag>	getFlags() Get the list of flags that the directory authorities assigned to this relay.
java.util.List<java.lang.String>	getFlagStrings() Get the list of flags that the directory authorities assigned to this relay.
java.time.ZonedDateTime	getLastRestarted() Get the time the relay was last (re-)started.
java.time.ZonedDateTime	getLastSeen() Get the time the relay was last seen in a network status consensus.
java.lang.String	getNickname() Get the relay's nickname.
java.util.List<java.lang.String>	getOrAddresses() Get a list of IPv4 or IPv6 addresses and TCP ports where the relay accepts onion-routing connections.
java.lang.String	getPlatform() Get platform and operating system information for the relay.
java.lang.String	humanString(java.lang.Boolean withAtlasUrl) Returns a human readable string with interesting information about the relay.
java.lang.Boolean	isRunning() Get whether or not the relay is currently running in the latest network status consensus.

Method Detail

getNickname

java.lang.String getNickname()

Get the relay's nickname.

Returns:

A relay nickname consisting of 1-19 alphanumerical characters.

getFingerprint

java.lang.String getFingerprint()

Get the relay's fingerprint. In the case of bridge relays, a SHA-1 hash of the fingerprint will be returned.

Returns:

A relay fingerprint or hashed fingerprint consisting of 40 upper-case hexadecimal characters.

getOrAddresses

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

Get a list of IPv4 or IPv6 addresses and TCP ports where the relay accepts onion-routing connections. The first address is the primary onion-routing address that the relay used to register in the network, subsequent addresses are in arbitrary order. IPv6 hex characters are all lower-case. In the case of bridge relays, IP addresses will be sanitized. Sanitized IP addresses are always in 10/8 or [fd9f:2e19:3bcf/48] IP networks and are only useful to learn which IP version the bridge uses and to detect whether the bridge changed its address. Sanitized IP addresses always change on the 1st of every month at 00:00:00 UTC, regardless of the bridge actually changing its IP address. TCP ports are not sanitized.

Returns:

A list of IPv4 or IPv6 addresses and TCP ports.

getLastSeen

java.time.ZonedDateTime getLastSeen()

Get the time the relay was last seen in a network status consensus.

Returns:

A UTC date and time.

getFirstSeen

java.time.ZonedDateTime getFirstSeen()

Get the time the relay was first seen in a network status consensus.

Returns:

A UTC date and time.

isRunning

java.lang.Boolean isRunning()

Get whether or not the relay is currently running in the latest network status consensus.

Returns:

True if the relay is running, otherwise false.

getFlagStrings

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

Get the list of flags that the directory authorities assigned to this relay.

Returns:

A list of flags.

getFlags

java.util.List<RelayFlag> getFlags()

Get the list of flags that the directory authorities assigned to this relay.

Returns:

A list of flags.

See Also:

getFlagStrings()

getLastRestarted

java.time.ZonedDateTime getLastRestarted()

Get the time the relay was last (re-)started.

Returns:

A UTC date and time.

getAdvertisedBandwidth

java.lang.Long getAdvertisedBandwidth()

Bandwidth that this relay is willing and capable to provide. This bandwidth value is the minimum of bandwidth_rate, bandwidth_burst, and observed_bandwidth.

Returns:

A bandwidth in bytes per second.

getPlatform

java.lang.String getPlatform()

Get platform and operating system information for the relay.

Returns:

Platform string containing operating system and Tor version details.

See Also:

RelayImpl.isRecommendedVersion()

generateBadge

java.awt.image.RenderedImage generateBadge()

humanString

java.lang.String humanString(java.lang.Boolean withAtlasUrl)

Returns a human readable string with interesting information about the relay. This is intended to be provided in response to a user request, for example in an IRC channel.

Parameters:

withAtlasUrl - true if an atlas.torproject.org URL should be included, otherwise false

Returns:

a human readable string