RouterConsoleRunner (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.web.RouterConsoleRunner

All Implemented Interfaces:: ClientApp, RouterApp

public class RouterConsoleRunner
extends Object
implements RouterApp

Start the router console.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_LISTEN_PORT` Default HTTP listen port for the console.
`static String`	`ENABLED` Property suffix for webapp enable flags.
`static String`	`JETTY_REALM` Realm name for console authentication.
`static String`	`PREFIX` Property prefix for webapp enable flags.
`(package private) static String`	`PROP_ALLOWED_HOSTS` Property name for hosts allowed to access the console.
`static String`	`PROP_CONSOLE_PW` Property name for the console authentication password.
`static String`	`PROP_DTG_ENABLED` Property name for the desktop GUI enable flag.
`static String`	`PROP_KEY_PASSWORD` Property name for the console SSL key password.
`static String`	`PROP_KEYSTORE_PASSWORD` Property name for the console keystore password.
`static String`	`PROP_PW_ENABLE` Property name for enabling console authentication.
`static String`	`ROUTERCONSOLE` Name of the root console webapp.
`(package private) static FileFilter`	`WAR_FILTER`

Constructor Summary

Constructors
Constructor and Description
`RouterConsoleRunner(RouterContext ctx, ClientAppManager mgr, String[] args)` non-SSL: RouterConsoleRunner RouterConsoleRunner 7657 RouterConsoleRunner 7657 127.0.0.1 RouterConsoleRunner 7657 127.0.0.1,::1 RouterConsoleRunner 7657 127.0.0.1,::1 ./webapps/ SSL: RouterConsoleRunner -s 7657 RouterConsoleRunner -s 7657 127.0.0.1 RouterConsoleRunner -s 7657 127.0.0.1,::1 RouterConsoleRunner -s 7657 127.0.0.1,::1 ./webapps/ If using both, non-SSL must be first: RouterConsoleRunner 7657 127.0.0.1 -s 7667 RouterConsoleRunner 7657 127.0.0.1 -s 7667 127.0.0.1 RouterConsoleRunner 7657 127.0.0.1,::1 -s 7667 127.0.0.1,::1 RouterConsoleRunner 7657 127.0.0.1,::1 -s 7667 127.0.0.1,::1 ./webapps/

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) Server`	`getConsoleServer()` The Jetty server backing the console.
`(package private) static Server`	`getConsoleServer(I2PAppContext ctx)` To get to Jetty.
`String`	`getDisplayName()` The display name of the ClientApp, used in user interfaces.
`String`	`getName()` The generic name of the ClientApp, used for registration, e.g.
`ClientAppState`	`getState()` The current state of the ClientApp.
`(package private) static void`	`initialize(RouterContext ctx, WebAppContext context)` Set up basic security constraints for the webapp.
`(package private) static boolean`	`isSystrayEnabled(I2PAppContext context)` Package private for ConfigServiceHandler
`static String`	`jettyVersion()`
`static void`	`main(String[] args)`
`void`	`shutdown(String[] args)` Do not take a long time.
`void`	`startConsole()` Handler tree:
`void`	`startup()` Do not take a long time.
`static void`	`storeWebAppProperties(RouterContext ctx, Properties props)` Persist the webapp enable properties to the config directory.
`static Properties`	`webAppProperties(I2PAppContext ctx)` Webapp enable properties from the router config directory.
`static Properties`	`webAppProperties(String dir)` Webapp enable properties from the given directory.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_LISTEN_PORT
```
public static final int DEFAULT_LISTEN_PORT
```
    Default HTTP listen port for the console.
    See Also:
    Constant Field Values
  - ENABLED
```
public static final String ENABLED
```
    Property suffix for webapp enable flags.
    See Also:
    Constant Field Values
  - JETTY_REALM
```
public static final String JETTY_REALM
```
    Realm name for console authentication.
    See Also:
    Constant Field Values
  - PREFIX
```
public static final String PREFIX
```
    Property prefix for webapp enable flags.
    See Also:
    Constant Field Values
  - PROP_ALLOWED_HOSTS
```
static final String PROP_ALLOWED_HOSTS
```
    Property name for hosts allowed to access the console.
    See Also:
    Constant Field Values
  - PROP_CONSOLE_PW
```
public static final String PROP_CONSOLE_PW
```
    Property name for the console authentication password.
    See Also:
    Constant Field Values
  - PROP_DTG_ENABLED
```
public static final String PROP_DTG_ENABLED
```
    Property name for the desktop GUI enable flag.
    See Also:
    Constant Field Values
  - PROP_KEY_PASSWORD
```
public static final String PROP_KEY_PASSWORD
```
    Property name for the console SSL key password.
    See Also:
    Constant Field Values
  - PROP_KEYSTORE_PASSWORD
```
public static final String PROP_KEYSTORE_PASSWORD
```
    Property name for the console keystore password.
    See Also:
    Constant Field Values
  - PROP_PW_ENABLE
```
public static final String PROP_PW_ENABLE
```
    Property name for enabling console authentication.
    See Also:
    Constant Field Values
  - ROUTERCONSOLE
```
public static final String ROUTERCONSOLE
```
    Name of the root console webapp.
    See Also:
    Constant Field Values
  - WAR_FILTER
```
static final FileFilter WAR_FILTER
```
- Constructor Detail
  - RouterConsoleRunner
```
public RouterConsoleRunner(RouterContext ctx,
                           ClientAppManager mgr,
                           String[] args)
```
```
  non-SSL:
  RouterConsoleRunner
  RouterConsoleRunner 7657
  RouterConsoleRunner 7657 127.0.0.1
  RouterConsoleRunner 7657 127.0.0.1,::1
  RouterConsoleRunner 7657 127.0.0.1,::1 ./webapps/

  SSL:
  RouterConsoleRunner -s 7657
  RouterConsoleRunner -s 7657 127.0.0.1
  RouterConsoleRunner -s 7657 127.0.0.1,::1
  RouterConsoleRunner -s 7657 127.0.0.1,::1 ./webapps/

  If using both, non-SSL must be first:
  RouterConsoleRunner 7657 127.0.0.1 -s 7667
  RouterConsoleRunner 7657 127.0.0.1 -s 7667 127.0.0.1
  RouterConsoleRunner 7657 127.0.0.1,::1 -s 7667 127.0.0.1,::1
  RouterConsoleRunner 7657 127.0.0.1,::1 -s 7667 127.0.0.1,::1 ./webapps/
  
```
    Parameters:
    args - second arg may be a comma-separated list of bind addresses, for example ::1,127.0.0.1 On XP, the other order (127.0.0.1,::1) fails the IPV6 bind, because 127.0.0.1 will bind ::1 also. But even though it's bound to both, we can't connect to [::1]:7657 for some reason. So the wise choice is ::1,127.0.0.1
- Method Detail
  - 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.
    Returns:
    may be null or stopped perhaps
  - getDisplayName
```
public String getDisplayName()
```
    Description copied from interface: ClientApp
    The display name of the ClientApp, used in user interfaces. The app must translate.
    Specified by:
    getDisplayName in interface ClientApp
    Returns:
    non-null
  - getName
```
public String getName()
```
    Description copied from interface: ClientApp
    The generic name of the ClientApp, used for registration, e.g. "console". Do not translate.
    Specified by:
    getName in interface ClientApp
    Returns:
    non-null
  - getState
```
public ClientAppState getState()
```
    Description copied from interface: ClientApp
    The current state of the ClientApp.
    Specified by:
    getState in interface ClientApp
    Returns:
    non-null
  - initialize
```
static void initialize(RouterContext ctx,
                       WebAppContext context)
```
    Set up basic security constraints for the webapp. Add all users and passwords.
  - isSystrayEnabled
```
static boolean isSystrayEnabled(I2PAppContext context)
```
    Package private for ConfigServiceHandler
  - jettyVersion
```
public static String jettyVersion()
```
  - main
```
public static void main(String[] args)
```
  - shutdown
```
public void shutdown(String[] args)
```
    Description copied from interface: ClientApp
    Do not take a long time. Do not block. Use a thread if necessary. If previously running, client must call ClientAppManager.notify() at least once within this method to change the state to STOPPING or STOPPED. May be called multiple times on the same object, in any state.
    Specified by:
    shutdown in interface ClientApp
    Parameters:
    args - generally null but could be stopArgs from clients.config
  - 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)
 
