net.i2p.i2ptunnel.web
Class IndexBean

java.lang.Object
  extended by net.i2p.i2ptunnel.web.IndexBean
Direct Known Subclasses:
EditBean

public class IndexBean
extends Object

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
protected  I2PAppContext _context
           
protected  TunnelControllerGroup _group
           
protected  GeneralHelper _helper
           
protected  Log _log
           
static String DEFAULT_THEME
           
static int NOT_RUNNING
           
static String PROP_CSS_DISABLED
           
static String PROP_JS_DISABLED
           
static String PROP_THEME_NAME
           
static int RUNNING
           
static int STANDBY
           
static int STARTING
           
 
Constructor Summary
IndexBean()
           
 
Method Summary
protected  String _(String key)
           
 boolean allowCSS()
           
 boolean allowJS()
           
 String getClientDestination(int tunnel)
           
 String getClientInterface(int tunnel)
           
 String getClientPort(int tunnel)
          No validation
 String getClientPort2(int tunnel)
          Returns error message if blank or invalid
protected  TunnelController getController(int tunnel)
           
 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 getInternalType(int tunnel)
           
 boolean getIsUsingOutproxyPlugin(int tunnel)
          For index.jsp
 String getMessages()
          Executes any action requested (start/stop/etc) and dump out the messages.
static String getNextNonce()
           
 String getServerTarget(int tunnel)
           
 String getSharedClient(int tunnel)
           
 String getTheme()
           
 int getTunnelCount()
           
 String getTunnelDescription(int tunnel)
           
 String getTunnelName(int tunnel)
           
 int getTunnelStatus(int tunnel)
           
 String getTunnelType(int tunnel)
           
(package private)  String getType()
           
 String getTypeName(String internalType)
           
 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()
           
 boolean isRejectInproxy(int tunnel)
           
 boolean isServerTargetLinkValid(int tunnel)
          Call this to see if it is ok to linkify getServerTarget()
 boolean isSSLEnabled(int tunnel)
           
protected  String ngettext(String s, String p, int n)
          translate (ngettext)
 void setAccessList(String val)
           
 void setAccessMode(String val)
           
 void setAction(String action)
           
 void setAllowAccept(String moo)
           
 void setAllowInternalSSL(String moo)
           
 void setAllowReferer(String moo)
           
 void setAllowUserAgent(String moo)
           
 void setCert(String val)
           
 void setClientHost(String host)
          I2CP host the router is on, ignored when in router context
 void setClientport(String port)
          I2CP port the router is on, ignored when in router context
 void setClose(String moo)
           
 void setCloseTime(String val)
           
 void setConnectDelay(String moo)
           
 void setDCC(String moo)
           
 void setDelayOpen(String moo)
           
 void setEffort(String val)
          params needed for hashcash and dest modification
 void setEncrypt(String moo)
           
 void setEncryptKey(String val)
           
 void setJumpList(String val)
           
 void setKey1(String s)
          Random keys, hidden in forms
 void setKey2(String s)
           
 void setKey3(String s)
           
 void setKey4(String s)
           
 void setLimitDay(String s)
           
 void setLimitHour(String s)
           
 void setLimitMinute(String s)
           
 void setMaxStreams(String s)
           
 void setMultihome(String moo)
           
 void setName(String name)
          Short name of the tunnel
 void setNewDest(String val)
           
 void setNofilter_customOptions(String customOptions)
          what I2P session overrides should be used
 void setNofilter_description(String description)
          one line description
 void setNofilter_outproxyPassword(String s)
           
 void setNofilter_proxyPassword(String s)
           
 void setNonce(String nonce)
           
 void setOutproxyAuth(String s)
           
 void setOutproxyUsername(String s)
           
 void setPort(String port)
          what port should this client/httpclient/ircclient listen on
 void setPostBanTime(String s)
           
 void setPostCheckTime(String s)
           
 void setPostMax(String s)
          POST limits
 void setPostTotalBanTime(String s)
           
 void setPostTotalMax(String s)
           
 void setPrivKeyFile(String file)
          What filename is this server tunnel's private keys stored in
 void setProfile(String profile)
           
 void setProxyAuth(String s)
          all proxy auth @since 0.8.2
 void setProxyList(String proxyList)
          what HTTP outproxies should be used (httpclient specific)
 void setProxyUsername(String s)
           
 void setReachableBy(String reachableBy)
          what interface should this client/httpclient/ircclient listen on
 void setReduce(String moo)
           
 void setReduceCount(String val)
           
 void setReduceTime(String val)
           
 void setRejectInproxy(String moo)
           
 void setRemoveConfirm(String moo)
          If called with any value (and the form submitted with action=Remove), we really do want to stop and remove the tunnel.
 void setShared(boolean val)
           
 void setShared(String moo)
           
 void setSigner(String val)
           
 void setSigType(String val)
           
 void setSpoofedHost(String host)
          What host does this http server tunnel spoof
 void setSslProxies(String s)
           
 void setStartOnLoad(String moo)
          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 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)
           
 void setTotalHour(String s)
           
 void setTotalMinute(String s)
           
 void setTunnel(String tunnel)
           
 void setTunnelBackupQuantity(String tunnelBackupQuantity)
          how many tunnels to hold in reserve to guard against failures
 void setTunnelDepth(String tunnelDepth)
          how many hops to use for inbound tunnels
 void setTunnelQuantity(String tunnelQuantity)
          how many parallel inbound tunnels to use
 void setTunnelVariance(String tunnelVariance)
          how much randomisation to apply to the depth of tunnels
 void setType(String type)
          What type of tunnel (httpclient, ircclient, client, or server).
 void setUniqueLocal(String moo)
           
 void setUseOutproxyPlugin(String moo)
           
 void setUseSSL(String moo)
           
 
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

