## net.i2p.data
Class RouterInfo

    java.lang.Object
      net.i2p.data.DataStructureImpl
          net.i2p.data.RouterInfo

All Implemented Interfaces:
  DataStructure

    public class RouterInfo

extends DataStructureImpl

Defines the data that a router either publishes to the global routing table or provides to trusted peers.

Author:
  jrandom

Field Summary
`static String` `BW_CAPABILITY_CHARS`
`static char` `CAPABILITY_HIDDEN`
`static String` `PROP_CAPABILITIES`
`static String` `PROP_NETWORK_ID`

Constructor Summary
`RouterInfo()`
`RouterInfo(RouterInfo old)`

Method Summary
`void` `addCapability(char cap)`
`void` `delCapability(char cap)`
`boolean` `equals(Object object)`
`Set<RouterAddress>` `getAddresses()` Retrieve the set of RouterAddress structures at which this router can be contacted.
`String` `getBandwidthTier()` Return a string representation of this node's bandwidth tier, or "Unknown"
`String` `getCapabilities()` what special capabilities this router offers
`RouterIdentity` `getIdentity()` Retrieve the identity of the router represented
`int` `getNetworkId()` which network is this routerInfo a part of.
`String` `getOption(String opt)`
`Properties` `getOptions()` Retrieve a set of options or statistics that the router can expose
`Set<Hash>` `getPeers()` Deprecated. Implemented here but unused elsewhere
`long` `getPublished()` Retrieve the approximate date on which the info was published (essentially a version number for the routerInfo structure, except that it also contains freshness information - whether or not the router is currently publishing its information).
`Hash` `getRoutingKey()` Get the routing key for the structure using the current modifier in the RoutingKeyGenerator.
`Signature` `getSignature()` Retrieve the proof that the identity stands behind the info here
`RouterAddress` `getTargetAddress(String transportStyle)` Pull the first workable target address for the given transport
`List<RouterAddress>` `getTargetAddresses(String transportStyle)`
`int` `hashCode()`
`boolean` `isCurrent(long maxAgeMs)` Determine whether the router was published recently (within the given age milliseconds).
`boolean` `isHidden()` Is this a hidden node?
`boolean` `isValid()` Determine whether this router info is authorized with a valid signature
`static void` `main(String[] args)` Print out routerinfos from files specified on the command line
`void` `readBytes(InputStream in)` Load up the current object with data from the given stream.
`void` `setAddresses(Set<RouterAddress> addresses)` Specify a set of RouterAddress structures at which this router can be contacted.
`void` `setIdentity(RouterIdentity ident)` Configure the identity of the router represented
`void` `setOptions(Properties options)` Configure a set of options or statistics that the router can expose
`void` `setPeers(Set<Hash> peers)` Deprecated. Implemented here but unused elsewhere
`void` `setPublished(long published)` Date on which it was published, in milliseconds since Midnight GMT on Jan 01, 1970
`void` `setRoutingKey(Hash key)`
`void` `setSignature(Signature signature)` Configure the proof that the entity stands behind the info here
`void` `sign(SigningPrivateKey key)` Sign the structure using the supplied signing key
`String` `toString()`
`boolean` `validateRoutingKey()`
`void` `writeBytes(OutputStream out)` Write out the data structure to the stream, using the format defined in the I2P data structure specification.

Methods inherited from class net.i2p.data.DataStructureImpl
`calculateHash, fromBase64, fromByteArray, read, toBase64, toByteArray`

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

Field Detail

### PROP_NETWORK_ID

    public static final String PROP_NETWORK_ID

See Also:
  Constant Field Values

### PROP_CAPABILITIES

    public static final String PROP_CAPABILITIES

See Also:
  Constant Field Values

### CAPABILITY_HIDDEN

    public static final char CAPABILITY_HIDDEN

See Also:
  Constant Field Values

### BW_CAPABILITY_CHARS

    public static final String BW_CAPABILITY_CHARS

See Also:
  Constant Field Values

Constructor Detail

### RouterInfo

    public RouterInfo()

### RouterInfo

    public RouterInfo(RouterInfo old)

Method Detail

### getIdentity

    public RouterIdentity getIdentity()

  Retrieve the identity of the router represented

### setIdentity

    public void setIdentity(RouterIdentity ident)

  Configure the identity of the router represented

