PersistentDataStore (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.networkdb.kademlia.TransientDataStore
- - net.i2p.router.networkdb.kademlia.PersistentDataStore

All Implemented Interfaces:
DataStore
```
public class PersistentDataStore
extends TransientDataStore
```
Persistent network database storage with disk I/O and memory management.
Writes RouterInfo entries to disk as received and periodically scans for unknown entries to load into memory. Newly discovered routers are automatically added to the routing table. Implements both flat and hierarchical directory structures for efficient file organization and access.
Public only for access to static methods by startup classes.

Field Summary
Fields
Modifier and Type Field and Description
(package private) static String DIR_PREFIX
Directory prefix for netDb files.
static FileFilter RI_FILTER
File filter for RouterInfo files.
- Fields inherited from class net.i2p.router.networkdb.kademlia.TransientDataStore
  _context, _log

Fields
Modifier and Type	Field and Description
`(package private) static String`	`DIR_PREFIX` Directory prefix for netDb files.
`static FileFilter`	`RI_FILTER` File filter for RouterInfo files.

Constructor Summary
Constructors
Constructor and Description
PersistentDataStore(RouterContext ctx, String dbDir, KademliaNetworkDatabaseFacade facade)
Creates a new persistent data store.

Constructors
Constructor and Description
`PersistentDataStore(RouterContext ctx, String dbDir, KademliaNetworkDatabaseFacade facade)` Creates a new persistent data store.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`countStoredRIs()` Count the number of RouterInfo files currently stored on disk.
`boolean`	`forcePut(Hash key, DatabaseEntry data)` Unconditionally store, bypass all newer/older checks.
`DatabaseEntry`	`get(Hash key)` The entry for the key, or null if not found.
`DatabaseEntry`	`get(Hash key, boolean persist)` Prepare for having only a partial set in memory and the rest on disk
`static File`	`getRouterInfoFile(RouterContext ctx, Hash hash)` The persistent RI file for a hash.
`(package private) static Hash`	`getRouterInfoHash(String filename)` Package private for installer BundleRouterInfos
`boolean`	`isInitialized()` Whether the data store is initialized.
`static boolean`	`isShuttingDown(RouterContext ctx)` Check if the router is in a graceful or hard shutdown state.
`boolean`	`put(Hash key, DatabaseEntry data)` Store a database entry with the given key.
`boolean`	`put(Hash key, DatabaseEntry data, boolean persist)` For PersistentDataStore only - don't use here.
`DatabaseEntry`	`remove(Hash key)` Remove and return the entry for the key.
`DatabaseEntry`	`remove(Hash key, boolean persist)` For PersistentDataStore only - don't use here.
`void`	`rescan()` No-op - the in-memory store has no external state to rescan.
`void`	`stop()` Clear the in-memory store.

Methods inherited from class net.i2p.router.networkdb.kademlia.TransientDataStore
countLeaseSets, getEntries, getKeys, getMapEntries, isKnown, size, toString

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

- Field Detail
  - DIR_PREFIX
```
static final String DIR_PREFIX
```
    Directory prefix for netDb files.
    See Also:
    Constant Field Values
  - RI_FILTER
```
public static final FileFilter RI_FILTER
```
    File filter for RouterInfo files.
- Constructor Detail
  - PersistentDataStore
```
public PersistentDataStore(RouterContext ctx,
                           String dbDir,
                           KademliaNetworkDatabaseFacade facade)
                    throws IOException
```
    Creates a new persistent data store.
    Parameters:
    ctx - the router context
    dbDir - relative path
    facade - the network database facade
    Throws:
    IOException - if the database directory cannot be created or accessed
- Method Detail
  - countStoredRIs
```
public int countStoredRIs()
```
    Count the number of RouterInfo files currently stored on disk. This includes files in subdirectories if not using flat mode.
    Returns:
    number of RI files on disk
  - forcePut
```
public boolean forcePut(Hash key,
                        DatabaseEntry data)
```
    Description copied from class: TransientDataStore
    Unconditionally store, bypass all newer/older checks.
    Specified by:
    forcePut in interface DataStore
    Overrides:
    forcePut in class TransientDataStore
    Parameters:
    key - non-null
    data - non-null
    Returns:
    success
  - get
```
public DatabaseEntry get(Hash key)
```
    Description copied from class: TransientDataStore
    The entry for the key, or null if not found.
    Specified by:
    get in interface DataStore
    Overrides:
    get in class TransientDataStore
    Parameters:
    key - the hash to look up
    Returns:
    the entry or null
  - get
```
public DatabaseEntry get(Hash key,
                         boolean persist)
```
    Prepare for having only a partial set in memory and the rest on disk
    Specified by:
    get in interface DataStore
    Overrides:
    get in class TransientDataStore
    Parameters:
    persist - if false, call super only, don't access disk
    key - the hash key to look up
    Returns:
    the database entry, or null if not found
  - getRouterInfoFile
```
public static File getRouterInfoFile(RouterContext ctx,
                                     Hash hash)
```
    The persistent RI file for a hash. This is available before the netdb subsystem is running, so we can delete our old RI.
    Parameters:
    ctx - the router context
    hash - the router hash
    Returns:
    non-null, should be absolute, does not necessarily exist
  - getRouterInfoHash
```
static Hash getRouterInfoHash(String filename)
```
    Package private for installer BundleRouterInfos
  - isInitialized
```
public boolean isInitialized()
```
    Description copied from class: TransientDataStore
    Whether the data store is initialized.
    Specified by:
    isInitialized in interface DataStore
    Overrides:
    isInitialized in class TransientDataStore
    Returns:
    whether initialized
  - isShuttingDown
```
public static boolean isShuttingDown(RouterContext ctx)
```
    Check if the router is in a graceful or hard shutdown state.
    Parameters:
    ctx - the router context
    Returns:
    true if shutdown is in progress
  - put
```
public boolean put(Hash key,
                   DatabaseEntry data)
```
    Description copied from interface: DataStore
    Store a database entry with the given key.
    Specified by:
    put in interface DataStore
    Overrides:
    put in class TransientDataStore
    Parameters:
    key - the hash key to store under
    data - must be validated before here
    Returns:
    success
  - put
```
public boolean put(Hash key,
                   DatabaseEntry data,
                   boolean persist)
```
    Description copied from class: TransientDataStore
    For PersistentDataStore only - don't use here.
    Specified by:
    put in interface DataStore
    Overrides:
    put in class TransientDataStore
    Parameters:
    key - the hash key to store under
    data - the database entry to store
    persist - if true, keep the entry in persistent storage
    Returns:
    true if the store was successful
  - remove
```
public DatabaseEntry remove(Hash key)
```
    Description copied from class: TransientDataStore
    Remove and return the entry for the key.
    Specified by:
    remove in interface DataStore
    Overrides:
    remove in class TransientDataStore
    Parameters:
    key - the hash to remove
    Returns:
    the removed entry, or null if not found
  - remove
```
public DatabaseEntry remove(Hash key,
                            boolean persist)
```
    Description copied from class: TransientDataStore
    For PersistentDataStore only - don't use here.
    Specified by:
    remove in interface DataStore
    Overrides:
    remove in class TransientDataStore
    Parameters:
    key - the hash key to remove
    persist - if true, also remove from persistent storage
    Returns:
    the removed database entry, or null if not found
  - rescan
```
public void rescan()
```
    Description copied from class: TransientDataStore
    No-op - the in-memory store has no external state to rescan.
    Specified by:
    rescan in interface DataStore
    Overrides:
    rescan in class TransientDataStore
  - stop
```
public void stop()
```
    Description copied from class: TransientDataStore
    Clear the in-memory store.
    Specified by:
    stop in interface DataStore
    Overrides:
    stop in class TransientDataStore

Class PersistentDataStore

Field Summary

Fields inherited from class net.i2p.router.networkdb.kademlia.TransientDataStore

Constructor Summary

Method Summary

Methods inherited from class net.i2p.router.networkdb.kademlia.TransientDataStore

Methods inherited from class java.lang.Object

Field Detail

DIR_PREFIX

RI_FILTER

Constructor Detail

PersistentDataStore

Method Detail

countStoredRIs

forcePut

get

get

getRouterInfoFile

getRouterInfoHash

isInitialized

isShuttingDown

put

put

remove

remove

rescan

stop