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

java.lang.Object
- net.i2p.i2ptunnel.web.IndexBean

Direct Known Subclasses:
EditBean
```
public class IndexBean
extends Object
```
Backend bean for I2P tunnel management web interface.
Simple accessor for exposing tunnel info, but also an ugly form handler.
Warning - This class is not part of the i2ptunnel API, it has been moved from the jar to the war. Usage by classes outside of i2ptunnel.war is deprecated.

Field Summary

Fields
Modifier and Type	Field and Description
`protected I2PAppContext`	`_context`
`protected TunnelControllerGroup`	`_group`
`protected GeneralHelper`	`_helper`
`protected Log`	`_log`
`static int`	`NOT_RUNNING` Tunnel status: not running.
`static int`	`RUNNING` Tunnel status: running.
`static int`	`STANDBY` Tunnel status: standby.
`static int`	`STARTING` Tunnel status: starting.

Constructor Summary
Constructors
Constructor and Description
IndexBean()
Create the IndexBean, initializing the tunnel controller group and helper.

Constructors
Constructor and Description
`IndexBean()` Create the IndexBean, initializing the tunnel controller group and helper.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`_t(String key)`
`protected String`	`encrypt(int tunnel, String k, String v)` Encrypt a property using an in-memory key, for interaction with the UI only, using ChaCha20.
`String`	`getAltDestHashBase32(int tunnel)` Works even if tunnel is not running.
`protected Destination`	`getAltDestination(int tunnel)` Works even if tunnel is not running.
`String`	`getAltDestinationBase64(int tunnel)` Works even if tunnel is not running.
`String`	`getClientDestination(int tunnel)` The destination Base64 for the specified client tunnel.
`String`	`getClientInterface(int tunnel)` The interface the specified client tunnel is configured to listen on.
`String`	`getClientPort(int tunnel)` No validation
`String`	`getClientPort2(int tunnel)` Returns error message if blank or invalid
`protected TunnelController`	`getController(int tunnel)` The controller for the given tunnel index.
`List<Integer>`	`getControllerNumbers(boolean isClient)` Return tunnel numbers of clients or servers only, sorted by tunnel name
`String`	`getDestHashBase32(int tunnel)` Works even if tunnel is not running.
`protected Destination`	`getDestination(int tunnel)` Works even if tunnel is not running.
`String`	`getDestinationBase64(int tunnel)` Works even if tunnel is not running.
`String`	`getEncryptedBase32(int tunnel)` Works even if tunnel is not running.
`String`	`getInternalType(int tunnel)` The internal type string for the specified tunnel.
`boolean`	`getIsOfflineKeys(int tunnel)` Works even if tunnel is not running.
`boolean`	`getIsUsingOutproxyPlugin(int tunnel)` For index.jsp
`int`	`getLastMessageID()` The last stored message ID
`String`	`getMessages()` Executes any action requested (start/stop/etc) and dump out the messages.
`static String`	`getNextNonce()` Get the next nonce from the queue.
`static String`	`getNextNonce(HttpSession session)` Session-bound nonce generation - replaces static nonce when session available
`int`	`getRemainingStartupDelay(int tunnel)` The remaining startup delay for the specified tunnel.
`String`	`getServerTarget(int tunnel)` Get the server target.
`String`	`getSharedClient(int tunnel)` Get the shared client for a tunnel.
`String`	`getSpoofedHost(int tunnel)` Get the spoofed host for a tunnel.
`String`	`getTheme()` Get the theme path.
`String`	`getThemeName()` Get the theme name.
`int`	`getTunnelCount()` Get the number of tunnels.
`String`	`getTunnelDescription(int tunnel)` The description for the specified tunnel, HTML-escaped.
`String`	`getTunnelName(int tunnel)` Get the tunnel name.
`int`	`getTunnelStatus(int tunnel)` The current status of the specified tunnel.
`String`	`getTunnelType(int tunnel)` Get the tunnel type.
`(package private) String`	`getType()` The tunnel type.
`String`	`getTypeName(String internalType)` Get the display name for an internal type.
`static boolean`	`haveNonce(String nonce)` Whether we know this nonce.
`static boolean`	`haveNonce(String nonce, HttpSession session)` Session-bound nonce validation
`boolean`	`isClient(int tunnelNum)` Is it a client or server in the UI and I2P side? Note that a streamr client is a UI and I2P client but a server on the localhost side.
`static boolean`	`isClient(String type)` Is it a client or server in the UI and I2P side? Note that a streamr client is a UI and I2P client but a server on the localhost side.
`boolean`	`isInitialized()` Check if the tunnel group is initialized.
`boolean`	`isRejectInproxy(int tunnel)`
`boolean`	`isRejectReferer(int tunnel)`
`boolean`	`isRejectUserAgents(int tunnel)`
`boolean`	`isServer(int tunnel)` Is this a server tunnel?
`boolean`	`isServerTargetLinkValid(int tunnel)` Call this to see if it is ok to linkify getServerTarget()
`boolean`	`isSharedClient(int tunnel)` Check if the tunnel is a shared client.
`boolean`	`isSSLEnabled(int tunnel)`
`boolean`	`isValidIRCServer(int tunnel)` Is this an IRC server? Call to establish if we should provide irc:// link on index page
`protected String`	`ngettext(String s, String p, int n)` translate (ngettext)
`void`	`setAccessList(String val)` Comma-separated list of destinations to whitelist or blacklist.
`void`	`setAccessMode(String val)` Set the access mode, 0 for none, 1 for whitelist, 2 for blacklist.
`void`	`setAction(String action)` Set the action to process.
`void`	`setAddClient(String val)`
`void`	`setAllowAccept(String val)` Allow the Accept header to pass through the HTTP client.
`void`	`setAllowInternalSSL(String val)` Allow SSL connections through the HTTP client.
`void`	`setAllowReferer(String val)` Allow the Referer header to pass through the HTTP client.
`void`	`setAllowUserAgent(String val)` Allow the User-Agent header to pass through the HTTP client.
`void`	`setAltPrivKeyFile(String file)` What filename is this server tunnel's alternate private keys stored in
`void`	`setCert(String val)` Set the certificate type, from the form selection.
`void`	`setClientHost(String host)` I2CP host the router is on, ignored when in router context
`void`	`setclientKey(String[] s)` Set client keys for access control (multiple entries in form).
`void`	`setClientport(String port)` I2CP port the router is on, ignored when in router context
`void`	`setClose(String val)` Close connections when idle.
`void`	`setCloseTime(String val)` Idle time in minutes before closing connections.
`void`	`setConnectDelay(String val)` Delay the connection to the target until the first client connects.
`void`	`setDCC(String val)`
`void`	`setDelayOpen(String val)` Delay opening to the target until the first client connects.
`void`	`setEncrypt(String val)` Encrypt the lease set.
`void`	`setEncryptKey(String val)` Key for encrypting the lease set.
`void`	`setEncryptMode(String val)` Set the LeaseSet encryption mode.
`void`	`setEncType(String s)` Adds to existing, comma separated
`void`	`setFilterDefinition(String val)` Set the filter definition.
`void`	`setJumpList(String val)` Comma-separated list of HTTP outproxy jump servers.
`void`	`setKey1(String s)` Random keys, hidden in forms
`void`	`setKey2(String s)` Random outbound key, hidden in forms.
`void`	`setKey3(String s)` Lease set signing private key, hidden in forms.
`void`	`setKey4(String s)` Lease set private key, hidden in forms.
`void`	`setLimitDay(String s)` Maximum total number of connections per day.
`void`	`setLimitHour(String s)` Maximum total number of connections per hour.
`void`	`setLimitMinute(String s)` Maximum total number of connections per minute.
`void`	`setMaxStreams(String s)` Maximum number of concurrent streams.
`void`	`setMsgid(String id)` Set the message ID for clearing messages.
`void`	`setMultihome(String val)` Bundle reply info for multihoming.
`void`	`setNewClientKey(String s)`
`void`	`setNewDest(String val)` Control how ephemeral the destination is.
`void`	`setNofilter_blindedPassword(String s)` Set the blinded password for hidden encrypted LeaseSets.
`void`	`setNofilter_clientName(String[] s)` Set client names for access control (multiple entries in form).
`void`	`setNofilter_customOptions(String customOptions)` what I2P session overrides should be used
`void`	`setNofilter_description(String description)` One line host description
`void`	`setNofilter_name(String name)` Short name of the tunnel
`void`	`setNofilter_newClientName(String s)`
`void`	`setNofilter_outproxyPassword(String s)` Password for outproxy authentication.
`void`	`setNofilter_proxyPassword(String s)` Password for client proxy authentication.
`void`	`setNonce(String nonce)` Set the current nonce.
`void`	`setOutproxyAuth(String s)` Require authentication for the outproxies.
`void`	`setOutproxyType(String s)` Set the type of the outproxy.
`void`	`setOutproxyUsername(String s)` Username for outproxy authentication.
`void`	`setPort(String port)` what port should this client/httpclient/ircclient listen on
`void`	`setPostBanTime(String s)` How long to ban a client that exceeds the POST limits, in minutes.
`void`	`setPostCheckTime(String s)` How often the total POST limit is checked, in minutes.
`void`	`setPostMax(String s)` Maximum total size of POST requests.
`void`	`setPostTotalBanTime(String s)` How long to ban a client that exceeds the total POST limit, in minutes.
`void`	`setPostTotalMax(String s)` Maximum total size of all POST requests in the check interval.
`void`	`setPrivKeyFile(String file)` What filename is this server tunnel's private keys stored in
`void`	`setProfile(String profile)` Set the streaming profile.
`void`	`setProxyAuth(String s)` Set the proxy authentication type.
`void`	`setProxyList(String proxyList)` what HTTP outproxies should be used (httpclient specific)
`void`	`setProxyUsername(String s)` Username for client proxy authentication.
`void`	`setReachableBy(String reachableBy)` what interface should this client/httpclient/ircclient listen on
`void`	`setReduce(String val)` Reduce the number of connections when idle.
`void`	`setReduceCount(String val)` Number of connections to reduce to when idle.
`void`	`setReduceTime(String val)` Idle time in minutes before reducing connections.
`void`	`setRejectInproxy(String val)`
`void`	`setRejectReferer(String val)`
`void`	`setRejectUserAgents(String val)`
`void`	`setRemoveConfirm(String val)` If called with any value (and the form submitted with action=Remove), we really do want to stop and remove the tunnel.
`void`	`setRevokeClient(String[] s)` Revoke access for specified clients (multiple entries in form, values are integers).
`void`	`setSession(HttpSession session)` For session-bound nonce generation and validation
`void`	`setShared(boolean val)` Share the private key with other client tunnels.
`void`	`setShared(String val)` Share the private key with other client tunnels.
`void`	`setShutdownDelayMax(String val)` The maximum shutdown delay in seconds for server tunnels.
`void`	`setShutdownDelayMin(String val)` The minimum shutdown delay in seconds for server tunnels.
`void`	`setSigner(String val)` Set the certificate signer.
`void`	`setSigType(String val)`
`void`	`setSpoofedHost(String host)` What host does this http server tunnel spoof
`void`	`setSslProxies(String s)` Comma-separated list of SSL-capable outproxies.
`void`	`setStartOnLoad(String val)` If called with any value, we want this tunnel to start whenever it is loaded (aka right now and whenever the router is started up)
`void`	`setStartupDelayMax(String val)` The maximum startup delay in seconds for server tunnels.
`void`	`setStartupDelayMin(String val)` The minimum startup delay in seconds for server tunnels.
`void`	`setTargetDestination(String dest)` What peer does this client tunnel point at
`void`	`setTargetHost(String host)` What host does this server tunnel point at
`void`	`setTargetPort(String port)` What port does this server tunnel point at
`void`	`setTotalDay(String s)` Maximum total number of connections per day, enforced by the total limit.
`void`	`setTotalHour(String s)` Maximum total number of connections per hour, enforced by the total limit.
`void`	`setTotalMinute(String s)` Maximum total number of connections per minute, enforced by the total limit.
`void`	`setTunnel(String tunnel)` Set the tunnel number.
`void`	`setTunnelBackupQuantity(String tunnelBackupQuantity)` How many tunnels to hold in reserve to guard against failures In or both in/out
`void`	`setTunnelBackupQuantityOut(String tunnelBackupQuantity)` How many outbound tunnels to hold in reserve to guard against failures
`void`	`setTunnelDepth(String tunnelDepth)` How many hops to use for inbound tunnels In or both in/out
`void`	`setTunnelDepthOut(String tunnelDepth)` How many hops to use for outbound tunnels
`void`	`setTunnelQuantity(String tunnelQuantity)` How many parallel inbound tunnels to use In or both in/out
`void`	`setTunnelQuantityOut(String tunnelQuantity)` How many parallel outbound tunnels to use
`void`	`setTunnelVariance(String tunnelVariance)` How much randomisation to apply to the depth of tunnels In or both in/out
`void`	`setTunnelVarianceOut(String tunnelVariance)` How much randomisation to apply to the depth of outbound tunnels
`void`	`setType(String type)` What type of tunnel (httpclient, ircclient, client, or server).
`void`	`setUniqueLocal(String val)`
`void`	`setUseOutproxyPlugin(String val)` Use the outproxy plugin for HTTP requests.
`void`	`setUserAgents(String agents)`
`void`	`setUseSSL(String val)`
`void`	`storeMethod(String method)` Store request method for P-R-G pattern
`boolean`	`useSoraFont()` Check if the Sora font is enabled.

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

