ApplicationContext (RapidContext 0.16 Java API)

java.lang.Object
- org.rapidcontext.app.ApplicationContext

```
public class ApplicationContext
extends java.lang.Object
```
The application context. This is a singleton object that contains references to global application settings and objects. It also provides simple procedure execution and resource and plug-in initialization and deinitialization.

Version:

1.0

Author:

Per Cederberg

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.Date`	`INIT_TIME` The class load time (system initialization time).
`static Path`	`PATH_CONFIG` The path to the global configuration.
`static java.util.Date`	`START_TIME` The context start (or reset) time.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static void`	`destroy()` Destroys the application context and frees all resources used.
`java.lang.Object`	`execute(java.lang.String name, java.lang.Object[] args, java.lang.String source, java.lang.StringBuffer trace)` Executes a procedure within this context.
`void`	`executeAsync(java.lang.String name, java.lang.Object[] args, java.lang.String source)` Executes a procedure asynchronously within this context.
`CallContext`	`findContext(int threadId)` Finds the currently active call context for a thread id.
`CallContext`	`findContext(java.lang.Thread thread)` Finds the currently active call context for a thread.
`java.io.File`	`getBaseDir()` Returns the application base directory.
`java.lang.ClassLoader`	`getClassLoader()` Returns the plug-in class loader.
`Dict`	`getConfig()` Returns the application configuration.
`Environment`	`getEnvironment()` Returns the environment used.
`static ApplicationContext`	`getInstance()` Returns the singleton application context instance.
`Library`	`getLibrary()` Returns the procedure library used.
`Storage`	`getStorage()` Returns the application data storage.
`WebMatcher[]`	`getWebMatchers()` Returns the array of cached web matchers (from the web services).
`protected static ApplicationContext`	`init(java.io.File baseDir, java.io.File localDir, boolean start)` Creates and initializes the application context.
`java.lang.String`	`installPlugin(java.io.File file)` Installs a plug-in from the specified file.
`boolean`	`isPluginLoaded(java.lang.String pluginId)` Checks if the specified plug-in is currently loaded.
`void`	`loadPlugin(java.lang.String pluginId)` Loads a plug-in.
`Dict`	`pluginConfig(java.lang.String pluginId)` Returns the specified plug-in configuration dictionary.
`void`	`reset()` Resets this context and reloads all resources.
`void`	`unloadPlugin(java.lang.String pluginId)` Unloads a plug-in.

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

- Field Detail
  - PATH_CONFIG
```
public static final Path PATH_CONFIG
```
    The path to the global configuration.
  - INIT_TIME
```
public static final java.util.Date INIT_TIME
```
    The class load time (system initialization time).
  - START_TIME
```
public static java.util.Date START_TIME
```
    The context start (or reset) time.
- Method Detail
  - init
```
protected static ApplicationContext init(java.io.File baseDir,
                                         java.io.File localDir,
                                         boolean start)
```
    Creates and initializes the application context. If the start flag is set, all plug-ins will be loaded along with procedures and the environment configuration. Otherwise only the storages will be initialized. Note that if the context has already been created, it will not be recreated.
    
    Parameters:
    
    baseDir - the base application directory
    
    localDir - the local add-on directory
    
    start - the initialize plug-ins flag
    
    Returns:
    
    the application context created or found
  - destroy
```
protected static void destroy()
```
    Destroys the application context and frees all resources used.
  - getInstance
```
public static ApplicationContext getInstance()
```
    Returns the singleton application context instance.
    
    Returns:
    
    the singleton application context instance
  - reset
```
public void reset()
```
    Resets this context and reloads all resources.
  - getConfig
```
public Dict getConfig()
```
    Returns the application configuration.
    
    Returns:
    
    the application configuration
  - getStorage
```
public Storage getStorage()
```
    Returns the application data storage. This is the global data storage that contains all loaded plug-ins and maps requests to them in order.
    
    Returns:
    
    the application data store
  - getEnvironment
```
public Environment getEnvironment()
```
    Returns the environment used.
    
    Returns:
    
    the environment used
  - getWebMatchers
