Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## net.i2p
Class I2PAppContext

    java.lang.Object
      net.i2p.I2PAppContext

Direct Known Subclasses:
  RouterContext

    public class I2PAppContext

extends Object

Provide a base scope for accessing singletons that I2P exposes. Rather than using the traditional singleton, where any component can access the component in question directly, all of those I2P related singletons are exposed through a particular I2PAppContext. This helps not only with understanding their use and the components I2P exposes, but it also allows multiple isolated environments to operate concurrently within the same JVM - particularly useful for stubbing out implementations of the rooted components and simulating the software's interaction between multiple instances.

As a simplification, there is also a global context - if some component needs access to one of the singletons but doesn't have its own context from which to root itself, it binds to the I2PAppContext's globalAppContext(), which is the first context that was created within the JVM, or a new one if no context existed already. This functionality is often used within the I2P core for logging - e.g.

         private static final Log _log = new Log(someClass.class);

It is for this reason that applications that care about working with multiple contexts should build their own context as soon as possible (within the main(..)) so that any referenced components will latch on to that context instead of instantiating a new one. However, there are situations in which both can be relevent.

Field Summary
`protected Clock` | `_clock`
`protected boolean` | `_clockInitialized`
`protected static I2PAppContext` | `_globalAppContext` the context that components without explicit root are bound
`protected KeyRing` | `_keyRing`
`protected boolean` | `_keyRingInitialized`

Constructor Summary
`I2PAppContext()` Lets root a brand new context
`I2PAppContext(Properties envProps)` Lets root a brand new context