- Field Detail
  - _context
```
protected final I2PAppContext _context
```
  - _group
```
protected final TunnelControllerGroup _group
```
  - _helper
```
protected final GeneralHelper _helper
```
  - _log
```
protected final Log _log
```
  - NOT_RUNNING
```
public static final int NOT_RUNNING
```
    Tunnel status: not running.
    See Also:
    Constant Field Values
  - RUNNING
```
public static final int RUNNING
```
    Tunnel status: running.
    See Also:
    Constant Field Values
  - STANDBY
```
public static final int STANDBY
```
    Tunnel status: standby.
    See Also:
    Constant Field Values
  - STARTING
```
public static final int STARTING
```
    Tunnel status: starting.
    See Also:
    Constant Field Values
- Constructor Detail
  - IndexBean
```
public IndexBean()
```
    Create the IndexBean, initializing the tunnel controller group and helper. Nonces are initialized for CSRF protection.
- Method Detail
  - _t
```
protected String _t(String key)
```
  - encrypt
```
protected String encrypt(int tunnel,
                         String k,
                         String v)
```
    Encrypt a property using an in-memory key, for interaction with the UI only, using ChaCha20. IV is SHA256(k). These are transient keys by design, but are persisted to hide restarts. They are hidden inputs in the edit form. Storage in config files is not encrypted.
    Parameters:
    k - non-null
    v - may be empty or null
    Returns:
    Base64, or empty, or null
  - getAltDestHashBase32
