ClientAppConfig (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.startup.ClientAppConfig

public class ClientAppConfig
extends Object

Contains a really simple ClientApp "structure" and some static methods so they can be used both by LoadClientAppsJob and by the configuration page in the router console.


 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.

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`args` The arguments.
`String`	`className` The main class name.
`String`	`classpath` The classpath.
`String`	`clientName` The display name.
`(package private) File`	`configFile` The config file.
`long`	`delay` The startup delay.
`boolean`	`disabled` Whether disabled.
`String`	`stopargs` The stop arguments.
`String`	`uninstallargs` The uninstall arguments.

Constructor Summary

Constructors
Constructor and Description
`ClientAppConfig(String cl, String client, String a, long d, boolean dis)` Create a new ClientAppConfig.
`ClientAppConfig(String cl, String client, String a, long d, boolean dis, String cp, String sa, String ua)` Create a new ClientAppConfig with all fields.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static File`	`configDir(I2PAppContext ctx)` This is the config dir.
`static File`	`configFile(I2PAppContext ctx)` This is the old config file.
`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)` Go through the file, and return a List of ClientAppConfig structures
`static List<ClientAppConfig>`	`getClientApps(RouterContext ctx)` Go through the files, and return a List of ClientAppConfig structures This is for the router.
`int`	`hashCode()` Hash code based on class name.
`static boolean`	`isSplitConfig(I2PAppContext ctx)` Only valid for the router's clients (not plugins).
`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.

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

- Field Detail
  - args
```
public String args
```
    The arguments.
  - className
```
public String className
```
    The main class name.
  - classpath
```
public final String classpath
```
    The classpath.
  - clientName
```
public String clientName
```
    The display name.
  - configFile
```
File configFile
```
    The config file.
  - delay
```
public final long delay
```
    The startup delay.
  - disabled
```
public boolean disabled
```
    Whether disabled.
  - stopargs
```
public final String stopargs
```
    The stop arguments.
  - uninstallargs
```
public final String uninstallargs
```
    The uninstall arguments.
- Constructor Detail
  - ClientAppConfig
```
public ClientAppConfig(String cl,
                       String client,
                       String a,
                       long d,
                       boolean dis)
```
    Create a new ClientAppConfig.
    Parameters:
    cl - the class name
    client - the display name
    a - the arguments
    d - the startup delay in ms
    dis - whether disabled
  - ClientAppConfig
```
public ClientAppConfig(String cl,
                       String client,
                       String a,
                       long d,
                       boolean dis,
                       String cp,
                       String sa,
                       String ua)
```
    Create a new ClientAppConfig with all fields.
    Parameters:
    cl - the class name
    client - the display name
    a - the arguments
    d - the startup delay in ms
    dis - whether disabled
    cp - the classpath
    sa - the stop arguments
    ua - the uninstall arguments
- Method Detail
  - configDir
```
public static File configDir(I2PAppContext ctx)
```
    This is the config dir. Only valid if a split config.
    Parameters:
    ctx - the I2P app context
    Returns:
    the config directory
  - configFile
```
public static File configFile(I2PAppContext ctx)
```
    This is the old config file. Only valid if not a split config.
    Parameters:
    ctx - the I2P app context
    Returns:
    the config file
  - deleteClientAppConfig
```
public static boolean deleteClientAppConfig(ClientAppConfig cac)
                                     throws IOException
```
    This works for both split and non-split config. If this is the only config in the file, the file will be deleted; otherwise the file will be saved with the remaining configs.
    Parameters:
    cac - the client app config to delete
    Returns:
    success
    Throws:
    IllegalArgumentException - if cac has a null configfile
    IOException - if the file cannot be read or written
  - equals
```
public boolean equals(Object o)
```
    Matches on class, args, and name only
    Overrides:
    equals in class Object
  - getClientApps
```
public static List<ClientAppConfig> getClientApps(File cfgFile)
                                           throws IOException
```
    Go through the file, and return a List of ClientAppConfig structures
    Parameters:
    cfgFile - the config file to read
    Returns:
    the list of client app configs
    Throws:
    IOException - if the file cannot be read
  - getClientApps
```
public static List<ClientAppConfig> getClientApps(RouterContext ctx)
```
    Go through the files, and return a List of ClientAppConfig structures This is for the router.
    Parameters:
    ctx - the router context
    Returns:
    the list of client app configs
  - hashCode
```
public int hashCode()
```
    Hash code based on class name.
    Overrides:
    hashCode in class Object
    Returns:
    whether h code is present
  - isSplitConfig
```
public static boolean isSplitConfig(I2PAppContext ctx)
```
    Only valid for the router's clients (not plugins). Only valid after getClientApps(ctx) has been called.
    Parameters:
    ctx - the I2P app context
    Returns:
    true if split config
  - writeClientAppConfig
```
public static void writeClientAppConfig(I2PAppContext ctx,
                                        ClientAppConfig app)
                                 throws IOException
```
    Classpath and stopargs not supported. All other apps in the file will be deleted. Do not use if multiple apps in a single file - use writeClientAppConfig(ctx, apps). If app.configFile is null, a new file will be created and assigned.
    Parameters:
    ctx - the I2P app context
    app - the client app config to write
    Throws:
    IOException - if the file cannot be written
  - writeClientAppConfig
```
public static void writeClientAppConfig(I2PAppContext ctx,
                                        List<ClientAppConfig> apps)
                                 throws IOException
```
    Classpath and stopargs not supported. All other apps in the files will be deleted. Do not add apps with this method - use writeClientAppConfig(ctx, app). Do not delete apps with this method - use deleteClientAppConfig().
    Parameters:
    ctx - the I2P app context
    apps - the list of client app configs to write
    Throws:
    IOException - if the file cannot be written

Class ClientAppConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

args

className

classpath

clientName

configFile

delay

disabled

stopargs

uninstallargs

Constructor Detail

ClientAppConfig

ClientAppConfig

Method Detail

configDir

configFile

deleteClientAppConfig

equals

getClientApps

getClientApps

hashCode

isSplitConfig

writeClientAppConfig

writeClientAppConfig