Application (Werval API Reference (0.7.5))

All Known Subinterfaces:

ApplicationSPI
```
public interface Application
```
Application.
An Application instance can run in different Modes, default Mode is Mode.TEST. For your code to be Mode.DEV friendly, don't hold references to instances returned by an Application instance.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`activate()` Activate the Application.
`Cache`	`cache()` Application `Cache`.
`ClassLoader`	`classLoader()` Application `ClassLoader`.
`Config`	`config()` Application `Config`.
`Crypto`	`crypto()` Application `Crypto`.
`Charset`	`defaultCharset()` Application default `Charset`.
`Errors`	`errors()` Application `Errors`.
`Events`	`events()` Application Events.
`default ExecutorService`	`executor()` Default Application ExecutorService.
`ApplicationExecutors`	`executors()` Application Executors.
`HttpBuilders`	`httpBuilders()` HTTP API Objects Builders.
`boolean`	`isActive()` Application activation state.
`Langs`	`langs()` Application `Langs`.
`MetaData`	`metaData()` Application `MetaData`.
`MimeTypes`	`mimeTypes()` Application `MimeTypes`.
`Mode`	`mode()` Application Mode.
`ParameterBinders`	`parameterBinders()` Application `ParameterBinders`.
`void`	`passivate()` Passivate the Application.
`<T> T`	`plugin(Class<T> pluginApiType)` Lookup a Plugin's API.
`<T> Iterable<T>`	`plugins(Class<T> pluginApiType)` Lookup possibly several Plugin's API.
`ReverseRoutes`	`reverseRoutes()` Application `ReverseRoutes`.
`Routes`	`routes()` Application `Routes`.
`Stacktraces.FileURLGenerator`	`sourceFileURLGenerator()` FileURLGenerator for Application Sources.
`Templates`	`templates()` Application `Templates`.
`File`	`tmpdir()` Application temporary directory `File`.

- Method Detail
  - activate
```
void activate()
       throws ActivationException
```
    Activate the Application.
    
    Throws:
    
    IllegalStateException - if the Application is already active.
    
    ActivationException - if something goes wrong.
  - passivate
```
void passivate()
```
    Passivate the Application.
    
    Throws:
    
    IllegalStateException - if the Application was not active.
  - isActive
```
boolean isActive()
```
    Application activation state.
    
    Returns:
    
    TRUE if the Application is active, otherwise return FALSE
  - mode
```
Mode mode()
```
    Application Mode.
    
    Returns:
    
    Application Mode, defaults to Mode.TEST.
  - config
```
Config config()
```
    Application Config.
    Don't hold references to the Config instance in order to make your code Mode.DEV friendly.
    
    Returns:
    
    Application Config
  - plugin
```
<T> T plugin(Class<T> pluginApiType)
```
    Lookup a Plugin's API.
    Don't hold references to the Plugins API instances in order to make your code Mode.DEV friendly.
    
    Type Parameters:
    
    T - Parameterized Plugin API type
    
    Parameters:
    
    pluginApiType - Plugin type
    
    Returns:
    
    The first Plugin API found that match given type (Type equals first, then assignable).
    
    Throws:
    
    IllegalArgumentException - if no Plugin is found for the given API type
    
    IllegalStateException - if the Application is not active
  - plugins
```
<T> Iterable<T> plugins(Class<T> pluginApiType)
```
    Lookup possibly several Plugin's API.
    Don't hold references to the Plugins API instances in order to make your code Mode.DEV friendly.
    
    Type Parameters:
    
    T - Parameterized Plugin API type
    
    Parameters:
    
    pluginApiType - Plugin type
    
    Returns:
    
    All Plugin APIs found that match the he given type (Type equals first, then assignables), or none if no Plugin is found for the given API type.
    
    Throws:
    
    IllegalStateException - if the Application is not active
  - crypto
```
Crypto crypto()
```
    Application Crypto.
    Don't hold references to the Crypto instance in order to make your code Mode.DEV friendly.
    
    Returns:
    
    Application Crypto
  - langs