```
public String getAltDestHashBase32(int tunnel)
```
    Works even if tunnel is not running.
    Parameters:
    tunnel - the tunnel
    Returns:
    "{52 chars}.b32.i2p" or ""
  - getAltDestination
```
protected Destination getAltDestination(int tunnel)
```
    Works even if tunnel is not running.
    Parameters:
    tunnel - the tunnel
    Returns:
    Destination or null
  - getAltDestinationBase64
```
public String getAltDestinationBase64(int tunnel)
```
    Works even if tunnel is not running.
    Parameters:
    tunnel - the tunnel
    Returns:
    Base64 or ""
  - getClientDestination
```
public String getClientDestination(int tunnel)
```
    The destination Base64 for the specified client tunnel.
    Parameters:
    tunnel - the tunnel
    Returns:
    the client destination
  - getClientInterface
```
public String getClientInterface(int tunnel)
```
    The interface the specified client tunnel is configured to listen on.
    Parameters:
    tunnel - the tunnel
    Returns:
    the client interface
  - getClientPort
```
public String getClientPort(int tunnel)
```
    No validation
    Parameters:
    tunnel - the tunnel
    Returns:
    the client port
  - getClientPort2
```
public String getClientPort2(int tunnel)
```
    Returns error message if blank or invalid
    Parameters:
    tunnel - the tunnel
    Returns:
    the client port or error message
  - getController
