ConfigServiceHandler

java.lang.Object

net.i2p.router.web.FormHandler

net.i2p.router.web.ConfigServiceHandler

public class ConfigServiceHandlerextends FormHandler

Handler to deal with form submissions from the service config form and act upon the values.

Nested Class Summary
Nested Classes
Modifier and Type
Class
Description
private static class
ConfigServiceHandler.FinalWrapperTask
Tell the wrapper we are stopped.
private static class
ConfigServiceHandler.UpdateWrapperOrRekeyTask
Rekey and/or tell the wrapper we are stopping.
Nested classes/interfaces inherited from class FormHandler
FormHandler.Message, FormHandler.RateLimitEntry
Modifier and Type
Class
Description
static class
FormHandler.Message
Message class to encapsulate the message text and the canClose flag.
(package private) static class
FormHandler.RateLimitEntry
One window's POST count.
Field Summary
Fields
Modifier and Type
Field
Description
private static final String
LISTENER_AVAILABLE
Wrapper version with the listener API.
private static final String
LOCATION_AVAILABLE
Wrapper version with the location command.
private static final String
PROPERTIES_AVAILABLE
Wrapper version with the properties command.
private static WrapperListener
wrapperListener
Listener for the wrapper service commands.
Fields inherited from class FormHandler
_action, _context, _log, _method, _out, _requestWrapper, _session, _settings, RATE_LIMIT_GLOBAL_KEY, RATE_LIMIT_MAP, RATE_LIMIT_MAX_POSTS, RATE_LIMIT_WINDOW_MS
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.
(package private) static final String
RATE_LIMIT_GLOBAL_KEY
The single budget key the console charges POSTs to.
(package private) static final ConcurrentHashMap<String, FormHandler.RateLimitEntry>
RATE_LIMIT_MAP
Live budgets, keyed by the value passed to checkRateLimit().
(package private) static final int
RATE_LIMIT_MAX_POSTS
POSTs admitted per window per key before further ones are refused.
(package private) static final int
RATE_LIMIT_WINDOW_MS
Length of one rate-limit window, in ms.
Constructor Summary
Constructors
Constructor
Description
ConfigServiceHandler()
Creates a handler; the container calls it with no arguments before each submission.
Method Summary
Modifier and Type
Method
Description
private void
browseOnStartup(boolean shouldLaunchBrowser)
Sets whether the browser opens at startup.
private void
changeSystray(boolean enable)
Enable/disable and start/stop systray.
private void
disableService()
Disables the router as a system service.
private void
enableService()
Enables the router as a system service.
private void
execServiceAction(String action)
Run the consolidated service management script (service.ps1).
String
getConsoleURL()
Get the console URL.
boolean
isSystrayEnabled()
Is the systray enabled?
protected void
processForm()
Implement this to perform the final processing (in turn, adding formNotice and formError messages, etc)
(package private) static void
registerSignalHandler(RouterContext ctx)
Register a handler for signals, so we can handle HUP from the wrapper (wrapper 3.2.0 or higher).
private void
registerWrapperNotifier(int code, boolean rekey)
Register two shutdown hooks, one to rekey and/or tell the wrapper we are stopping, and a final one to tell the wrapper we are stopped.
static void
registerWrapperNotifier(RouterContext ctx, int code, boolean rekey)
Register two shutdown hooks, one to rekey and/or tell the wrapper we are stopping, and a final one to tell the wrapper we are stopped.
boolean
shouldShowCancelGraceful()
Should we show the cancel button?
boolean
shouldShowSystray()
Should we show the systray controls?
static void
unregisterSignalHandler()
Unregister the handler for signals.
static File
wrapperLogFile(I2PAppContext ctx)
Does not necessarily exist.
Methods inherited from class FormHandler
_t, _t, _t, _x, addFormError, addFormError, addFormErrorNoEscape, addFormErrorNoEscape, addFormNotice, addFormNotice, addFormNoticeNoEscape, addFormNoticeNoEscape, checkRateLimit, cleanupRateLimits, 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.
(package private) static boolean
checkRateLimit(String key, long now)
Check and record one form submission against the budget for key.
(package private) static void
cleanupRateLimits(long now)
Remove budgets that have seen no POST for two full windows.
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
- wrapperListener
  private static WrapperListener wrapperListener
  Listener for the wrapper service commands.
