BanLogger (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

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

```
public class BanLogger
extends Object
```
Dedicated logger for all ban events. Writes to sessionbans.txt in the router's data directory.
This allows analysis of ban patterns without parsing router.log.

Constructor Summary
Constructors
Constructor and Description
BanLogger()
No-arg constructor for deferred initialization.
BanLogger(RouterContext context)
Constructor with context for immediate initialization.

Constructors
Constructor and Description
`BanLogger()` No-arg constructor for deferred initialization.
`BanLogger(RouterContext context)` Constructor with context for immediate initialization.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`archiveIfNeeded()` Archive the current log when closing.
`void`	`close()` Close the log writer and archive if there are entries.
`void`	`flush()` Flush the log writer.
`static BanLogger`	`getInstance()` Get the singleton instance of BanLogger.
`File`	`getLogFile()` Get the log file path.
`void`	`initialize(RouterContext context)` Initialize the logger.
`static boolean`	`isInitialized()` Check if the logger is initialized.
`void`	`logBan(Hash hash, RouterContext context, String reason, long durationMs)` Log a ban by hash with RouterContext (IP will be looked up from banlist).
`void`	`logBan(Hash hash, String ip, String reason, long durationMs)` Log a ban by hash with IP address.
`void`	`logBan(Hash hash, String ip, String reason, long durationMs, RouterInfo ri)` Log a ban with RouterInfo for direct caps extraction.
`void`	`logBan(String ip, String reason, long durationMs)` Log a ban by IP only (ignores hash).
`void`	`logBanForever(Hash hash, RouterContext context, String reason)` Log a permanent ban with RouterContext.
`void`	`logBanForever(Hash hash, String ip, String reason)` Log a permanent ban (forever).
`void`	`logBanForever(Hash hash, String ip, String reason, RouterInfo ri)` Log a permanent ban with RouterInfo for direct caps extraction.
`void`	`logBanForever(String ip, String reason)` Log a permanent ban by IP only.
`void`	`logBanIPOnly(String ip, String reason, long durationMs)` Log a ban by IP only (no router hash available).
`static void`	`shutdown()` Shutdown the ban logger — close the writer and release resources.

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

- Constructor Detail
  - BanLogger
```
public BanLogger()
```
    No-arg constructor for deferred initialization.
  - BanLogger
```
public BanLogger(RouterContext context)
```
    Constructor with context for immediate initialization.
    Parameters:
    context - the router context
- Method Detail
  - archiveIfNeeded
```
public void archiveIfNeeded()
```
    Archive the current log when closing. Uses the router start time to timestamp the archive.
  - close
```
public void close()
```
    Close the log writer and archive if there are entries.
  - flush
```
public void flush()
```
    Flush the log writer.
  - getInstance
```
public static BanLogger getInstance()
```
    Get the singleton instance of BanLogger. May return null if not initialized yet.
    Returns:
    the singleton instance, or null if not initialized
  - getLogFile
```
public File getLogFile()
```
    Get the log file path.
    Returns:
    the log file
  - initialize
```
public void initialize(RouterContext context)
```
    Initialize the logger. Safe to call multiple times.
    Parameters:
    context - the router context
  - isInitialized
```
public static boolean isInitialized()
```
    Check if the logger is initialized.
    Returns:
    true if initialized
  - logBan
```
public void logBan(Hash hash,
                   RouterContext context,
                   String reason,
                   long durationMs)
```
    Log a ban by hash with RouterContext (IP will be looked up from banlist).
    Parameters:
    hash - Router hash (may be null)
    context - Router context for IP lookup
    reason - Reason for the ban
    durationMs - Ban duration in milliseconds, or 0 for permanent
  - logBan
```
public void logBan(Hash hash,
                   String ip,
                   String reason,
                   long durationMs)
```
    Log a ban by hash with IP address.
    Parameters:
    hash - Router hash (may be null)
    ip - IP address with port (format: "1.2.3.4:5678" or "ipv6:port")
    reason - Reason for the ban
    durationMs - Ban duration in milliseconds, or 0 for permanent
  - logBan
```
public void logBan(Hash hash,
                   String ip,
                   String reason,
                   long durationMs,
                   RouterInfo ri)
```
    Log a ban with RouterInfo for direct caps extraction. Prefer this when the RouterInfo is available at the callsite, to avoid a NetDB lookup that may fail if the RI was never stored.
    Parameters:
    hash - Router hash (may be null)
    ip - IP address with port (format: "1.2.3.4:5678" or "ipv6:port")
    reason - Reason for the ban
    durationMs - Ban duration in milliseconds, or 0 for permanent
    ri - RouterInfo to extract capabilities from (may be null)
  - logBan
```
public void logBan(String ip,
                   String reason,
                   long durationMs)
```
    Log a ban by IP only (ignores hash).
    Parameters:
    ip - IP address with port (format: "1.2.3.4:5678" or "ipv6:port")
    reason - Reason for the ban
    durationMs - Ban duration in milliseconds, or 0 for permanent
  - logBanForever
```
public void logBanForever(Hash hash,
                          RouterContext context,
                          String reason)
```
    Log a permanent ban with RouterContext.
    Parameters:
    hash - Router hash (may be null)
    context - Router context for IP lookup
    reason - Reason for the ban
  - logBanForever
```
public void logBanForever(Hash hash,
                          String ip,
                          String reason)
```
    Log a permanent ban (forever).
    Parameters:
    hash - Router hash (may be null)
    ip - IP address with port (format: "1.2.3.4:5678" or "ipv6:port")
    reason - Reason for the ban
  - logBanForever
```
public void logBanForever(Hash hash,
                          String ip,
                          String reason,
                          RouterInfo ri)
```
    Log a permanent ban with RouterInfo for direct caps extraction.
    Parameters:
    hash - Router hash (may be null)
    ip - IP address with port (format: "1.2.3.4:5678" or "ipv6:port")
    reason - Reason for the ban
    ri - RouterInfo to extract capabilities from (may be null)
  - logBanForever
```
public void logBanForever(String ip,
                          String reason)
```
    Log a permanent ban by IP only.
    Parameters:
    ip - IP address with port (format: "1.2.3.4:5678" or "ipv6:port")
    reason - Reason for the ban
  - logBanIPOnly
```
public void logBanIPOnly(String ip,
                         String reason,
                         long durationMs)
```
    Log a ban by IP only (no router hash available). Uses "UNKNOWN" for the hash column.
    Parameters:
    ip - IP address with port (format: "1.2.3.4:5678" or "ipv6:port")
    reason - Reason for the ban
    durationMs - Ban duration in milliseconds, or 0 for permanent
  - shutdown
```
public static void shutdown()
```
    Shutdown the ban logger — close the writer and release resources. Safe to call multiple times.

Class BanLogger

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BanLogger

BanLogger

Method Detail

archiveIfNeeded

close

flush

getInstance

getLogFile

initialize

isInitialized

logBan

logBan

logBan

logBan

logBanForever

logBanForever

logBanForever

logBanForever

logBanIPOnly

shutdown