```
protected TunnelController getController(int tunnel)
```
    The controller for the given tunnel index.
    Returns:
    the controller
  - getControllerNumbers
```
public List<Integer> getControllerNumbers(boolean isClient)
```
    Return tunnel numbers of clients or servers only, sorted by tunnel name
    Parameters:
    isClient - true for clients, false for servers
    Returns:
    non-null, may be empty
  - getDestHashBase32
```
public String getDestHashBase32(int tunnel)
```
    Works even if tunnel is not running.
    Parameters:
    tunnel - the tunnel
    Returns:
    "{52 chars}.b32.i2p" or ""
  - getDestination
```
protected Destination getDestination(int tunnel)
```
    Works even if tunnel is not running.
    Parameters:
    tunnel - the tunnel
    Returns:
    Destination or null
  - getDestinationBase64
```
public String getDestinationBase64(int tunnel)
```
    Works even if tunnel is not running.
    Parameters:
    tunnel - the tunnel
    Returns:
    Base64 or ""
  - getEncryptedBase32
```
public String getEncryptedBase32(int tunnel)
```
    Works even if tunnel is not running.
    Parameters:
    tunnel - the tunnel
    Returns:
    "{56 chars}.b32.i2p" or "" if not blinded
  - getInternalType
```
public String getInternalType(int tunnel)
```
    The internal type string for the specified tunnel.
    Parameters:
    tunnel - the tunnel
    Returns:
    the internal type
  - getIsOfflineKeys
```
public boolean getIsOfflineKeys(int tunnel)
```
    Works even if tunnel is not running.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if offline keys
  - getIsUsingOutproxyPlugin
```
public boolean getIsUsingOutproxyPlugin(int tunnel)
```
    For index.jsp
    Parameters:
    tunnel - the tunnel
    Returns:
    true if the plugin is enabled, installed, and running
  - getLastMessageID
```
public int getLastMessageID()
```
    The last stored message ID
    Returns:
    the last message ID
  - getMessages
```
public String getMessages()
```
    Executes any action requested (start/stop/etc) and dump out the messages. Only call this ONCE! Or you will get duplicate tunnels on save.
    Returns:
    HTML escaped or "" if empty
  - getNextNonce
```
public static String getNextNonce()
```
    Get the next nonce from the queue.
    Returns:
    the next nonce
  - getNextNonce
```
public static String getNextNonce(HttpSession session)
```
    Session-bound nonce generation - replaces static nonce when session available
    Parameters:
    session - returns static nonce if null
    Returns:
    a new nonce for each call
  - getRemainingStartupDelay
```
public int getRemainingStartupDelay(int tunnel)
```
    The remaining startup delay for the specified tunnel.
    Parameters:
    tunnel - the tunnel
    Returns:
    the remaining startup delay
  - getServerTarget
```
public String getServerTarget(int tunnel)
```
    Get the server target.
    Parameters:
    tunnel - the tunnel
    Returns:
    valid host:port only if isServerTargetLinkValid() is true
  - getSharedClient
