ConfigClientsHandler

java.lang.Object

net.i2p.router.web.FormHandler

net.i2p.router.web.helpers.ConfigClientsHandler

public class ConfigClientsHandlerextends FormHandler

Handles configuration changes for I2P client applications and web apps. Saves changes to clients.config and webapps.config files, manages client installation, updates, and startup configuration.

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 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
ConfigClientsHandler()
Construct a new ConfigClientsHandler.
Method Summary
Private Methods
Modifier and Type
Method
Description
private void
checkPlugin(String app)
Checks the plugin for an update.
private void
deleteClient(int i)
Deletes the client at the index.
private void
installPlugin()
Installs the plugin from the form.
private void
installPlugin(String app, String url)
Install a plugin from a URL.
private void
installPluginFromFile()
Install a plugin from a local file upload.
protected void
processForm()
Implement this to perform the final processing (in turn, adding formNotice and formError messages, etc)
private void
saveClientChanges()
Saves the client changes from the form.
private void
saveClientChanges2()
Writes the client changes to the config.
private void
saveInterfaceChanges()
Handle interface form.
private void
savePluginChanges()
Saves the plugin changes from the form.
private void
saveWebAppChanges()
Saves the webapp changes from the form.
private void
startClient(int i)
Starts the client at the index.
private void
startPlugin(String app)
Starts the plugin.
private void
startWebApp(String app)
Big hack for the moment, not using properties for directory and port Go through all the Jetty servers, find the one serving port 7657, requested and add the .war to that one.
private void
stopClient(int i)
Stop a running client by index.
private void
updateAllPlugins()
Update all installed plugins.
private void
updatePlugin(String app)
Updates the plugin from the update site.
private boolean
verifyProxy()
Plugin checks, updates, and installs are always proxied.
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

Constructor Details
- ConfigClientsHandler
  public ConfigClientsHandler()
  Construct a new ConfigClientsHandler.
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
- saveClientChanges
  private void saveClientChanges()
  Saves the client changes from the form.
- saveClientChanges2
  private void saveClientChanges2() throws IOException
  Writes the client changes to the config.
  Throws:
  IOException - if the writing fails
- stopClient
  private void stopClient(int i)
  Stop a running client by index.
  Parameters:
  i - index into the client app list of the client to stop
- startClient
  private void startClient(int i)
  Starts the client at the index.
  Parameters:
  i - the index of the client
- deleteClient
  private void deleteClient(int i)
  Deletes the client at the index.
  Parameters:
  i - the index of the client
- saveWebAppChanges
  private void saveWebAppChanges()
  Saves the webapp changes from the form.
- savePluginChanges
  private void savePluginChanges()
  Saves the plugin changes from the form.
- startWebApp
  private void startWebApp(String app)
  Big hack for the moment, not using properties for directory and port Go through all the Jetty servers, find the one serving port 7657, requested and add the .war to that one.
  Parameters:
  app - the web app name, also the base name of the .war file in webapps
- installPlugin
  private void installPlugin()
  Installs the plugin from the form.
- installPluginFromFile
  private void installPluginFromFile()
  Install a plugin from a local file upload.
- updatePlugin
  private void updatePlugin(String app)
  Updates the plugin from the update site.
  Parameters:
  app - the name of the plugin
- updateAllPlugins
  private void updateAllPlugins()
  Update all installed plugins.
- installPlugin
  private void installPlugin(String app, String url)
  Install a plugin from a URL.
  Parameters:
  app - null for a new install
  url - http: or file:
- checkPlugin
  private void checkPlugin(String app)
  Checks the plugin for an update.
  Parameters:
  app - the name of the plugin
- verifyProxy
  private boolean verifyProxy()
  Plugin checks, updates, and installs are always proxied. See if the proxy tunnel is available, unless we're configured to use something else (probably not). Outputs form error if returning false.
  Returns:
  true if available
- startPlugin
  private void startPlugin(String app)
  Starts the plugin.
  Parameters:
  app - the name of the plugin
- saveInterfaceChanges
  private void saveInterfaceChanges()
  Handle interface form.

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

Constructor Details

Method Details

processForm

saveClientChanges

saveClientChanges2

stopClient

startClient

deleteClient

saveWebAppChanges

savePluginChanges

startWebApp

installPlugin

installPluginFromFile

updatePlugin

updateAllPlugins

installPlugin

checkPlugin

verifyProxy

startPlugin

saveInterfaceChanges