```
  - startup
```
public void startup()
```
    Description copied from interface: ClientApp
    Do not take a long time. Do not block. Start threads here if necessary. Client must call ClientAppManager.notify() at least once within this method to change the state from INITIALIZED to something else. Will not be called multiple times on the same object.
    Specified by:
    startup in interface ClientApp
  - storeWebAppProperties
```
public static void storeWebAppProperties(RouterContext ctx,
                                         Properties props)
```
    Persist the webapp enable properties to the config directory.
  - webAppProperties
```
public static Properties webAppProperties(I2PAppContext ctx)
```
    Webapp enable properties from the router config directory.
  - webAppProperties
```
public static Properties webAppProperties(String dir)
```
    Webapp enable properties from the given directory.

Class RouterConsoleRunner

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LISTEN_PORT

ENABLED

JETTY_REALM

PREFIX

PROP_ALLOWED_HOSTS

PROP_CONSOLE_PW

PROP_DTG_ENABLED

PROP_KEY_PASSWORD

PROP_KEYSTORE_PASSWORD

PROP_PW_ENABLE

ROUTERCONSOLE

WAR_FILTER

Constructor Detail

RouterConsoleRunner

Method Detail

getConsoleServer

getConsoleServer

getDisplayName

getName

getState

initialize

isSystrayEnabled

jettyVersion

main

shutdown

startConsole

startup

storeWebAppProperties

webAppProperties

webAppProperties