```
public WebMatcher[] getWebMatchers()
```
    Returns the array of cached web matchers (from the web services). This list is only re-read when the context is reset.
    
    Returns:
    
    the array of cached web matchers
    
    See Also:
    
    reset()
  - getLibrary
```
public Library getLibrary()
```
    Returns the procedure library used.
    
    Returns:
    
    the procedure library used
  - getBaseDir
```
public java.io.File getBaseDir()
```
    Returns the application base directory.
    
    Returns:
    
    the application base directory
  - getClassLoader
```
public java.lang.ClassLoader getClassLoader()
```
    Returns the plug-in class loader.
    
    Returns:
    
    the plug-in class loader
  - isPluginLoaded
```
public boolean isPluginLoaded(java.lang.String pluginId)
```
    Checks if the specified plug-in is currently loaded.
    
    Parameters:
    
    pluginId - the unique plug-in id
    
    Returns:
    
    true if the plug-in was loaded, or false otherwise
  - pluginConfig
```
public Dict pluginConfig(java.lang.String pluginId)
```
    Returns the specified plug-in configuration dictionary.
    
    Parameters:
    
    pluginId - the unique plug-in id
    
    Returns:
    
    the plug-in configuration dictionary, or null if not found
  - installPlugin
```
public java.lang.String installPlugin(java.io.File file)
                               throws PluginException
```
    Installs a plug-in from the specified file. If an existing plug-in with the same id already exists, it will be replaced without warning. After installation, the new plug-in will also be loaded and added to the default configuration for automatic launch on the next restart.
    
    Parameters:
    
    file - the plug-in ZIP file
    
    Returns:
    
    the unique plug-in id
    
    Throws:
    
    PluginException - if the plug-in couldn't be installed correctly
  - loadPlugin
```
public void loadPlugin(java.lang.String pluginId)
                throws PluginException
```
    Loads a plug-in. If the plug-in was loaded successfully, it will also be added to the default configuration for automatic launch on the next restart.
    
    Parameters:
    
    pluginId - the unique plug-in id
    
    Throws:
    
    PluginException - if no plug-in instance could be created or if the plug-in initialization failed
  - unloadPlugin
```
public void unloadPlugin(java.lang.String pluginId)
                  throws PluginException
```
    Unloads a plug-in. The plug-in will also be removed from the default configuration for automatic launches.
    
    Parameters:
    
    pluginId - the unique plug-in id
    
    Throws:
    
    PluginException - if the plug-in deinitialization failed
  - execute
```
public java.lang.Object execute(java.lang.String name,
                                java.lang.Object[] args,
                                java.lang.String source,
                                java.lang.StringBuffer trace)
                         throws ProcedureException
```
    Executes a procedure within this context.
    
    Parameters:
    
    name - the procedure name
    
    args - the procedure arguments
    
    source - the call source information
    
    trace - the trace buffer or null for none
    
    Returns:
    
    the result of the call, or null if the call produced no result
    
    Throws:
    
    ProcedureException - if the procedure execution failed
  - executeAsync
```
public void executeAsync(java.lang.String name,
                         java.lang.Object[] args,
                         java.lang.String source)
```
    Executes a procedure asynchronously within this context. This method will sleep for 10 minutes after terminating the procedure execution, allowing the results to be fetched from the context by another thread.
    
    Parameters:
    
    name - the procedure name
    
    args - the procedure arguments
    
    source - the call source information
  - findContext
```
public CallContext findContext(java.lang.Thread thread)
```
    Finds the currently active call context for a thread.
    
    Parameters:
    
    thread - the thread to search for
    
    Returns:
    
    the call context found, or null if no context was active
  - findContext
```
public CallContext findContext(int threadId)
```
    Finds the currently active call context for a thread id. The thread id is identical to the hash code for the thread.
    
    Parameters:
    
    threadId - the thread id to search for
    
    Returns:
    
    the call context found, or null if no context was active

Class ApplicationContext

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PATH_CONFIG

INIT_TIME

START_TIME

Method Detail

init

destroy

getInstance

reset

getConfig

getStorage

getEnvironment

getWebMatchers

getLibrary

getBaseDir

getClassLoader

isPluginLoaded

pluginConfig

installPlugin

loadPlugin

unloadPlugin

execute

executeAsync

findContext

findContext