```
public String getSharedClient(int tunnel)
```
    Get the shared client for a tunnel.
    Parameters:
    tunnel - the tunnel
    Returns:
    the shared client
  - getSpoofedHost
```
public String getSpoofedHost(int tunnel)
```
    Get the spoofed host for a tunnel.
    Parameters:
    tunnel - the tunnel
    Returns:
    the spoofed host
  - getTheme
```
public String getTheme()
```
    Get the theme path.
    Returns:
    the theme path
  - getThemeName
```
public String getThemeName()
```
    Get the theme name.
    Returns:
    the theme name
  - getTunnelCount
```
public int getTunnelCount()
```
    Get the number of tunnels.
    Returns:
    the tunnel count
  - getTunnelDescription
```
public String getTunnelDescription(int tunnel)
```
    The description for the specified tunnel, HTML-escaped.
    Parameters:
    tunnel - the tunnel
    Returns:
    the tunnel description
  - getTunnelName
```
public String getTunnelName(int tunnel)
```
    Get the tunnel name.
    Parameters:
    tunnel - the tunnel
    Returns:
    the tunnel name
  - getTunnelStatus
```
public int getTunnelStatus(int tunnel)
```
    The current status of the specified tunnel.
    Parameters:
    tunnel - the tunnel
    Returns:
    the tunnel status
  - getTunnelType
```
public String getTunnelType(int tunnel)
```
    Get the tunnel type.
    Parameters:
    tunnel - the tunnel
    Returns:
    the tunnel type
  - getType
```
String getType()
```
    The tunnel type.
    Returns:
    the tunnel type
  - getTypeName
```
public String getTypeName(String internalType)
```
    Get the display name for an internal type.
    Parameters:
    internalType - the internal type
    Returns:
    the display name
  - haveNonce
```
public static boolean haveNonce(String nonce)
```
    Whether we know this nonce.
    Parameters:
    nonce - the nonce to check
    Returns:
    true if the nonce is known
  - haveNonce
```
public static boolean haveNonce(String nonce,
                                HttpSession session)
```
    Session-bound nonce validation
    Parameters:
    nonce - returns false if null
    session - returns static nonce check if null
    Returns:
    true if valid
  - isClient
```
public boolean isClient(int tunnelNum)
```
    Is it a client or server in the UI and I2P side? Note that a streamr client is a UI and I2P client but a server on the localhost side. Note that a streamr server is a UI and I2P server but a client on the localhost side.
    Parameters:
    tunnelNum - the tunnel number
    Returns:
    true if it is a client
  - isClient
```
public static boolean isClient(String type)
```
    Is it a client or server in the UI and I2P side? Note that a streamr client is a UI and I2P client but a server on the localhost side. Note that a streamr server is a UI and I2P server but a client on the localhost side.
    Parameters:
    type - the tunnel type
    Returns:
    true if it is a client
  - isInitialized
```
public boolean isInitialized()
```
    Check if the tunnel group is initialized.
    Returns:
    true if initialized
  - isRejectInproxy
```
public boolean isRejectInproxy(int tunnel)
```
  - isRejectReferer
```
public boolean isRejectReferer(int tunnel)
```
  - isRejectUserAgents
```
public boolean isRejectUserAgents(int tunnel)
```
  - isServer
```
public boolean isServer(int tunnel)
```
    Is this a server tunnel?
    Parameters:
    tunnel - the tunnel
    Returns:
    true if it is a server
  - isServerTargetLinkValid
```
public boolean isServerTargetLinkValid(int tunnel)
```
    Call this to see if it is ok to linkify getServerTarget()
    Parameters:
    tunnel - the tunnel
    Returns:
    true if the server target link is valid
  - isSharedClient
```
public boolean isSharedClient(int tunnel)
```
    Check if the tunnel is a shared client.
    Parameters:
    tunnel - the tunnel
    Returns:
    true if shared client
  - isSSLEnabled
```
public boolean isSSLEnabled(int tunnel)
```
  - isValidIRCServer
```
public boolean isValidIRCServer(int tunnel)
```
    Is this an IRC server? Call to establish if we should provide irc:// link on index page
    Parameters:
    tunnel - the tunnel
    Returns:
    true if it is a valid IRC server
  - ngettext
```
protected String ngettext(String s,
                          String p,
                          int n)
```
    translate (ngettext)
  - setAccessList
```
public void setAccessList(String val)
```
    Comma-separated list of destinations to whitelist or blacklist.
  - setAccessMode
```
public void setAccessMode(String val)
```
    Set the access mode, 0 for none, 1 for whitelist, 2 for blacklist.
  - setAction
```
public void setAction(String action)
```
    Set the action to process.
    Parameters:
    action - the action string
  - setAddClient
```
public void setAddClient(String val)
```
  - setAllowAccept
