com.subgraph.orchid

Interface Descriptor

All Superinterfaces:

Document

All Known Subinterfaces:

RouterDescriptor, RouterMicrodescriptor

All Known Implementing Classes:

RouterDescriptorImpl, RouterMicrodescriptorImpl

public interface Descriptor
extends Document

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Descriptor.CacheLocation

Method Summary

Modifier and Type	Method and Description
boolean	exitPolicyAccepts(int port) Return true if the exit policy of this router accepts most connections to the specified destination port.
boolean	exitPolicyAccepts(IPv4Address address, int port) Return true if the exit policy of this router permits connections to the specified destination endpoint.
IPv4Address	getAddress() Return the IPv4 address of this router.
int	getBodyLength()
Descriptor.CacheLocation	getCacheLocation()
HexDigest	getDescriptorDigest()
Set<String>	getFamilyMembers()
long	getLastListed()
byte[]	getNTorOnionKey()
TorPublicKey	getOnionKey() Return the public key used to encrypt EXTEND cells while establishing a circuit through this router.
int	getRouterPort() Return the port on which this node accepts TLS connections for the main OR protocol, or 0 if no router service is advertised.
void	setCacheLocation(Descriptor.CacheLocation location)
void	setLastListed(long timestamp)

Methods inherited from interface com.subgraph.orchid.Document

getRawDocumentBytes, getRawDocumentData, isValidDocument

Method Detail

getDescriptorDigest

HexDigest getDescriptorDigest()

setLastListed

void setLastListed(long timestamp)

getLastListed

long getLastListed()

setCacheLocation

void setCacheLocation(Descriptor.CacheLocation location)

getCacheLocation

Descriptor.CacheLocation getCacheLocation()

getBodyLength

int getBodyLength()

getOnionKey

TorPublicKey getOnionKey()

Return the public key used to encrypt EXTEND cells while establishing a circuit through this router.

Returns:

The onion routing protocol key for this router.

getNTorOnionKey

byte[] getNTorOnionKey()

getAddress

IPv4Address getAddress()

Return the IPv4 address of this router.

Returns:

The IPv4 address of this router.

getRouterPort

int getRouterPort()

Return the port on which this node accepts TLS connections for the main OR protocol, or 0 if no router service is advertised.

Returns:

The onion routing port, or 0 if not a router.

getFamilyMembers

Set<String> getFamilyMembers()

exitPolicyAccepts

boolean exitPolicyAccepts(IPv4Address address,
                          int port)

Return true if the exit policy of this router permits connections to the specified destination endpoint.

Parameters:

address - The IPv4 address of the destination.

port - The destination port.

Returns:

True if an exit connection to the specified destination is allowed or false otherwise.

exitPolicyAccepts

boolean exitPolicyAccepts(int port)

Return true if the exit policy of this router accepts most connections to the specified destination port.

Parameters:

port - The destination port.

Returns:

True if an exit connection to the specified destination port is generally allowed or false otherwise.