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 relevant.
Modifier and Type | Field and Description |
---|---|
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 |
protected I2PProperties |
_overrideProps |
protected SessionKeyManager |
_sessionKeyManager |
protected boolean |
_sessionKeyManagerInitialized |
protected Set<Runnable> |
_shutdownTasks |
Constructor and Description |
---|
I2PAppContext()
Create a brand new context.
|
I2PAppContext(Properties envProps)
Create a brand new context.
|
Modifier and Type | Method and Description |
---|---|
void |
addPropertyCallback(I2PProperties.I2PPropertyCallback callback)
Add a callback, which will fire upon changes in the property
given in the specific callback.
|
void |
addShutdownTask(Runnable task)
WARNING - Shutdown tasks are not executed in an I2PAppContext.
|
AESEngine |
aes()
Ok, I'll admit it.
|
ClientAppManager |
clientAppManager()
The RouterAppManager in RouterContext, null always in I2PAppContext
|
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 |
getCurrentContext()
Pull the default context, WITHOUT creating a new one.
|
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.
|
Properties |
getProperties()
Access the configuration attributes of this context, listing the properties
provided during the context construction, as well as the ones included in
System.getProperties.
|
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
|
long |
getProperty(String propName,
long defaultVal)
Return a long with a long 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<String> |
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.
|
boolean |
hasWrapper()
Is the wrapper present?
|
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.
used only by syndie
|
protected void |
initializeClock() |
protected void |
initializeKeyRing() |
protected void |
initializeSessionKeyManager() |
InternalClientManager |
internalClientManager()
Use this to connect to the router in the same JVM.
|
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.
|
PortMapper |
portMapper()
Basic mapping from service names to ports
|
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)
|
SimpleScheduler |
simpleScheduler()
Deprecated.
in 0.9.20, use simpleTimer2()
|
SimpleTimer |
simpleTimer()
Deprecated.
use SimpleTimer2
|
SimpleTimer2 |
simpleTimer2()
Use instead of SimpleTimer2.getInstance()
|
StatManager |
statManager()
The statistics component with which we can track various events
over time.
|
protected static volatile I2PAppContext _globalAppContext
protected final I2PProperties _overrideProps
protected SessionKeyManager _sessionKeyManager
protected Clock _clock
protected KeyRing _keyRing
protected volatile boolean _sessionKeyManagerInitialized
protected volatile boolean _clockInitialized
protected volatile boolean _keyRingInitialized
public I2PAppContext()
public I2PAppContext(Properties envProps)
public static I2PAppContext getGlobalContext()
public static I2PAppContext getCurrentContext()
public File getBaseDir()
public File getConfigDir()
public File getRouterDir()
public File getPIDDir()
public File getLogDir()
public File getAppDir()
public File getTempDir()
public void deleteTempDir()
public String getProperty(String propName)
public String getProperty(String propName, String defaultValue)
public int getProperty(String propName, int defaultVal)
public long getProperty(String propName, long defaultVal)
public boolean getProperty(String propName, boolean defaultVal)
public boolean getBooleanProperty(String propName)
public boolean getBooleanPropertyDefaultTrue(String propName)
public Set<String> getPropertyNames()
public Properties getProperties()
public void addPropertyCallback(I2PProperties.I2PPropertyCallback callback)
callback
- The implementation of the callback.public StatManager statManager()
public SessionKeyManager sessionKeyManager()
protected void initializeSessionKeyManager()
public NamingService namingService()
public ElGamalEngine elGamalEngine()
public ElGamalAESEngine elGamalAESEngine()
public AESEngine aes()
public LogManager logManager()
public HMACGenerator hmac()
@Deprecated public HMAC256Generator hmac256()
public SHA256Generator sha()
public DSAEngine dsa()
public KeyGenerator keyGenerator()
public Clock clock()
protected void initializeClock()
public RoutingKeyGenerator routingKeyGenerator()
public KeyRing keyRing()
protected void initializeKeyRing()
public RandomSource random()
public void addShutdownTask(Runnable task)
public boolean isRouterContext()
public InternalClientManager internalClientManager()
public boolean hasWrapper()
public PortMapper portMapper()
@Deprecated public SimpleScheduler simpleScheduler()
@Deprecated public SimpleTimer simpleTimer()
public SimpleTimer2 simpleTimer2()
public ClientAppManager clientAppManager()