public class ClientAppConfig extends Object
clients.config format: Lines are of the form clientApp.x.prop=val, where x is the app number. App numbers MUST start with 0 and be consecutive. Properties are as follows: main: Full class name. Required. The main() method in this class will be run. name: Name to be displayed on console. args: Arguments to the main class, separated by spaces or tabs. Arguments containing spaces or tabs may be quoted with ' or " delay: Seconds before starting, default 120 onBoot: {true|false}, default false, forces a delay of 0, overrides delay setting startOnLoad: {true|false} Is the client to be run at all? Default true The following additional properties are used only by plugins: stopargs: Arguments to stop the client. uninstallargs: Arguments to stop the client. classpath: Additional classpath elements for the client, separated by commas. The following substitutions are made in the args, stopargs, uninstallargs, and classpath lines, for plugins only: $I2P: The base I2P install directory $CONFIG: The user's configuration directory (e.g. ~/.i2p) $PLUGIN: This plugin's directory (e.g. ~/.i2p/plugins/foo) All properties except "main" are optional. Lines starting with "#" are comments. If the delay is less than zero, the client is run immediately, in the same thread, so that exceptions may be propagated to the console. In this case, the client should either throw an exception, return quickly, or spawn its own thread. If the delay is greater than or equal to zero, it will be run in a new thread, and exceptions will be logged but not propagated to the console.
Modifier and Type | Field and Description |
---|---|
String |
args |
String |
className |
String |
classpath |
String |
clientName |
long |
delay |
boolean |
disabled |
String |
stopargs |
String |
uninstallargs |
Constructor and Description |
---|
ClientAppConfig(String cl,
String client,
String a,
long d,
boolean dis) |
ClientAppConfig(String cl,
String client,
String a,
long d,
boolean dis,
String cp,
String sa,
String ua) |
Modifier and Type | Method and Description |
---|---|
static File |
configDir(I2PAppContext ctx) |
static File |
configFile(I2PAppContext ctx) |
static boolean |
deleteClientAppConfig(ClientAppConfig cac)
This works for both split and non-split config.
|
boolean |
equals(Object o)
Matches on class, args, and name only
|
static List<ClientAppConfig> |
getClientApps(File cfgFile) |
static List<ClientAppConfig> |
getClientApps(RouterContext ctx) |
int |
hashCode() |
static boolean |
isSplitConfig(I2PAppContext ctx) |
static void |
writeClientAppConfig(I2PAppContext ctx,
ClientAppConfig app)
Classpath and stopargs not supported.
|
static void |
writeClientAppConfig(I2PAppContext ctx,
List<ClientAppConfig> apps)
Classpath and stopargs not supported.
|
public String className
public String clientName
public String args
public boolean disabled
public final long delay
public final String classpath
public final String stopargs
public final String uninstallargs
public static boolean isSplitConfig(I2PAppContext ctx)
public static File configFile(I2PAppContext ctx)
public static File configDir(I2PAppContext ctx)
public static List<ClientAppConfig> getClientApps(RouterContext ctx)
public static List<ClientAppConfig> getClientApps(File cfgFile) throws IOException
IOException
public static void writeClientAppConfig(I2PAppContext ctx, ClientAppConfig app) throws IOException
IOException
public static void writeClientAppConfig(I2PAppContext ctx, List<ClientAppConfig> apps) throws IOException
IOException
public static boolean deleteClientAppConfig(ClientAppConfig cac) throws IOException
IllegalArgumentException
- if cac has a null configfileIOException