```
Langs langs()
```
    Application Langs.
    Don't hold references to the Langs instance in order to make your code Mode.DEV friendly.
    
    Returns:
    
    Application Langs
  - defaultCharset
```
Charset defaultCharset()
```
    Application default Charset.
    
    Returns:
    
    Application default Charset
  - tmpdir
```
File tmpdir()
```
    Application temporary directory File.
    
    Returns:
    
    Application temporary directory File
  - classLoader
```
ClassLoader classLoader()
```
    Application ClassLoader.
    Don't hold references to the ClassLoader instance to prevent memory leaks in Mode.DEV.
    
    Returns:
    
    Application ClassLoader
  - executor
```
default ExecutorService executor()
```
    Default Application ExecutorService.
    Convey the current Context to parallel threads if any.
    
    Use when composing CompletableFutures or to submit parallel Stream operations.
    
    Returns:
    
    Default Application ExecutorService.
  - executors
```
ApplicationExecutors executors()
```
    Application Executors.
    Convey the current Context to parallel threads if any.
    
    Use when composing CompletableFutures or to submit parallel Stream operations.
    
    Returns:
    
    Application Executors
  - events
```
Events events()
```
    Application Events.
    
    Returns:
    
    Application Events
  - httpBuilders
```
HttpBuilders httpBuilders()
```
    HTTP API Objects Builders.
    Use this to create instances of HTTP API Objects found in the io.werval.api.http package. All builders are immutable and reusable.
    
    Returns:
    
    HTTP API Objects Builders
  - routes
```
Routes routes()
```
    Application Routes.
    Don't hold references to the Routes instance in order to make your code Mode.DEV friendly.
    
    The Application Routes include Routes contributed by registered Plugins.
    
    Returns:
    
    Application Routes
    
    Throws:
    
    IllegalStateException - if the Application is not active
  - reverseRoutes
```
ReverseRoutes reverseRoutes()
```
    Application ReverseRoutes.
    Don't hold references to the ReverseRoutes instance in order to make your code Mode.DEV friendly.
    
    Returns:
    
    Application ReverseRoutes
    
    Throws:
    
    IllegalStateException - if the Application is not active
  - parameterBinders
```
ParameterBinders parameterBinders()
```
    Application ParameterBinders.
    Don't hold references to the ParameterBinders instance in order to make your code Mode.DEV friendly.
    
    Returns:
    
    Application ParameterBinders
  - mimeTypes
```
MimeTypes mimeTypes()
```
    Application MimeTypes.
    Don't hold references to the MimeTypes instance in order to make your code Mode.DEV friendly.
    
    Returns:
    
    Application MimeTypes
  - metaData
```
MetaData metaData()
```
    Application MetaData.
    Don't hold references to the MetaData instance in order to make your code Mode.DEV friendly.
    
    Returns:
    
    Application MetaData
  - cache
```
Cache cache()
```
    Application Cache.
    Don't hold references to the Cache instance in order to make your code Mode.DEV friendly.
    
    Returns:
    
    Application Cache
  - templates
```
Templates templates()
```
    Application Templates.
    Don't hold references to the Templates instance in order to make your code Mode.DEV friendly.
    
    Returns:
    
    Application Templates
    
    Throws:
    
    IllegalArgumentException - if no Plugin is found for Templates
  - errors
```
Errors errors()
```
    Application Errors.
    Don't hold references to the Errors instance in order to make your code Mode.DEV friendly.
    
    Returns:
    
    Application Errors
  - sourceFileURLGenerator
```
Stacktraces.FileURLGenerator sourceFileURLGenerator()
```
    FileURLGenerator for Application Sources.
    Works only in Mode.DEV mode.
    
    Returns:
    
    FileURLGenerator for Application Sources

Interface Application

Method Summary

Method Detail

activate

passivate

isActive

mode

config

plugin

plugins

crypto

langs

defaultCharset

tmpdir

classLoader

executor

executors

events

httpBuilders

routes

reverseRoutes

parameterBinders

mimeTypes

metaData

cache

templates

errors

sourceFileURLGenerator