```
public void setAllowAccept(String val)
```
    Allow the Accept header to pass through the HTTP client. @since 0.9.14
  - setAllowInternalSSL
```
public void setAllowInternalSSL(String val)
```
    Allow SSL connections through the HTTP client. @since 0.9.14
  - setAllowReferer
```
public void setAllowReferer(String val)
```
    Allow the Referer header to pass through the HTTP client. @since 0.9.14
  - setAllowUserAgent
```
public void setAllowUserAgent(String val)
```
    Allow the User-Agent header to pass through the HTTP client. @since 0.9.14
  - setAltPrivKeyFile
```
public void setAltPrivKeyFile(String file)
```
    What filename is this server tunnel's alternate private keys stored in
  - setCert
```
public void setCert(String val)
```
    Set the certificate type, from the form selection.
  - setClientHost
```
public void setClientHost(String host)
```
    I2CP host the router is on, ignored when in router context
    Parameters:
    host - the client host
  - setclientKey
```
public void setclientKey(String[] s)
```
    Set client keys for access control (multiple entries in form).
    Parameters:
    s - the client keys
  - setClientport
```
public void setClientport(String port)
```
    I2CP port the router is on, ignored when in router context
    Parameters:
    port - the client port
  - setClose
```
public void setClose(String val)
```
    Close connections when idle.
  - setCloseTime
```
public void setCloseTime(String val)
```
    Idle time in minutes before closing connections.
  - setConnectDelay
```
public void setConnectDelay(String val)
```
    Delay the connection to the target until the first client connects.
  - setDCC
```
public void setDCC(String val)
```
  - setDelayOpen
```
public void setDelayOpen(String val)
```
    Delay opening to the target until the first client connects.
  - setEncrypt
```
public void setEncrypt(String val)
```
    Encrypt the lease set.
  - setEncryptKey
```
public void setEncryptKey(String val)
```
    Key for encrypting the lease set.
  - setEncryptMode
```
public void setEncryptMode(String val)
```
    Set the LeaseSet encryption mode.
    Parameters:
    val - the encryption mode value
  - setEncType
```
public void setEncType(String s)
```
    Adds to existing, comma separated
  - setFilterDefinition
```
public void setFilterDefinition(String val)
```
    Set the filter definition. @since 0.9.40
  - setJumpList
```
public void setJumpList(String val)
```
    Comma-separated list of HTTP outproxy jump servers.
  - setKey1
```
public void setKey1(String s)
```
    Random keys, hidden in forms
  - setKey2
```
public void setKey2(String s)
```
    Random outbound key, hidden in forms. @since 0.9.18
  - setKey3
```
public void setKey3(String s)
```
    Lease set signing private key, hidden in forms. @since 0.9.18
  - setKey4
```
public void setKey4(String s)
```
    Lease set private key, hidden in forms. @since 0.9.18
  - setLimitDay
```
public void setLimitDay(String s)
```
    Maximum total number of connections per day.
  - setLimitHour
```
public void setLimitHour(String s)
```
    Maximum total number of connections per hour.
  - setLimitMinute
```
public void setLimitMinute(String s)
```
    Maximum total number of connections per minute.
  - setMaxStreams
```
public void setMaxStreams(String s)
```
    Maximum number of concurrent streams.
  - setMsgid
```
public void setMsgid(String id)
```
    Set the message ID for clearing messages.
    Parameters:
    id - the message ID
  - setMultihome
```
public void setMultihome(String val)
```
    Bundle reply info for multihoming. @since 0.9.18
  - setNewClientKey
```
public void setNewClientKey(String s)
```
  - setNewDest
```
public void setNewDest(String val)
```
    Control how ephemeral the destination is.
  - setNofilter_blindedPassword
```
public void setNofilter_blindedPassword(String s)
```
    Set the blinded password for hidden encrypted LeaseSets.
    Parameters:
    s - the blinded password
  - setNofilter_clientName
```
public void setNofilter_clientName(String[] s)
```
    Set client names for access control (multiple entries in form).
    Parameters:
    s - the client names
  - setNofilter_customOptions
```
public void setNofilter_customOptions(String customOptions)
```
    what I2P session overrides should be used
    Parameters:
    customOptions - the custom options
  - setNofilter_description
```
public void setNofilter_description(String description)
```
    One line host description
    Parameters:
    description - the tunnel description
  - setNofilter_name
```
public void setNofilter_name(String name)
```
    Short name of the tunnel
    Parameters:
    name - the tunnel name
  - setNofilter_newClientName
```
public void setNofilter_newClientName(String s)
```
  - setNofilter_outproxyPassword
```
public void setNofilter_outproxyPassword(String s)
```
    Password for outproxy authentication.
  - setNofilter_proxyPassword
```
public void setNofilter_proxyPassword(String s)
```
    Password for client proxy authentication.
  - setNonce
