ProfilePersistenceHelper (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.peermanager.ProfilePersistenceHelper

```
class ProfilePersistenceHelper
extends Object
```
Write profiles to disk at shutdown, read at startup. The files are gzip compressed, we previously stored them with a ".dat" extension instead of ".txt.gz", so it wasn't apparent. Now migrated to a ".txt.gz" extension.

Field Summary
Fields
Modifier and Type Field and Description
static String DEFAULT_PEER_PROFILE_DIR
DEFAULT_PEER_PROFILE_DIR.
static String PROP_PEER_PROFILE_DIR
PROP_PEER_PROFILE_DIR.

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_PEER_PROFILE_DIR` DEFAULT_PEER_PROFILE_DIR.
`static String`	`PROP_PEER_PROFILE_DIR` PROP_PEER_PROFILE_DIR.

Constructor Summary
Constructors
Constructor and Description
ProfilePersistenceHelper(RouterContext ctx)
ProfilePersistenceHelper.

Constructors
Constructor and Description
`ProfilePersistenceHelper(RouterContext ctx)` ProfilePersistenceHelper.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`deleteOldProfiles(long age)` Delete profile files with timestamps older than 'age' ago
`(package private) static long`	`getLong(Properties props, String key)` Parse a long value from the properties, or 0 if missing or invalid.
`int`	`getStoredProfileCount()` Last known number of profile files on disk, from the most recent load, stale-profile cleanup, or purge.
`void`	`purgeExcessProfiles(Set<Hash> keepPeers, int maxProfiles)` Delete profile files not in 'keepPeers', if total file count > maxProfiles.
`PeerProfile`	`readProfile(File file, long cutoff)` Read and parse a single stored profile.
`List<PeerProfile>`	`readProfiles()` Load all existing profiles from the profile directory.
`void`	`setUs(Hash routerIdentHash)` Store the local router identity hash for filtering out the router's own profile.
`boolean`	`writeProfile(PeerProfile profile)` Write the data from the profile to the file
`void`	`writeProfile(PeerProfile profile, OutputStream out)` Write the data from the profile to the stream includes comments
`void`	`writeProfile(PeerProfile profile, OutputStream out, boolean addComments)` Write the data from the profile to the stream

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

- Field Detail
  - DEFAULT_PEER_PROFILE_DIR
```
public static final String DEFAULT_PEER_PROFILE_DIR
```
    DEFAULT_PEER_PROFILE_DIR.
    See Also:
    Constant Field Values
  - PROP_PEER_PROFILE_DIR
```
public static final String PROP_PEER_PROFILE_DIR
```
    PROP_PEER_PROFILE_DIR.
    See Also:
    Constant Field Values
- Constructor Detail
  - ProfilePersistenceHelper
```
public ProfilePersistenceHelper(RouterContext ctx)
```
    ProfilePersistenceHelper.
- Method Detail
  - deleteOldProfiles
```
public int deleteOldProfiles(long age)
```
    Delete profile files with timestamps older than 'age' ago
    Returns:
    number deleted
  - getLong
```
static long getLong(Properties props,
                    String key)
```
    Parse a long value from the properties, or 0 if missing or invalid.
    Returns:
    the long value or 0
  - getStoredProfileCount
```
public int getStoredProfileCount()
```
    Last known number of profile files on disk, from the most recent load, stale-profile cleanup, or purge.
    Returns:
    the stored profile count, 0 if the store has never been scanned
  - purgeExcessProfiles
```
public void purgeExcessProfiles(Set<Hash> keepPeers,
                                int maxProfiles)
```
    Delete profile files not in 'keepPeers', if total file count > maxProfiles. Deletes oldest or least relevant first (based on file mtime if no RouterInfo). Prioritizes deletion: Tier 3 (Gossip) > Tier 2 (Passive) > Tier 1 (Active). Tier 1 profiles are protected and only deleted as absolute last resort.
  - readProfile
```
public PeerProfile readProfile(File file,
                               long cutoff)
```
    Read and parse a single stored profile.
    Parameters:
    cutoff - delete and return null if older than this (absolute time)
  - readProfiles
```
public List<PeerProfile> readProfiles()
```
    Load all existing profiles from the profile directory.
  - setUs
```
public void setUs(Hash routerIdentHash)
```
    Store the local router identity hash for filtering out the router's own profile.
  - writeProfile
```
public boolean writeProfile(PeerProfile profile)
```
    Write the data from the profile to the file
    Returns:
    success
  - writeProfile
```
public void writeProfile(PeerProfile profile,
                         OutputStream out)
                  throws IOException
```
    Write the data from the profile to the stream includes comments
    Throws:
    IOException
  - writeProfile
```
public void writeProfile(PeerProfile profile,
                         OutputStream out,
                         boolean addComments)
                  throws IOException
```
    Write the data from the profile to the stream
    Parameters:
    addComments - add comment lines to the output
    Throws:
    IOException

Class ProfilePersistenceHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PEER_PROFILE_DIR

PROP_PEER_PROFILE_DIR

Constructor Detail

ProfilePersistenceHelper

Method Detail

deleteOldProfiles

getLong

getStoredProfileCount

purgeExcessProfiles

readProfile

readProfiles

setUs

writeProfile

writeProfile

writeProfile