### getPublished

    public long getPublished()

  Retrieve the approximate date on which the info was published (essentially a version number for the routerInfo structure, except that it also contains freshness information - whether or not the router is currently publishing its information). This should be used to help expire old routerInfo structures

### setPublished

    public void setPublished(long published)

  Date on which it was published, in milliseconds since Midnight GMT on Jan 01, 1970

### getAddresses

    public Set<RouterAddress> getAddresses()

  Retrieve the set of RouterAddress structures at which this router can be contacted.

### setAddresses

    public void setAddresses(Set<RouterAddress> addresses)

  Specify a set of RouterAddress structures at which this router can be contacted.

### getPeers

    public Set<Hash> getPeers()

  Deprecated. Implemented here but unused elsewhere

  Retrieve a set of SHA-256 hashes of RouterIdentities from routers this router can be reached through.

### setPeers

    public void setPeers(Set<Hash> peers)

  Deprecated. Implemented here but unused elsewhere

  Specify a set of SHA-256 hashes of RouterIdentities from routers this router can be reached through.

### getOptions

    public Properties getOptions()

  Retrieve a set of options or statistics that the router can expose

### getOption

    public String getOption(String opt)

### setOptions

    public void setOptions(Properties options)

  Configure a set of options or statistics that the router can expose

### getSignature

    public Signature getSignature()

  Retrieve the proof that the identity stands behind the info here

### setSignature

    public void setSignature(Signature signature)

  Configure the proof that the entity stands behind the info here

### sign

    public void sign(SigningPrivateKey key)
              throws DataFormatException

  Sign the structure using the supplied signing key

  Throws:
    `DataFormatException`

### isValid

    public boolean isValid()

  Determine whether this router info is authorized with a valid signature

### getNetworkId

    public int getNetworkId()

  which network is this routerInfo a part of. configured through the property PROP_NETWORK_ID

### getCapabilities

    public String getCapabilities()

  what special capabilities this router offers

### isHidden

    public boolean isHidden()

  Is this a hidden node?

### getBandwidthTier

    public String getBandwidthTier()

  Return a string representation of this node's bandwidth tier, or "Unknown"

### addCapability

    public void addCapability(char cap)

### delCapability

    public void delCapability(char cap)

### getRoutingKey

    public Hash getRoutingKey()

  Get the routing key for the structure using the current modifier in the RoutingKeyGenerator. This only calculates a new one when necessary though (if the generator's key modifier changes)

### setRoutingKey

    public void setRoutingKey(Hash key)

### validateRoutingKey

    public boolean validateRoutingKey()

### isCurrent

    public boolean isCurrent(long maxAgeMs)

  Determine whether the router was published recently (within the given age milliseconds). The age should be large enough to take into consideration any clock fudge factor, so values such as 1 or 2 hours are probably reasonable.

  Parameters:
    `maxAgeMs` - milliseconds between the current time and publish date to check
  Returns:
    true if it was published recently, false otherwise

### getTargetAddress

    public RouterAddress getTargetAddress(String transportStyle)

  Pull the first workable target address for the given transport

### getTargetAddresses

    public List<RouterAddress> getTargetAddresses(String transportStyle)

### readBytes

    public void readBytes(InputStream in)
                   throws DataFormatException,
                          IOException

  Description copied from interface: `DataStructure`
  Load up the current object with data from the given stream. Data loaded this way must match the I2P data structure specification.

  Parameters:
    `in` - stream to read from
  Throws:
    `DataFormatException` - if the data is improperly formatted
    `IOException` - if there was a problem reading the stream

### writeBytes

    public void writeBytes(OutputStream out)
                    throws DataFormatException,
                           IOException

  Description copied from interface: `DataStructure`
  Write out the data structure to the stream, using the format defined in the I2P data structure specification.

  Parameters:
    `out` - stream to write to
  Throws:
    `DataFormatException` - if the data was incomplete or not yet ready to be written
    `IOException` - if there was a problem writing to the stream

### equals

    public boolean equals(Object object)

  Overrides:
    `equals` in class `Object`

### hashCode

    public int hashCode()

  Overrides:
    `hashCode` in class `Object`

### toString

    public String toString()

  Overrides:
    `toString` in class `Object`

### main

    public static void main(String[] args)

  Print out routerinfos from files specified on the command line

  Since:
    0.8