GeneralHelper (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.i2ptunnel.ui.GeneralHelper

```
public class GeneralHelper
extends Object
```
General helper functions used by all UIs. This class is also used by Android. Maintain as a stable API and take care not to break Android.

Field Summary

Fields
Modifier and Type	Field and Description
`protected TunnelControllerGroup`	`_group`
`static int`	`NOT_RUNNING` Tunnel is not running
`protected static String`	`PROP_ENABLE_ACCESS_LIST` Property key for enabling access list filtering
`protected static String`	`PROP_ENABLE_BLACKLIST` Property key for enabling blacklist filtering
`static int`	`RUNNING` Tunnel is fully operational
`static int`	`STANDBY` Tunnel is alive but idle, ready for activity
`static int`	`STARTING` Tunnel is in the process of starting up

Constructor Summary

Constructors
Constructor and Description
`GeneralHelper(I2PAppContext context, TunnelControllerGroup tcg)` Construct a new helper with a specific context.
`GeneralHelper(TunnelControllerGroup tcg)` Construct a new helper with the global context.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static String`	`_t(String key, I2PAppContext context)` Translate a string using the given context.
`static List<String>`	`deleteTunnel(I2PAppContext context, TunnelControllerGroup tcg, int tunnel, String privKeyFile)` Stop the tunnel, delete from config, rename the private key file if in the default directory
`List<String>`	`deleteTunnel(int tunnel, String privKeyFile)` Stop and delete the tunnel, remove its configuration, and rename the private key file if it uses a default name in the default directory.
`String`	`getAccessList(int tunnel)` Return the access control list (comma-separated destinations), newline-delimited.
`int`	`getAccessMode(int tunnel)` Return the access control mode for the tunnel.
`boolean`	`getAllowAccept(int tunnel)` Check whether the HTTP client allows custom Accept headers.
`boolean`	`getAllowInternalSSL(int tunnel)` Check whether internal SSL connections are allowed through the HTTP client.
`boolean`	`getAllowReferer(int tunnel)` Check whether the HTTP client allows custom Referer headers.
`boolean`	`getAllowUserAgent(int tunnel)` Check whether the HTTP client allows custom User-Agent headers.
`Destination`	`getAltDestination(int tunnel)` Retrieve the alternate tunnel Destination from the key file.
`String`	`getAltPrivateKeyFile(int tunnel)` Return the alternate private key file path.
`String`	`getAltPrivateKeyFile(TunnelControllerGroup tcg, int tunnel)` Return the alternate private key file path from a specific group.
`String`	`getBlindedPassword(int tunnel)` Return the blinded password for the tunnel's lease set.
`int`	`getCert(int tunnel)` Return the certificate type for the tunnel (currently unused, always 0).
`List<String>`	`getClientAuths(int tunnel, boolean isDH)` Return the list of authorized client authentications for the lease set.
`String`	`getClientDestination(int tunnel)` Return the client destination (base64) or proxy list for the tunnel.
`String`	`getClientInterface(int tunnel)` Return the interface address the client tunnel listens on.
`int`	`getClientPort(int tunnel)` Return the port the client tunnel listens on.
`boolean`	`getCloseOnIdle(int tunnel, boolean def)` Check whether I2CP close-on-idle is enabled.
`int`	`getCloseTime(int tunnel, int def)` Return the I2CP close-on-idle timeout in minutes.
`TunnelController`	`getController(int tunnel)` Retrieve a tunnel controller by index.
`static TunnelController`	`getController(TunnelControllerGroup tcg, int tunnel)`
`String`	`getCustomOptionsString(int tunnel)` Return the custom client options as a single URL-parameter-style string.
`boolean`	`getDCC(int tunnel)` Check whether DCC (direct client-to-client) is enabled for IRC tunnels.
`boolean`	`getDelayOpen(int tunnel)` Check whether I2CP delay-open is enabled.
`Destination`	`getDestination(int tunnel)` Retrieve the tunnel Destination, reading from the key file if the tunnel is not running.
`int`	`getEffort(int tunnel)` Return the proof-of-work effort for blinded leases (currently unused, always 23).
`boolean`	`getEncrypt(int tunnel)` Check whether the lease set should be encrypted.
`String`	`getEncryptKey(int tunnel)` Return the lease set encryption key.
`int`	`getEncryptMode(int tunnel)` Determine the encryption mode for the tunnel's lease set.
`String`	`getFilterDefinition(int tunnel)` Return the connect filter definition for the tunnel.
`String`	`getInboundRandomKey(int tunnel)` Return the inbound random key (used for testing LS encryption).
`String`	`getJumpList(int tunnel)` Return the jump server list for HTTP clients (one per line).
`String`	`getLeaseSetPrivateKey(int tunnel)` Return the lease set private key (for encrypted LS).
`String`	`getLeaseSetSigningPrivateKey(int tunnel)` Return the lease set signing private key.
`int`	`getLimitDay(int tunnel)` Return the per-day connection limit.
`int`	`getLimitHour(int tunnel)` Return the per-hour connection limit.
`int`	`getLimitMinute(int tunnel)` Return the per-minute connection limit.
`int`	`getMaxStreams(int tunnel)` Return the maximum concurrent streams for the tunnel.
`boolean`	`getMultihome(int tunnel)` Check whether the tunnel should bundle reply information (multihome mode).
`boolean`	`getNewDest(int tunnel)` Check whether the tunnel should get a new destination on resume.
`String`	`getOutboundRandomKey(int tunnel)` Return the outbound random key (used for testing LS encryption).
`boolean`	`getOutproxyAuth(int tunnel)` Check whether outproxy authentication is required.
`String`	`getOutproxyPassword(int tunnel)` Return the outproxy password (only if a username is set).
`String`	`getOutproxyType(int tunnel)` Return the outproxy connection type.
`String`	`getOutproxyUsername(int tunnel)` Return the outproxy username.
`boolean`	`getPersistentClientKey(int tunnel)` Check whether the tunnel uses a persistent client key file.
`int`	`getPostBanTime(int tunnel)` Return the POST ban duration in minutes.
`int`	`getPostCheckTime(int tunnel)` Return the POST check window size in minutes.
`int`	`getPostMax(int tunnel)` Return the maximum POST request size in bytes.
`int`	`getPostTotalBanTime(int tunnel)` Return the total POST ban duration in minutes.
`int`	`getPostTotalMax(int tunnel)` Return the maximum total POST request size for the window.
`String`	`getPrivateKeyFile(int tunnel)` Return the private key file path for the tunnel.
`String`	`getPrivateKeyFile(TunnelControllerGroup tcg, int tunnel)` Return the private key file path, computing a default if none is configured.
`String`	`getProxyAuth(int tunnel)` Return the proxy authentication mode.
`int`	`getReduceCount(int tunnel, int def)` Return the I2CP reduce quantity (target number of tunnels when idle).
`boolean`	`getReduceOnIdle(int tunnel, boolean def)` Check whether I2CP session reduction on idle is enabled.
`int`	`getReduceTime(int tunnel, int def)` Return the I2CP idle reduction time threshold.
`boolean`	`getRejectInproxy(int tunnel)` Check whether inproxy connections are rejected.
`boolean`	`getRejectReferer(int tunnel)` Check whether connections with a Referer header are rejected.
`boolean`	`getRejectUserAgents(int tunnel)` Check whether connections with known bad User-Agents are rejected.
`int`	`getRemainingStartupDelay(int tunnel)` Get the remaining startup delay time for tunnels with delayed startup.
`String`	`getSigner(int tunnel)` Return the signer for blinded leases (currently unused, always empty).
`int`	`getSigType(int tunnel, String newTunnelType)` Return the signature type code for the tunnel.
`String`	`getSpoofedHost(int tunnel)` Return the spoofed HTTP host header.
`String`	`getSslProxies(int tunnel)` Return the list of SSL outproxies.
`String`	`getTargetHost(int tunnel)` Return the target host for the tunnel.
`int`	`getTargetPort(int tunnel)` Return the target port for the tunnel.
`int`	`getTotalDay(int tunnel)` Return the per-day total connection limit across all sources.
`int`	`getTotalHour(int tunnel)` Return the per-hour total connection limit across all sources.
`int`	`getTotalMinute(int tunnel)` Return the per-minute total connection limit across all sources.
`int`	`getTunnelBackupQuantity(int tunnel, int defaultBackupQuantity)` Return the inbound backup tunnel quantity (applies to both in/out if not split).
`int`	`getTunnelBackupQuantityOut(int tunnel, int defaultBackupQuantity)` Return the outbound backup tunnel quantity.
`int`	`getTunnelDepth(int tunnel, int defaultLength)` Return the inbound tunnel depth (applies to both in/out if not split).
`int`	`getTunnelDepthOut(int tunnel, int defaultLength)` Return the outbound tunnel depth.
`String`	`getTunnelDescription(int tunnel)` Return the tunnel description.
`String`	`getTunnelName(int tunnel)` Return the tunnel name.
`static String`	`getTunnelName(TunnelControllerGroup tcg, int tunnel)` Return the tunnel name from a specific group.
`int`	`getTunnelQuantity(int tunnel, int defaultQuantity)` Return the inbound tunnel quantity (applies to both in/out if not split).
`int`	`getTunnelQuantityOut(int tunnel, int defaultQuantity)` Return the outbound tunnel quantity.
`int`	`getTunnelStatus(int tunnel)` Return the operational status of the tunnel.
`String`	`getTunnelType(int tunnel)` Return the tunnel type string (e.g.
`int`	`getTunnelVariance(int tunnel, int defaultVariance)` Return the inbound tunnel length variance (applies to both in/out if not split).
`int`	`getTunnelVarianceOut(int tunnel, int defaultVariance)` Return the outbound tunnel length variance.
`boolean`	`getUniqueLocal(int tunnel)` Check whether the server tunnel uses unique local addresses for each client.
`boolean`	`getUseOutproxyPlugin(int tunnel)` Check whether the outproxy plugin is enabled.
`String`	`getUserAgents(int tunnel)` Return the blocked User-Agent list.
`boolean`	`hasEncType(int tunnel, int encType)` Check whether the tunnel supports a given encryption type.
`boolean`	`isInteractive(int tunnel)` Check whether the tunnel is configured for interactive streaming (small window).
`boolean`	`isOfflineKeys(int tunnel)` Check whether the tunnel uses offline keys.
`boolean`	`isSharedClient(int tunnel)` Check whether this tunnel shares its I2CP session with other clients.
`boolean`	`isSSLEnabled(int tunnel)` Check whether SSL is enabled for the server tunnel.
`protected static List<String>`	`saveConfig(I2PAppContext context, TunnelControllerGroup tcg, int tunnel)` Save the configuration for an existing tunnel to disk.
`static List<String>`	`saveTunnel(I2PAppContext context, TunnelControllerGroup tcg, int tunnel, TunnelConfig config)` Save the configuration for a new or existing tunnel to disk.
`List<String>`	`saveTunnel(int tunnel, TunnelConfig config)` Save the configuration for a new or existing tunnel to disk.
`boolean`	`shouldDelayConnect(int tunnel)` Check whether the tunnel has a streaming connect delay configured.
`boolean`	`shouldStartAutomatically(int tunnel)` Check whether the tunnel is configured to start automatically.
`protected static List<String>`	`updateTunnelConfig(TunnelControllerGroup tcg, int tunnel, TunnelConfig config)` Update the config and if shared, adjust and save the config of other shared clients.

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

- Field Detail
  - _group
```
protected final TunnelControllerGroup _group
```
  - NOT_RUNNING
```
public static final int NOT_RUNNING
```
    Tunnel is not running
    See Also:
    Constant Field Values
  - PROP_ENABLE_ACCESS_LIST
```
protected static final String PROP_ENABLE_ACCESS_LIST
```
    Property key for enabling access list filtering
    See Also:
    Constant Field Values
  - PROP_ENABLE_BLACKLIST
```
protected static final String PROP_ENABLE_BLACKLIST
```
    Property key for enabling blacklist filtering
    See Also:
    Constant Field Values
  - RUNNING
```
public static final int RUNNING
```
    Tunnel is fully operational
    See Also:
    Constant Field Values
  - STANDBY
```
public static final int STANDBY
```
    Tunnel is alive but idle, ready for activity
    See Also:
    Constant Field Values
  - STARTING
```
public static final int STARTING
```
    Tunnel is in the process of starting up
    See Also:
    Constant Field Values
- Constructor Detail
  - GeneralHelper
```
public GeneralHelper(I2PAppContext context,
                     TunnelControllerGroup tcg)
```
    Construct a new helper with a specific context.
    Parameters:
    context - the I2P app context to use
    tcg - the group of tunnel controllers, may be null
  - GeneralHelper
```
public GeneralHelper(TunnelControllerGroup tcg)
```
    Construct a new helper with the global context.
    Parameters:
    tcg - the group of tunnel controllers, may be null
- Method Detail
  - _t
```
protected static String _t(String key,
                           I2PAppContext context)
```
    Translate a string using the given context.
    Parameters:
    key - the untranslated string
    context - the app context for translation
    Returns:
    the translated string
  - deleteTunnel
```
public static List<String> deleteTunnel(I2PAppContext context,
                                        TunnelControllerGroup tcg,
                                        int tunnel,
                                        String privKeyFile)
```
    Stop the tunnel, delete from config, rename the private key file if in the default directory
    Parameters:
    privKeyFile - The priv key file name from the tunnel edit form. Can be null if not known.
  - deleteTunnel
```
public List<String> deleteTunnel(int tunnel,
                                 String privKeyFile)
```
    Stop and delete the tunnel, remove its configuration, and rename the private key file if it uses a default name in the default directory.
    Parameters:
    tunnel - the tunnel
    privKeyFile - the private key file name from the edit form, may be null
    Returns:
    list of status messages
  - getAccessList
```
public String getAccessList(int tunnel)
```
    Return the access control list (comma-separated destinations), newline-delimited.
    Parameters:
    tunnel - the tunnel
    Returns:
    the access list entries, one per line
  - getAccessMode
```
public int getAccessMode(int tunnel)
```
    Return the access control mode for the tunnel.
    Parameters:
    tunnel - the tunnel
    Returns:
    0=none, 1=whitelist, 2=blacklist
  - getAllowAccept
```
public boolean getAllowAccept(int tunnel)
```
    Check whether the HTTP client allows custom Accept headers.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if custom Accept is allowed
  - getAllowInternalSSL
```
public boolean getAllowInternalSSL(int tunnel)
```
    Check whether internal SSL connections are allowed through the HTTP client. As of 0.9.35, defaults to true unless explicitly disabled.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if internal SSL is allowed
  - getAllowReferer
```
public boolean getAllowReferer(int tunnel)
```
    Check whether the HTTP client allows custom Referer headers.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if custom Referer is allowed
  - getAllowUserAgent
```
public boolean getAllowUserAgent(int tunnel)
```
    Check whether the HTTP client allows custom User-Agent headers.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if custom User-Agent is allowed
  - getAltDestination
```
public Destination getAltDestination(int tunnel)
```
    Retrieve the alternate tunnel Destination from the key file.
    Parameters:
    tunnel - the tunnel
    Returns:
    Destination or null
  - getAltPrivateKeyFile
```
public String getAltPrivateKeyFile(int tunnel)
```
    Return the alternate private key file path.
    Parameters:
    tunnel - the tunnel
    Returns:
    path or ""
  - getAltPrivateKeyFile
```
public String getAltPrivateKeyFile(TunnelControllerGroup tcg,
                                   int tunnel)
```
    Return the alternate private key file path from a specific group.
    Parameters:
    tcg - the controller group, may be null
    tunnel - the tunnel
    Returns:
    path or ""
  - getBlindedPassword
```
public String getBlindedPassword(int tunnel)
```
    Return the blinded password for the tunnel's lease set.
    Parameters:
    tunnel - the tunnel
    Returns:
    the decoded blinded password, or empty string
  - getCert
```
public int getCert(int tunnel)
```
    Return the certificate type for the tunnel (currently unused, always 0).
    Parameters:
    tunnel - the tunnel
    Returns:
    always 0
  - getClientAuths
```
public List<String> getClientAuths(int tunnel,
                                   boolean isDH)
```
    Return the list of authorized client authentications for the lease set. Each entry is a base64-encoded name:key pair.
    Parameters:
    tunnel - the tunnel
    isDH - true for DH public keys, false for PSK private keys
    Returns:
    non-null list of auth entries
  - getClientDestination
```
public String getClientDestination(int tunnel)
```
    Return the client destination (base64) or proxy list for the tunnel.
    Parameters:
    tunnel - the tunnel
    Returns:
    the destination string or proxy list, never null
  - getClientInterface
```
public String getClientInterface(int tunnel)
```
    Return the interface address the client tunnel listens on.
    Parameters:
    tunnel - the tunnel
    Returns:
    the interface address, defaults to "127.0.0.1"
  - getClientPort
```
public int getClientPort(int tunnel)
```
    Return the port the client tunnel listens on.
    Parameters:
    tunnel - the tunnel
    Returns:
    the port number, or -1 if unset or invalid
  - getCloseOnIdle
```
public boolean getCloseOnIdle(int tunnel,
                              boolean def)
```
    Check whether I2CP close-on-idle is enabled.
    Parameters:
    tunnel - the tunnel
    def - default value if not configured
    Returns:
    true if close-on-idle is enabled
  - getCloseTime
```
public int getCloseTime(int tunnel,
                        int def)
```
    Return the I2CP close-on-idle timeout in minutes.
    Parameters:
    tunnel - the tunnel
    def - default value in minutes
    Returns:
    idle timeout in minutes
  - getController
```
public TunnelController getController(int tunnel)
```
    Retrieve a tunnel controller by index.
    Parameters:
    tunnel - the tunnel
    Returns:
    the controller, or null if not found
  - getController
```
public static TunnelController getController(TunnelControllerGroup tcg,
                                             int tunnel)
```
    Parameters:
    tcg - may be null
    Returns:
    null if not found or tcg is null
  - getCustomOptionsString
```
public String getCustomOptionsString(int tunnel)
```
    Return the custom client options as a single URL-parameter-style string.
    Parameters:
    tunnel - the tunnel
    Returns:
    the options string, HTML-escaped, or empty string
  - getDCC
```
public boolean getDCC(int tunnel)
```
    Check whether DCC (direct client-to-client) is enabled for IRC tunnels.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if DCC is enabled
  - getDelayOpen
```
public boolean getDelayOpen(int tunnel)
```
    Check whether I2CP delay-open is enabled.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if delay-open is enabled
  - getDestination
```
public Destination getDestination(int tunnel)
```
    Retrieve the tunnel Destination, reading from the key file if the tunnel is not running.
    Parameters:
    tunnel - the tunnel
    Returns:
    Destination or null
  - getEffort
```
public int getEffort(int tunnel)
```
    Return the proof-of-work effort for blinded leases (currently unused, always 23).
    Parameters:
    tunnel - the tunnel
    Returns:
    always 23
  - getEncrypt
```
public boolean getEncrypt(int tunnel)
```
    Check whether the lease set should be encrypted.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if encryption is enabled
  - getEncryptKey
```
public String getEncryptKey(int tunnel)
```
    Return the lease set encryption key.
    Parameters:
    tunnel - the tunnel
    Returns:
    the key, or empty string if not set
  - getEncryptMode
```
public int getEncryptMode(int tunnel)
```
    Determine the encryption mode for the tunnel's lease set.
    Parameters:
    tunnel - the tunnel
    Returns:
    encryption mode code (0=none, 1=full, 2=blinded, etc.)
  - getFilterDefinition
```
public String getFilterDefinition(int tunnel)
```
    Return the connect filter definition for the tunnel.
    Parameters:
    tunnel - the tunnel
    Returns:
    the filter definition, or empty string if not set
  - getInboundRandomKey
```
public String getInboundRandomKey(int tunnel)
```
    Return the inbound random key (used for testing LS encryption).
    Parameters:
    tunnel - the tunnel
    Returns:
    the key, or empty string if not set
  - getJumpList
```
public String getJumpList(int tunnel)
```
    Return the jump server list for HTTP clients (one per line).
    Parameters:
    tunnel - the tunnel
    Returns:
    the jump server list, newline-delimited
  - getLeaseSetPrivateKey
```
public String getLeaseSetPrivateKey(int tunnel)
```
    Return the lease set private key (for encrypted LS).
    Parameters:
    tunnel - the tunnel
    Returns:
    the key, or empty string if not set
  - getLeaseSetSigningPrivateKey
```
public String getLeaseSetSigningPrivateKey(int tunnel)
```
    Return the lease set signing private key.
    Parameters:
    tunnel - the tunnel
    Returns:
    the key, or empty string if not set
  - getLimitDay
```
public int getLimitDay(int tunnel)
```
    Return the per-day connection limit.
    Parameters:
    tunnel - the tunnel
    Returns:
    max connections per day
  - getLimitHour
```
public int getLimitHour(int tunnel)
```
    Return the per-hour connection limit.
    Parameters:
    tunnel - the tunnel
    Returns:
    max connections per hour
  - getLimitMinute
```
public int getLimitMinute(int tunnel)
```
    Return the per-minute connection limit.
    Parameters:
    tunnel - the tunnel
    Returns:
    max connections per minute
  - getMaxStreams
```
public int getMaxStreams(int tunnel)
```
    Return the maximum concurrent streams for the tunnel.
    Parameters:
    tunnel - the tunnel
    Returns:
    max streams
  - getMultihome
```
public boolean getMultihome(int tunnel)
```
    Check whether the tunnel should bundle reply information (multihome mode).
    Parameters:
    tunnel - the tunnel
    Returns:
    true if bundling is enabled
  - getNewDest
```
public boolean getNewDest(int tunnel)
```
    Check whether the tunnel should get a new destination on resume.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if a new destination will be created on resume
  - getOutboundRandomKey
```
public String getOutboundRandomKey(int tunnel)
```
    Return the outbound random key (used for testing LS encryption).
    Parameters:
    tunnel - the tunnel
    Returns:
    the key, or empty string if not set
  - getOutproxyAuth
```
public boolean getOutproxyAuth(int tunnel)
```
    Check whether outproxy authentication is required.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if outproxy auth is enabled
  - getOutproxyPassword
```
public String getOutproxyPassword(int tunnel)
```
    Return the outproxy password (only if a username is set).
    Parameters:
    tunnel - the tunnel
    Returns:
    the password, or empty string
  - getOutproxyType
```
public String getOutproxyType(int tunnel)
```
    Return the outproxy connection type.
    Parameters:
    tunnel - the tunnel
    Returns:
    "connect" or "socks", default depends on tunnel type
  - getOutproxyUsername
```
public String getOutproxyUsername(int tunnel)
```
    Return the outproxy username.
    Parameters:
    tunnel - the tunnel
    Returns:
    the username, or empty string
  - getPersistentClientKey
```
public boolean getPersistentClientKey(int tunnel)
```
    Check whether the tunnel uses a persistent client key file.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if the key is persistent
  - getPostBanTime
```
public int getPostBanTime(int tunnel)
```
    Return the POST ban duration in minutes.
    Parameters:
    tunnel - the tunnel
    Returns:
    ban time in minutes
  - getPostCheckTime
```
public int getPostCheckTime(int tunnel)
```
    Return the POST check window size in minutes.
    Parameters:
    tunnel - the tunnel
    Returns:
    check window in minutes
  - getPostMax
```
public int getPostMax(int tunnel)
```
    Return the maximum POST request size in bytes.
    Parameters:
    tunnel - the tunnel
    Returns:
    max POST size in bytes
  - getPostTotalBanTime
```
public int getPostTotalBanTime(int tunnel)
```
    Return the total POST ban duration in minutes.
    Parameters:
    tunnel - the tunnel
    Returns:
    total ban time in minutes
  - getPostTotalMax
```
public int getPostTotalMax(int tunnel)
```
    Return the maximum total POST request size for the window.
    Parameters:
    tunnel - the tunnel
    Returns:
    max total POST size in bytes
  - getPrivateKeyFile
```
public String getPrivateKeyFile(int tunnel)
```
    Return the private key file path for the tunnel.
    Parameters:
    tunnel - the tunnel
    Returns:
    path, non-null, non-empty
  - getPrivateKeyFile
```
public String getPrivateKeyFile(TunnelControllerGroup tcg,
                                int tunnel)
```
    Return the private key file path, computing a default if none is configured.
    Parameters:
    tcg - the controller group, may be null
    tunnel - the tunnel
    Returns:
    path, non-null, non-empty
  - getProxyAuth
```
public String getProxyAuth(int tunnel)
```
    Return the proxy authentication mode.
    Parameters:
    tunnel - the tunnel
    Returns:
    "false", "true", or "basic"
  - getReduceCount
```
public int getReduceCount(int tunnel,
                          int def)
```
    Return the I2CP reduce quantity (target number of tunnels when idle).
    Parameters:
    tunnel - the tunnel
    def - default value if not configured
    Returns:
    reduce quantity
  - getReduceOnIdle
```
public boolean getReduceOnIdle(int tunnel,
                               boolean def)
```
    Check whether I2CP session reduction on idle is enabled.
    Parameters:
    tunnel - the tunnel
    def - default value if not configured
    Returns:
    true if reduction on idle is enabled
  - getReduceTime
```
public int getReduceTime(int tunnel,
                         int def)
```
    Return the I2CP idle reduction time threshold.
    Parameters:
    tunnel - the tunnel
    def - default idle time in minutes
    Returns:
    idle time in minutes
  - getRejectInproxy
```
public boolean getRejectInproxy(int tunnel)
```
    Check whether inproxy connections are rejected.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if inproxy connections are rejected
  - getRejectReferer
```
public boolean getRejectReferer(int tunnel)
```
    Check whether connections with a Referer header are rejected.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if Referer connections are rejected
  - getRejectUserAgents
```
public boolean getRejectUserAgents(int tunnel)
```
    Check whether connections with known bad User-Agents are rejected.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if User-Agent rejection is enabled
  - getRemainingStartupDelay
```
public int getRemainingStartupDelay(int tunnel)
```
    Get the remaining startup delay time for tunnels with delayed startup.
    Parameters:
    tunnel - the tunnel
    Returns:
    remaining delay in seconds, or 0 if not applicable
  - getSigner
```
public String getSigner(int tunnel)
```
    Return the signer for blinded leases (currently unused, always empty).
    Parameters:
    tunnel - the tunnel
    Returns:
    always ""
  - getSigType
```
public int getSigType(int tunnel,
                      String newTunnelType)
```
    Return the signature type code for the tunnel.
    Parameters:
    tunnel - the tunnel
    newTunnelType - used if tunnel < 0 to determine default
    Returns:
    the current type if a destination exists, else the default for that tunnel type
  - getSpoofedHost
```
public String getSpoofedHost(int tunnel)
```
    Return the spoofed HTTP host header.
    Parameters:
    tunnel - the tunnel
    Returns:
    the spoofed host, or empty string if not set
  - getSslProxies
```
public String getSslProxies(int tunnel)
```
    Return the list of SSL outproxies.
    Parameters:
    tunnel - the tunnel
    Returns:
    comma-separated SSL outproxy list
  - getTargetHost
```
public String getTargetHost(int tunnel)
```
    Return the target host for the tunnel.
    Parameters:
    tunnel - the tunnel
    Returns:
    the target host, defaults to "127.0.0.1"
  - getTargetPort
```
public int getTargetPort(int tunnel)
```
    Return the target port for the tunnel.
    Parameters:
    tunnel - the tunnel
    Returns:
    the port number, or -1 if unset or invalid
  - getTotalDay
```
public int getTotalDay(int tunnel)
```
    Return the per-day total connection limit across all sources.
    Parameters:
    tunnel - the tunnel
    Returns:
    max total connections per day
  - getTotalHour
```
public int getTotalHour(int tunnel)
```
    Return the per-hour total connection limit across all sources.
    Parameters:
    tunnel - the tunnel
    Returns:
    max total connections per hour
  - getTotalMinute
```
public int getTotalMinute(int tunnel)
```
    Return the per-minute total connection limit across all sources.
    Parameters:
    tunnel - the tunnel
    Returns:
    max total connections per minute
  - getTunnelBackupQuantity
```
public int getTunnelBackupQuantity(int tunnel,
                                   int defaultBackupQuantity)
```
    Return the inbound backup tunnel quantity (applies to both in/out if not split).
    Parameters:
    tunnel - the tunnel
    defaultBackupQuantity - default value if not configured
    Returns:
    number of backup tunnels
  - getTunnelBackupQuantityOut
```
public int getTunnelBackupQuantityOut(int tunnel,
                                      int defaultBackupQuantity)
```
    Return the outbound backup tunnel quantity.
    Parameters:
    tunnel - the tunnel
    defaultBackupQuantity - default value if not configured
    Returns:
    number of backup tunnels
  - getTunnelDepth
```
public int getTunnelDepth(int tunnel,
                          int defaultLength)
```
    Return the inbound tunnel depth (applies to both in/out if not split).
    Parameters:
    tunnel - the tunnel
    defaultLength - default value if not configured
    Returns:
    tunnel depth in hops
  - getTunnelDepthOut
```
public int getTunnelDepthOut(int tunnel,
                             int defaultLength)
```
    Return the outbound tunnel depth.
    Parameters:
    tunnel - the tunnel
    defaultLength - default value if not configured
    Returns:
    tunnel depth in hops
  - getTunnelDescription
```
public String getTunnelDescription(int tunnel)
```
    Return the tunnel description.
    Parameters:
    tunnel - the tunnel
    Returns:
    the description, or empty string if not found
  - getTunnelName
```
public String getTunnelName(int tunnel)
```
    Return the tunnel name.
    Parameters:
    tunnel - the tunnel
    Returns:
    null if unset
  - getTunnelName
```
public static String getTunnelName(TunnelControllerGroup tcg,
                                   int tunnel)
```
    Return the tunnel name from a specific group.
    Parameters:
    tcg - the controller group, may be null
    tunnel - the tunnel
    Returns:
    null if unset
  - getTunnelQuantity
```
public int getTunnelQuantity(int tunnel,
                             int defaultQuantity)
```
    Return the inbound tunnel quantity (applies to both in/out if not split).
    Parameters:
    tunnel - the tunnel
    defaultQuantity - default value if not configured
    Returns:
    number of tunnels
  - getTunnelQuantityOut
```
public int getTunnelQuantityOut(int tunnel,
                                int defaultQuantity)
```
    Return the outbound tunnel quantity.
    Parameters:
    tunnel - the tunnel
    defaultQuantity - default value if not configured
    Returns:
    number of tunnels
  - getTunnelStatus
```
public int getTunnelStatus(int tunnel)
```
    Return the operational status of the tunnel.
    Parameters:
    tunnel - the tunnel
    Returns:
    RUNNING, STARTING, NOT_RUNNING, or STANDBY
  - getTunnelType
```
public String getTunnelType(int tunnel)
```
    Return the tunnel type string (e.g. "httpclient", "httpserver").
    Parameters:
    tunnel - the tunnel
    Returns:
    the type string, or empty string if tunnel not found
  - getTunnelVariance
```
public int getTunnelVariance(int tunnel,
                             int defaultVariance)
```
    Return the inbound tunnel length variance (applies to both in/out if not split).
    Parameters:
    tunnel - the tunnel
    defaultVariance - default value if not configured
    Returns:
    length variance in hops
  - getTunnelVarianceOut
```
public int getTunnelVarianceOut(int tunnel,
                                int defaultVariance)
```
    Return the outbound tunnel length variance.
    Parameters:
    tunnel - the tunnel
    defaultVariance - default value if not configured
    Returns:
    length variance in hops
  - getUniqueLocal
```
public boolean getUniqueLocal(int tunnel)
```
    Check whether the server tunnel uses unique local addresses for each client.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if unique local addressing is enabled
  - getUseOutproxyPlugin
```
public boolean getUseOutproxyPlugin(int tunnel)
```
    Check whether the outproxy plugin is enabled.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if the outproxy plugin is used, defaults to true
  - getUserAgents
```
public String getUserAgents(int tunnel)
```
    Return the blocked User-Agent list.
    Parameters:
    tunnel - the tunnel
    Returns:
    comma-separated user agents to block
  - hasEncType
```
public boolean hasEncType(int tunnel,
                          int encType)
```
    Check whether the tunnel supports a given encryption type.
    Parameters:
    tunnel - the tunnel
    encType - encryption type code
    Returns:
    true if the encryption type is in the configured list
  - isInteractive
```
public boolean isInteractive(int tunnel)
```
    Check whether the tunnel is configured for interactive streaming (small window).
    Parameters:
    tunnel - the tunnel
    Returns:
    true if max window size is 16
  - isOfflineKeys
```
public boolean isOfflineKeys(int tunnel)
```
    Check whether the tunnel uses offline keys.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if offline keys
  - isSharedClient
```
public boolean isSharedClient(int tunnel)
```
    Check whether this tunnel shares its I2CP session with other clients.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if it is a shared client
  - isSSLEnabled
```
public boolean isSSLEnabled(int tunnel)
```
    Check whether SSL is enabled for the server tunnel.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if SSL is enabled
  - saveConfig
```
protected static List<String> saveConfig(I2PAppContext context,
                                         TunnelControllerGroup tcg,
                                         int tunnel)
```
    Save the configuration for an existing tunnel to disk. New tunnels must use saveConfig(..., TunnelController).
    Parameters:
    context - unused, taken from tcg
    tunnel - must already exist
  - saveTunnel
```
public static List<String> saveTunnel(I2PAppContext context,
                                      TunnelControllerGroup tcg,
                                      int tunnel,
                                      TunnelConfig config)
```
    Save the configuration for a new or existing tunnel to disk. For new tunnels, adds to controller and (if configured) starts it.
    Parameters:
    context - unused, taken from tcg
  - saveTunnel
```
public List<String> saveTunnel(int tunnel,
                               TunnelConfig config)
```
    Save the configuration for a new or existing tunnel to disk. For new tunnels, adds to controller and (if configured) starts it.
    Parameters:
    tunnel - the tunnel
    config - the configuration to apply
    Returns:
    list of status messages
  - shouldDelayConnect
```
public boolean shouldDelayConnect(int tunnel)
```
    Check whether the tunnel has a streaming connect delay configured.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if connect delay is positive
  - shouldStartAutomatically
```
public boolean shouldStartAutomatically(int tunnel)
```
    Check whether the tunnel is configured to start automatically.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if auto-start is enabled
  - updateTunnelConfig
```
protected static List<String> updateTunnelConfig(TunnelControllerGroup tcg,
                                                 int tunnel,
                                                 TunnelConfig config)
```
    Update the config and if shared, adjust and save the config of other shared clients. If a new tunnel, this will call tcg.addController(), and start it if so configured. This does NOT save this tunnel's config. Caller must call saveConfig() also.

Class GeneralHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_group

NOT_RUNNING

PROP_ENABLE_ACCESS_LIST

PROP_ENABLE_BLACKLIST

RUNNING

STANDBY

STARTING

Constructor Detail

GeneralHelper

GeneralHelper

Method Detail

_t

deleteTunnel

deleteTunnel

getAccessList

getAccessMode

getAllowAccept

getAllowInternalSSL

getAllowReferer

getAllowUserAgent

getAltDestination

getAltPrivateKeyFile

getAltPrivateKeyFile

getBlindedPassword

getCert

getClientAuths

getClientDestination

getClientInterface

getClientPort

getCloseOnIdle

getCloseTime

getController

getController

getCustomOptionsString

getDCC

getDelayOpen

getDestination

getEffort

getEncrypt

getEncryptKey

getEncryptMode

getFilterDefinition

getInboundRandomKey

getJumpList

getLeaseSetPrivateKey

getLeaseSetSigningPrivateKey

getLimitDay

getLimitHour

getLimitMinute

getMaxStreams

getMultihome

getNewDest

getOutboundRandomKey

getOutproxyAuth

getOutproxyPassword

getOutproxyType

getOutproxyUsername

getPersistentClientKey

getPostBanTime

getPostCheckTime

getPostMax

getPostTotalBanTime

getPostTotalMax

getPrivateKeyFile

getPrivateKeyFile

getProxyAuth

getReduceCount

getReduceOnIdle

getReduceTime

getRejectInproxy

getRejectReferer

getRejectUserAgents

getRemainingStartupDelay

getSigner