Method Details

• getReceivedBy

  public Hash getReceivedBy()

  The Hash of the local client that received this LS, null if the router or unknown.

  Returns:

  the hash of the receiving client, or null

• setReceivedBy

  public void setReceivedBy(Hash receivedBy)

  Local client that received this entry.

  Parameters:

  receivedBy - the hash of the receiving client

• getDate

  public abstract long getDate()

  A common interface to the timestamp of the two subclasses. Identical to getEarliestLeaseDate() in LeaseSet, and getPublished() in RouterInfo. Note that for a LeaseSet this will be in the future, and for a RouterInfo it will be in the past. Either way, it's a timestamp.

  Returns:

  the date this entry takes effect, in milliseconds since the epoch: the expiration of the earliest lease for a LeaseSet, the publication time for a RouterInfo

• getKeysAndCert

  public abstract KeysAndCert getKeysAndCert()

  Keys and certificate for this entry. Identical to getDestination() in LeaseSet, and getIdentity() in RouterInfo.

  Returns:

  KAC or null

• getHash

  public Hash getHash()

  A common interface to the Hash of the two subclasses. Identical to getDestination().calculateHash() in LeaseSet, and getIdentity().getHash() in RouterInfo.

  Returns:

  Hash or null

• getType

  public abstract int getType()

  Type of the data structure. This should be faster than instanceof.

  Returns:

  KEY_TYPE_ROUTERINFO or KEY_TYPE_LEASESET or LS2 types

• isLeaseSet

  public boolean isLeaseSet()

  Convenience method, is the type any variant of leaseset?

  Returns:

  true for any type of LeaseSet, false for RouterInfo, false for others

• isLeaseSet

  public static boolean isLeaseSet(int type)

  Convenience method, is the type any variant of leaseset?

  Parameters:

  type - one of the DatabaseEntry key type constants

  Returns:

  true for any type of LeaseSet, false for RouterInfo, false for others

• isRouterInfo

  public boolean isRouterInfo()

  Convenience method, is the type any variant of router info?

  Returns:

  true for any type of RouterInfo, false for LeaseSet, false for others

• getBytes

  protected abstract byte[] getBytes() throws DataFormatException

  Returns the raw payload data, excluding the signature, to be signed by sign(SigningPrivateKey).

  Most callers should use writeBytes() or toByteArray() instead.

  Returns:

  the raw payload data, or null on error (for example, if this is a RouterInfo, a DataFormatException is thrown instead)

  Throws:

  DataFormatException - if the data cannot be serialized

• getRoutingKey

  public Hash getRoutingKey()

  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).

  Returns:

  the routing key

  Throws:

  IllegalStateException - if not in RouterContext

• validateRoutingKey

  public boolean validateRoutingKey()

  Validates the routing key for this entry.

  Returns:

  true if the routing key is valid

  Throws:

  IllegalStateException - if not in RouterContext

• getSignature

  public Signature getSignature()

  Retrieve the proof that the identity stands behind the info here.

  Returns:

  the signature, or null if not signed

• setSignature

  public void setSignature(Signature signature)

  Configure the proof that the entity stands behind the info here.

  Parameters:

  signature - the signature to set

  Throws:

  IllegalStateException - if already signed

• sign

  public void sign(SigningPrivateKey key) throws DataFormatException

  Sign the structure using the supplied signing key.

  Parameters:

  key - the signing private key

  Throws:

  IllegalStateException - if already signed

  DataFormatException - if signing fails

• getSigningPublicKey

  protected SigningPublicKey getSigningPublicKey()

  Identical to getDestination().getSigningPublicKey() in LeaseSet, and getIdentity().getSigningPublicKey() in RouterInfo.

  Returns:

  SPK or null

• verifySignature

  public boolean verifySignature()

  This is the same as isValid() in RouterInfo or verifySignature() in LeaseSet.

  Returns:

  true if the entry carries a signature that verifies over its own data

• getReceivedAsPublished

  public boolean getReceivedAsPublished()

  If true, we received this LeaseSet by a remote peer publishing it to us, rather than by searching for it ourselves or locally creating it. Default false.

  Returns:

  true if received as published

• setReceivedAsPublished

  public void setReceivedAsPublished()

  Marks this entry as received via published mode. Use this carefully, when updating the flag make sure the old and new leaseSet are actually equivalent, or simply copy the reply value, as copyStoreMetadata() in KademliaNetworkDatabaseFacade does.

• getReceivedAsReply

  public boolean getReceivedAsReply()

  If true, we received this LeaseSet by searching for it Default false.

  Returns:

  true if received as reply

• setReceivedAsReply

  public void setReceivedAsReply()

  Marks this entry as received via reply.