ConfigNetHandler

java.lang.Object

net.i2p.router.web.FormHandler

net.i2p.router.web.helpers.ConfigNetHandler

public class ConfigNetHandlerextends FormHandler

Handler to deal with form submissions from the main config form and act upon the values.

Used for both /config and /confignet.

Nested Class Summary
Nested classes/interfaces inherited from class FormHandler
FormHandler.Message
Modifier and Type
Class
Description
static class
FormHandler.Message
Message class to encapsulate the message text and the canClose flag.
Field Summary
Fields
Modifier and Type
Field
Description
private boolean
_dynamicKeys
Form flag for dynamic key re-creation.
private boolean
_hiddenMode
Form flag for hidden mode.
private String
_inboundRate
Form value for the inbound bandwidth limit.
private boolean
_ipv4Firewalled
Form flag for forcing IPv4 firewalled.
private boolean
_ipv6Firewalled
Form flag for forcing IPv6 firewalled.
private String
_ipv6Mode
Form value for the IPv6 mode.
private boolean
_laptop
Form flag for the laptop mode.
private String
_ntcpAutoIP
Form value for the NTCP auto-detected IP.
private boolean
_ntcpAutoPort
Form flag for picking a random NTCP port.
private String
_ntcpHostname
Form value for the NTCP bind address.
private String
_ntcpPort
Form value for the NTCP port.
private String
_outboundRate
Form value for the outbound bandwidth limit.
private boolean
_ratesOnly
True to save the bandwidth limits only.
private boolean
_requireIntroductions
Form flag for requiring introductions.
private boolean
_saveRequested
True when the form was submitted to save.
private String
_sharePct
Form value for the share percentage.
private String
_udpAutoIP
Form value for the UDP auto-detected IP.
private boolean
_udpDisabled
Form flag for disabling UDP.
private String
_udpHost1
Form value for the UDP bind address.
private String
_udpPort
Form value for the UDP port.
private boolean
_upnp
Form flag for enabling UPnP.
private final Map<String,String>
changes
Config changes to show after a save.
(package private) static final int
DEF_BURST_PCT
Default burst percentage.
(package private) static final int
DEF_BURST_TIME
Default burst time.
private static final String
PROP_HIDDEN
Config key for hidden mode.
Fields inherited from class FormHandler
_action, _context, _log, _method, _out, _requestWrapper, _session, _settings
Modifier and Type
Field
Description
protected String
_action
Form action.
protected RouterContext
_context
Router context.
protected Log
_log
Class logger.
protected String
_method
Request method.
protected Writer
_out
Output writer.
protected RequestWrapper
_requestWrapper
Only for multipart/form-data.
protected HttpSession
_session
HTTP session for nonce validation.
protected Map
_settings
Not for multipart/form-data, will be null.
Constructor Summary
Constructors
Constructor
Description
ConfigNetHandler()
Create a new handler.
Method Summary
Modifier and Type
Method
Description
private void
hiddenSwitch()
A full restart is required to apply a hidden mode change.
protected void
processForm()
Applies the submitted form, saving when a save was requested.
private void
saveChanges()
The user made changes to the network config and wants to save them, so lets go ahead and do so.
void
setDisableUDP(String foo)
Set whether UDP transport is disabled.
void
setDynamicKeys(String moo)
Set that the user wants dynamic keys.
void
setEnableloadtesting(String moo)
Enable load testing.
void
setInboundrate(String rate)
Set the inbound rate.
void
setIPv4Firewalled(String moo)
Set whether IPv4 is firewalled.
void
setIpv6(String mode)
Set the IPv6 mode configuration.
void
setIPv6Firewalled(String moo)
Set whether IPv6 is firewalled.
void
setLaptop(String moo)
Set that the user wants laptop mode enabled.
void
setNtcpAutoIP(String mode)
Set the NTCP auto IP mode.
void
setNtcpAutoPort(String mode)
Set the NTCP auto port mode.
void
setNtcphost(String host)
Set the NTCP hostname.
void
setNtcpport(String port)
Set the NTCP port.
void
setOutboundrate(String rate)
Set the outbound rate.
void
setRatesOnly(String foo)
Set rates-only mode (skip IP/transport changes).
void
setRequireIntroductions(String moo)
Set that the user wants to require introducers.
void
setSave(String moo)
Set that the user wants to save.
void
setSharePercentage(String pct)
Set the share percentage.
void
setUdpAutoIP(String mode)
Set the UDP address detection mode and whether the address is withheld.
void
setUdpHost1(String host)
Set the first UDP host.
void
setUdpPort(String port)
Set the UDP port.
void
setUpnp(String moo)
Set that the user wants UPnP enabled.
private boolean
updateRates()
Apply the new rate settings, returning whether they changed.
private boolean
verifyAddress(String addr)
Do basic verification of address here to prevent problems later.
Methods inherited from class FormHandler
_t, _t, _t, _x, addFormError, addFormError, addFormErrorNoEscape, addFormErrorNoEscape, addFormNotice, addFormNotice, addFormNoticeNoEscape, addFormNoticeNoEscape, getAllMessages, getErrors, getJettyString, getNotices, isAdvanced, resolveEffectiveAction, setAction, setContextId, setNonce, setRequestWrapper, setSettings, storeMethod, storeSession, storeWriter
Modifier and Type
Method
Description
String
_t(String s)
Translate a string.
String
_t(String s, Object o)
Translate a string with a parameter This is a lot more expensive than _t(s), so use sparingly.
String
_t(String s, Object o, Object o2)
Translate a string with two parameters.
static String
_x(String s)
Mark a string for extraction by xgettext and translation.
protected void
addFormError(String errorMsg)
Add an error message to display Use if it does not include a link.
protected void
addFormError(String errorMsg, boolean canClose)
Add an error message to display Use if it does not include a link.
protected void
addFormErrorNoEscape(String msg)
Add an error message to display Use if it includes a link or other formatting.
protected void
addFormErrorNoEscape(String msg, boolean canClose)
Add an error message to display Use if it includes a link or other formatting.
protected void
addFormNotice(String msg)
Add a non-error message to display Use if it does not include a link.
protected void
addFormNotice(String msg, boolean canClose)
Add a non-error message to display Use if it does not include a link.
protected void
addFormNoticeNoEscape(String msg)
Add a non-error message to display Use if it includes a link or other formatting.
protected void
addFormNoticeNoEscape(String msg, boolean canClose)
Add a non-error message to display Use if it includes a link or other formatting.
String
getAllMessages()
Display everything, wrap it in a div for consistent presentation.
String
getErrors()
Display any error messages (processing the form if it hasn't been yet).
protected String
getJettyString(String key)
FormHandler.setSettings(Map) must have been called previously Curses Jetty for returning arrays.
String
getNotices()
Display any non-error messages (processing the form if it hasn't been yet).
boolean
isAdvanced()
Same as HelperBase.
static String
resolveEffectiveAction(String action, Map<?,?> settings)
Resolve which operation the user actually requested.
void
setAction(String val)
Action value.
void
setContextId(String contextId)
Configure this bean to query a particular router context.
void
setNonce(String val)
Nonce value.
void
setRequestWrapper(RequestWrapper rw)
Only set by formhandler.jsi for multipart/form-data.
void
setSettings(Map settings)
For many forms, it's easiest just to put all the parameters here.
void
storeMethod(String val)
Call this to prevent changes using GET.
void
storeSession(HttpSession session)
For nonce validation.
void
storeWriter(Writer out)
Store the output writer for inline form processing.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- _saveRequested
  private boolean _saveRequested
  True when the form was submitted to save.
- _requireIntroductions
  private boolean _requireIntroductions
  Form flag for requiring introductions.
- _hiddenMode
  private boolean _hiddenMode
  Form flag for hidden mode.
- _dynamicKeys
  private boolean _dynamicKeys
  Form flag for dynamic key re-creation.
- _ntcpHostname
  private String _ntcpHostname
  Form value for the NTCP bind address.
- _ntcpPort
  private String _ntcpPort
  Form value for the NTCP port.
- _udpHost1
  private String _udpHost1
  Form value for the UDP bind address.
- _udpPort
  private String _udpPort
  Form value for the UDP port.
- _udpAutoIP
  private String _udpAutoIP
  Form value for the UDP auto-detected IP.
- _ntcpAutoIP
  private String _ntcpAutoIP
  Form value for the NTCP auto-detected IP.
- _ntcpAutoPort
  private boolean _ntcpAutoPort
  Form flag for picking a random NTCP port.
- _upnp
  private boolean _upnp
  Form flag for enabling UPnP.
- _laptop
  private boolean _laptop
  Form flag for the laptop mode.
- _inboundRate
  private String _inboundRate
  Form value for the inbound bandwidth limit.
- _outboundRate
  private String _outboundRate
  Form value for the outbound bandwidth limit.
- _sharePct
  private String _sharePct
  Form value for the share percentage.
- _ratesOnly
  private boolean _ratesOnly
  True to save the bandwidth limits only.
- _udpDisabled
  private boolean _udpDisabled
  Form flag for disabling UDP.
- _ipv6Mode
  private String _ipv6Mode
  Form value for the IPv6 mode.
- _ipv4Firewalled
  private boolean _ipv4Firewalled
  Form flag for forcing IPv4 firewalled.
- _ipv6Firewalled
  private boolean _ipv6Firewalled
  Form flag for forcing IPv6 firewalled.
- changes
  private final Map<String,String> changes
  Config changes to show after a save.
- PROP_HIDDEN
  private static final String PROP_HIDDEN
  Config key for hidden mode.
  See Also:
  Constant Field Values
- DEF_BURST_PCT
  static final int DEF_BURST_PCT
  Default burst percentage.
  See Also:
  Constant Field Values
- DEF_BURST_TIME
  static final int DEF_BURST_TIME
  Default burst time.
  See Also:
  Constant Field Values
Constructor Details
- ConfigNetHandler
  public ConfigNetHandler()
  Create a new handler.
Method Details
- processForm
  protected void processForm()
  Applies the submitted form, saving when a save was requested.
  Specified by:
  processForm in class FormHandler
- setSave
  public void setSave(String moo)
  Set that the user wants to save.
  Parameters:
  moo - a placeholder for the setter signature; the value is never read
- setRequireIntroductions
  public void setRequireIntroductions(String moo)
  Set that the user wants to require introducers.
  Parameters:
  moo - a placeholder for the setter signature; the value is never read
- setDynamicKeys
  public void setDynamicKeys(String moo)
  Set that the user wants dynamic keys.
  Parameters:
  moo - a placeholder for the setter signature; the value is never read
- setEnableloadtesting
  public void setEnableloadtesting(String moo)
  Enable load testing.
  Parameters:
  moo - a placeholder for the setter signature; the value is never read
- setUdpAutoIP
  public void setUdpAutoIP(String mode)
  Set the UDP address detection mode and whether the address is withheld.
  Parameters:
  mode - comma-separated list of IP address detection sources to use ("local", "upnp", "ssu"), "fixed" to use the manually entered address, or "hidden" to withhold our address from the NetDb
- setNtcpAutoIP
  public void setNtcpAutoIP(String mode)
  Set the NTCP auto IP mode.
  Parameters:
  mode - the auto IP mode
- setNtcpAutoPort
  public void setNtcpAutoPort(String mode)
  Set the NTCP auto port mode.
  Parameters:
  mode - the auto port mode
- setUpnp
  public void setUpnp(String moo)
  Set that the user wants UPnP enabled.
  Parameters:
  moo - a placeholder for the setter signature; the value is never read
- setLaptop
  public void setLaptop(String moo)
  Set that the user wants laptop mode enabled.
  Parameters:
  moo - a placeholder for the setter signature; the value is never read
- setIPv4Firewalled
  public void setIPv4Firewalled(String moo)
  Set whether IPv4 is firewalled.
  Parameters:
  moo - a placeholder for the setter signature; the value is never read
- setIPv6Firewalled
  public void setIPv6Firewalled(String moo)
  Set whether IPv6 is firewalled.
  Parameters:
  moo - a placeholder for the setter signature; the value is never read
- setNtcphost
  public void setNtcphost(String host)
  Set the NTCP hostname.
  Parameters:
  host - the hostname to store, trimmed of surrounding whitespace; null stores null
- setNtcpport
  public void setNtcpport(String port)
  Set the NTCP port.
  Parameters:
  port - the port number
- setUdpHost1
  public void setUdpHost1(String host)
  Set the first UDP host.
  Parameters:
  host - the hostname to store, trimmed of surrounding whitespace; null stores null
- setUdpPort
  public void setUdpPort(String port)
  Set the UDP port.
  Parameters:
  port - the port number
- setInboundrate
  public void setInboundrate(String rate)
  Set the inbound rate.
  Parameters:
  rate - the inbound rate
- setOutboundrate
  public void setOutboundrate(String rate)
  Set the outbound rate.
  Parameters:
  rate - the outbound rate
- setSharePercentage
  public void setSharePercentage(String pct)
  Set the share percentage.
  Parameters:
  pct - the percentage to store, trimmed of surrounding whitespace; null leaves the percentage out of the pending changes
- setRatesOnly
  public void setRatesOnly(String foo)
  Set rates-only mode (skip IP/transport changes).
  Parameters:
  foo - a placeholder for the setter signature; the value is never read
- setDisableUDP
  public void setDisableUDP(String foo)
  Set whether UDP transport is disabled.
  Parameters:
  foo - the disable UDP mode
- setIpv6
  public void setIpv6(String mode)
  Set the IPv6 mode configuration.
  Parameters:
  mode - the IPv6 mode
- saveChanges
  private void saveChanges()
  The user made changes to the network config and wants to save them, so lets go ahead and do so.
- verifyAddress
  private boolean verifyAddress(String addr)
  Do basic verification of address here to prevent problems later.
  Parameters:
  addr - the address string to verify
  Returns:
  true if the address parses and is publicly routable; false adds a form error describing which check failed
- hiddenSwitch
  private void hiddenSwitch()
  A full restart is required to apply a hidden mode change. The new keys are not built on shutdown: Router.PROP_REBUILD_KEYS has been saved as true, so the next startup kills the old keys. There is no rekey-only path here, and registerWrapperNotifier() is safe to call whether or not a wrapper is present - its shutdown task notifies the wrapper only when there is one.
- updateRates
  private boolean updateRates()
  Apply the new rate settings, returning whether they changed.
  Returns:
  true if any rate or share property was staged in the pending changes map, meaning a restart is needed to apply it

Nested Class Summary

Nested classes/interfaces inherited from class FormHandler

Field Summary

Fields inherited from class FormHandler

Constructor Summary

Method Summary

Methods inherited from class FormHandler

Methods inherited from class Object

Field Details

_saveRequested

_requireIntroductions

_hiddenMode

_dynamicKeys

_ntcpHostname

_ntcpPort

_udpHost1

_udpPort

_udpAutoIP

_ntcpAutoIP

_ntcpAutoPort

_upnp

_laptop

_inboundRate

_outboundRate

_sharePct

_ratesOnly

_udpDisabled

_ipv6Mode

_ipv4Firewalled

_ipv6Firewalled

changes

PROP_HIDDEN

DEF_BURST_PCT

DEF_BURST_TIME

Constructor Details

Method Details

processForm

setSave

setRequireIntroductions

setDynamicKeys

setEnableloadtesting

setUdpAutoIP

setNtcpAutoIP

setNtcpAutoPort

setUpnp

setLaptop

setIPv4Firewalled

setIPv6Firewalled

setNtcphost

setNtcpport

setUdpHost1

setUdpPort

setInboundrate

setOutboundrate

setSharePercentage

setRatesOnly

setDisableUDP

setIpv6

saveChanges

verifyAddress

hiddenSwitch

updateRates