```
public void setNonce(String nonce)
```
    Set the current nonce.
    Parameters:
    nonce - the nonce value
  - setOutproxyAuth
```
public void setOutproxyAuth(String s)
```
    Require authentication for the outproxies.
  - setOutproxyType
```
public void setOutproxyType(String s)
```
    Set the type of the outproxy.
    Parameters:
    s - "connect" or "socks"
  - setOutproxyUsername
```
public void setOutproxyUsername(String s)
```
    Username for outproxy authentication.
  - setPort
```
public void setPort(String port)
```
    what port should this client/httpclient/ircclient listen on
    Parameters:
    port - the port number
  - setPostBanTime
```
public void setPostBanTime(String s)
```
    How long to ban a client that exceeds the POST limits, in minutes.
  - setPostCheckTime
```
public void setPostCheckTime(String s)
```
    How often the total POST limit is checked, in minutes.
  - setPostMax
```
public void setPostMax(String s)
```
    Maximum total size of POST requests. @since 0.9.9
  - setPostTotalBanTime
```
public void setPostTotalBanTime(String s)
```
    How long to ban a client that exceeds the total POST limit, in minutes.
  - setPostTotalMax
```
public void setPostTotalMax(String s)
```
    Maximum total size of all POST requests in the check interval.
  - setPrivKeyFile
```
public void setPrivKeyFile(String file)
```
    What filename is this server tunnel's private keys stored in
  - setProfile
```
public void setProfile(String profile)
```
    Set the streaming profile.
  - setProxyAuth
```
public void setProxyAuth(String s)
```
    Set the proxy authentication type. @since 0.8.2
  - setProxyList
```
public void setProxyList(String proxyList)
```
    what HTTP outproxies should be used (httpclient specific)
    Parameters:
    proxyList - the proxy list
  - setProxyUsername
```
public void setProxyUsername(String s)
```
    Username for client proxy authentication.
  - setReachableBy
```
public void setReachableBy(String reachableBy)
```
    what interface should this client/httpclient/ircclient listen on
    Parameters:
    reachableBy - the reachable interface
  - setReduce
```
public void setReduce(String val)
```
    Reduce the number of connections when idle.
  - setReduceCount
```
public void setReduceCount(String val)
```
    Number of connections to reduce to when idle.
  - setReduceTime
```
public void setReduceTime(String val)
```
    Idle time in minutes before reducing connections.
  - setRejectInproxy
```
public void setRejectInproxy(String val)
```
  - setRejectReferer
```
public void setRejectReferer(String val)
```
  - setRejectUserAgents
```
public void setRejectUserAgents(String val)
```
  - setRemoveConfirm
```
public void setRemoveConfirm(String val)
```
    If called with any value (and the form submitted with action=Remove), we really do want to stop and remove the tunnel.
  - setRevokeClient
```
public void setRevokeClient(String[] s)
```
    Revoke access for specified clients (multiple entries in form, values are integers).
    Parameters:
    s - the client indices to revoke
  - setSession
```
public void setSession(HttpSession session)
```
    For session-bound nonce generation and validation
    Parameters:
    session - the HTTP session
  - setShared
```
public void setShared(boolean val)
```
    Share the private key with other client tunnels.
    Parameters:
    val - true to share the private key with other client tunnels
  - setShared
```
public void setShared(String val)
```
    Share the private key with other client tunnels.
    Parameters:
    val - any value triggers shared private key mode
  - setShutdownDelayMax
```
public void setShutdownDelayMax(String val)
```
    The maximum shutdown delay in seconds for server tunnels.
    Parameters:
    val - the maximum shutdown delay in seconds for server tunnels
  - setShutdownDelayMin
```
public void setShutdownDelayMin(String val)
```
    The minimum shutdown delay in seconds for server tunnels.
    Parameters:
    val - the minimum shutdown delay in seconds for server tunnels
  - setSigner
```
public void setSigner(String val)
```
    Set the certificate signer.
  - setSigType
```
public void setSigType(String val)
```
  - setSpoofedHost
```
public void setSpoofedHost(String host)
```
    What host does this http server tunnel spoof
    Parameters:
    host - the spoofed host
  - setSslProxies
```
public void setSslProxies(String s)
```
    Comma-separated list of SSL-capable outproxies. @since 0.9.11
  - setStartOnLoad
```
public void setStartOnLoad(String val)
```
    If called with any value, we want this tunnel to start whenever it is loaded (aka right now and whenever the router is started up)
    Parameters:
    val - any value triggers startup on load
  - setStartupDelayMax
```
public void setStartupDelayMax(String val)
```
    The maximum startup delay in seconds for server tunnels.
    Parameters:
    val - the maximum startup delay in seconds for server tunnels
  - setStartupDelayMin
```
public void setStartupDelayMin(String val)
```
    The minimum startup delay in seconds for server tunnels.
    Parameters:
    val - the minimum startup delay in seconds for server tunnels
  - setTargetDestination
