Furnace (Furnace - Runtime API 2.0.0.Final API)

```
public interface Furnace
```
Operations for initializing, starting, interacting with, and stopping a Furnace container.

Author:

Lincoln Baxter, III

Method Summary

Methods
Modifier and Type	Method and Description
`ListenerRegistration<ContainerLifecycleListener>`	`addContainerLifecycleListener(ContainerLifecycleListener listener)` Register a `ContainerLifecycleListener` instance.
`AddonRepository`	`addRepository(AddonRepository repository)` Add an `AddonRepository` to be scanned for deployed and enabled `Addon` instances.
`AddonRepository`	`addRepository(AddonRepositoryMode mode, File repository)` Add an `AddonRepository` to be scanned for deployed and enabled `Addon` instances.
`AddonRegistry`	`getAddonRegistry(AddonRepository... repositories)` Get the central `AddonRegistry` for this `Furnace` instance.
`String[]`	`getArgs()` Get the arguments with which `Furnace` should start.
`LockManager`	`getLockManager()` Get the `LockManager` associated with this `Furnace` instance
`List<AddonRepository>`	`getRepositories()` Get an immutable `List` of configured `AddonRepository` instances.
`ClassLoader`	`getRuntimeClassLoader()` Get the `ClassLoader` from which `Furnace` loaded its internal classes.
`ContainerStatus`	`getStatus()` Get the current status of this `Furnace` container
`Version`	`getVersion()` Get the current runtime API version of `Furnace`.
`boolean`	`isServerMode()` Returns `true` or `false` if `setServerMode(boolean)` has been set.
`void`	`setArgs(String[] args)` Set the arguments with which `Furnace` should start.
`Furnace`	`setServerMode(boolean server)` When server mode is set to `true`, `Furnace` will run as a server process until explicitly stopped.
`Furnace`	`start()` Start this `Furnace` instance and wait for completion.
`Furnace`	`start(ClassLoader loader)` Start this `Furnace` instance and wait for completion, using the given `ClassLoader` to load core implementation resources.
`Furnace`	`startAsync()` Start this `Furnace` instance in a new background `Thread`.
`Furnace`	`startAsync(ClassLoader loader)` Start this `Furnace` instance in a new background `Thread`, using the given `ClassLoader` to load core implementation resources.
`Furnace`	`stop()` Stop this `Furnace` instance.

- Method Detail
  - startAsync
```
Furnace startAsync()
```
    Start this Furnace instance in a new background Thread.
  - startAsync
```
Furnace startAsync(ClassLoader loader)
```
    Start this Furnace instance in a new background Thread, using the given ClassLoader to load core implementation resources.
  - start
```
Furnace start()
```
    Start this Furnace instance and wait for completion.
  - start
```
Furnace start(ClassLoader loader)
```
    Start this Furnace instance and wait for completion, using the given ClassLoader to load core implementation resources.
  - stop
```
Furnace stop()
```
    Stop this Furnace instance.
  - isServerMode
```
boolean isServerMode()
```
    Returns true or false if setServerMode(boolean) has been set.
  - setServerMode
```
Furnace setServerMode(boolean server)
```
    When server mode is set to true, Furnace will run as a server process until explicitly stopped. When server mode is false, Furnace will process all inputs and exit once addons have completed any requested operations.
  - getAddonRegistry
```
AddonRegistry getAddonRegistry(AddonRepository... repositories)
```
    Get the central AddonRegistry for this Furnace instance. Contains Addon registration and service information. If specific AddonRepository instances are supplied, return an registry that functions with the given repositories only.
  - getRepositories
```
List<AddonRepository> getRepositories()
```
    Get an immutable List of configured AddonRepository instances.
  - addRepository
```
AddonRepository addRepository(AddonRepositoryMode mode,
                            File repository)
```
    Add an AddonRepository to be scanned for deployed and enabled Addon instances. This method must not be called once Furnace is started.
  - addRepository
```
AddonRepository addRepository(AddonRepository repository)
```
    Add an AddonRepository to be scanned for deployed and enabled Addon instances. This method must not be called once Furnace is started.
  - getVersion
```
Version getVersion()
```
    Get the current runtime API version of Furnace.
  - addContainerLifecycleListener
```
ListenerRegistration<ContainerLifecycleListener> addContainerLifecycleListener(ContainerLifecycleListener listener)
```
    Register a ContainerLifecycleListener instance. Returns a ListenerRegistration that can be used to un-register the listener.
  - getRuntimeClassLoader
```
ClassLoader getRuntimeClassLoader()
```
    Get the ClassLoader from which Furnace loaded its internal classes.
  - getLockManager
```
LockManager getLockManager()
```
    Get the LockManager associated with this Furnace instance
  - getStatus
```
ContainerStatus getStatus()
```
    Get the current status of this Furnace container
  - setArgs
```
void setArgs(String[] args)
```
    Set the arguments with which Furnace should start. Typically this will simply be passed through from public static void main(String[] args).
  - getArgs
```
String[] getArgs()
```
    Get the arguments with which Furnace should start. Typically this will simply be passed through from public static void main(String[] args).
    
    Returns:
    the arguments, or null if no arguments were set.

Interface Furnace

Method Summary

Method Detail

startAsync

startAsync

start

start

stop

isServerMode

setServerMode

getAddonRegistry

getRepositories

addRepository

addRepository

getVersion

addContainerLifecycleListener

getRuntimeClassLoader

getLockManager

getStatus

setArgs

getArgs