com.subgraph.orchid

Interface RouterDescriptor

All Superinterfaces:

Descriptor, Document

All Known Implementing Classes:

RouterDescriptorImpl

public interface RouterDescriptor
extends Descriptor

Directory information about a single onion router. This interface provides access to the fields of a router descriptor document which has been published through to Tor directory system.

Nested Class Summary

Nested classes/interfaces inherited from interface com.subgraph.orchid.Descriptor

Descriptor.CacheLocation

Method Summary

Modifier and Type	Method and Description
boolean	allowsSingleHopExits() Return true if this router allows single-hop circuits to make exit connections.
boolean	cachesExtraInfo() Returns true if this router is a directory cache that provides extra-info documents.
int	getAverageBandwidth() Returns the volume of traffic in bytes per second that this router is willing to sustain over long periods.
int	getBurstBandwidth() Returns the volume of traffic in bytes per second that this router is willing to sustain in very short intervals.
String	getContact() Return a string which describes how to contact the server's administrator.
int	getDirectoryPort() Return the port on which this router provides directory related HTTP connections, or 0 if this node does not provide directory services.
ExitPolicy	getExitPolicy()
HexDigest	getExtraInfoDigest() Return a digest of this router's extra-info document, or null if not available.
HexDigest	getFingerprint() Return a fingerprint of the public key of this router.
TorPublicKey	getIdentityKey() Return the long-term identity and signing public key for this router.
String	getNickname() Returns the nickname of this router.
int	getObservedBandwidth() Returns the volume of traffic in bytes per second that this router is estimated to be able to sustain.
String	getPlatform() Return a human-readable string describing the system on which this router is running, including possibly the operating system version and Tor implementation version.
Timestamp	getPublishedTime() Return the time this descriptor was generated.
int	getUptime() Return the number of seconds this router has been running.
boolean	isHibernating() Return true if this router is currently hibernating and not suitable for building new circuits.
boolean	isHiddenServiceDirectory() Returns true if this router stores and serves hidden service descriptors.
boolean	isNewerThan(RouterDescriptor other) Compare two router descriptors and return true if this router descriptor was published at a later time than the other descriptor.
boolean	supportsEventDNS() Return true if this router is running a version of Tor which supports the newer enhanced DNS logic.

Methods inherited from interface com.subgraph.orchid.Descriptor

exitPolicyAccepts, exitPolicyAccepts, getAddress, getBodyLength, getCacheLocation, getDescriptorDigest, getFamilyMembers, getLastListed, getNTorOnionKey, getOnionKey, getRouterPort, setCacheLocation, setLastListed

Methods inherited from interface com.subgraph.orchid.Document

getRawDocumentBytes, getRawDocumentData, isValidDocument

Method Detail

getNickname

String getNickname()

Returns the nickname of this router.

Returns:

The nickname of this router.

getDirectoryPort

int getDirectoryPort()

Return the port on which this router provides directory related HTTP connections, or 0 if this node does not provide directory services.

Returns:

The directory service port, or 0 if not a directory server.

getAverageBandwidth

int getAverageBandwidth()

Returns the volume of traffic in bytes per second that this router is willing to sustain over long periods.

Returns:

The average bandwidth of this router in bytes per second.

getBurstBandwidth

int getBurstBandwidth()

Returns the volume of traffic in bytes per second that this router is willing to sustain in very short intervals.

Returns:

The burst bandwidth of this router in bytes per second.

getObservedBandwidth

int getObservedBandwidth()

Returns the volume of traffic in bytes per second that this router is estimated to be able to sustain.

Returns:

The observed bandwidth capacity of this router in bytes per second.

getPlatform

String getPlatform()

Return a human-readable string describing the system on which this router is running, including possibly the operating system version and Tor implementation version.

Returns:

A string describing the platform this router is running on.

getPublishedTime

Timestamp getPublishedTime()

Return the time this descriptor was generated.

Returns:

The time this descriptor was generated.

getFingerprint

HexDigest getFingerprint()

Return a fingerprint of the public key of this router. The fingerprint is an optional field, so this method may return null if the descriptor of the router did not include the 'fingerprint' field.

Returns:

The fingerprint of this router, or null if no fingerprint is available.

getUptime

int getUptime()

Return the number of seconds this router has been running.

Returns:

The number of seconds this router has been running.

getIdentityKey

TorPublicKey getIdentityKey()

Return the long-term identity and signing public key for this router.

Returns:

The long-term identity and signing public key for this router.

getContact

String getContact()

Return a string which describes how to contact the server's administrator. This is an optional field, so this method will return null if the descriptor of this router did not include the 'contact' field.

Returns:

The contact information for this router, or null if not available.

isHibernating

boolean isHibernating()

Return true if this router is currently hibernating and not suitable for building new circuits.

Returns:

True if this router is currently hibernating.

isHiddenServiceDirectory

boolean isHiddenServiceDirectory()

Returns true if this router stores and serves hidden service descriptors.

Returns:

True if this router is a hidden service directory.

supportsEventDNS

boolean supportsEventDNS()

Return true if this router is running a version of Tor which supports the newer enhanced DNS logic. If false, this router should be used for reverse hostname lookups.

Returns:

True if this router supports newer enhanced DNS logic.

cachesExtraInfo

boolean cachesExtraInfo()

Returns true if this router is a directory cache that provides extra-info documents.

Returns:

True if this router provides an extra-info document directory service.

getExtraInfoDigest

HexDigest getExtraInfoDigest()

Return a digest of this router's extra-info document, or null if not available. This is an optional field and will only be present if the 'extra-info-digest' field was present in the original router descriptor.

Returns:

The digest of the router extra-info-document, or null if not available.

allowsSingleHopExits

boolean allowsSingleHopExits()

Return true if this router allows single-hop circuits to make exit connections.

Returns:

True if this router allows single-hop circuits to make exit connections.

isNewerThan

boolean isNewerThan(RouterDescriptor other)

Compare two router descriptors and return true if this router descriptor was published at a later time than the other descriptor.

Parameters:

other - Another router descriptor to compare.

Returns:

True if this descriptor was published later than other

getExitPolicy

ExitPolicy getExitPolicy()