ConfigUIHandler

java.lang.Object

net.i2p.router.web.FormHandler

net.i2p.router.web.helpers.ConfigUIHandler

public class ConfigUIHandlerextends FormHandler

Handles router console UI configuration and theme management. Processes theme selection, mobile console settings, user management, language settings, password configuration, and display preferences for the router console interface.

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
The name of the config being edited.
private boolean
_embedApps
True to embed the apps in the console.
private boolean
_forceMobileConsole
True to force the mobile console.
private boolean
_shouldSave
True if the form is to be saved.
private boolean
_universalTheming
True to allow theming of all pages.
private boolean
_useSoraFont
True to display the Sora font.
private static final Pattern
CONFIG_PATTERN
Pattern of characters allowed in config keys.
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
ConfigUIHandler()
ConfigUIHandler default constructor.
Method Summary
Modifier and Type
Method
Description
private void
addUser()
Adds a console user from the form.
private void
delUser()
Deletes a console user from the form.
protected void
processForm()
Implement this to perform the final processing (in turn, adding formNotice and formError messages, etc)
private void
saveChanges()
Note - lang change is handled in CSSHelper but we still need to save it here.
void
setEmbedApps(String baa)
Enables embedded application display.
void
setForceMobileConsole(String baa)
Forces the mobile console interface.
void
setShouldsave(String moo)
Sets the save flag for configuration changes.
void
setTheme(String val)
Sets the theme name for configuration.
void
setUniversalTheming(String baa)
Enables universal theming support.
void
setUseSoraFont(String baa)
Enables Sora font usage.
private void
updateLoginTheme(String theme)
Updates the theme of the login page.
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
- CONFIG_PATTERN
  private static final Pattern CONFIG_PATTERN
  Pattern of characters allowed in config keys.
- _shouldSave
  private boolean _shouldSave
  True if the form is to be saved.
- _universalTheming
  private boolean _universalTheming
  True to allow theming of all pages.
- _forceMobileConsole
  private boolean _forceMobileConsole
  True to force the mobile console.
- _embedApps
  private boolean _embedApps
  True to embed the apps in the console.
- _useSoraFont
  private boolean _useSoraFont
  True to display the Sora font.
- _config
  private String _config
  The name of the config being edited.
Constructor Details
- ConfigUIHandler
  public ConfigUIHandler()
  ConfigUIHandler default constructor.
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)
  Sets the save flag for configuration changes.
  Parameters:
  moo - the JSP form value; any string, including null, enables the save
- setUniversalTheming
  public void setUniversalTheming(String baa)
  Enables universal theming support.
  Parameters:
  baa - the JSP form value; any string, including null, enables universal theming
- setForceMobileConsole
  public void setForceMobileConsole(String baa)
  Forces the mobile console interface.
  Parameters:
  baa - the JSP form value; any string, including null, forces the mobile console
- setEmbedApps
  public void setEmbedApps(String baa)
  Enables embedded application display.
  Parameters:
  baa - the JSP form value; any string, including null, enables embedded application display
- setUseSoraFont
  public void setUseSoraFont(String baa)
  Enables Sora font usage.
  Parameters:
  baa - the JSP form value; any string, including null, enables the Sora font
- setTheme
  public void setTheme(String val)
  Sets the theme name for configuration.
  Parameters:
  val - the theme name
- saveChanges
  private void saveChanges()
  Note - lang change is handled in CSSHelper but we still need to save it here.
- addUser
  private void addUser()
  Adds a console user from the form.
- delUser
  private void delUser()
  Deletes a console user from the form.
- updateLoginTheme
  private void updateLoginTheme(String theme)
  Updates the theme of the login page.
  Parameters:
  theme - the new theme name

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

CONFIG_PATTERN

_shouldSave

_universalTheming

_forceMobileConsole

_embedApps

_useSoraFont

_config

Constructor Details

Method Details

processForm

setShouldsave

setUniversalTheming

setForceMobileConsole

setEmbedApps

setUseSoraFont

setTheme

saveChanges

addUser

delUser

updateLoginTheme