_log

protected final Log _log

_group

protected final TunnelControllerGroup _group

_helper

protected final GeneralHelper _helper

RUNNING

public static final int RUNNING
See Also:
Constant Field Values

STARTING

public static final int STARTING
See Also:
Constant Field Values

NOT_RUNNING

public static final int NOT_RUNNING
See Also:
Constant Field Values

STANDBY

public static final int STANDBY
See Also:
Constant Field Values

PROP_THEME_NAME

public static final String PROP_THEME_NAME
See Also:
Constant Field Values

DEFAULT_THEME

public static final String DEFAULT_THEME
See Also:
Constant Field Values

PROP_CSS_DISABLED

public static final String PROP_CSS_DISABLED
See Also:
Constant Field Values

PROP_JS_DISABLED

public static final String PROP_JS_DISABLED
See Also:
Constant Field Values
Constructor Detail

IndexBean

public IndexBean()
Method Detail

isInitialized

public boolean isInitialized()
Since:
0.9.4

getNextNonce

public static String getNextNonce()

setNonce

public void setNonce(String nonce)

setAction

public void setAction(String action)

setTunnel

public void setTunnel(String tunnel)

getMessages

public String getMessages()
Executes any action requested (start/stop/etc) and dump out the messages.

Returns:
HTML escaped

getTheme

public String getTheme()

allowCSS

public boolean allowCSS()

allowJS

public boolean allowJS()

getTunnelCount

public int getTunnelCount()

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.


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.


getTunnelName

public String getTunnelName(int tunnel)

getClientPort

public String getClientPort(int tunnel)
No validation


getClientPort2

public String getClientPort2(int tunnel)
Returns error message if blank or invalid

Since:
0.9.3

getTunnelType

public String getTunnelType(int tunnel)

getTypeName

public String getTypeName(String internalType)

getInternalType

public String getInternalType(int tunnel)

getClientInterface

public String getClientInterface(int tunnel)

getTunnelStatus

public int getTunnelStatus(int tunnel)

getTunnelDescription

public String getTunnelDescription(int tunnel)

getSharedClient

public String getSharedClient(int tunnel)

getClientDestination

public String getClientDestination(int tunnel)

isServerTargetLinkValid

public boolean isServerTargetLinkValid(int tunnel)
Call this to see if it is ok to linkify getServerTarget()

Since:
0.8.3

getServerTarget

public String getServerTarget(int tunnel)
Returns:
valid host:port only if isServerTargetLinkValid() is true

getDestination

protected Destination getDestination(int tunnel)
Works even if tunnel is not running.

Returns:
Destination or null
Since:
0.9.17

getDestinationBase64

public String getDestinationBase64(int tunnel)
Works even if tunnel is not running.

Returns:
Base64 or ""

getDestHashBase32

public String getDestHashBase32(int tunnel)
Works even if tunnel is not running.

Returns:
"{52 chars}.b32.i2p" or ""

getIsUsingOutproxyPlugin

public boolean getIsUsingOutproxyPlugin(int tunnel)
For index.jsp

Returns:
true if the plugin is enabled, installed, and running
Since:
0.9.11

setType

public void setType(String type)
What type of tunnel (httpclient, ircclient, client, or server). This is required when adding a new tunnel.


getType

String getType()

setName

public void setName(String name)
Short name of the tunnel


setNofilter_description

public void setNofilter_description(String description)
one line description


setClientHost

public void setClientHost(String host)
I2CP host the router is on, ignored when in router context


setClientport

public void setClientport(String port)
I2CP port the router is on, ignored when in router context


setTunnelDepth

public void setTunnelDepth(String tunnelDepth)
how many hops to use for inbound tunnels


setTunnelQuantity

public void setTunnelQuantity(String tunnelQuantity)
how many parallel inbound tunnels to use


setTunnelVariance

public void setTunnelVariance(String tunnelVariance)
how much randomisation to apply to the depth of tunnels


setTunnelBackupQuantity