```
public void setTargetDestination(String dest)
```
    What peer does this client tunnel point at
    Parameters:
    dest - the target destination
  - setTargetHost
```
public void setTargetHost(String host)
```
    What host does this server tunnel point at
    Parameters:
    host - the target host
  - setTargetPort
```
public void setTargetPort(String port)
```
    What port does this server tunnel point at
    Parameters:
    port - the target port
  - setTotalDay
```
public void setTotalDay(String s)
```
    Maximum total number of connections per day, enforced by the total limit.
  - setTotalHour
```
public void setTotalHour(String s)
```
    Maximum total number of connections per hour, enforced by the total limit.
  - setTotalMinute
```
public void setTotalMinute(String s)
```
    Maximum total number of connections per minute, enforced by the total limit.
  - setTunnel
```
public void setTunnel(String tunnel)
```
    Set the tunnel number.
    Parameters:
    tunnel - the tunnel
  - setTunnelBackupQuantity
```
public void setTunnelBackupQuantity(String tunnelBackupQuantity)
```
    How many tunnels to hold in reserve to guard against failures In or both in/out
    Parameters:
    tunnelBackupQuantity - the backup quantity
  - setTunnelBackupQuantityOut
```
public void setTunnelBackupQuantityOut(String tunnelBackupQuantity)
```
    How many outbound tunnels to hold in reserve to guard against failures
    Parameters:
    tunnelBackupQuantity - the outbound backup quantity
  - setTunnelDepth
```
public void setTunnelDepth(String tunnelDepth)
```
    How many hops to use for inbound tunnels In or both in/out
    Parameters:
    tunnelDepth - the tunnel depth
  - setTunnelDepthOut
```
public void setTunnelDepthOut(String tunnelDepth)
```
    How many hops to use for outbound tunnels
    Parameters:
    tunnelDepth - the outbound tunnel depth
  - setTunnelQuantity
```
public void setTunnelQuantity(String tunnelQuantity)
```
    How many parallel inbound tunnels to use In or both in/out
    Parameters:
    tunnelQuantity - the tunnel quantity
  - setTunnelQuantityOut
```
public void setTunnelQuantityOut(String tunnelQuantity)
```
    How many parallel outbound tunnels to use
    Parameters:
    tunnelQuantity - the outbound tunnel quantity
  - setTunnelVariance
```
public void setTunnelVariance(String tunnelVariance)
```
    How much randomisation to apply to the depth of tunnels In or both in/out
    Parameters:
    tunnelVariance - the tunnel variance
  - setTunnelVarianceOut
```
public void setTunnelVarianceOut(String tunnelVariance)
```
    How much randomisation to apply to the depth of outbound tunnels
    Parameters:
    tunnelVariance - the outbound tunnel variance
  - setType
```
public void setType(String type)
```
    What type of tunnel (httpclient, ircclient, client, or server). This is required when adding a new tunnel.
    Parameters:
    type - the tunnel type
  - setUniqueLocal
```
public void setUniqueLocal(String val)
```
  - setUseOutproxyPlugin
```
public void setUseOutproxyPlugin(String val)
```
    Use the outproxy plugin for HTTP requests.
  - setUserAgents
```
public void setUserAgents(String agents)
```
  - setUseSSL
```
public void setUseSSL(String val)
```
  - storeMethod
```
public void storeMethod(String method)
```
    Store request method for P-R-G pattern
    Parameters:
    method - the request method
  - useSoraFont
```
public boolean useSoraFont()
```
    Check if the Sora font is enabled.
    Returns:
    true if Sora font is enabled

Class IndexBean

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_context

_group

_helper

_log

NOT_RUNNING

RUNNING

STANDBY

STARTING

Constructor Detail

IndexBean

Method Detail

_t

encrypt

getAltDestHashBase32

getAltDestination

getAltDestinationBase64

getClientDestination

getClientInterface

getClientPort

getClientPort2

getController

getControllerNumbers

getDestHashBase32

getDestination

getDestinationBase64

getEncryptedBase32

getInternalType

getIsOfflineKeys

getIsUsingOutproxyPlugin

getLastMessageID

getMessages

getNextNonce

getNextNonce

getRemainingStartupDelay

getServerTarget

getSharedClient

getSpoofedHost

getTheme

getThemeName

getTunnelCount

getTunnelDescription

getTunnelName

getTunnelStatus

getTunnelType

getType

getTypeName

haveNonce

haveNonce

isClient

isClient

isInitialized

isRejectInproxy

isRejectReferer

isRejectUserAgents

isServer

isServerTargetLinkValid

isSharedClient

isSSLEnabled

isValidIRCServer

ngettext

setAccessList

setAccessMode

setAction

setAddClient

setAllowAccept

setAllowInternalSSL

setAllowReferer

setAllowUserAgent

setAltPrivKeyFile

setCert

setClientHost

setclientKey

setClientport

setClose