- LISTENER_AVAILABLE
  private static final String LISTENER_AVAILABLE
  Wrapper version with the listener API.
  See Also:
  Constant Field Values
- PROPERTIES_AVAILABLE
  private static final String PROPERTIES_AVAILABLE
  Wrapper version with the properties command.
  See Also:
  Constant Field Values
- LOCATION_AVAILABLE
  private static final String LOCATION_AVAILABLE
  Wrapper version with the location command.
  See Also:
  Constant Field Values
Constructor Details
- ConfigServiceHandler
  public ConfigServiceHandler()
  Creates a handler; the container calls it with no arguments before each submission.
Method Details
- registerWrapperNotifier
  private void registerWrapperNotifier(int code, boolean rekey)
  Register two shutdown hooks, one to rekey and/or tell the wrapper we are stopping, and a final one to tell the wrapper we are stopped.
  Parameters:
  code - the exit code
  rekey - true to kill the router's keys on shutdown
- registerWrapperNotifier
  public static void registerWrapperNotifier(RouterContext ctx, int code, boolean rekey)
  Register two shutdown hooks, one to rekey and/or tell the wrapper we are stopping, and a final one to tell the wrapper we are stopped.
  Parameters:
  ctx - the router context
  code - the exit code
  rekey - whether to rekey
- registerSignalHandler
  static void registerSignalHandler(RouterContext ctx)
  Register a handler for signals, so we can handle HUP from the wrapper (wrapper 3.2.0 or higher).
  Parameters:
  ctx - the router context
- unregisterSignalHandler
  public static void unregisterSignalHandler()
  Unregister the handler for signals.
- shouldShowCancelGraceful
  public boolean shouldShowCancelGraceful()
  Should we show the cancel button?
  Returns:
  true if graceful shutdown is in progress
- shouldShowSystray
  public boolean shouldShowSystray()
  Should we show the systray controls?
  Returns:
  true if the systray should be shown
- isSystrayEnabled
  public boolean isSystrayEnabled()
  Is the systray enabled?
  Returns:
  true if the systray is enabled
- getConsoleURL
  public String getConsoleURL()
  Get the console URL.
  Returns:
  the full http://host:port URL of the console
- 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
- wrapperLogFile
  public static File wrapperLogFile(I2PAppContext ctx)
  Does not necessarily exist.
  Parameters:
  ctx - the I2P app context
  Returns:
  non-null, doesn't necessarily exist
- enableService
  private void enableService()
  Enables the router as a system service.
- disableService
  private void disableService()
  Disables the router as a system service.
- execServiceAction
  private void execServiceAction(String action) throws IOException
  Run the consolidated service management script (service.ps1). The legacy EnableI2P+Service.bat / DisableI2P+Service.bat shims were removed; the Enable/Disable actions now live in service.ps1.
  Parameters:
  action - the action to pass to the script, "Enable" or "Disable"
  Throws:
  IOException - if powershell.exe cannot be started
- browseOnStartup
  private void browseOnStartup(boolean shouldLaunchBrowser)
  Sets whether the browser opens at startup.
  Parameters:
  shouldLaunchBrowser - true to open the browser on startup
- changeSystray
  private void changeSystray(boolean enable)
  Enable/disable and start/stop systray.
  Parameters:
  enable - true to start the systray app, false to shut it down

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

wrapperListener

LISTENER_AVAILABLE

PROPERTIES_AVAILABLE

LOCATION_AVAILABLE

Constructor Details

Method Details

registerWrapperNotifier

registerWrapperNotifier

registerSignalHandler

unregisterSignalHandler

shouldShowCancelGraceful

shouldShowSystray

isSystrayEnabled

getConsoleURL

processForm

wrapperLogFile

enableService

disableService

execServiceAction

browseOnStartup

changeSystray