Method Summary
`void` | `addShutdownTask(Runnable task)`
`AESEngine` | `aes()` Ok, I'll admit it.
`Clock` | `clock()` The context's synchronized clock, which is kept context specific only to enable simulators to play with clock skew among different instances.
`void` | `deleteTempDir()` don't rely on deleteOnExit()
`DSAEngine` | `dsa()` Our DSA engine (see HMAC and SHA above)
`ElGamalAESEngine` | `elGamalAESEngine()` Access the ElGamal/AES+SessionTag engine for this context.
`ElGamalEngine` | `elGamalEngine()` This is the ElGamal engine used within this context.
`File` | `getAppDir()` Where applications may store data.
`File` | `getBaseDir()` This is the installation dir, often referred to as $I2P.
`boolean` | `getBooleanProperty(String propName)` Default false
`boolean` | `getBooleanPropertyDefaultTrue(String propName)`
`File` | `getConfigDir()` The base dir for config files.
`static I2PAppContext` | `getGlobalContext()` Pull the default context, creating a new one if necessary, else using the first one created.
`File` | `getLogDir()` Where the router keeps its log directory.
`File` | `getPIDDir()` Where router.ping goes.
`String` | `getProperty(String propName)` Access the configuration attributes of this context, using properties provided during the context construction, or falling back on System.getProperty if no properties were provided during construction (or the specified prop wasn't included).
`boolean` | `getProperty(String propName, boolean defaultVal)` Return a boolean with a boolean default
`int` | `getProperty(String propName, int defaultVal)` Return an int with an int default
`String` | `getProperty(String propName, String defaultValue)` Access the configuration attributes of this context, using properties provided during the context construction, or falling back on System.getProperty if no properties were provided during construction (or the specified prop wasn't included).
`Set` | `getPropertyNames()` Access the configuration attributes of this context, listing the properties provided during the context construction, as well as the ones included in System.getProperties.
`File` | `getRouterDir()` Where the router keeps its files.
`Set<Runnable>` | `getShutdownTasks()`
`File` | `getTempDir()` Where anybody may store temporary data.
`HMACGenerator` | `hmac()` There is absolutely no good reason to make this context specific, other than for consistency, and perhaps later we'll want to include some stats.
`HMAC256Generator` | `hmac256()` Deprecated. unused
`protected void` | `initializeClock()`
`protected void` | `initializeKeyRing()`
`boolean` | `isRouterContext()` Use this instead of context instanceof RouterContext
`KeyGenerator` | `keyGenerator()` Component to generate ElGamal, DSA, and Session keys.
`KeyRing` | `keyRing()` Basic hash map
`LogManager` | `logManager()` Query the log manager for this context, which may in turn have its own set of configuration settings (loaded from the context's properties).
`NamingService` | `namingService()` Pull up the naming service used in this context.
`PetNameDB` | `petnameDb()` Deprecated. unused
`RandomSource` | `random()` [insert snarky comment here]
`RoutingKeyGenerator` | `routingKeyGenerator()` Determine how much do we want to mess with the keys to turn them into something we can route.
`SessionKeyManager` | `sessionKeyManager()` The session key manager which coordinates the sessionKey / sessionTag data.
`SHA256Generator` | `sha()` Our SHA256 instance (see the hmac discussion for why its context specific)
`StatManager` | `statManager()` The statistics component with which we can track various events over time.

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

Field Detail

### _globalAppContext

    protected static I2PAppContext _globalAppContext

  the context that components without explicit root are bound

### _clock

    protected Clock _clock

### _keyRing

    protected KeyRing _keyRing

### _clockInitialized

    protected volatile boolean _clockInitialized

### _keyRingInitialized

    protected volatile boolean _keyRingInitialized

Constructor Detail

### I2PAppContext

    public I2PAppContext()

  Lets root a brand new context

### I2PAppContext

    public I2PAppContext(Properties envProps)

  Lets root a brand new context

Method Detail

### getGlobalContext

    public static I2PAppContext getGlobalContext()

  Pull the default context, creating a new one if necessary, else using the first one created.

### getBaseDir

    public File getBaseDir()

  This is the installation dir, often referred to as $I2P. Applilcations should consider this directory read-only and never attempt to write to it. It may actually be read-only on a multi-user installation. The config files in this directory are templates for user installations and should not be accessed by applications. The only thing that may be useful in here is the lib/ dir containing the .jars.

  Returns:
    dir constant for the life of the context
  Since:
    0.7.6

### getConfigDir

    public File getConfigDir()

  The base dir for config files. Applications may use this to access router configuration files if necessary. Usually ~/.i2p on Linux and %APPDIR%\I2P on Windows. In installations originally installed with 0.7.5 or earlier, and in "portable" installations, this will be the same as the base dir.

  Returns:
    dir constant for the life of the context
  Since:
    0.7.6

### getRouterDir

    public File getRouterDir()

  Where the router keeps its files. Applications should not use this. The same as the config dir for now.

  Returns:
    dir constant for the life of the context
  Since:
    0.7.6

### getPIDDir

    public File getPIDDir()

  Where router.ping goes. Applications should not use this. The same as the system temp dir for now. Which is a problem for multi-user installations.

  Returns:
    dir constant for the life of the context
  Since:
    0.7.6

### getLogDir

    public File getLogDir()

  Where the router keeps its log directory. Applications should not use this. The same as the config dir for now. (i.e. ~/.i2p, NOT ~/.i2p/logs)

  Returns:
    dir constant for the life of the context
  Since:
    0.7.6

### getAppDir

    public File getAppDir()

  Where applications may store data. The same as the config dir for now, but may change in the future. Apps should be careful not to overwrite router files.

  Returns:
    dir constant for the life of the context
  Since:
    0.7.6

### getTempDir

    public File getTempDir()

  Where anybody may store temporary data. This is a directory created in the system temp dir on the first call in this context, and is deleted on JVM exit. Applications should create their own directory inside this directory to avoid collisions with other apps.

  Returns:
    dir constant for the life of the context
  Since:
    0.7.6

### deleteTempDir

    public void deleteTempDir()

  don't rely on deleteOnExit()

### getProperty

    public String getProperty(String propName)

  Access the configuration attributes of this context, using properties provided during the context construction, or falling back on System.getProperty if no properties were provided during construction (or the specified prop wasn't included).

### getProperty

    public String getProperty(String propName,
                              String defaultValue)

  Access the configuration attributes of this context, using properties provided during the context construction, or falling back on System.getProperty if no properties were provided during construction (or the specified prop wasn't included).

### getProperty

    public int getProperty(String propName,
                           int defaultVal)

  Return an int with an int default

### getProperty

    public boolean getProperty(String propName,
                               boolean defaultVal)

  Return a boolean with a boolean default

  Since:
    0.7.12

### getBooleanProperty

    public boolean getBooleanProperty(String propName)

  Default false

  Since:
    0.7.12

### getBooleanPropertyDefaultTrue

    public boolean getBooleanPropertyDefaultTrue(String propName)

  Since:
    0.7.12

### getPropertyNames

    public Set getPropertyNames()

  Access the configuration attributes of this context, listing the properties provided during the context construction, as well as the ones included in System.getProperties.

  Returns:
    set of Strings containing the names of defined system properties

### statManager

    public StatManager statManager()

  The statistics component with which we can track various events over time.

### sessionKeyManager

    public SessionKeyManager sessionKeyManager()

  The session key manager which coordinates the sessionKey / sessionTag data. This component allows transparent operation of the ElGamal/AES+SessionTag algorithm, and contains all of the session tags for one particular application. This is deprecated for client use, it should be used only by the router as its own key manager. Not that clients are doing end-to-end crypto anyway. For client crypto within the router, use RouterContext.clientManager.getClientSessionKeyManager(dest)

### namingService

    public NamingService namingService()

  Pull up the naming service used in this context. The naming service itself works by querying the context's properties, so those props should be specified to customize the naming service exposed.

### petnameDb

    public PetNameDB petnameDb()

  Deprecated. unused

### elGamalEngine

    public ElGamalEngine elGamalEngine()

  This is the ElGamal engine used within this context. While it doesn't really have anything substantial that is context specific (the algorithm just does the algorithm), it does transparently use the context for logging its performance and activity. In addition, the engine can be swapped with the context's properties (though only someone really crazy should mess with it ;)

### elGamalAESEngine

    public ElGamalAESEngine elGamalAESEngine()

  Access the ElGamal/AES+SessionTag engine for this context. The algorithm makes use of the context's sessionKeyManager to coordinate transparent access to the sessionKeys and sessionTags, as well as the context's elGamal engine (which in turn keeps stats, etc).

### aes

    public AESEngine aes()

  Ok, I'll admit it. there is no good reason for having a context specific AES engine. We dont really keep stats on it, since its just too fast to matter. Though for the crazy people out there, we do expose a way to disable it.

### logManager

    public LogManager logManager()

  Query the log manager for this context, which may in turn have its own set of configuration settings (loaded from the context's properties). Each context's logManager keeps its own isolated set of Log instances with their own log levels, output locations, and rotation configuration.

### hmac

    public HMACGenerator hmac()

  There is absolutely no good reason to make this context specific, other than for consistency, and perhaps later we'll want to include some stats.

### hmac256

    public HMAC256Generator hmac256()

  Deprecated. unused

### sha

    public SHA256Generator sha()

  Our SHA256 instance (see the hmac discussion for why its context specific)

### dsa

    public DSAEngine dsa()

  Our DSA engine (see HMAC and SHA above)

### keyGenerator

    public KeyGenerator keyGenerator()

  Component to generate ElGamal, DSA, and Session keys. For why it is in the appContext, see the DSA, HMAC, and SHA comments above.

### clock

    public Clock clock()

  The context's synchronized clock, which is kept context specific only to enable simulators to play with clock skew among different instances.

### initializeClock

    protected void initializeClock()

### routingKeyGenerator

    public RoutingKeyGenerator routingKeyGenerator()

  Determine how much do we want to mess with the keys to turn them into something we can route. This is context specific because we may want to test out how things react when peers don't agree on how to skew.

### keyRing

    public KeyRing keyRing()

  Basic hash map

### initializeKeyRing

    protected void initializeKeyRing()

### random

    public RandomSource random()

  [insert snarky comment here]

### addShutdownTask

    public void addShutdownTask(Runnable task)

### getShutdownTasks

    public Set<Runnable> getShutdownTasks()

### isRouterContext

    public boolean isRouterContext()

  Use this instead of context instanceof RouterContext

  Since:
    0.7.9

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD