Method Details

• main

  public static void main(String[] args)

  Start the console against the first running router context.

  Parameters:

  args - the console options, in the order documented on the constructor

• startup

  public void startup()

  Start the console web server.

  Specified by:

  startup in interface ClientApp

• shutdown

  public void shutdown(String[] args)

  Stop the console web server.

  Specified by:

  shutdown in interface ClientApp

  Parameters:

  args - generally null but could be stopArgs from clients.config

• getState

  public ClientAppState getState()

  Current console state.

  Specified by:

  getState in interface ClientApp

  Returns:

  non-null

• getName

  public String getName()

  The console's internal name.

  Specified by:

  getName in interface ClientApp

  Returns:

  non-null

• getDisplayName

  public String getDisplayName()

  The console's display name.

  Specified by:

  getDisplayName in interface ClientApp

  Returns:

  non-null

• changeState

  private void changeState(ClientAppState state)

  Records the new app state and notifies the app manager.

  Parameters:

  state - the state to move to

• getConsoleServer

  Server getConsoleServer()

  The Jetty server backing the console.

  Returns:

  the server, may be null or stopped

• getConsoleServer

  static Server getConsoleServer(I2PAppContext ctx)

  To get to Jetty. Warning, this will NOT work during shutdown, because changeState(STOPPING) will unregister us first.

  Parameters:

  ctx - the context whose registered console instance to look up

  Returns:

  may be null or stopped perhaps

• jettyVersion

  public static String jettyVersion()

  The version string of the Jetty server library the console runs on.

  Returns:

  the Jetty version, as reported by Jetty itself

• isSystrayEnabled

  static boolean isSystrayEnabled(I2PAppContext context)

  Package private for ConfigServiceHandler.

  Parameters:

  context - the context to read the desktopgui.enabled property from

  Returns:

  true if the desktop GUI tray icon is enabled, false if not or on a headless box

• startTrayApp

  private void startTrayApp()

  Starts the system tray icon if enabled.

• checkJavaVersion

  private void checkJavaVersion()

  Warn if the JVM is too old.

• startConsole

  public void startConsole()

  Handler tree:

  Server
      HandlerCollection
          HostCheckHandler
              ContextHandlerCollection
                  LocaleWebAppHandler (routerconsole)
                      SessionHandler
                      SecurityHandler
                      ServletHandler
                          servlets...
                  WebAppContext (i2psnark, i2ptunnel, imagegen,
                                 susidns, susimail, and each plugin with a .war)
          DefaultHandler
          RequestLogHandler (opt)
  

• addListeners

  private int addListeners(List<Connector> connectors, Set<String> listenHosts, boolean hasIPV4, boolean hasIPV6)

  Add the HTTP listeners for the configured hosts, testing each bind before the connector is added, and register the console service with the port mapper.

  Parameters:

  connectors - the list to add the created connectors to

  listenHosts - collects the hosts successfully bound

  hasIPV4 - whether IPv4 is available

  hasIPV6 - whether IPv6 is available

  Returns:

  the number of hosts bound

• addSSLListeners

  private int addSSLListeners(List<Connector> connectors, Set<String> listenHosts, boolean hasIPV4, boolean hasIPV6)

  Add the HTTPS listeners for the configured hosts, creating the self-signed keystore if needed and testing each bind before the connector is added, and register the HTTPS console service with the port mapper.

  Parameters:

  connectors - the list to add the created connectors to

  listenHosts - collects the hosts successfully bound

  hasIPV4 - whether IPv4 is available

  hasIPV6 - whether IPv6 is available

  Returns:

  the number of hosts bound

• fixUpListenHosts

  private void fixUpListenHosts(Set<String> listenHosts, HostCheckHandler chCollWrapper)

  Expand the listen-host set with the local addresses and the allowed-hosts property, unless a wildcard address was configured, and hand it to the host check handler.

  Parameters:

  listenHosts - the configured hosts, modified in place

  chCollWrapper - the handler that rejects requests with an unexpected Host header

• startConnectors

  private void startConnectors(List<Connector> connectors)

  Start the server, then add and start each connector one at a time so a failing bind does not take down the console.

  Parameters:

  connectors - the connectors to add, started in list order

• startWebApps

  private List<String> startWebApps(ContextHandlerCollection chColl, Properties props)

  Start the other webapps in the webapps directory once the server is up, since Jetty starts the connector before the router console is ready; this makes startup faster and keeps one bad webapp from breaking the console. Enable-property rewrites are persisted here.

  Parameters:

  chColl - the context collection to add the webapps to

  props - the webapp properties, updated with the enable rewrites

  Returns:

  the names of the webapps that were not started

• mapNotStartedWebApps

  private void mapNotStartedWebApps(ServletHandler rootServletHandler, List<String> notStarted)

  Map each not-started webapp to the no-webapp error page.

  Parameters:

  rootServletHandler - the root servlet handler to add the mappings to

  notStarted - the names of the webapps that did not start

• startBackgroundServices

  private void startBackgroundServices()

  Start the graph generator, update manager, news manager, and plugin starter threads, and register the shutdown and signal handlers.

• verifyKeyStore

  private boolean verifyKeyStore(File ks, Set<String> altNames)

  Check the console keystore, creating one with a self-signed keypair if needed.

  Parameters:

  ks - the keystore file to check

  altNames - the Subject Alternative Names if a new keystore is created, may be null

  Returns:

  true if the keystore exists with a password or was created successfully

• createKeyStore

  private boolean createKeyStore(File ks, Set<String> altNames)

  Create a new keystore with a keypair in it.

  Parameters:

  ks - the keystore file to create

  altNames - the Subject Alternative Names for the new certificate, may be null

  Returns:

  true if the keystore was created

• initialize

  static void initialize(RouterContext ctx, WebAppContext context)

  Set up basic security constraints for the webapp. Add all users and passwords.

  Parameters:

  ctx - the router context, supplying the config directory and password store

  context - the Jetty webapp context the constraints are attached to

• webAppProperties

  private Properties webAppProperties()

  Loads the webapps config file.

  Returns:

  the properties read, empty if missing

• webAppProperties

  public static Properties webAppProperties(I2PAppContext ctx)

  Webapp enable properties from the router config directory.

  Parameters:

  ctx - the context whose config directory holds the webapp config file

  Returns:

  the webapp enable properties, empty if the file does not exist yet

• webAppProperties

  public static Properties webAppProperties(String dir)

  Webapp enable properties from the given directory.

  Parameters:

  dir - the directory holding the webapp config file

  Returns:

  the webapp enable properties, empty if the file does not exist or cannot be read

• storeWebAppProperties

  public static void storeWebAppProperties(RouterContext ctx, Properties props)

  Persist the webapp enable properties to the config directory. A config directory that cannot be written is logged and otherwise ignored, so the flags are simply re-derived on the next start.

  Parameters:

  ctx - the router context, supplying the config directory to write to

  props - the webapp enable properties to store

• stopAllWebApps

  private void stopAllWebApps()

  Stops all but the root webapp (routerconsole.war) In Jetty 9, stopping the server doesn't stop the non-root webapps, so we must do it here. There should be a better way to do this, possibly by making the webapps "managed".