WizardHandler

java.lang.Object

net.i2p.router.web.FormHandler

net.i2p.router.web.helpers.WizardHandler

public class WizardHandlerextends FormHandler

The new user wizard.

This handler has request scope (as all FormHandlers must), so it controls the test via the helper, which has session scope.

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 WizardHelper
_helper
Holds the wizard's state between requests.
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
WizardHandler()
No session-scoped helper is bound yet; setWizardHelper(WizardHelper) supplies it before processForm() runs.
Method Summary
Modifier and Type
Method
Description
private void
cancelNDT()
Cancel the test.
protected void
processForm()
Implement this to perform the final processing (in turn, adding formNotice and formError messages, etc)
void
setWizardHelper(WizardHelper helper)
Bind the helper (scope session) to this handler (scope request).
private void
startNDT()
Start the test.
private boolean
updateRates(Map<String,String> changes)
Modified from ConfigNetHandler.
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
- _helper
  private WizardHelper _helper
  Holds the wizard's state between requests.
Constructor Details
- WizardHandler
  public WizardHandler()
  No session-scoped helper is bound yet; setWizardHelper(WizardHelper) supplies it before processForm() runs.
Method Details
- setWizardHelper
  public void setWizardHelper(WizardHelper helper)
  Bind the helper (scope session) to this handler (scope request).
  Parameters:
  helper - session-scoped WizardHelper holding the wizard state this request handler drives
- 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
- updateRates
  private boolean updateRates(Map<String,String> changes)
  Modified from ConfigNetHandler.
  Parameters:
  changes - the map of config key-value pairs to be saved; each rate setting that changed is added to it
  Returns:
  true if any bandwidth, share or burst setting was written
- startNDT
  private void startNDT()
  Start the test.
- cancelNDT
  private void cancelNDT()
  Cancel the test.

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

_helper

Constructor Details

Method Details

setWizardHelper

processForm

updateRates

startNDT

cancelNDT