KademliaNetworkDatabaseFacade (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.NetworkDatabaseFacade
- - net.i2p.router.networkdb.kademlia.KademliaNetworkDatabaseFacade

All Implemented Interfaces:
Service
Direct Known Subclasses:
FloodfillNetworkDatabaseFacade
```
public abstract class KademliaNetworkDatabaseFacade
extends NetworkDatabaseFacade
```
Kademlia based version of network database.
Provides core network database functionality using Kademlia DHT for peer discovery, routing table management, and data storage/lookup operations. Never instantiated directly; see FloodfillNetworkDatabaseFacade.

Field Summary

Fields
Modifier and Type	Field and Description
`protected RouterContext`	`_context` _context.
`protected Log`	`_log` Class logger.
`protected int`	`_networkID` Network identifier.
`protected PeerSelector`	`_peerSelector` _peerSelector.
`static String`	`CURRENT_VERSION` Current minor version identifier for net DB format.
`static String`	`DEFAULT_DB_DIR` Default database directory name.
`static long`	`DONT_FAIL_PERIOD` For 15 minutes after startup, don't fail db entries so that if we were offline for a while, we'll have a chance of finding some live peers with the previous references
`(package private) static int`	`MAX_EXPLORE_QUEUE` Maximum number of peers to place in the queue to explore
`protected static int`	`MIN_REMAINING_ROUTERS` If we have less than this many routers left, don't drop any more, even if they're failing or doing bad stuff.
`(package private) static int`	`MIN_RESEED` Reseed if below this.
`static String`	`MIN_ROUTER_VERSION`
`static String`	`MIN_VERSION`
`static String`	`PROP_BLOCK_MY_COUNTRY` Config property for blocking own-country peers.
`(package private) static String`	`PROP_BUCKET_SIZE` P r o p b u c k e t s i z e
`static String`	`PROP_DB_DIR` Config property for database directory.
`(package private) static String`	`PROP_EXPLORE_QUEUE` P r o p e x p l o r e q u e u e
`static String`	`PROP_IP_COUNTRY` Config property for IP country override.
`(package private) static String`	`PROP_KAD_B` P r o p k a d b
`(package private) static String`	`PROP_MIN_ROUTER_VERSION` P r o p m i n r o u t e r v e r s i o n
`(package private) static String`	`PROP_ROUTER_INFO_EXPIRATION_ADJUSTED` P r o p r o u t e r i n f o e x p i r a t i o n a d j u s t e d
`(package private) static String`	`PROP_VALIDATE_ROUTERS_AFTER` P r o p v a l i d a t e r o u t e r s a f t e r
`protected static long`	`PUBLISH_JOB_DELAY` This needs to be long enough to give us time to start up, but less than 20m (when we start accepting tunnels and could be a IBGW) Actually no, we need this soon if we are a new router or other routers have forgotten about us, else we can't build IB exploratory tunnels.

Constructor Summary
Constructors
Constructor and Description
KademliaNetworkDatabaseFacade(RouterContext context, Hash dbid)
Initializes the Kademlia-based network database facade.

Constructors
Constructor and Description
`KademliaNetworkDatabaseFacade(RouterContext context, Hash dbid)` Initializes the Kademlia-based network database facade.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accessLeaseSet(Hash key)` Record access to a LeaseSet for refresh tracking.
`protected BlindCache`	`blindCache()` Returns the blind data cache used by this database.
`void`	`cleanupLURouters()` Clean up existing LU routers loaded before the ban was added.
`protected void`	`createHandlers()` Unused, see override
`protected PeerSelector`	`createPeerSelector()` Creates a peer selector for the network database.
`(package private) boolean`	`dropAfterLookupFailed(Hash peer)` Final remove for a router info.
`void`	`fail(Hash dbEntry)` Final remove for a leaseset.
`(package private) void`	`failPermanently(Destination dest)` Negative cache until restart
`Set<Hash>`	`findNearestRouters(Hash key, int maxNumRouters, Set<Hash> peersToIgnore)` Get the routers closest to that key in response to a remote lookup Only used by ../HDLMJ Set MAY INCLUDE our own router - add to peersToIgnore if you don't want
`Set<Hash>`	`getAllRouters()` Get the hashes for all known routers
`List<BlindData>`	`getBlindData()` For console ConfigKeyringHelper
`BlindData`	`getBlindData(SigningPublicKey spk)`
`Set<LeaseSet>`	`getClientLeases()` Public for NetDbRenderer in routerconsole
`(package private) DataStore`	`getDataStore()`
`(package private) String`	`getDbDir()` For the main DB only.
`Set<Hash>`	`getExploreKeys()` Gets the set of keys to explore.
`Set<LeaseSet>`	`getFloodfillLeases()`
`(package private) KBucketSet<Hash>`	`getKBuckets()` Get the KBucketSet for the main DB.
`protected int`	`getKBucketSetSize()` Get the size of the KBucketSet.
`int`	`getKnownLeaseSets()` This is only used by StatisticsManager to publish the count if we are floodfill.
`int`	`getKnownRouters()` This used to return the number of routers that were in both the kbuckets AND the data store, which was fine when the kbuckets held everything.
`(package private) long`	`getLastExploreNewDate()`
`long`	`getLastRouterInfoPublishTime()` The last time we successfully published our RI.
`Set<LeaseSet>`	`getLeases()` Public for NetDbRenderer in routerconsole
`PeerSelector`	`getPeerSelector()` Returns the main database's peer selector.
`int`	`getPeerTimeout(Hash peer)` Get the timeout for a peer, based on the profile data, or the default timeout.
`Set<LeaseSet>`	`getPublishedLeases()` Public for NetDbRenderer in routerconsole
`String`	`getRouterIPPort(RouterInfo router)` Extract IP address and port from RouterInfo for logging to sessionbans.txt.
`Set<RouterInfo>`	`getRouters()` public for NetDbRenderer in routerconsole
`int`	`getStoredRouterInfoCount()` Get the number of RouterInfo files stored on disk, if using PersistentDataStore.
`Set<LeaseSet>`	`getUnpublishedLeases()` Public for NetDbRenderer in routerconsole
`(package private) boolean`	`hasActiveRepublishJob(Hash hash)` Check if an active republish job exists for the given destination.
`boolean`	`isClientDb()` Check if the database is a client DB.
`boolean`	`isInitialized()` Checks whether the network database has been fully initialized.
`(package private) boolean`	`isNegativeCached(Hash key)` Is the key in the negative lookup cache?
`boolean`	`isNegativeCachedForever(Hash key)` Is it permanently negative cached?
`static boolean`	`isNewer(LeaseSet a, LeaseSet b)` Utility to determine if a is newer than b.
`protected void`	`lookupBeforeDropping(Hash peer, RouterInfo info)` Don't use directly - see F.N.D.F.
`void`	`lookupDestination(Hash key, Job onFinishedJob, long timeoutMs, Hash fromLocalDest)` Lookup using the client's tunnels Succeeds even if LS validation and store fails due to unsupported sig type, expired, etc.
`Destination`	`lookupDestinationLocally(Hash key)` Lookup locally in netDB and in badDest cache Succeeds even if LS validation fails due to unsupported sig type, expired, etc.
`(package private) void`	`lookupFailed(Hash key)` Increment in the negative lookup cache
`void`	`lookupLeaseSet(Hash key, Job onFindJob, Job onFailedLookupJob, long timeoutMs)` Lookup a LeaseSet in the network database.
`void`	`lookupLeaseSet(Hash key, Job onFindJob, Job onFailedLookupJob, long timeoutMs, Hash fromLocalDest)` Lookup using the client's tunnels Use lookupDestination() if you don't need the LS or don't need it validated.
`LeaseSet`	`lookupLeaseSetLocally(Hash key)` key).
`void`	`lookupLeaseSetRemotely(Hash key, Hash fromLocalDest)` Unconditionally lookup using the client's tunnels.
`void`	`lookupLeaseSetRemotely(Hash key, Job onFindJob, Job onFailedLookupJob, long timeoutMs, Hash fromLocalDest)` Unconditionally lookup using the client's tunnels.
`DatabaseEntry`	`lookupLocally(Hash key)` Lookup a database entry locally.
`DatabaseEntry`	`lookupLocallyWithoutValidation(Hash key)` Not for use without validation
`void`	`lookupRouterInfo(Hash key, Job onFindJob, Job onFailedLookupJob, long timeoutMs)` timeoutMs).
`RouterInfo`	`lookupRouterInfoLocally(Hash key)` This will return immediately with the result or null.
`void`	`lookupRouterInfoRemote(Hash key, Job onFindJob, Job onFailedLookupJob, long timeoutMs)` Look up a RouterInfo by hash, performing a network search if not locally cached.
`void`	`markHostCheckerLeaseSet(Hash hash)` Mark a destination hash as being looked up on behalf of HostChecker.
`(package private) void`	`negativeCacheNow(Hash key)` Immediately negative-cache a key (set to its max fail count) so the next lookup short-circuits via `isNegativeCached(net.i2p.data.Hash)` instead of running a full search.
`void`	`publish(LeaseSet localLeaseSet)` Publishes a local LeaseSet by storing it and scheduling republishing if applicable.
`void`	`publish(RouterInfo localRouterInfo)` Stores to local db only.
`void`	`purgeMatchingRouters()` Trigger a retroactive purge sweep of the NetDb.
`void`	`queueForExploration(Collection<Hash> keys)` Queue keys for exploration.
`(package private) boolean`	`registerPublishingJob(RepublishLeaseSetJob job)` Register a new job for tracking.
`boolean`	`removeBlindData(SigningPublicKey spk)` For console ConfigKeyringHelper
`void`	`removeFromCache(Hash hash)` Remove a remote LeaseSet from local cache (e.g.
`void`	`removeFromExploreKeys(Collection<Hash> toRemove)` Remove keys from the exploration set.
`void`	`removeLeaseSetFromTracking(Hash key)` Remove a LeaseSet from refresh tracking.
`(package private) void`	`removePublishingJob(Hash hash, RepublishLeaseSetJob job)` Remove a specific job from the tracking set.
`void`	`removeRouterInfo(Hash key)` Remove a RouterInfo from the local netdb.
`void`	`renderStatusHTML(Writer out)` Debug only - all user info moved to NetDbRenderer in router console
`void`	`rescan()` Rescan the netdb directory for new RouterInfo files.
`ReseedChecker`	`reseedChecker()`
`(package private) void`	`routerInfoPublishSuccessful()` Set the last time we successfully published our RI.
`void`	`routingKeyChanged()` Notify the netDB that the routing key changed at midnight UTC
`(package private) SearchJob`	`search(Hash key, Job onFindJob, Job onFailedLookupJob, long timeoutMs, boolean isLease)` Begin a kademlia style search for the key specified, which can take up to timeoutMs and will fire the appropriate jobs on success or timeout (or if the kademlia search completes without any match) Unused - called only by FNDF.searchFull() from FloodSearchJob which is overridden - don't use this.
`(package private) SearchJob`	`search(Hash key, Job onFindJob, Job onFailedLookupJob, long timeoutMs, boolean isLease, Hash fromLocalDest)` Unused - see FNDF
`(package private) void`	`searchComplete(Hash key)` The search for the given key is no longer active.
`(package private) abstract void`	`sendStore(Hash key, DatabaseEntry ds, Job onSuccess, Job onFailure, long sendTimeout, Set<Hash> toIgnore)` See implementation in FNDF
`void`	`setBlindData(BlindData bd)`
`(package private) void`	`setLastExploreNewDate(long when)`
`void`	`shutdown()` Instruct the service that the router is shutting down and that it should do whatever is necessary to go down gracefully.
`void`	`startup()` Instruct the service that it should start normal operation.
`(package private) void`	`stopPublishing(Hash target)`
`LeaseSet`	`store(Hash key, LeaseSet leaseSet)`
`LeaseSet`	`store(Hash key, LeaseSet leaseSet, boolean force)` Store the leaseSet.
`RouterInfo`	`store(Hash key, RouterInfo routerInfo)` Store the routerInfo.
`(package private) RouterInfo`	`store(Hash key, RouterInfo routerInfo, boolean persist)` Store the routerInfo.
`String`	`toString()`
`void`	`unpublish(LeaseSet localLeaseSet)` Unpublish a LeaseSet from the network database.
`String`	`validate(Hash key, LeaseSet leaseSet)` Validates whether the given LeaseSet is acceptable as valid and current based on current known parameters.
`(package private) String`	`validate(RouterInfo routerInfo)` Determine whether this routerInfo will be accepted as valid and current given what we know now.

Methods inherited from class net.i2p.router.NetworkDatabaseFacade
floodfillEnabled, store

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

Methods inherited from interface net.i2p.router.Service
restart

- Field Detail
  - _context
```
protected final RouterContext _context
```
    _context.
  - _log
```
protected final Log _log
```
    Class logger.
  - _networkID
```
protected final int _networkID
```
    Network identifier.
  - _peerSelector
```
protected final PeerSelector _peerSelector
```
    _peerSelector.
  - CURRENT_VERSION
```
public static String CURRENT_VERSION
```
    Current minor version identifier for net DB format.
  - DEFAULT_DB_DIR
```
public static final String DEFAULT_DB_DIR
```
    Default database directory name.
    See Also:
    Constant Field Values
  - DONT_FAIL_PERIOD
```
public static long DONT_FAIL_PERIOD
```
    For 15 minutes after startup, don't fail db entries so that if we were offline for a while, we'll have a chance of finding some live peers with the previous references
  - MAX_EXPLORE_QUEUE
```
static final int MAX_EXPLORE_QUEUE
```
    Maximum number of peers to place in the queue to explore
    See Also:
    Constant Field Values
  - MIN_REMAINING_ROUTERS
```
protected static final int MIN_REMAINING_ROUTERS
```
    If we have less than this many routers left, don't drop any more, even if they're failing or doing bad stuff. As of 0.9.4, we make this LOWER than the min for reseeding, so a reseed will be forced if necessary.
    See Also:
    Constant Field Values
  - MIN_RESEED
```
static final int MIN_RESEED
```
    Reseed if below this.
    See Also:
    Constant Field Values
  - MIN_ROUTER_VERSION
```
public static final String MIN_ROUTER_VERSION
```
    See Also:
    Constant Field Values
  - MIN_VERSION
```
public static final String MIN_VERSION
```
    See Also:
    Constant Field Values
  - PROP_BLOCK_MY_COUNTRY
```
public static final String PROP_BLOCK_MY_COUNTRY
```
    Config property for blocking own-country peers.
    See Also:
    Constant Field Values
  - PROP_BUCKET_SIZE
```
static final String PROP_BUCKET_SIZE
```
    P r o p b u c k e t s i z e
    See Also:
    Constant Field Values
  - PROP_DB_DIR
```
public static final String PROP_DB_DIR
```
    Config property for database directory.
    See Also:
    Constant Field Values
  - PROP_EXPLORE_QUEUE
```
static final String PROP_EXPLORE_QUEUE
```
    P r o p e x p l o r e q u e u e
    See Also:
    Constant Field Values
  - PROP_IP_COUNTRY
```
public static final String PROP_IP_COUNTRY
```
    Config property for IP country override.
    See Also:
    Constant Field Values
  - PROP_KAD_B
```
static final String PROP_KAD_B
```
    P r o p k a d b
    See Also:
    Constant Field Values
  - PROP_MIN_ROUTER_VERSION
```
static final String PROP_MIN_ROUTER_VERSION
```
    P r o p m i n r o u t e r v e r s i o n
    See Also:
    Constant Field Values
  - PROP_ROUTER_INFO_EXPIRATION_ADJUSTED
```
static final String PROP_ROUTER_INFO_EXPIRATION_ADJUSTED
```
    P r o p r o u t e r i n f o e x p i r a t i o n a d j u s t e d
    See Also:
    Constant Field Values
  - PROP_VALIDATE_ROUTERS_AFTER
```
static final String PROP_VALIDATE_ROUTERS_AFTER
```
    P r o p v a l i d a t e r o u t e r s a f t e r
    See Also:
    Constant Field Values
  - PUBLISH_JOB_DELAY
```
protected static final long PUBLISH_JOB_DELAY
```
    This needs to be long enough to give us time to start up, but less than 20m (when we start accepting tunnels and could be a IBGW) Actually no, we need this soon if we are a new router or other routers have forgotten about us, else we can't build IB exploratory tunnels. Unused.
    See Also:
    Constant Field Values
- Constructor Detail
  - KademliaNetworkDatabaseFacade
```
public KademliaNetworkDatabaseFacade(RouterContext context,
                                     Hash dbid)
```
    Initializes the Kademlia-based network database facade.
    Parameters:
    context - the router context
    dbid - the unique identifier for this network database
- Method Detail
  - accessLeaseSet
```
public void accessLeaseSet(Hash key)
```
    Record access to a LeaseSet for refresh tracking. Call this when actively using a LeaseSet (tunnel build, outbound message). Only tracks if we have tunnels built AND there's a hostname. Do NOT call for HostChecker lookups.
    Specified by:
    accessLeaseSet in class NetworkDatabaseFacade
  - blindCache
```
protected BlindCache blindCache()
```
    Returns the blind data cache used by this database. We still always use a single blind cache in the main Db(for now), see issue #421 on i2pgit.org/i2p-hackers/i2p.i2p for details. This checks if we're the main DB already and returns our blind cache if we are. If not, it looks up the main Db and gets it.
    Returns:
    the BlindCache instance, never null
  - cleanupLURouters
```
public void cleanupLURouters()
```
    Clean up existing LU routers loaded before the ban was added. Called at startup to remove LU routers from the netdb.
  - createHandlers
```
protected void createHandlers()
```
    Unused, see override
  - createPeerSelector
```
protected PeerSelector createPeerSelector()
```
    Creates a peer selector for the network database. Only applicable for the main database.
    Returns:
    a new PeerSelector instance
    Throws:
    IllegalStateException - if called on a client database
  - dropAfterLookupFailed
```
boolean dropAfterLookupFailed(Hash peer)
```
    Final remove for a router info. Do NOT use for leasesets.
    Parameters:
    peer - the peer hash
    Returns:
    true if logged
  - fail
```
public void fail(Hash dbEntry)
```
    Final remove for a leaseset. For a router info, will look up in the network before dropping.
    Specified by:
    fail in class NetworkDatabaseFacade
    Parameters:
    dbEntry - the key of the entry to fail
  - failPermanently
```
void failPermanently(Destination dest)
```
    Negative cache until restart
    Parameters:
    dest - the destination
  - findNearestRouters
```
public Set<Hash> findNearestRouters(Hash key,
                                    int maxNumRouters,
                                    Set<Hash> peersToIgnore)
```
    Get the routers closest to that key in response to a remote lookup Only used by ../HDLMJ Set MAY INCLUDE our own router - add to peersToIgnore if you don't want
    Specified by:
    findNearestRouters in class NetworkDatabaseFacade
    Parameters:
    key - the real key, NOT the routing key
    peersToIgnore - can be null
    maxNumRouters - The maximum number of routers to return
    Returns:
    set of router hashes closest to the key
  - getAllRouters
```
public Set<Hash> getAllRouters()
```
    Get the hashes for all known routers
    Specified by:
    getAllRouters in class NetworkDatabaseFacade
    Returns:
    set of router hashes
  - getBlindData
```
public List<BlindData> getBlindData()
```
    Description copied from class: NetworkDatabaseFacade
    For console ConfigKeyringHelper
    Overrides:
    getBlindData in class NetworkDatabaseFacade
    Returns:
    the blind data
  - getBlindData
```
public BlindData getBlindData(SigningPublicKey spk)
```
    Overrides:
    getBlindData in class NetworkDatabaseFacade
    Parameters:
    spk - unblinded key
    Returns:
    BlindData or null
  - getClientLeases
```
public Set<LeaseSet> getClientLeases()
```
    Public for NetDbRenderer in routerconsole
    Overrides:
    getClientLeases in class NetworkDatabaseFacade
    Returns:
    the client leases
  - getDataStore
```
DataStore getDataStore()
```
    Returns:
    the data store
  - getDbDir
```
String getDbDir()
```
    For the main DB only. Sub DBs are not persisted and must not access this directory.
    Returns:
    null before startup() is called; non-null thereafter, even for subdbs.
  - getExploreKeys
```
public Set<Hash> getExploreKeys()
```
    Gets the set of keys to explore.
    Returns:
    unmodifiable set
  - getFloodfillLeases
```
public Set<LeaseSet> getFloodfillLeases()
```
    Overrides:
    getFloodfillLeases in class NetworkDatabaseFacade
    Returns:
    the floodfill leases
  - getKBuckets
```
KBucketSet<Hash> getKBuckets()
```
    Get the KBucketSet for the main DB.
    Returns:
    the main DB's KBucketSet. Client DBs do not have their own.
  - getKBucketSetSize
```
protected int getKBucketSetSize()
```
    Get the size of the KBucketSet. The KBucketSet contains RIs only.
    Returns:
    the size
  - getKnownLeaseSets
```
public int getKnownLeaseSets()
```
    This is only used by StatisticsManager to publish the count if we are floodfill. So to hide a clue that a popular eepsite is hosted on a floodfill router, only count leasesets that are "received as published", as of 0.7.14
    Overrides:
    getKnownLeaseSets in class NetworkDatabaseFacade
    Returns:
    the known lease sets
  - getKnownRouters
```
public int getKnownRouters()
```
    This used to return the number of routers that were in both the kbuckets AND the data store, which was fine when the kbuckets held everything. But now that is probably not what you want. Just return the count in the data store.
    Overrides:
    getKnownRouters in class NetworkDatabaseFacade
    Returns:
    0 if this is a client DB
  - getLastExploreNewDate
```
long getLastExploreNewDate()
```
    Returns:
    the last explore new date
  - getLastRouterInfoPublishTime
```
public long getLastRouterInfoPublishTime()
```
    Description copied from class: NetworkDatabaseFacade
    The last time we successfully published our RI.
    Overrides:
    getLastRouterInfoPublishTime in class NetworkDatabaseFacade
    Returns:
    the timestamp, or 0
  - getLeases
```
public Set<LeaseSet> getLeases()
```
    Public for NetDbRenderer in routerconsole
    Overrides:
    getLeases in class NetworkDatabaseFacade
    Returns:
    set of LeaseSets, or empty
  - getPeerSelector
```
public PeerSelector getPeerSelector()
```
    Returns the main database's peer selector.
    Returns:
    the PeerSelector instance, or null if this is a client database
  - getPeerTimeout
```
public int getPeerTimeout(Hash peer)
```
    Get the timeout for a peer, based on the profile data, or the default timeout.
    Parameters:
    peer - the peer
    Returns:
    the timeout for a peer, based on the profile data, or the default timeout
  - getPublishedLeases
```
public Set<LeaseSet> getPublishedLeases()
```
    Public for NetDbRenderer in routerconsole
    Overrides:
    getPublishedLeases in class NetworkDatabaseFacade
    Returns:
    the published leases
  - getRouterIPPort
```
public String getRouterIPPort(RouterInfo router)
```
    Extract IP address and port from RouterInfo for logging to sessionbans.txt. Returns IP:PORT format for IPv4 or [IPv6]:PORT format for IPv6.
    Parameters:
    router - the RouterInfo to extract from
    Returns:
    IP:PORT string or "UNKNOWN" if not available
  - getRouters
```
public Set<RouterInfo> getRouters()
```
    Description copied from class: NetworkDatabaseFacade
    public for NetDbRenderer in routerconsole
    Overrides:
    getRouters in class NetworkDatabaseFacade
  - getStoredRouterInfoCount
```
public int getStoredRouterInfoCount()
```
    Get the number of RouterInfo files stored on disk, if using PersistentDataStore.
    Returns:
    number of RIs on disk, or 0 if not using persistent storage
  - getUnpublishedLeases
```
public Set<LeaseSet> getUnpublishedLeases()
```
    Public for NetDbRenderer in routerconsole
    Overrides:
    getUnpublishedLeases in class NetworkDatabaseFacade
    Returns:
    the unpublished leases
  - hasActiveRepublishJob
```
boolean hasActiveRepublishJob(Hash hash)
```
    Check if an active republish job exists for the given destination.
    Parameters:
    hash - the destination hash
    Returns:
    true if active
  - isClientDb
```
public boolean isClientDb()
```
    Check if the database is a client DB.
    Returns:
    true if the database is a client DB, false otherwise
  - isInitialized
```
public boolean isInitialized()
```
    Checks whether the network database has been fully initialized.
    Overrides:
    isInitialized in class NetworkDatabaseFacade
    Returns:
    true if the database is initialized and ready for use, false otherwise
  - isNegativeCached
```
boolean isNegativeCached(Hash key)
```
    Is the key in the negative lookup cache?
    Parameters:
    key - for Destinations or RouterIdentities
    Returns:
    true if cached
  - isNegativeCachedForever
```
public boolean isNegativeCachedForever(Hash key)
```
    Is it permanently negative cached?
    Overrides:
    isNegativeCachedForever in class NetworkDatabaseFacade
    Parameters:
    key - only for Destinations; for RouterIdentities, see Banlist
    Returns:
    whether negative cached forever
  - isNewer
```
public static boolean isNewer(LeaseSet a,
                              LeaseSet b)
```
    Utility to determine if a is newer than b. Uses publish date if a and b are both LS2, else earliest lease date.
    Parameters:
    a - non-null
    b - non-null
    Returns:
    if a is newer than b
  - lookupBeforeDropping
```
protected void lookupBeforeDropping(Hash peer,
                                    RouterInfo info)
```
    Don't use directly - see F.N.D.F. override.
    Parameters:
    peer - the peer
    info - the router info
  - lookupDestination
```
public void lookupDestination(Hash key,
                              Job onFinishedJob,
                              long timeoutMs,
                              Hash fromLocalDest)
```
    Lookup using the client's tunnels Succeeds even if LS validation and store fails due to unsupported sig type, expired, etc. Note that there are not separate success and fail jobs. Caller must call lookupDestinationLocally() in the job to determine success.
    Specified by:
    lookupDestination in class NetworkDatabaseFacade
    Parameters:
    onFinishedJob - non-null
    fromLocalDest - use these tunnels for the lookup, or null for exploratory
  - lookupDestinationLocally
```
public Destination lookupDestinationLocally(Hash key)
```
    Lookup locally in netDB and in badDest cache Succeeds even if LS validation fails due to unsupported sig type, expired, etc.
    Specified by:
    lookupDestinationLocally in class NetworkDatabaseFacade
  - lookupFailed
```
void lookupFailed(Hash key)
```
    Increment in the negative lookup cache
    Parameters:
    key - for Destinations or RouterIdentities
  - lookupLeaseSet
```
public void lookupLeaseSet(Hash key,
                           Job onFindJob,
                           Job onFailedLookupJob,
                           long timeoutMs)
```
    Description copied from class: NetworkDatabaseFacade
    Lookup a LeaseSet in the network database.
    Specified by:
    lookupLeaseSet in class NetworkDatabaseFacade
    Parameters:
    key - the key
    onFindJob - job to run on success
    onFailedLookupJob - job to run on failure
    timeoutMs - timeout in milliseconds
  - lookupLeaseSet
```
public void lookupLeaseSet(Hash key,
                           Job onFindJob,
                           Job onFailedLookupJob,
                           long timeoutMs,
                           Hash fromLocalDest)
```
    Lookup using the client's tunnels Use lookupDestination() if you don't need the LS or don't need it validated.
    Specified by:
    lookupLeaseSet in class NetworkDatabaseFacade
    Parameters:
    fromLocalDest - use these tunnels for the lookup, or null for exploratory
  - lookupLeaseSetLocally
```
public LeaseSet lookupLeaseSetLocally(Hash key)
```
    Description copied from class: NetworkDatabaseFacade
    key).
    Specified by:
    lookupLeaseSetLocally in class NetworkDatabaseFacade
  - lookupLeaseSetRemotely
```
public void lookupLeaseSetRemotely(Hash key,
                                   Hash fromLocalDest)
```
    Unconditionally lookup using the client's tunnels. No success or failed jobs, no local lookup, no checks. Use this to refresh a leaseset before expiration.
    Specified by:
    lookupLeaseSetRemotely in class NetworkDatabaseFacade
    Parameters:
    fromLocalDest - use these tunnels for the lookup, or null for exploratory
  - lookupLeaseSetRemotely
```
public void lookupLeaseSetRemotely(Hash key,
                                   Job onFindJob,
                                   Job onFailedLookupJob,
                                   long timeoutMs,
                                   Hash fromLocalDest)
```
    Unconditionally lookup using the client's tunnels.
    Specified by:
    lookupLeaseSetRemotely in class NetworkDatabaseFacade
    Parameters:
    fromLocalDest - use these tunnels for the lookup, or null for exploratory
    onFindJob - may be null
    onFailedLookupJob - may be null
  - lookupLocally
```
public DatabaseEntry lookupLocally(Hash key)
```
    Description copied from class: NetworkDatabaseFacade
    Lookup a database entry locally.
    Specified by:
    lookupLocally in class NetworkDatabaseFacade
    Parameters:
    key - the key
    Returns:
    RouterInfo, LeaseSet, or null, validated
  - lookupLocallyWithoutValidation
```
public DatabaseEntry lookupLocallyWithoutValidation(Hash key)
```
    Not for use without validation
    Specified by:
    lookupLocallyWithoutValidation in class NetworkDatabaseFacade
    Parameters:
    key - the key
    Returns:
    RouterInfo, LeaseSet, or null, NOT validated
  - lookupRouterInfo
```
public void lookupRouterInfo(Hash key,
                             Job onFindJob,
                             Job onFailedLookupJob,
                             long timeoutMs)
```
    Description copied from class: NetworkDatabaseFacade
    timeoutMs).
    Specified by:
    lookupRouterInfo in class NetworkDatabaseFacade
  - lookupRouterInfoLocally
```
public RouterInfo lookupRouterInfoLocally(Hash key)
```
    This will return immediately with the result or null. However, this may still fire off a lookup if the RI is present but expired (and will return null). This may result in deadlocks. For true local only, use lookupLocallyWithoutValidation()
    Specified by:
    lookupRouterInfoLocally in class NetworkDatabaseFacade
    Returns:
    null always for client dbs
  - lookupRouterInfoRemote
```
public void lookupRouterInfoRemote(Hash key,
                                   Job onFindJob,
                                   Job onFailedLookupJob,
                                   long timeoutMs)
```
    Look up a RouterInfo by hash, performing a network search if not locally cached. Unlike lookupRouterInfo() which calls onFailedLookupJob immediately for unknown routers, this method schedules an IterativeSearchJob when the RI is absent from the local netdb. The caller should provide a timeoutMs shorter than the acceptable delay (typical: 8-15 seconds).
    The onFindJob fires when the RI is available locally (either it was already present or the search completed). The onFailedLookupJob fires on search timeout or failure.
    Caller must clean up via removeRouterInfo() after extracting the needed data.
    Parameters:
    key - the Router hash to look up
    onFindJob - run when RI is local (may be null)
    onFailedLookupJob - run on lookup failure (may be null)
    timeoutMs - max wait in ms (bounded internally by the adaptive lookup cap)
  - markHostCheckerLeaseSet
```
public void markHostCheckerLeaseSet(Hash hash)
```
    Mark a destination hash as being looked up on behalf of HostChecker. The LeaseSet will be eligible for removal from cache when HostChecker finishes its ping test. LeaseSets that were independently cached (not in this set) are preserved.
    Parameters:
    hash - the destination hash being pinged by HostChecker
  - negativeCacheNow
```
void negativeCacheNow(Hash key)
```
    Immediately negative-cache a key (set to its max fail count) so the next lookup short-circuits via isNegativeCached(net.i2p.data.Hash) instead of running a full search. Used for transit next-hop RouterInfo misses: a peer that is gone or unreachable should fail fast for subsequent transit messages rather than each one waiting out the full lookup timeout.
    Parameters:
    key - RouterInfo or Destination hash
  - publish
```
public void publish(LeaseSet localLeaseSet)
             throws IllegalArgumentException
```
    Publishes a local LeaseSet by storing it and scheduling republishing if applicable. Ensures LeaseSet expiry dates are valid (not expired before publish).
    Specified by:
    publish in class NetworkDatabaseFacade
    Parameters:
    localLeaseSet - the LeaseSet to publish
    Throws:
    IllegalArgumentException - if LeaseSet is invalid or expired
  - publish
```
public void publish(RouterInfo localRouterInfo)
             throws IllegalArgumentException
```
    Stores to local db only. Overridden in FNDF to actually send to the floodfills.
    Specified by:
    publish in class NetworkDatabaseFacade
    Parameters:
    localRouterInfo - the RouterInfo to publish
    Throws:
    IllegalArgumentException - if the local router info is invalid or if this is a client DB
  - purgeMatchingRouters
```
public void purgeMatchingRouters()
```
    Trigger a retroactive purge sweep of the NetDb. Bans and removes all routers matching enabled LU/XG/custom-cap bans. Only call this on config change, not on startup or disable.
    Overrides:
    purgeMatchingRouters in class NetworkDatabaseFacade
  - queueForExploration
```
public void queueForExploration(Collection<Hash> keys)
```
    Queue keys for exploration.
    Parameters:
    keys - keys to queue
  - registerPublishingJob
```
boolean registerPublishingJob(RepublishLeaseSetJob job)
```
    Register a new job for tracking. Skips registration if a job is already active.
    Parameters:
    job - the job to register
    Returns:
    true if job was registered, false if one was already active
  - removeBlindData
```
public boolean removeBlindData(SigningPublicKey spk)
```
    For console ConfigKeyringHelper
    Overrides:
    removeBlindData in class NetworkDatabaseFacade
    Parameters:
    spk - the unblinded public key
    Returns:
    true if removed
  - removeFromCache
```
public void removeFromCache(Hash hash)
```
    Remove a remote LeaseSet from local cache (e.g. after HostChecker has used it). Only removes LeaseSets that were explicitly fetched for HostChecker (tracked via markHostCheckerLeaseSet()). Pre-existing LeaseSets that were independently cached by other clients (e.g. HTTP Proxy browsing) are preserved.
    Parameters:
    hash - the LeaseSet hash to remove
  - removeFromExploreKeys
```
public void removeFromExploreKeys(Collection<Hash> toRemove)
```
    Remove keys from the exploration set.
    Parameters:
    toRemove - keys to remove
  - removeLeaseSetFromTracking
```
public void removeLeaseSetFromTracking(Hash key)
```
    Remove a LeaseSet from refresh tracking. Call this after HostChecker completes to avoid unnecessary refreshes.
    Specified by:
    removeLeaseSetFromTracking in class NetworkDatabaseFacade
  - removePublishingJob
```
void removePublishingJob(Hash hash,
                         RepublishLeaseSetJob job)
```
    Remove a specific job from the tracking set.
    Parameters:
    hash - the destination hash
    job - the job to remove
  - removeRouterInfo
```
public void removeRouterInfo(Hash key)
```
    Remove a RouterInfo from the local netdb. No-op if the key is not present or is not a RouterInfo. Safe to call on any hash — non-RouterInfo entries are left untouched.
    Parameters:
    key - the Router hash to remove
  - renderStatusHTML
```
public void renderStatusHTML(Writer out)
                      throws IOException
```
    Description copied from class: NetworkDatabaseFacade
    Debug only - all user info moved to NetDbRenderer in router console
    Specified by:
    renderStatusHTML in interface Service
    Overrides:
    renderStatusHTML in class NetworkDatabaseFacade
    Parameters:
    out - the writer to write to
    Throws:
    IOException - if an error occurs writing
  - rescan
```
public void rescan()
```
    Rescan the netdb directory for new RouterInfo files.
    Overrides:
    rescan in class NetworkDatabaseFacade
  - reseedChecker
```
public ReseedChecker reseedChecker()
```
    Overrides:
    reseedChecker in class NetworkDatabaseFacade
  - routerInfoPublishSuccessful
```
void routerInfoPublishSuccessful()
```
    Set the last time we successfully published our RI.
  - routingKeyChanged
```
public void routingKeyChanged()
```
    Notify the netDB that the routing key changed at midnight UTC
    Overrides:
    routingKeyChanged in class NetworkDatabaseFacade
  - search
```
SearchJob search(Hash key,
                 Job onFindJob,
                 Job onFailedLookupJob,
                 long timeoutMs,
                 boolean isLease)
```
    Begin a kademlia style search for the key specified, which can take up to timeoutMs and will fire the appropriate jobs on success or timeout (or if the kademlia search completes without any match) Unused - called only by FNDF.searchFull() from FloodSearchJob which is overridden - don't use this.
    Parameters:
    key - the hash to search for
    onFindJob - job on find
    onFailedLookupJob - job on failure
    timeoutMs - timeout in ms
    isLease - whether searching for lease
    Returns:
    never returns
    Throws:
    UnsupportedOperationException - always
  - search
```
SearchJob search(Hash key,
                 Job onFindJob,
                 Job onFailedLookupJob,
                 long timeoutMs,
                 boolean isLease,
                 Hash fromLocalDest)
```
    Unused - see FNDF
    Parameters:
    key - the hash to search for
    onFindJob - job on find
    onFailedLookupJob - job on failure
    timeoutMs - timeout in ms
    isLease - whether searching for lease
    fromLocalDest - the local destination
    Returns:
    never returns
    Throws:
    UnsupportedOperationException - always
  - searchComplete
```
void searchComplete(Hash key)
```
    The search for the given key is no longer active.
    Parameters:
    key - the key whose search is complete
  - sendStore
```
abstract void sendStore(Hash key,
                        DatabaseEntry ds,
                        Job onSuccess,
                        Job onFailure,
                        long sendTimeout,
                        Set<Hash> toIgnore)
```
    See implementation in FNDF
    Parameters:
    key - the DatabaseEntry hash
    onSuccess - may be null, always called if we are ff and ds is an RI
    onFailure - may be null, ignored if we are ff and ds is an RI
    ds - the database entry
    sendTimeout - timeout in ms for send operations if we are ff and ds is an RI
    toIgnore - may be null, if non-null, all attempted and skipped targets will be added as of 0.9.53, unused if we are ff and ds is an RI
  - setBlindData
```
public void setBlindData(BlindData bd)
```
    Overrides:
    setBlindData in class NetworkDatabaseFacade
    Parameters:
    bd - new BlindData to put in the cache
  - setLastExploreNewDate
```
void setLastExploreNewDate(long when)
```
    Parameters:
    when - the new date
  - shutdown
```
public void shutdown()
```
    Description copied from interface: Service
    Instruct the service that the router is shutting down and that it should do whatever is necessary to go down gracefully. It should not depend on other components at this point. This call DOES block.
  - startup
```
public void startup()
```
    Description copied from interface: Service
    Instruct the service that it should start normal operation. This call DOES block until the service is ready.
  - stopPublishing
```
void stopPublishing(Hash target)
```
    Parameters:
    target - hash to stop publishing
  - store
```
public LeaseSet store(Hash key,
                      LeaseSet leaseSet)
               throws IllegalArgumentException
```
    Specified by:
    store in class NetworkDatabaseFacade
    Returns:
    the leaseSet if another leaseSet already existed at that key
    Throws:
    IllegalArgumentException - if the data is not valid
  - store
```
public LeaseSet store(Hash key,
                      LeaseSet leaseSet,
                      boolean force)
               throws IllegalArgumentException
```
    Store the leaseSet. If the store fails due to unsupported crypto, it will negative cache the hash until restart.
    Parameters:
    key - the hash key
    leaseSet - the leaseSet to store
    force - always store even if not newer
    Returns:
    previous entry or null
    Throws:
    IllegalArgumentException - if the leaseSet is not valid
    UnsupportedCryptoException - if that's why it failed.
  - store
```
public RouterInfo store(Hash key,
                        RouterInfo routerInfo)
                 throws IllegalArgumentException
```
    Store the routerInfo. If the store fails due to unsupported crypto, it will banlist the router hash until restart and then throw UnsupportedCrytpoException.
    Specified by:
    store in class NetworkDatabaseFacade
    Returns:
    previous entry or null
    Throws:
    IllegalArgumentException - if the routerInfo is not valid
    UnsupportedCryptoException - if that's why it failed.
  - store
```
RouterInfo store(Hash key,
                 RouterInfo routerInfo,
                 boolean persist)
          throws IllegalArgumentException
```
    Store the routerInfo. If the store fails due to unsupported crypto, it will banlist the router hash until restart and then throw UnsupportedCrytpoException.
    Parameters:
    key - the hash key
    routerInfo - the router info to store
    persist - whether to persist to disk
    Returns:
    previous entry or null
    Throws:
    IllegalArgumentException - if the routerInfo is not valid
    UnsupportedCryptoException - if that's why it failed.
  - toString
```
public String toString()
```
    Overrides:
    toString in class Object
    Returns:
    "MainNetDb" for the main netdb, or "ClientNetDb [base32]" for a client netdb
  - unpublish
```
public void unpublish(LeaseSet localLeaseSet)
```
    Description copied from class: NetworkDatabaseFacade
    Unpublish a LeaseSet from the network database.
    Specified by:
    unpublish in class NetworkDatabaseFacade
    Parameters:
    localLeaseSet - the LeaseSet to unpublish
  - validate
```
public String validate(Hash key,
                       LeaseSet leaseSet)
                throws UnsupportedCryptoException
```
    Validates whether the given LeaseSet is acceptable as valid and current based on current known parameters.
    This method performs several checks including:
    - Verifying the key matches the LeaseSet destination.
    - Validating the LeaseSet's cryptographic signature.
    - Checking if the LeaseSet is too old (expired).
    - Checking if the LeaseSet expires too far in the future.
    Note: Unlike RouterInfos, this validation is only done once at storage time. Afterward, LeaseSet.isCurrent() should be used to check currency.
    Parameters:
    key - the expected key (destination hash) for this LeaseSet
    leaseSet - the LeaseSet instance to validate
    Returns:
    a descriptive reason why the LeaseSet is invalid or expired, or null if the LeaseSet is valid
    Throws:
    UnsupportedCryptoException - if the LeaseSet uses an unsupported cryptographic type/signature
  - validate
```
String validate(RouterInfo routerInfo)
         throws IllegalArgumentException
```
    Determine whether this routerInfo will be accepted as valid and current given what we know now. Call this before each use, to check expiration
    Parameters:
    routerInfo - the router info to validate
    Returns:
    reason why the entry is not valid, or null if it is valid
    Throws:
    IllegalArgumentException

Class KademliaNetworkDatabaseFacade

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.i2p.router.NetworkDatabaseFacade

Methods inherited from class java.lang.Object

Methods inherited from interface net.i2p.router.Service

Field Detail

_context

_log

_networkID

_peerSelector

CURRENT_VERSION

DEFAULT_DB_DIR

DONT_FAIL_PERIOD

MAX_EXPLORE_QUEUE

MIN_REMAINING_ROUTERS

MIN_RESEED

MIN_ROUTER_VERSION

MIN_VERSION

PROP_BLOCK_MY_COUNTRY

PROP_BUCKET_SIZE

PROP_DB_DIR

PROP_EXPLORE_QUEUE

PROP_IP_COUNTRY

PROP_KAD_B

PROP_MIN_ROUTER_VERSION

PROP_ROUTER_INFO_EXPIRATION_ADJUSTED

PROP_VALIDATE_ROUTERS_AFTER

PUBLISH_JOB_DELAY

Constructor Detail

KademliaNetworkDatabaseFacade

Method Detail

accessLeaseSet

blindCache

cleanupLURouters

createHandlers

createPeerSelector

dropAfterLookupFailed

fail

failPermanently

findNearestRouters

getAllRouters

getBlindData

getBlindData

getClientLeases

getDataStore

getDbDir

getExploreKeys

getFloodfillLeases

getKBuckets

getKBucketSetSize

getKnownLeaseSets

getKnownRouters

getLastExploreNewDate

getLastRouterInfoPublishTime

getLeases

getPeerSelector

getPeerTimeout

getPublishedLeases

getRouterIPPort

getRouters

getStoredRouterInfoCount

getUnpublishedLeases

hasActiveRepublishJob

isClientDb

isInitialized

isNegativeCached

isNegativeCachedForever

isNewer

lookupBeforeDropping

lookupDestination

lookupDestinationLocally

lookupFailed

lookupLeaseSet

lookupLeaseSet

lookupLeaseSetLocally

lookupLeaseSetRemotely

lookupLeaseSetRemotely

lookupLocally