ConfigAdvancedHandler

java.lang.Object

net.i2p.router.web.FormHandler

net.i2p.router.web.helpers.ConfigAdvancedHandler

public class ConfigAdvancedHandlerextends FormHandler

Handles form submissions from the advanced configuration page. Processes and saves changes to router configuration including floodfill settings and advanced router properties. Validates permissions and applies configuration changes.

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 String
_config
Settings as the form submitted them.
private String
_ff
Property filter the page is showing.
private String
_oldConfig
Settings as they were before the form.
private boolean
_shouldSave
True when the form asks for the settings to be written.
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
ConfigAdvancedHandler()
Creates a handler; the container calls it with no arguments before each submission.
Method Summary
Modifier and Type
Method
Description
protected void
processForm()
Implement this to perform the final processing (in turn, adding formNotice and formError messages, etc)
private void
saveChanges()
The user made changes to the config and wants to save them, so lets go ahead and do so.
private void
saveFF()
Save floodfill settings.
void
setFf(String ff)
Set the floodfill status from form submission.
void
setNofilter_config(String val)
Set the config text.
void
setNofilter_oldConfig(String val)
Set the previous config text for diff comparison.
void
setShouldsave(String moo)
Set whether to save configuration.
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
- _shouldSave
  private boolean _shouldSave
  True when the form asks for the settings to be written.
- _oldConfig
  private String _oldConfig
  Settings as they were before the form.
- _config
  private String _config
  Settings as the form submitted them.
- _ff
  private String _ff
  Property filter the page is showing.
Constructor Details
- ConfigAdvancedHandler
  public ConfigAdvancedHandler()
  Creates a handler; the container calls it with no arguments before each submission.
Method Details
- processForm
  protected void processForm()
  Description copied from class: FormHandler
  Implement this to perform the final processing (in turn, adding formNotice and formError messages, etc)
  Will only be called if _action is non-null and the nonce is valid.
  Specified by:
  processForm in class FormHandler
- setShouldsave
  public void setShouldsave(String moo)
  Set whether to save configuration.
  Parameters:
  moo - ignored; the value only marks saving as enabled
- setFf
  public void setFf(String ff)
  Set the floodfill status from form submission.
  Parameters:
  ff - the floodfill status
- setNofilter_config
  public void setNofilter_config(String val)
  Set the config text.
  Parameters:
  val - the config text
- setNofilter_oldConfig
  public void setNofilter_oldConfig(String val)
  Set the previous config text for diff comparison.
  Parameters:
  val - the previous config text
- saveChanges
  private void saveChanges()
  The user made changes to the config and wants to save them, so lets go ahead and do so.
  We saved the previous config in the form, so we do a diff between the two. This will reduce the chance of undoing some change that happened in-between.
- saveFF
  private void saveFF()
  Save floodfill settings.

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

_shouldSave

_oldConfig

_config

_ff

Constructor Details

Method Details

processForm

setShouldsave

setFf

setNofilter_config

setNofilter_oldConfig

saveChanges

saveFF