RouterDescriptorImpl (Orchid 1.1.1 API)

java.lang.Object
- com.subgraph.orchid.directory.router.RouterDescriptorImpl

All Implemented Interfaces:: Descriptor, Document, RouterDescriptor

public class RouterDescriptorImpl
extends Object
implements RouterDescriptor

Nested Class Summary
- Nested classes/interfaces inherited from interface com.subgraph.orchid.Descriptor
  Descriptor.CacheLocation

Constructor Summary

Constructors
Constructor and Description

RouterDescriptorImpl()

Constructors
Constructor and Description
`RouterDescriptorImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`boolean`	`equals(Object o)`
`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`	`getAverageBandwidth()` Returns the volume of traffic in bytes per second that this router is willing to sustain over long periods.
`int`	`getBodyLength()`
`int`	`getBurstBandwidth()` Returns the volume of traffic in bytes per second that this router is willing to sustain in very short intervals.
`Descriptor.CacheLocation`	`getCacheLocation()`
`String`	`getContact()` Return a string which describes how to contact the server's administrator.
`HexDigest`	`getDescriptorDigest()`
`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.
`Set<String>`	`getFamilyMembers()`
`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.
`long`	`getLastListed()`
`String`	`getNickname()` Returns the nickname of this router.
`byte[]`	`getNTorOnionKey()`
`int`	`getObservedBandwidth()` Returns the volume of traffic in bytes per second that this router is estimated to be able to sustain.
`TorPublicKey`	`getOnionKey()` Return the public key used to encrypt EXTEND cells while establishing a circuit through this router.
`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.
`ByteBuffer`	`getRawDocumentBytes()`
`String`	`getRawDocumentData()`
`BandwidthHistory`	`getReadHistory()`
`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.
`int`	`getUptime()` Return the number of seconds this router has been running.
`BandwidthHistory`	`getWriteHistory()`
`int`	`hashCode()`
`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`	`isValidDocument()`
`void`	`print()`
`void`	`setAddress(IPv4Address address)`
`void`	`setCacheLocation(Descriptor.CacheLocation location)`
`void`	`setLastListed(long timestamp)`
`void`	`setNickname(String nickname)`
`void`	`setOnionKey(TorPublicKey key)`
`void`	`setRouterPort(int port)`
`boolean`	`supportsEventDNS()` Return true if this router is running a version of Tor which supports the newer enhanced DNS logic.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RouterDescriptorImpl
```
public RouterDescriptorImpl()
```
- Method Detail
  - setNickname
```
public void setNickname(String nickname)
```
  - setAddress
```
public void setAddress(IPv4Address address)
```
  - setRouterPort
```
public void setRouterPort(int port)
```
  - setOnionKey
```
public void setOnionKey(TorPublicKey key)
```
  - isValidDocument
```
public boolean isValidDocument()
```
    Specified by:
    
    isValidDocument in interface Document
  - getNickname
```
public String getNickname()
```
    Description copied from interface: RouterDescriptor
    
    Returns the nickname of this router.
    
    Specified by:
    
    getNickname in interface RouterDescriptor
    
    Returns:
    
    The nickname of this router.
  - getAddress
```
public IPv4Address getAddress()
```
    Description copied from interface: Descriptor
    
    Return the IPv4 address of this router.
    
    Specified by:
    
    getAddress in interface Descriptor
    
    Returns:
    
    The IPv4 address of this router.
  - getRouterPort
```
public int getRouterPort()
```
    Description copied from interface: Descriptor
    
    Return the port on which this node accepts TLS connections for the main OR protocol, or 0 if no router service is advertised.
    
    Specified by:
    
    getRouterPort in interface Descriptor
    
    Returns:
    
    The onion routing port, or 0 if not a router.
  - getDirectoryPort
```
public int getDirectoryPort()
```
    Description copied from interface: RouterDescriptor
    
    Return the port on which this router provides directory related HTTP connections, or 0 if this node does not provide directory services.
    
    Specified by:
    
    getDirectoryPort in interface RouterDescriptor
    
    Returns:
    
    The directory service port, or 0 if not a directory server.
  - getAverageBandwidth
```
public int getAverageBandwidth()
```
    Description copied from interface: RouterDescriptor
    
    Returns the volume of traffic in bytes per second that this router is willing to sustain over long periods.
    
    Specified by:
    
    getAverageBandwidth in interface RouterDescriptor
    
    Returns:
    
    The average bandwidth of this router in bytes per second.
  - getBurstBandwidth
```
public int getBurstBandwidth()
```
    Description copied from interface: RouterDescriptor
    
    Returns the volume of traffic in bytes per second that this router is willing to sustain in very short intervals.
    
    Specified by:
    
    getBurstBandwidth in interface RouterDescriptor
    
    Returns:
    
    The burst bandwidth of this router in bytes per second.
  - getObservedBandwidth
```
public int getObservedBandwidth()
```
    Description copied from interface: RouterDescriptor
    
    Returns the volume of traffic in bytes per second that this router is estimated to be able to sustain.
    
    Specified by:
    
    getObservedBandwidth in interface RouterDescriptor
    
    Returns:
    
    The observed bandwidth capacity of this router in bytes per second.
  - getPlatform
```
public String getPlatform()
```
    Description copied from interface: RouterDescriptor
    
    Return a human-readable string describing the system on which this router is running, including possibly the operating system version and Tor implementation version.
    
    Specified by:
    
    getPlatform in interface RouterDescriptor
    
    Returns:
    
    A string describing the platform this router is running on.
  - getFingerprint
```
public HexDigest getFingerprint()
```
    Description copied from interface: RouterDescriptor
    
    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.
    
    Specified by:
    
    getFingerprint in interface RouterDescriptor
    
    Returns:
    
    The fingerprint of this router, or null if no fingerprint is available.
  - getUptime
```
public int getUptime()
```
    Description copied from interface: RouterDescriptor
    
    Return the number of seconds this router has been running.
    
    Specified by:
    
    getUptime in interface RouterDescriptor
    
    Returns:
    
    The number of seconds this router has been running.
  - getOnionKey
```
public TorPublicKey getOnionKey()
```
    Description copied from interface: Descriptor
    
    Return the public key used to encrypt EXTEND cells while establishing a circuit through this router.
    
    Specified by:
    
    getOnionKey in interface Descriptor
    
    Returns:
    
    The onion routing protocol key for this router.
  - getNTorOnionKey
```
public byte[] getNTorOnionKey()
```
    Specified by:
    
    getNTorOnionKey in interface Descriptor
  - getIdentityKey
```
public TorPublicKey getIdentityKey()
```
    Description copied from interface: RouterDescriptor
    
    Return the long-term identity and signing public key for this router.
    
    Specified by:
    
    getIdentityKey in interface RouterDescriptor
    
    Returns:
    
    The long-term identity and signing public key for this router.
  - getContact
```
public String getContact()
```
    Description copied from interface: RouterDescriptor
    
    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.
    
    Specified by:
    
    getContact in interface RouterDescriptor
    
    Returns:
    
    The contact information for this router, or null if not available.
  - isHibernating
```
public boolean isHibernating()
```
    Description copied from interface: RouterDescriptor
    
    Return true if this router is currently hibernating and not suitable for building new circuits.
    
    Specified by:
    
    isHibernating in interface RouterDescriptor
    
    Returns:
    
    True if this router is currently hibernating.
  - cachesExtraInfo
```
public boolean cachesExtraInfo()
```
    Description copied from interface: RouterDescriptor
    
    Returns true if this router is a directory cache that provides extra-info documents.
    
    Specified by:
    
    cachesExtraInfo in interface RouterDescriptor
    
    Returns:
    
    True if this router provides an extra-info document directory service.
  - allowsSingleHopExits
```
public boolean allowsSingleHopExits()
```
    Description copied from interface: RouterDescriptor
    
    Return true if this router allows single-hop circuits to make exit connections.
    
    Specified by:
    
    allowsSingleHopExits in interface RouterDescriptor
    
    Returns:
    
    True if this router allows single-hop circuits to make exit connections.
  - getPublishedTime
```
public Timestamp getPublishedTime()
```
    Description copied from interface: RouterDescriptor
    
    Return the time this descriptor was generated.
    
    Specified by:
    
    getPublishedTime in interface RouterDescriptor
    
    Returns:
    
    The time this descriptor was generated.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - print
```
public void print()
```
  - exitPolicyAccepts
```
public boolean exitPolicyAccepts(IPv4Address address,
                                 int port)
