ConfigReseedHandler

java.lang.Object

net.i2p.router.web.FormHandler

net.i2p.router.web.helpers.ConfigReseedHandler

public class ConfigReseedHandlerextends FormHandler

Handler for reseed configuration form processing.

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 final Map<String,String>
changes
Reseed URLs the form set, by name.
private final List<String>
removes
Reseed URL names the form cleared.
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
ConfigReseedHandler()
Construct a new ConfigReseedHandler.
Method Summary
Modifier and Type
Method
Description
private boolean
addCheckerStatus(ReseedChecker checker)
Add checker error or status messages to the form.
String
ngettext(String s, String p, int n)
Translate a message with plural forms.
protected void
processForm()
Implement this to perform the final processing (in turn, adding formNotice and formError messages, etc)
private void
resetUrlList()
Replaces the form's URLs with the ones in the config.
private void
saveBoolean(String config, String param)
Save a boolean reseed setting.
private void
saveChanges()
Writes the submitted URLs into the config.
private void
saveString(String config, String param)
Save a string reseed setting.
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
- changes
  private final Map<String,String> changes
  Reseed URLs the form set, by name.
- removes
  private final List<String> removes
  Reseed URL names the form cleared.
Constructor Details
- ConfigReseedHandler
  public ConfigReseedHandler()
  Construct a new ConfigReseedHandler.
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
- addCheckerStatus
  private boolean addCheckerStatus(ReseedChecker checker)
  Add checker error or status messages to the form.
  Parameters:
  checker - the reseed checker whose error or status text is displayed
  Returns:
  true if anything was output
- resetUrlList
  private void resetUrlList()
  Replaces the form's URLs with the ones in the config.
- saveString
  private void saveString(String config, String param)
  Save a string reseed setting.
  Parameters:
  config - the reseed configuration property to change
  param - the form field name to read the value from, empty means remove
- saveBoolean
  private void saveBoolean(String config, String param)
  Save a boolean reseed setting.
  Parameters:
  config - the reseed configuration property to change
  param - the form field name, true if the field is present in the request
- saveChanges
  private void saveChanges()
  Writes the submitted URLs into the config.
- ngettext
  public String ngettext(String s, String p, int n)
  Translate a message with plural forms.
  Parameters:
  s - the singular form
  p - the plural form
  n - the count for plural selection
  Returns:
  the translated string

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

changes

removes

Constructor Details

Method Details

processForm

addCheckerStatus

resetUrlList

saveString

saveBoolean

saveChanges

ngettext