I2PSnarkUtil (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- org.klomp.snark.I2PSnarkUtil

All Implemented Interfaces:
I2PSocketManager.DisconnectListener
```
public class I2PSnarkUtil
extends Object
implements I2PSocketManager.DisconnectListener
```
I2P-specific utilities and context management for I2PSnark.
This class provides I2P network integration and serves as a context object for I2PSnark operations. It handles:
- I2P socket management and connection configuration
- Proxy settings for external tracker communication
- Peer banlist management
- Bandwidth and connection limits
- DHT integration and UDP tracker support
- File and directory management
- UI preferences and display options
- Comments and ratings system configuration
This class acts as a singleton-like context that allows multiple individual Snark instances to run while sharing common I2P configuration and resources. Note that while multiple Snarks can share one I2PSnarkUtil instance, multiple SnarkManagers are not supported due to static resources.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_COLLAPSE_PANELS`
`static boolean`	`DEFAULT_ENABLE_ADDCREATE`
`static boolean`	`DEFAULT_ENABLE_LIGHTBOX`
`static boolean`	`DEFAULT_SHOW_STATUSFILTER`
`static boolean`	`DEFAULT_USE_DHT`
`static boolean`	`DEFAULT_USE_OPENTRACKERS`
`static boolean`	`DEFAULT_VARY_INBOUND_HOPS`
`static boolean`	`DEFAULT_VARY_OUTBOUND_HOPS`
`static String`	`EEPGET_USER_AGENT` User agent for eepget requests.
`static int`	`MAX_CONNECTIONS`
`static String`	`PROP_CLIENT_ID` Client identity spoofing setting: empty (default, identify as I2PSnark), "random" to pick a random known client profile per destination per run, or the name of a known client to always impersonate it.
`static String`	`PROP_CLIENT_IDS` Optional comma-separated subset of client names to choose from when `PROP_CLIENT_ID` is "random"; unknown names are ignored.
`static String`	`PROP_MAX_BW` Bandwidth throttle property.

Constructor Summary

Constructors
Constructor and Description
`I2PSnarkUtil(I2PAppContext ctx)`
`I2PSnarkUtil(I2PAppContext ctx, String baseName, I2PSocketManager.DisconnectListener discon)` Create a utility instance bound to the given context.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`banPeer(Hash h, long period)` Ban the given destination hash for the given period.
`boolean`	`collapsePanels()`
`boolean`	`commentsEnabled()`
`boolean`	`connect()` Connect to the router, if we aren't already
`(package private) I2PSocket`	`connect(PeerID peer)` Connect to the given destination
`(package private) I2PSocket`	`connect(PeerID peer, byte[] ih)` Connect to the given destination through the torrent's own destination, or the shared destination if multi-dest is disabled or the torrent has no destination yet.
`boolean`	`connected()`
`void`	`disconnect()` Destroy the destination itself
`boolean`	`enableAddCreate()`
`boolean`	`enableLightbox()`
`boolean`	`enableVaryInboundHops()`
`boolean`	`enableVaryOutboundHops()`
`File`	`get(String url)` Fetch the given URL, returning the file it is stored in, or null on error.
`File`	`get(String url, boolean rewrite)` Fetch the given URL to a file.
`File`	`get(String url, boolean rewrite, int retries)` Fetch the given URL to a file.
`File`	`get(String url, boolean rewrite, int retries, byte[] ih)` Fetch the given URL through the torrent's own destination.
`byte[]`	`get(String url, boolean rewrite, int retries, int initialSize, int maxSize)` Fetch to memory
`byte[]`	`get(String url, boolean rewrite, int retries, int initialSize, int maxSize, byte[] ih)` Fetch to memory through the torrent's own destination.
`File`	`get(String url, int retries)` Fetch the given URL to a file.
`String`	`getAPIKey()` The API key, or null if not set.
`String`	`getAPITarget()` The API target base path.
`List<String>`	`getBackupTrackers()` List of open tracker announce URLs to use as backups even if disabled
`long`	`getBanDiscardPeriod()` Duration of the ban applied to peers with an excessive discard ratio.
`ClientID.Profile`	`getClientID(byte[] ih)` The spoofed client identity for the torrent's destination, or null when identifying as I2PSnark.
`String`	`getCommentsName()` The comments file name.
`I2PAppContext`	`getContext()` The context this utility is bound to.
`(package private) Destination`	`getDestination(String ip)` Base64 Hash or Hash.i2p or name.i2p using naming service
`(package private) static Destination`	`getDestinationFromBase64(String ip)` Resolves a base64-encoded destination string.
`DHT`	`getDHT()` The main DHT instance, or null if disabled or not started.
`DHT`	`getDHTForTorrent(byte[] ih)` The DHT instance for the torrent, on the torrent's own destination, or the shared DHT instance when multi-dest is disabled or the DHT is disabled.
`String`	`getEepProxyHost()` The EepProxy host configured.
`int`	`getEepProxyPort()` The EepProxy port configured.
`boolean`	`getEepProxySet()` Whether an EepProxy is configured.
`boolean`	`getFilesPublic()` Whether files in the data directory are world-readable.
`String`	`getI2CPHost()` The I2CP host configured.
`Map<String,String>`	`getI2CPOptions()` A copy of the I2CP options.
`int`	`getI2CPPort()` The I2CP port configured.
`int`	`getMaxConnections()` The maximum number of connections per torrent.
`int`	`getMaxDest()` The maximum number of per-torrent destinations in multi-dest mode, 0 for one destination per torrent.
`int`	`getMaxFilesPerTorrent()` Maximum number of files a torrent may contain.
`int`	`getMaxUpBW()` The maximum upload bandwidth per torrent.
`int`	`getMaxUploaders()` The maximum number of uploaders per torrent.
`boolean`	`getMultiDest()` Whether each torrent runs on its own destination.
`(package private) Destination`	`getMyDestination()` The shared destination.
`(package private) Destination`	`getMyDestination(byte[] ih)` The destination for the torrent, or the shared destination when multi-dest is disabled or the torrent has no destination.
`(package private) static String`	`getNickname(String name)` The tunnel nickname for a torrent's destination, "I2PSnark - <name>" with the name reduced to just the content title, truncated to `MAX_NAME_LENGTH` characters plus an ellipsis.
`List<String>`	`getOpenTrackers()` List of open tracker announce URLs to use as backups
`TorrentDest`	`getOrCreateTorrentDest(String key, String name)` The destination for a torrent, creating the destination and session on first use, or assigning the torrent to a shared pool when the configured maximum number of destinations is exceeded.
`String`	`getOurIPString()` Full Base64 of the Destination.
`String`	`getOurIPString(byte[] ih)` Full Base64 of the destination for the torrent.
`int`	`getPoolIndex(byte[] ih)` Pool index that would be assigned to the torrent, -1 when pooling is off.
`(package private) static String`	`getPoolNickname(int poolNum)` Tunnel nickname for a shared pool, "I2PSnark - Pool <n>", with the pool's member names carried in the i2psnark.poolMembers session property for the pool tooltip.
`boolean`	`getPreallocateFiles()` Whether new torrents preallocate their storage files.
`I2PServerSocket`	`getServerSocket()` The shared server socket.
`I2PServerSocket`	`getServerSocket(byte[] ih)` The server socket for the torrent's destination, or the shared server socket when multi-dest is disabled or the torrent has no destination.
`boolean`	`getShouldPadFiles()` Whether BEP 47 padding files are added to new torrents created by I2PSnark, so each file except the last ends on a piece boundary.
`I2PSocketManager`	`getSocketManager()` For FetchAndAdd
`I2PSocketManager`	`getSocketManager(byte[] ih)` The socket manager for the torrent's destination, or the shared manager when multi-dest is disabled or the torrent has no destination.
`long`	`getStartedTime()` When did we connect to the network? For RPC
`int`	`getStartupDelayMax()` The maximum startup delay in minutes.
`int`	`getStartupDelayMin()` The minimum startup delay in minutes.
`String`	`getString(int n, String s, String p)` A translated plural string for the given count.
`String`	`getString(String key)` A translated string for the given key.
`String`	`getString(String s, Object o)` Translate a string with a parameter This is a lot more expensive than getString(s, ctx), so use sparingly.
`String`	`getString(String s, Object o, Object o2)` {0} and {1}
`File`	`getTempDir()` The temporary directory used for downloads in progress.
`String`	`getTempDirProp()` The staging directory configured via `i2psnark.tempDir` in i2psnark.config, or null if the staging feature is disabled.
`Collection<TorrentDest>`	`getTorrentDests()` All active transient destinations, for the tunnel quantity ramp in the IdleChecker.
`int[]`	`getTunnelCounts()` The inbound and outbound tunnel counts allocated to our sessions, summed over the primary session and all per-torrent destinations, so both grow with the number of sessions in multi-dest mode.
`UDPTrackerClient`	`getUDPTrackerClient()` The shared UDP tracker client, or null if disabled or not started.
`UDPTrackerClient`	`getUDPTrackerClient(byte[] ih)` The UDP tracker client for the torrent's destination, or the shared client when the torrent has no destination.
`String`	`getUserAgent(byte[] ih)` The HTTP User-Agent to send for the torrent's requests: the spoofed profile's UA when spoofing is on, else the default I2PSnark UA.
`boolean`	`getVaryInboundHops()` Whether hops are randomly varied for inbound torrent tunnels.
`boolean`	`getVaryOutboundHops()` Whether hops are randomly varied for outbound torrent tunnels.
`boolean`	`hasAPIKey()` Whether both an API target and key are configured.
`boolean`	`isBanDiscardRatio()` Whether to disconnect peers that cancel most of what they request.
`boolean`	`isBanned(Hash h)` Is the given destination hash banned?
`boolean`	`isConnecting()` Whether an I2CP connection attempt is in progress.
`boolean`	`isKnownOpenTracker(String url)` Is this announce URL probably for an open tracker?
`(package private) static void`	`loadProps(Properties props, File f)` Same as DataHelper.loadProps() but allows '#' in values, so we can have filenames with '#' in them in torrent config files.
`String`	`lookup(String name)` Look up a destination by name.
`static int`	`parseInt(String s, int dflt)` Parse an int, returning the default on null or parse failure.
`static long`	`parseLong(String s, long dflt)` Parse a long, returning the default on null or parse failure.
`boolean`	`ratingsEnabled()`
`void`	`removeAllTorrentDests()` Destroy all transient destinations.
`void`	`removeTorrentDest(String key)` Remove and destroy the destination for a torrent, destroying a pooled destination only when its last torrent is removed.
`(package private) String`	`rewriteAnnounce(String origAnnounce)` Given http://KEY.i2p/foo/announce turn it into http://i2p/KEY/foo/announce Given http://tracker.blah.i2p/foo/announce leave it alone
`void`	`sessionDisconnected()` Handle the I2CP session being disconnected, dropping the manager reference.
`void`	`setAPI(String target, String key)` Configure the API target and key.
`void`	`setBanDiscardPeriod(long period)` Set the duration of the ban applied to peers with an excessive discard ratio.
`void`	`setBanDiscardRatio(boolean ban)` Whether to disconnect peers that cancel most of what they request.
`void`	`setClientId(String setting)` Client identity spoofing.
`void`	`setClientIdCandidates(List<ClientID.Profile> candidates)` Restrict the candidate set for random client selection.
`void`	`setCollapsePanels(boolean yes)`
`void`	`setCommentsEnabled(boolean yes)`
`void`	`setCommentsName(String name)`
`void`	`setEnableAddCreate(boolean yes)`
`void`	`setEnableLightbox(boolean yes)`
`void`	`setEnableVaryInboundHops(boolean yes)`
`void`	`setEnableVaryOutboundHops(boolean yes)`
`void`	`setFilesPublic(boolean yes)` Whether files in the data directory are world-readable.
`void`	`setI2CPConfig(String i2cpHost, int i2cpPort, Map opts)` Configure the I2CP connection parameters.
`void`	`setMaxConnections(int limit)`
`void`	`setMaxDest(int maxDest)` Configure the maximum number of per-torrent destinations, 0-1000; zero is unlimited.
`void`	`setMaxFilesPerTorrent(int max)` Maximum number of files a torrent may contain.
`void`	`setMaxUpBW(int limit)` This updates ALL the session options (not just the bw) and tells the router
`void`	`setMaxUploaders(int limit)`
`void`	`setMultiDest(boolean multiDest)`
`void`	`setOpenTrackers(List<String> ot)` Configure the open tracker announce URLs to use as backups.
`void`	`setPreallocateFiles(boolean yes)` Whether new torrents preallocate their storage files.
`void`	`setRatingsEnabled(boolean yes)`
`void`	`setShouldPadFiles(boolean yes)` Sets whether BEP 47 padding files are added to new torrents.
`void`	`setShowStatusFilter(boolean yes)`
`void`	`setStartupDelayMax(int minutes)`
`void`	`setStartupDelayMin(int minutes)`
`void`	`setTempDirProp(String tempDir)` Sets the staging directory (or null to disable the feature).
`void`	`setUDPEnabled(boolean yes)`
`void`	`setUseDHT(boolean yes)`
`void`	`setUseOpenTrackers(boolean yes)`
`void`	`setVaryInboundHops(boolean yes)` Whether hops are randomly varied for inbound torrent tunnels.
`void`	`setVaryOutboundHops(boolean yes)`
`boolean`	`shouldUseDHT()` Whether the DHT is used.
`boolean`	`shouldUseOpenTrackers()` Whether open trackers are used as backups.
`boolean`	`showStatusFilter()`
`(package private) static void`	`storeProps(Properties props, File file)` Same as DataHelper.loadProps() but allows '#' in values, so we can have filenames with '#' in them in torrent config files.
`static String`	`toHex(byte[] b)` Like DataHelper.toHexString but ensures no loss of leading zero bytes
`static String`	`trackerB32ToHostname(String url)` Replace known base32 and base64 tracker hosts with their symbolic names, and strip the leading scheme, for display purposes.
`boolean`	`udpEnabled()`
`boolean`	`utCommentsEnabled()`

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

- Field Detail
  - DEFAULT_COLLAPSE_PANELS
```
public static final boolean DEFAULT_COLLAPSE_PANELS
```
    See Also:
    Constant Field Values
  - DEFAULT_ENABLE_ADDCREATE
```
public static final boolean DEFAULT_ENABLE_ADDCREATE
```
    See Also:
    Constant Field Values
  - DEFAULT_ENABLE_LIGHTBOX
```
public static final boolean DEFAULT_ENABLE_LIGHTBOX
```
    See Also:
    Constant Field Values
  - DEFAULT_SHOW_STATUSFILTER
```
public static final boolean DEFAULT_SHOW_STATUSFILTER
```
    See Also:
    Constant Field Values
  - DEFAULT_USE_DHT
```
public static final boolean DEFAULT_USE_DHT
```
    See Also:
    Constant Field Values
  - DEFAULT_USE_OPENTRACKERS
```
public static final boolean DEFAULT_USE_OPENTRACKERS
```
    See Also:
    Constant Field Values
  - DEFAULT_VARY_INBOUND_HOPS
```
public static final boolean DEFAULT_VARY_INBOUND_HOPS
```
    See Also:
    Constant Field Values
  - DEFAULT_VARY_OUTBOUND_HOPS
```
public static final boolean DEFAULT_VARY_OUTBOUND_HOPS
```
    See Also:
    Constant Field Values
  - EEPGET_USER_AGENT
```
public static final String EEPGET_USER_AGENT
```
    User agent for eepget requests.
    See Also:
    Constant Field Values
  - MAX_CONNECTIONS
```
public static final int MAX_CONNECTIONS
```
    See Also:
    Constant Field Values
  - PROP_CLIENT_ID
```
public static final String PROP_CLIENT_ID
```
    Client identity spoofing setting: empty (default, identify as I2PSnark), "random" to pick a random known client profile per destination per run, or the name of a known client to always impersonate it.
    See Also:
    Constant Field Values
  - PROP_CLIENT_IDS
```
public static final String PROP_CLIENT_IDS
```
    Optional comma-separated subset of client names to choose from when PROP_CLIENT_ID is "random"; unknown names are ignored.
    See Also:
    Constant Field Values
  - PROP_MAX_BW
```
public static final String PROP_MAX_BW
```
    Bandwidth throttle property.
    See Also:
    Constant Field Values
- Constructor Detail
  - I2PSnarkUtil
```
public I2PSnarkUtil(I2PAppContext ctx)
```
  - I2PSnarkUtil
```
public I2PSnarkUtil(I2PAppContext ctx,
                    String baseName,
                    I2PSocketManager.DisconnectListener discon)
```
    Create a utility instance bound to the given context.
    Parameters:
    baseName - generally "i2psnark"
- Method Detail
  - banPeer
```
public void banPeer(Hash h,
                    long period)
```
    Ban the given destination hash for the given period. Does not remove any existing ban of the same hash.
    Parameters:
    h - the hash
    period - the ban period in milliseconds
  - collapsePanels
```
public boolean collapsePanels()
```
  - commentsEnabled
```
public boolean commentsEnabled()
```
  - connect
```
public boolean connect()
```
    Connect to the router, if we aren't already
  - connect
```
I2PSocket connect(PeerID peer)
           throws IOException
```
    Connect to the given destination
    Throws:
    IOException
  - connect
```
I2PSocket connect(PeerID peer,
                  byte[] ih)
           throws IOException
```
    Connect to the given destination through the torrent's own destination, or the shared destination if multi-dest is disabled or the torrent has no destination yet.
    Parameters:
    ih - the torrent's info hash
    Throws:
    IOException
  - connected
```
public boolean connected()
```
  - disconnect
```
public void disconnect()
```
    Destroy the destination itself
  - enableAddCreate
```
public boolean enableAddCreate()
```
  - enableLightbox
```
public boolean enableLightbox()
```
  - enableVaryInboundHops
```
public boolean enableVaryInboundHops()
```
  - enableVaryOutboundHops
```
public boolean enableVaryOutboundHops()
```
  - get
```
public File get(String url)
```
    Fetch the given URL, returning the file it is stored in, or null on error. No retries.
  - get
```
public File get(String url,
                boolean rewrite)
```
    Fetch the given URL to a file.
    Parameters:
    rewrite - if true, convert http://KEY.i2p/foo/announce to http://i2p/KEY/foo/announce
    Returns:
    the file it is stored in, or null on error
  - get
```
public File get(String url,
                boolean rewrite,
                int retries)
```
    Fetch the given URL to a file.
    Parameters:
    rewrite - if true, convert http://KEY.i2p/foo/announce to http://i2p/KEY/foo/announce
    retries - if > 0, set timeout to a few seconds
    Returns:
    the file it is stored in, or null on error
  - get
```
public File get(String url,
                boolean rewrite,
                int retries,
                byte[] ih)
```
    Fetch the given URL through the torrent's own destination.
    Parameters:
    ih - the torrent's info hash
    retries - if > 0, set timeout to a few seconds
    Returns:
    the file it is stored in, or null on error
  - get
```
public byte[] get(String url,
                  boolean rewrite,
                  int retries,
                  int initialSize,
                  int maxSize)
```
    Fetch to memory
    Parameters:
    retries - if < 0, set timeout to a few seconds
    initialSize - buffer size
    maxSize - fails if greater
    Returns:
    null on error
  - get
```
public byte[] get(String url,
                  boolean rewrite,
                  int retries,
                  int initialSize,
                  int maxSize,
                  byte[] ih)
```
    Fetch to memory through the torrent's own destination.
    Parameters:
    retries - if < 0, set timeout to a few seconds
    initialSize - buffer size
    maxSize - fails if greater
    ih - the torrent's info hash
    Returns:
    null on error or if the torrent has no destination
  - get
```
public File get(String url,
                int retries)
```
    Fetch the given URL to a file.
    Parameters:
    retries - if > 0, set timeout to a few seconds
    Returns:
    the file it is stored in, or null on error
  - getAPIKey
```
public String getAPIKey()
```
    The API key, or null if not set.
    Returns:
    the a p i key
  - getAPITarget
```
public String getAPITarget()
```
    The API target base path.
    Returns:
    the a p i target
  - getBackupTrackers
```
public List<String> getBackupTrackers()
```
    List of open tracker announce URLs to use as backups even if disabled
    Returns:
    non-null
  - getBanDiscardPeriod
```
public long getBanDiscardPeriod()
```
    Duration of the ban applied to peers with an excessive discard ratio.
    Returns:
    the ban period in milliseconds
  - getClientID
```
public ClientID.Profile getClientID(byte[] ih)
```
    The spoofed client identity for the torrent's destination, or null when identifying as I2PSnark. All torrents sharing a destination share one identity: a single profile per run when multi-dest is off, one profile per pool index otherwise, and one profile per torrent for dedicated destinations. With no i2psnark.clientId configured, multi-dest pools get random profiles by default and single-dest mode keeps the classic I2PSnark identity.
    Parameters:
    ih - the torrent's info hash, or null
    Returns:
    the profile, or null for no spoofing
  - getCommentsName
```
public String getCommentsName()
```
    The comments file name.
    Returns:
    non-null, "" if none
  - getContext
```
public I2PAppContext getContext()
```
    The context this utility is bound to.
    Returns:
    the context
  - getDestination
```
Destination getDestination(String ip)
```
    Base64 Hash or Hash.i2p or name.i2p using naming service
  - getDestinationFromBase64
```
static Destination getDestinationFromBase64(String ip)
```
    Resolves a base64-encoded destination string. Does not use naming service.
    Parameters:
    ip - destination string, with or without .i2p suffix
    Returns:
    the Destination, or null if parsing fails
  - getDHT
```
public DHT getDHT()
```
    The main DHT instance, or null if disabled or not started.
    Returns:
    null if disabled or not started
  - getDHTForTorrent
```
public DHT getDHTForTorrent(byte[] ih)
```
    The DHT instance for the torrent, on the torrent's own destination, or the shared DHT instance when multi-dest is disabled or the DHT is disabled.
    Parameters:
    ih - the torrent's info hash
    Returns:
    the DHT instance
  - getEepProxyHost
```
public String getEepProxyHost()
```
    The EepProxy host configured.
    Returns:
    the eep proxy host
  - getEepProxyPort
```
public int getEepProxyPort()
```
    The EepProxy port configured.
    Returns:
    the eep proxy port
  - getEepProxySet
```
public boolean getEepProxySet()
```
    Whether an EepProxy is configured.
    Returns:
    the eep proxy set
  - getFilesPublic
```
public boolean getFilesPublic()
```
    Whether files in the data directory are world-readable.
    Returns:
    the files public
  - getI2CPHost
```
public String getI2CPHost()
```
    The I2CP host configured.
    Returns:
    the i2 c p host
  - getI2CPOptions
```
public Map<String,String> getI2CPOptions()
```
    A copy of the I2CP options.
    Returns:
    a copy
  - getI2CPPort
```
public int getI2CPPort()
```
    The I2CP port configured.
    Returns:
    the i2 c p port
  - getMaxConnections
```
public int getMaxConnections()
```
    The maximum number of connections per torrent.
    Returns:
    the max connections
  - getMaxDest
```
public int getMaxDest()
```
    The maximum number of per-torrent destinations in multi-dest mode, 0 for one destination per torrent.
    Returns:
    the maximum number of per-torrent destinations
  - getMaxFilesPerTorrent
```
public int getMaxFilesPerTorrent()
```
    Maximum number of files a torrent may contain.
    Returns:
    the max files per torrent
  - getMaxUpBW
```
public int getMaxUpBW()
```
    The maximum upload bandwidth per torrent.
    Returns:
    KBps
  - getMaxUploaders
```
public int getMaxUploaders()
```
    The maximum number of uploaders per torrent.
    Returns:
    the max uploaders
  - getMultiDest
```
public boolean getMultiDest()
```
    Whether each torrent runs on its own destination.
  - getMyDestination
```
Destination getMyDestination()
```
    The shared destination.
    Returns:
    dest or null
  - getMyDestination
```
Destination getMyDestination(byte[] ih)
```
    The destination for the torrent, or the shared destination when multi-dest is disabled or the torrent has no destination.
    Parameters:
    ih - the torrent's info hash
    Returns:
    the destination
  - getNickname
```
static String getNickname(String name)
```
    The tunnel nickname for a torrent's destination, "I2PSnark - <name>" with the name reduced to just the content title, truncated to MAX_NAME_LENGTH characters plus an ellipsis. Parentheses and brackets with anything inside them (year, resolution, release group), a metadata tail after the first dash, file extensions and common quality tokens (resolution, codec, source) are removed, so the nickname is shorter and the title stands out on the console's tunnels page. Local only; not shared with trackers or the DHT.
    Parameters:
    name - the torrent name
    Returns:
    the nickname
  - getOpenTrackers
```
public List<String> getOpenTrackers()
```
    List of open tracker announce URLs to use as backups
    Returns:
    non-null, possibly unmodifiable, empty if disabled
  - getOrCreateTorrentDest
```
public TorrentDest getOrCreateTorrentDest(String key,
                                          String name)
```
    The destination for a torrent, creating the destination and session on first use, or assigning the torrent to a shared pool when the configured maximum number of destinations is exceeded. Only used when multi-dest is enabled.
    Parameters:
    key - Base64 encoding of the torrent's info hash
    name - torrent name, used in the tunnel nickname
    Returns:
    the destination, or null if the session could not be created
  - getOurIPString
```
public String getOurIPString()
```
    Full Base64 of the Destination.
    Returns:
    the our i p string
  - getOurIPString
```
public String getOurIPString(byte[] ih)
```
    Full Base64 of the destination for the torrent.
    Returns:
    the destination string, or the shared destination string
  - getPoolIndex
```
public int getPoolIndex(byte[] ih)
```
    Pool index that would be assigned to the torrent, -1 when pooling is off. Deterministic within a run, so batch starts can compute pool membership up front; matches the assignment in getOrCreateTorrentDest().
    Parameters:
    ih - the torrent's info hash, or null
    Returns:
    the pool index in [0, _maxDest), or -1 for a dedicated destination
  - getPoolNickname
```
static String getPoolNickname(int poolNum)
```
    Tunnel nickname for a shared pool, "I2PSnark - Pool <n>", with the pool's member names carried in the i2psnark.poolMembers session property for the pool tooltip. Single-torrent pools keep their torrent's nickname instead; this is applied by TorrentDest only when a second torrent joins the pool.
    Parameters:
    poolNum - the sequential pool number, assigned when the pool destination was created
    Returns:
    the nickname
  - getPreallocateFiles
```
public boolean getPreallocateFiles()
```
    Whether new torrents preallocate their storage files.
    Returns:
    the preallocate files
  - getServerSocket
```
public I2PServerSocket getServerSocket()
```
    The shared server socket.
    Returns:
    the server socket
  - getServerSocket
```
public I2PServerSocket getServerSocket(byte[] ih)
```
    The server socket for the torrent's destination, or the shared server socket when multi-dest is disabled or the torrent has no destination.
    Parameters:
    ih - the torrent's info hash
    Returns:
    the server socket
  - getShouldPadFiles
```
public boolean getShouldPadFiles()
```
    Whether BEP 47 padding files are added to new torrents created by I2PSnark, so each file except the last ends on a piece boundary. Set by SnarkManager when the config is loaded or re-read; consumed by Storage when creating torrents.
  - getSocketManager
```
public I2PSocketManager getSocketManager()
```
    For FetchAndAdd
    Returns:
    null if not connected
  - getSocketManager
```
public I2PSocketManager getSocketManager(byte[] ih)
```
    The socket manager for the torrent's destination, or the shared manager when multi-dest is disabled or the torrent has no destination.
    Parameters:
    ih - the torrent's info hash
    Returns:
    the socket manager
  - getStartedTime
```
public long getStartedTime()
```
    When did we connect to the network? For RPC
    Returns:
    0 if not connected
  - getStartupDelayMax
```
public int getStartupDelayMax()
```
    The maximum startup delay in minutes.
    Returns:
    the maximum startup delay
  - getStartupDelayMin
```
public int getStartupDelayMin()
```
    The minimum startup delay in minutes.
    Returns:
    the minimum startup delay
  - getString
```
public String getString(int n,
                        String s,
                        String p)
```
    A translated plural string for the given count.
    Parameters:
    n - the count, selects singular or plural form
    s - the singular form
    p - the plural form
    Returns:
    the translated string
  - getString
```
public String getString(String key)
```
    A translated string for the given key.
    Returns:
    the translated string, in the routerconsole.lang property if set, else the current locale
  - getString
```
public String getString(String s,
                        Object o)
```
    Translate a string with a parameter This is a lot more expensive than getString(s, ctx), so use sparingly.
    Parameters:
    s - string to be translated containing {0} The {0} will be replaced by the parameter. Single quotes must be doubled, i.e. ' -> '' in the string.
    o - parameter, not translated. To translate parameter also, use _t("foo {0} bar", _t("baz")) Do not double the single quotes in the parameter. Use autoboxing to call with ints, longs, floats, etc.
    Returns:
    the string
  - getString
```
public String getString(String s,
                        Object o,
                        Object o2)
```
    {0} and {1}
  - getTempDir
```
public File getTempDir()
```
    The temporary directory used for downloads in progress.
    Returns:
    the temp dir
  - getTempDirProp
```
public String getTempDirProp()
```
    The staging directory configured via i2psnark.tempDir in i2psnark.config, or null if the staging feature is disabled. Set by SnarkManager at startup and from the I2PSnark configuration page; consumed by Storage.
    Returns:
    the staging directory, or null
  - getTorrentDests
```
public Collection<TorrentDest> getTorrentDests()
```
    All active transient destinations, for the tunnel quantity ramp in the IdleChecker.
  - getTunnelCounts
```
public int[] getTunnelCounts()
```
    The inbound and outbound tunnel counts allocated to our sessions, summed over the primary session and all per-torrent destinations, so both grow with the number of sessions in multi-dest mode. Inbound tunnels are counted exactly as the number of leases in each session's current lease set, one lease per allocated inbound tunnel. Outbound tunnels are not visible to an I2CP client, so the count is the effective outbound.quantity configured for each session, which this application assigns dynamically (build options and the IdleChecker ramp) and the router maintains as the session's outbound pool. Counts are zero before the sessions are connected.
    Returns:
    int[] of {inbound, outbound}, never null
  - getUDPTrackerClient
```
public UDPTrackerClient getUDPTrackerClient()
```
    The shared UDP tracker client, or null if disabled or not started.
    Returns:
    null if disabled or not started
  - getUDPTrackerClient
```
public UDPTrackerClient getUDPTrackerClient(byte[] ih)
```
    The UDP tracker client for the torrent's destination, or the shared client when the torrent has no destination.
    Parameters:
    ih - the torrent's info hash
    Returns:
    the UDP tracker client
  - getUserAgent
```
public String getUserAgent(byte[] ih)
```
    The HTTP User-Agent to send for the torrent's requests: the spoofed profile's UA when spoofing is on, else the default I2PSnark UA.
    Parameters:
    ih - the torrent's info hash, or null
    Returns:
    the User-Agent string, never null
  - getVaryInboundHops
```
public boolean getVaryInboundHops()
```
    Whether hops are randomly varied for inbound torrent tunnels.
    Returns:
    the vary inbound hops
  - getVaryOutboundHops
```
public boolean getVaryOutboundHops()
```
    Whether hops are randomly varied for outbound torrent tunnels.
    Returns:
    the vary outbound hops
  - hasAPIKey
```
public boolean hasAPIKey()
```
    Whether both an API target and key are configured.
    Returns:
    whether a p i key is present
  - isBanDiscardRatio
```
public boolean isBanDiscardRatio()
```
    Whether to disconnect peers that cancel most of what they request.
    Returns:
    true if the discard-ratio auto-ban is enabled
  - isBanned
```
public boolean isBanned(Hash h)
```
    Is the given destination hash banned?
    Parameters:
    h - the hash
    Returns:
    true if banned
  - isConnecting
```
public boolean isConnecting()
```
    Whether an I2CP connection attempt is in progress.
    Returns:
    whether connecting
  - isKnownOpenTracker
```
public boolean isKnownOpenTracker(String url)
```
    Is this announce URL probably for an open tracker?
    Returns:
    whether known open tracker
  - loadProps
```
static void loadProps(Properties props,
                      File f)
               throws IOException
```
    Same as DataHelper.loadProps() but allows '#' in values, so we can have filenames with '#' in them in torrent config files. '#' must be in column 1 for a comment.
    Throws:
    IOException
  - lookup
```
public String lookup(String name)
```
    Look up a destination by name. Uses naming service for .i2p names, raw base64 otherwise.
    Parameters:
    name - hostname or base64 destination
    Returns:
    the base64-encoded destination, or null if not found
  - parseInt
```
public static int parseInt(String s,
                           int dflt)
```
    Parse an int, returning the default on null or parse failure.
    Parameters:
    s - may be null
    dflt - returned on failure
  - parseLong
```
public static long parseLong(String s,
                             long dflt)
```
    Parse a long, returning the default on null or parse failure.
    Parameters:
    s - may be null
    dflt - returned on failure
  - ratingsEnabled
```
public boolean ratingsEnabled()
```
  - removeAllTorrentDests
```
public void removeAllTorrentDests()
```
    Destroy all transient destinations. Called on shutdown.
  - removeTorrentDest
```
public void removeTorrentDest(String key)
```
    Remove and destroy the destination for a torrent, destroying a pooled destination only when its last torrent is removed.
  - rewriteAnnounce
```
String rewriteAnnounce(String origAnnounce)
```
    Given http://KEY.i2p/foo/announce turn it into http://i2p/KEY/foo/announce Given http://tracker.blah.i2p/foo/announce leave it alone
  - sessionDisconnected
```
public void sessionDisconnected()
```
    Handle the I2CP session being disconnected, dropping the manager reference.
    Specified by:
    sessionDisconnected in interface I2PSocketManager.DisconnectListener
  - setAPI
```
public void setAPI(String target,
                   String key)
```
    Configure the API target and key.
    Parameters:
    target - the API target base path
    key - the API key
  - setBanDiscardPeriod
```
public void setBanDiscardPeriod(long period)
```
    Set the duration of the ban applied to peers with an excessive discard ratio.
    Parameters:
    period - the ban period in milliseconds
  - setBanDiscardRatio
```
public void setBanDiscardRatio(boolean ban)
```
    Whether to disconnect peers that cancel most of what they request.
    Parameters:
    ban - true to enable the discard-ratio auto-ban
  - setClientId
```
public void setClientId(String setting)
```
    Client identity spoofing. Empty (default): random known client profiles per pool in multi-dest mode, classic I2PSnark identity otherwise. "random": random profiles in all modes. "i2psnark": classic identity even in multi-dest mode. Any other value: the name of a known client to always impersonate, as accepted by ClientID.getByName(java.lang.String).
    Parameters:
    setting - the i2psnark.clientId value
  - setClientIdCandidates
```
public void setClientIdCandidates(List<ClientID.Profile> candidates)
```
    Restrict the candidate set for random client selection. Unknown names are dropped; an empty list selects from all known clients.
    Parameters:
    candidates - the parsed candidate list, may be empty
  - setCollapsePanels
```
public void setCollapsePanels(boolean yes)
```
  - setCommentsEnabled
```
public void setCommentsEnabled(boolean yes)
```
  - setCommentsName
```
public void setCommentsName(String name)
```
  - setEnableAddCreate
```
public void setEnableAddCreate(boolean yes)
```
  - setEnableLightbox
```
public void setEnableLightbox(boolean yes)
```
  - setEnableVaryInboundHops
```
public void setEnableVaryInboundHops(boolean yes)
```
  - setEnableVaryOutboundHops
```
public void setEnableVaryOutboundHops(boolean yes)
```
  - setFilesPublic
```
public void setFilesPublic(boolean yes)
```
    Whether files in the data directory are world-readable.
  - setI2CPConfig
```
public void setI2CPConfig(String i2cpHost,
                          int i2cpPort,
                          Map opts)
```
    Configure the I2CP connection parameters.
    Parameters:
    i2cpHost - may be null for no change
    i2cpPort - may be 0 for no change
    opts - may be null for no change
  - setMaxConnections
```
public void setMaxConnections(int limit)
```
  - setMaxDest
```
public void setMaxDest(int maxDest)
```
    Configure the maximum number of per-torrent destinations, 0-1000; zero is unlimited.
    Parameters:
    maxDest - the maximum number of destinations, 0-1000; zero is unlimited
  - setMaxFilesPerTorrent
```
public void setMaxFilesPerTorrent(int max)
```
    Maximum number of files a torrent may contain.
  - setMaxUpBW
```
public void setMaxUpBW(int limit)
```
    This updates ALL the session options (not just the bw) and tells the router
    Parameters:
    limit - KBps
  - setMaxUploaders
```
public void setMaxUploaders(int limit)
```
  - setMultiDest
```
public void setMultiDest(boolean multiDest)
```
  - setOpenTrackers
```
public void setOpenTrackers(List<String> ot)
```
    Configure the open tracker announce URLs to use as backups.
    Parameters:
    ot - non-null list of announce URLs
  - setPreallocateFiles
```
public void setPreallocateFiles(boolean yes)
```
    Whether new torrents preallocate their storage files.
  - setRatingsEnabled
```
public void setRatingsEnabled(boolean yes)
```
  - setShouldPadFiles
```
public void setShouldPadFiles(boolean yes)
```
    Sets whether BEP 47 padding files are added to new torrents.
  - setShowStatusFilter
```
public void setShowStatusFilter(boolean yes)
```
  - setStartupDelayMax
```
public void setStartupDelayMax(int minutes)
```
  - setStartupDelayMin
```
public void setStartupDelayMin(int minutes)
```
  - setTempDirProp
```
public void setTempDirProp(String tempDir)
```
    Sets the staging directory (or null to disable the feature). The value should already be trimmed and unquoted.
  - setUDPEnabled
```
public void setUDPEnabled(boolean yes)
```
  - setUseDHT
```
public void setUseDHT(boolean yes)
```
  - setUseOpenTrackers
```
public void setUseOpenTrackers(boolean yes)
```
  - setVaryInboundHops
```
public void setVaryInboundHops(boolean yes)
```
    Whether hops are randomly varied for inbound torrent tunnels.
  - setVaryOutboundHops
```
public void setVaryOutboundHops(boolean yes)
```
  - shouldUseDHT
```
public boolean shouldUseDHT()
```
    Whether the DHT is used.
    Returns:
    whether use d h t
  - shouldUseOpenTrackers
```
public boolean shouldUseOpenTrackers()
```
    Whether open trackers are used as backups.
    Returns:
    whether use open trackers
  - showStatusFilter
```
public boolean showStatusFilter()
```
  - storeProps
```
static void storeProps(Properties props,
                       File file)
                throws IOException
```
    Same as DataHelper.loadProps() but allows '#' in values, so we can have filenames with '#' in them in torrent config files. '#' must be in column 1 for a comment.
    Throws:
    IOException
  - toHex
```
public static String toHex(byte[] b)
```
    Like DataHelper.toHexString but ensures no loss of leading zero bytes
  - trackerB32ToHostname
```
public static String trackerB32ToHostname(String url)
```
    Replace known base32 and base64 tracker hosts with their symbolic names, and strip the leading scheme, for display purposes.
    Parameters:
    url - may be null
    Returns:
    the converted hostname, or null if url is null
  - udpEnabled
```
public boolean udpEnabled()
```
  - utCommentsEnabled
```
public boolean utCommentsEnabled()
```

Class I2PSnarkUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_COLLAPSE_PANELS

DEFAULT_ENABLE_ADDCREATE

DEFAULT_ENABLE_LIGHTBOX

DEFAULT_SHOW_STATUSFILTER

DEFAULT_USE_DHT

DEFAULT_USE_OPENTRACKERS

DEFAULT_VARY_INBOUND_HOPS

DEFAULT_VARY_OUTBOUND_HOPS

EEPGET_USER_AGENT

MAX_CONNECTIONS

PROP_CLIENT_ID

PROP_CLIENT_IDS

PROP_MAX_BW

Constructor Detail

I2PSnarkUtil

I2PSnarkUtil

Method Detail

banPeer

collapsePanels

commentsEnabled

connect

connect

connect

connected

disconnect

enableAddCreate

enableLightbox

enableVaryInboundHops

enableVaryOutboundHops

get

get

get

get

get

get

get

getAPIKey

getAPITarget

getBackupTrackers

getBanDiscardPeriod

getClientID

getCommentsName

getContext

getDestination

getDestinationFromBase64

getDHT

getDHTForTorrent

getEepProxyHost

getEepProxyPort

getEepProxySet

getFilesPublic

getI2CPHost

getI2CPOptions

getI2CPPort

getMaxConnections

getMaxDest

getMaxFilesPerTorrent

getMaxUpBW

getMaxUploaders

getMultiDest

getMyDestination

getMyDestination

getNickname

getOpenTrackers

getOrCreateTorrentDest

getOurIPString

getOurIPString

getPoolIndex

getPoolNickname

getPreallocateFiles

getServerSocket

getServerSocket

getShouldPadFiles

getSocketManager