NetworkDatabaseFacade (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.NetworkDatabaseFacade

All Implemented Interfaces:
Service
Direct Known Subclasses:
DummyNetworkDatabaseFacade, KademliaNetworkDatabaseFacade
```
public abstract class NetworkDatabaseFacade
extends Object
implements Service
```
Abstract interface for I2P network database operations. Provides router info and lease set lookup, storage, and search functionality for peer discovery and routing.

Constructor Summary
Constructors
Constructor and Description
NetworkDatabaseFacade()

Constructors
Constructor and Description
`NetworkDatabaseFacade()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`accessLeaseSet(Hash key)` Record access to a LeaseSet for refresh tracking.
`abstract void`	`fail(Hash dbEntry)` Mark a database entry as failed.
`abstract Set<Hash>`	`findNearestRouters(Hash key, int maxNumRouters, Set<Hash> peersToIgnore)` Return the RouterInfo structures for the routers closest to the given key.
`boolean`	`floodfillEnabled()` For convenience, so users don't have to cast to FNDF, and unit tests using Dummy NDF will work.
`abstract Set<Hash>`	`getAllRouters()` All known router hashes.
`List<BlindData>`	`getBlindData()` The blind data for the given unblinded key, for console ConfigKeyringHelper.
`BlindData`	`getBlindData(SigningPublicKey spk)` Look up the cached BlindData for the given key.
`Set<LeaseSet>`	`getClientLeases()` The known client LeaseSets.
`Set<LeaseSet>`	`getFloodfillLeases()` The known floodfill LeaseSets.
`int`	`getKnownLeaseSets()` Number of known LeaseSets.
`int`	`getKnownRouters()` Number of known routers.
`long`	`getLastRouterInfoPublishTime()` The last time we successfully published our RI.
`Set<LeaseSet>`	`getLeases()` All known LeaseSets for display.
`Set<LeaseSet>`	`getPublishedLeases()` The known published LeaseSets.
`Set<RouterInfo>`	`getRouters()` Public for NetDbRenderer in routerconsole
`Set<LeaseSet>`	`getUnpublishedLeases()` The known unpublished LeaseSets.
`boolean`	`isInitialized()` Is the network database initialized?
`boolean`	`isNegativeCachedForever(Hash key)` Is it permanently negative cached?
`abstract void`	`lookupDestination(Hash key, Job onFinishedJob, long timeoutMs, Hash fromLocalDest)` Lookup using the client's tunnels Succeeds even if LS validation fails due to unsupported sig type
`abstract Destination`	`lookupDestinationLocally(Hash key)` Lookup locally in netDB and in badDest cache Succeeds even if LS validation failed due to unsupported sig type
`abstract void`	`lookupLeaseSet(Hash key, Job onFindJob, Job onFailedLookupJob, long timeoutMs)` Lookup a LeaseSet in the network database.
`abstract void`	`lookupLeaseSet(Hash key, Job onFindJob, Job onFailedLookupJob, long timeoutMs, Hash fromLocalDest)` Lookup using the client's tunnels
`abstract LeaseSet`	`lookupLeaseSetLocally(Hash key)` Look up a LeaseSet in the local network database.
`abstract void`	`lookupLeaseSetRemotely(Hash key, Hash fromLocalDest)` Unconditionally lookup using the client's tunnels.
`abstract void`	`lookupLeaseSetRemotely(Hash key, Job onFindJob, Job onFailedLookupJob, long timeoutMs, Hash fromLocalDest)` Unconditionally lookup using the client's tunnels.
`abstract DatabaseEntry`	`lookupLocally(Hash key)` Lookup a database entry locally.
`abstract DatabaseEntry`	`lookupLocallyWithoutValidation(Hash key)` Not for use without validation
`abstract void`	`lookupRouterInfo(Hash key, Job onFindJob, Job onFailedLookupJob, long timeoutMs)` Look up a RouterInfo in the network database.
`abstract RouterInfo`	`lookupRouterInfoLocally(Hash key)` Look up a RouterInfo in the local network database.
`abstract void`	`publish(LeaseSet localLeaseSet)` Publish a LeaseSet to the network database.
`abstract void`	`publish(RouterInfo localRouterInfo)` Publish a RouterInfo to the network database.
`void`	`purgeMatchingRouters()` Trigger a retroactive purge sweep of the NetDb.
`boolean`	`removeBlindData(SigningPublicKey spk)` For console ConfigKeyringHelper
`abstract void`	`removeLeaseSetFromTracking(Hash key)` Remove a LeaseSet from refresh tracking.
`void`	`renderStatusHTML(Writer out)` Debug only - all user info moved to NetDbRenderer in router console
`void`	`rescan()` Rescan the network database.
`ReseedChecker`	`reseedChecker()`
`void`	`routingKeyChanged()` Notify the netDB that the routing key changed at midnight UTC
`void`	`setBlindData(BlindData bd)` Cache the given BlindData for later lookup.
`DatabaseEntry`	`store(Hash key, DatabaseEntry entry)` Store a DatabaseEntry in the network database.
`abstract LeaseSet`	`store(Hash key, LeaseSet leaseSet)` Store a LeaseSet in the network database.
`abstract RouterInfo`	`store(Hash key, RouterInfo routerInfo)` Store a RouterInfo in the network database.
`abstract void`	`unpublish(LeaseSet localLeaseSet)` Unpublish a LeaseSet from the network database.

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

Methods inherited from interface net.i2p.router.Service
restart, shutdown, startup

- Constructor Detail
  - NetworkDatabaseFacade
```
public NetworkDatabaseFacade()
```
- Method Detail
  - accessLeaseSet
```
public abstract void accessLeaseSet(Hash key)
```
    Record access to a LeaseSet for refresh tracking. Only tracks if we have tunnels built AND there's a hostname.
  - fail
```
public abstract void fail(Hash dbEntry)
```
    Mark a database entry as failed.
    Parameters:
    dbEntry - the key of the entry to fail
  - findNearestRouters
```
public abstract Set<Hash> findNearestRouters(Hash key,
                                             int maxNumRouters,
                                             Set<Hash> peersToIgnore)
```
    Return the RouterInfo structures for the routers closest to the given key. At most maxNumRouters will be returned
    Parameters:
    key - The key
    maxNumRouters - The maximum number of routers to return
    peersToIgnore - Hash of routers not to include
    Returns:
    set of router hashes closest to the key
  - floodfillEnabled
```
public boolean floodfillEnabled()
```
    For convenience, so users don't have to cast to FNDF, and unit tests using Dummy NDF will work.
    Returns:
    false; FNDF overrides to return actual setting
  - getAllRouters
```
public abstract Set<Hash> getAllRouters()
```
    All known router hashes.
    Returns:
    set of router hashes
  - getBlindData
```
public List<BlindData> getBlindData()
```
    The blind data for the given unblinded key, for console ConfigKeyringHelper.
    Returns:
    the blind data
  - getBlindData
```
public BlindData getBlindData(SigningPublicKey spk)
```
    Look up the cached BlindData for the given key.
    Parameters:
    spk - unblinded key
    Returns:
    BlindData or null
  - getClientLeases
```
public Set<LeaseSet> getClientLeases()
```
    The known client LeaseSets. Public for NetDbRenderer in routerconsole.
    Returns:
    the client leases
  - getFloodfillLeases
```
public Set<LeaseSet> getFloodfillLeases()
```
    The known floodfill LeaseSets. Public for NetDbRenderer in routerconsole.
    Returns:
    the floodfill leases
  - getKnownLeaseSets
```
public int getKnownLeaseSets()
```
    Number of known LeaseSets.
    Returns:
    the count
  - getKnownRouters
```
public int getKnownRouters()
```
    Number of known routers.
    Returns:
    the count
  - getLastRouterInfoPublishTime
```
public long getLastRouterInfoPublishTime()
```
    The last time we successfully published our RI.
    Returns:
    the timestamp, or 0
  - getLeases
```
public Set<LeaseSet> getLeases()
```
    All known LeaseSets for display.
    Returns:
    set of LeaseSets, or empty
  - getPublishedLeases
```
public Set<LeaseSet> getPublishedLeases()
```
    The known published LeaseSets. Public for NetDbRenderer in routerconsole.
    Returns:
    the published leases
  - getRouters
```
public Set<RouterInfo> getRouters()
```
    Public for NetDbRenderer in routerconsole
  - getUnpublishedLeases
```
public Set<LeaseSet> getUnpublishedLeases()
```
    The known unpublished LeaseSets. Public for NetDbRenderer in routerconsole.
    Returns:
    the unpublished leases
  - isInitialized
```
public boolean isInitialized()
```
    Is the network database initialized?
    Returns:
    true if initialized
  - isNegativeCachedForever
```
public boolean isNegativeCachedForever(Hash key)
```
    Is it permanently negative cached?
    Parameters:
    key - only for Destinations; for RouterIdentities, see Banlist
    Returns:
    whether negative cached forever
  - lookupDestination
```
public abstract void lookupDestination(Hash key,
                                       Job onFinishedJob,
                                       long timeoutMs,
                                       Hash fromLocalDest)
```
    Lookup using the client's tunnels Succeeds even if LS validation fails due to unsupported sig type
    Parameters:
    fromLocalDest - use these tunnels for the lookup, or null for exploratory
  - lookupDestinationLocally
```
public abstract Destination lookupDestinationLocally(Hash key)
```
    Lookup locally in netDB and in badDest cache Succeeds even if LS validation failed due to unsupported sig type
  - lookupLeaseSet
```
public abstract void lookupLeaseSet(Hash key,
                                    Job onFindJob,
                                    Job onFailedLookupJob,
                                    long timeoutMs)
```
    Lookup a LeaseSet in the network database.
    Parameters:
    key - the key
    onFindJob - job to run on success
    onFailedLookupJob - job to run on failure
    timeoutMs - timeout in milliseconds
  - lookupLeaseSet
```
public abstract void lookupLeaseSet(Hash key,
                                    Job onFindJob,
                                    Job onFailedLookupJob,
                                    long timeoutMs,
                                    Hash fromLocalDest)
```
    Lookup using the client's tunnels
    Parameters:
    fromLocalDest - use these tunnels for the lookup, or null for exploratory
  - lookupLeaseSetLocally
```
public abstract LeaseSet lookupLeaseSetLocally(Hash key)
```
    Look up a LeaseSet in the local network database.
    Parameters:
    key - the key
    Returns:
    the LeaseSet, or null if not found
  - lookupLeaseSetRemotely
```
public abstract 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.
    Parameters:
    fromLocalDest - use these tunnels for the lookup, or null for exploratory
  - lookupLeaseSetRemotely
```
public abstract void lookupLeaseSetRemotely(Hash key,
                                            Job onFindJob,
                                            Job onFailedLookupJob,
                                            long timeoutMs,
                                            Hash fromLocalDest)
```
    Unconditionally lookup using the client's tunnels.
    Parameters:
    fromLocalDest - use these tunnels for the lookup, or null for exploratory
    onFindJob - may be null
    onFailedLookupJob - may be null
  - lookupLocally
```
public abstract DatabaseEntry lookupLocally(Hash key)
```
    Lookup a database entry locally.
    Parameters:
    key - the key
    Returns:
    RouterInfo, LeaseSet, or null
  - lookupLocallyWithoutValidation
```
public abstract DatabaseEntry lookupLocallyWithoutValidation(Hash key)
```
    Not for use without validation
    Parameters:
    key - the key
    Returns:
    RouterInfo, LeaseSet, or null, NOT validated
  - lookupRouterInfo
```
public abstract void lookupRouterInfo(Hash key,
                                      Job onFindJob,
                                      Job onFailedLookupJob,
                                      long timeoutMs)
```
    Look up a RouterInfo in the network database.
    Parameters:
    key - the key
    onFindJob - job to run on success
    onFailedLookupJob - job to run on failure
    timeoutMs - timeout in milliseconds
  - lookupRouterInfoLocally
```
public abstract RouterInfo lookupRouterInfoLocally(Hash key)
```
    Look up a RouterInfo in the local network database.
    Parameters:
    key - the key
    Returns:
    the RouterInfo, or null if not found
  - publish
```
public abstract void publish(LeaseSet localLeaseSet)
```
    Publish a LeaseSet to the network database.
    Parameters:
    localLeaseSet - the LeaseSet to publish
  - publish
```
public abstract void publish(RouterInfo localRouterInfo)
                      throws IllegalArgumentException
```
    Publish a RouterInfo to the network database.
    Parameters:
    localRouterInfo - the RouterInfo to publish
    Throws:
    IllegalArgumentException - if the local router is not valid
  - purgeMatchingRouters
```
public void purgeMatchingRouters()
```
    Trigger a retroactive purge sweep of the NetDb. Bans and removes all routers matching enabled LU/XG/custom-cap bans.
  - removeBlindData
```
public boolean removeBlindData(SigningPublicKey spk)
```
    For console ConfigKeyringHelper
    Returns:
    true if removed
  - removeLeaseSetFromTracking
```
public abstract void removeLeaseSetFromTracking(Hash key)
```
    Remove a LeaseSet from refresh tracking. Call this after HostChecker completes to avoid unnecessary refreshes.
  - renderStatusHTML
```
public void renderStatusHTML(Writer out)
                      throws IOException
```
    Debug only - all user info moved to NetDbRenderer in router console
    Specified by:
    renderStatusHTML in interface Service
    Parameters:
    out - the writer to write to
    Throws:
    IOException - if an error occurs writing
  - rescan
```
public void rescan()
```
    Rescan the network database.
  - reseedChecker
```
public ReseedChecker reseedChecker()
```
  - routingKeyChanged
```
public void routingKeyChanged()
```
    Notify the netDB that the routing key changed at midnight UTC
  - setBlindData
```
public void setBlindData(BlindData bd)
```
    Cache the given BlindData for later lookup.
    Parameters:
    bd - new BlindData to put in the cache
  - store
```
public DatabaseEntry store(Hash key,
                           DatabaseEntry entry)
                    throws IllegalArgumentException
```
    Store a DatabaseEntry in the network database.
    Parameters:
    key - the key
    entry - the entry to store
    Returns:
    the old entry if it already existed at that key
    Throws:
    IllegalArgumentException - if the data is not valid
  - store
```
public abstract LeaseSet store(Hash key,
                               LeaseSet leaseSet)
                        throws IllegalArgumentException
```
    Store a LeaseSet in the network database.
    Parameters:
    key - the key
    leaseSet - the LeaseSet to store
    Returns:
    the leaseSet if another leaseSet already existed at that key
    Throws:
    IllegalArgumentException - if the data is not valid
  - store
```
public abstract RouterInfo store(Hash key,
                                 RouterInfo routerInfo)
                          throws IllegalArgumentException
```
    Store a RouterInfo in the network database.
    Parameters:
    key - the key
    routerInfo - the RouterInfo to store
    Returns:
    the routerInfo if another router already existed at that key
    Throws:
    IllegalArgumentException - if the data is not valid
  - unpublish
```
public abstract void unpublish(LeaseSet localLeaseSet)
```
    Unpublish a LeaseSet from the network database.
    Parameters:
    localLeaseSet - the LeaseSet to unpublish

Class NetworkDatabaseFacade

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.i2p.router.Service

Constructor Detail

NetworkDatabaseFacade

Method Detail

accessLeaseSet

fail

findNearestRouters

floodfillEnabled

getAllRouters

getBlindData

getBlindData

getClientLeases

getFloodfillLeases

getKnownLeaseSets

getKnownRouters

getLastRouterInfoPublishTime

getLeases

getPublishedLeases

getRouters

getUnpublishedLeases

isInitialized

isNegativeCachedForever

lookupDestination

lookupDestinationLocally

lookupLeaseSet

lookupLeaseSet

lookupLeaseSetLocally

lookupLeaseSetRemotely

lookupLeaseSetRemotely

lookupLocally

lookupLocallyWithoutValidation

lookupRouterInfo

lookupRouterInfoLocally

publish

publish

purgeMatchingRouters

removeBlindData

removeLeaseSetFromTracking

renderStatusHTML

rescan

reseedChecker

routingKeyChanged

setBlindData

store

store

store

unpublish