public void setTunnelBackupQuantity(String tunnelBackupQuantity)
how many tunnels to hold in reserve to guard against failures


setNofilter_customOptions

public void setNofilter_customOptions(String customOptions)
what I2P session overrides should be used


setProxyList

public void setProxyList(String proxyList)
what HTTP outproxies should be used (httpclient specific)


setPort

public void setPort(String port)
what port should this client/httpclient/ircclient listen on


setReachableBy

public void setReachableBy(String reachableBy)
what interface should this client/httpclient/ircclient listen on


setTargetDestination

public void setTargetDestination(String dest)
What peer does this client tunnel point at


setTargetHost

public void setTargetHost(String host)
What host does this server tunnel point at


setTargetPort

public void setTargetPort(String port)
What port does this server tunnel point at


setSpoofedHost

public void setSpoofedHost(String host)
What host does this http server tunnel spoof


setPrivKeyFile

public void setPrivKeyFile(String file)
What filename is this server tunnel's private keys stored in


setRemoveConfirm

public void setRemoveConfirm(String moo)
If called with any value (and the form submitted with action=Remove), we really do want to stop and remove the tunnel.


setStartOnLoad

public void setStartOnLoad(String moo)
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)


setShared

public void setShared(String moo)

setShared

public void setShared(boolean val)

setConnectDelay

public void setConnectDelay(String moo)

setProfile

public void setProfile(String profile)

setReduce

public void setReduce(String moo)

setClose

public void setClose(String moo)

setEncrypt

public void setEncrypt(String moo)

setDCC

public void setDCC(String moo)
Since:
0.8.9

setUseSSL

public void setUseSSL(String moo)
Since:
0.9.9

isSSLEnabled

public boolean isSSLEnabled(int tunnel)
Since:
0.9.9

setRejectInproxy

public void setRejectInproxy(String moo)
Since:
0.9.12

isRejectInproxy

public boolean isRejectInproxy(int tunnel)
Since:
0.9.12

setUniqueLocal

public void setUniqueLocal(String moo)
Since:
0.9.13

setAccessMode

public void setAccessMode(String val)

setDelayOpen

public void setDelayOpen(String moo)

setNewDest

public void setNewDest(String val)

setReduceTime

public void setReduceTime(String val)

setReduceCount

public void setReduceCount(String val)

setEncryptKey

public void setEncryptKey(String val)

setAccessList

public void setAccessList(String val)

setJumpList

public void setJumpList(String val)

setCloseTime

public void setCloseTime(String val)

setAllowUserAgent

public void setAllowUserAgent(String moo)
Since:
0.9.14

setAllowReferer

public void setAllowReferer(String moo)
Since:
0.9.14

setAllowAccept

public void setAllowAccept(String moo)
Since:
0.9.14

setAllowInternalSSL

public void setAllowInternalSSL(String moo)
Since:
0.9.14

setMultihome

public void setMultihome(String moo)
Since:
0.9.18

setProxyAuth

public void setProxyAuth(String s)
all proxy auth @since 0.8.2


setProxyUsername

public void setProxyUsername(String s)

setNofilter_proxyPassword

public void setNofilter_proxyPassword(String s)

setOutproxyAuth

public void setOutproxyAuth(String s)

setOutproxyUsername

public void setOutproxyUsername(String s)

setNofilter_outproxyPassword

public void setNofilter_outproxyPassword(String s)

setSslProxies

public void setSslProxies(String s)
Since:
0.9.11

setUseOutproxyPlugin

public void setUseOutproxyPlugin(String moo)
Since:
0.9.11

setLimitMinute

public void setLimitMinute(String s)

setLimitHour

public void setLimitHour(String s)

setLimitDay

public void setLimitDay(String s)

setTotalMinute

public void setTotalMinute(String s)

setTotalHour

public void setTotalHour(String s)

setTotalDay

public void setTotalDay(String s)

setMaxStreams

public void setMaxStreams(String s)

setPostMax

public void setPostMax(String s)
POST limits

Since:
0.9.9

setPostTotalMax

public void setPostTotalMax(String s)

setPostCheckTime

public void setPostCheckTime(String s)

setPostBanTime

public void setPostBanTime(String s)

setPostTotalBanTime

public void setPostTotalBanTime(String s)

setEffort

public void setEffort(String val)
params needed for hashcash and dest modification


setCert

public void setCert(String val)

setSigner

public void setSigner(String val)

setSigType

public void setSigType(String val)
Since:
0.9.12

setKey1

public void setKey1(String s)
Random keys, hidden in forms

Since:
0.9.18

setKey2

public void setKey2(String s)

setKey3

public void setKey3(String s)

setKey4

public void setKey4(String s)

getController

protected TunnelController getController(int tunnel)

_

protected String _(String key)

ngettext

protected String ngettext(String s,
                          String p,
                          int n)
translate (ngettext)

Since:
0.9.7