```
    Description copied from interface: Descriptor
    
    Return true if the exit policy of this router permits connections to the specified destination endpoint.
    
    Specified by:
    
    exitPolicyAccepts in interface Descriptor
    
    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
```
public boolean exitPolicyAccepts(int port)
```
    Description copied from interface: Descriptor
    
    Return true if the exit policy of this router accepts most connections to the specified destination port.
    
    Specified by:
    
    exitPolicyAccepts in interface Descriptor
    
    Parameters:
    
    port - The destination port.
    
    Returns:
    
    True if an exit connection to the specified destination port is generally allowed or false otherwise.
  - getExtraInfoDigest
```
public HexDigest getExtraInfoDigest()
```
    Description copied from interface: RouterDescriptor
    
    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.
    
    Specified by:
    
    getExtraInfoDigest in interface RouterDescriptor
    
    Returns:
    
    The digest of the router extra-info-document, or null if not available.
  - isHiddenServiceDirectory
```
public boolean isHiddenServiceDirectory()
```
    Description copied from interface: RouterDescriptor
    
    Returns true if this router stores and serves hidden service descriptors.
    
    Specified by:
    
    isHiddenServiceDirectory in interface RouterDescriptor
    
    Returns:
    
    True if this router is a hidden service directory.
  - getFamilyMembers
```
public Set<String> getFamilyMembers()
```
    Specified by:
    
    getFamilyMembers in interface Descriptor
  - supportsEventDNS
```
public boolean supportsEventDNS()
```
    Description copied from interface: RouterDescriptor
    
    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.
    
    Specified by:
    
    supportsEventDNS in interface RouterDescriptor
    
    Returns:
    
    True if this router supports newer enhanced DNS logic.
  - getReadHistory
```
public BandwidthHistory getReadHistory()
```
  - getWriteHistory
```
public BandwidthHistory getWriteHistory()
```
  - isNewerThan
```
public boolean isNewerThan(RouterDescriptor other)
```
    Description copied from interface: RouterDescriptor
    
    Compare two router descriptors and return true if this router descriptor was published at a later time than the other descriptor.
    
    Specified by:
    
    isNewerThan in interface RouterDescriptor
    
    Parameters:
    
    other - Another router descriptor to compare.
    
    Returns:
    
    True if this descriptor was published later than other
  - getDescriptorDigest
```
public HexDigest getDescriptorDigest()
```
    Specified by:
    
    getDescriptorDigest in interface Descriptor
  - getRawDocumentData
```
public String getRawDocumentData()
```
    Specified by:
    
    getRawDocumentData in interface Document
  - getRawDocumentBytes
```
public ByteBuffer getRawDocumentBytes()
```
    Specified by:
    
    getRawDocumentBytes in interface Document
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getExitPolicy
```
public ExitPolicy getExitPolicy()
```
    Specified by:
    
    getExitPolicy in interface RouterDescriptor
  - setLastListed
```
public void setLastListed(long timestamp)
```
    Specified by:
    
    setLastListed in interface Descriptor
  - getLastListed
```
public long getLastListed()
```
    Specified by:
    
    getLastListed in interface Descriptor
  - setCacheLocation
```
public void setCacheLocation(Descriptor.CacheLocation location)
```
    Specified by:
    
    setCacheLocation in interface Descriptor
  - getCacheLocation
```
public Descriptor.CacheLocation getCacheLocation()
```
    Specified by:
    
    getCacheLocation in interface Descriptor
  - getBodyLength
```
public int getBodyLength()
```
    Specified by:
    
    getBodyLength in interface Descriptor

Class RouterDescriptorImpl

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RouterDescriptorImpl

Method Detail

setNickname

setAddress

setRouterPort

setOnionKey

isValidDocument

getNickname

getAddress

getRouterPort

getDirectoryPort

getAverageBandwidth

getBurstBandwidth

getObservedBandwidth

getPlatform

getFingerprint

getUptime

getOnionKey

getNTorOnionKey

getIdentityKey

getContact

isHibernating

cachesExtraInfo

allowsSingleHopExits

getPublishedTime

toString

print

exitPolicyAccepts

exitPolicyAccepts

getExtraInfoDigest

isHiddenServiceDirectory

getFamilyMembers

supportsEventDNS

getReadHistory

getWriteHistory

isNewerThan

getDescriptorDigest

getRawDocumentData

getRawDocumentBytes

equals

hashCode

getExitPolicy

setLastListed

getLastListed

setCacheLocation

getCacheLocation

getBodyLength