org.jboss.gravia.runtime

Interface Runtime

All Known Implementing Classes:

AbstractRuntime

public interface Runtime

The Gravia runtime.

It is used to install and maintain the set of installed Modules.

Since:

27-Sep-2013

Author:

thomas.diesler@jboss.com

Method Summary

Methods

Modifier and Type	Method and Description
boolean	awaitShutdown(long timeout, TimeUnit unit) Await shutdown complete
Module	getModule(ClassLoader classLoader) Returns a module that is associated with the specified class loader.
Module	getModule(long id) Returns the module with the specified identifier.
Module	getModule(org.jboss.gravia.resource.ResourceIdentity identity) Returns the module with the specified resource identity.
ModuleContext	getModuleContext() Get the sytem module context.
Set<Module>	getModules() Returns the set of all installed modules.
Set<Module>	getModules(ClassLoader classLoader) Returns the set of installed modules associated with the given class loader.
Set<Module>	getModules(String symbolicName, org.jboss.gravia.resource.VersionRange range) Returns the set of installed modules with a given symbolic name or version.
Object	getProperty(String key) Returns the value of the specified property.
Object	getProperty(String key, Object defaultValue) Returns the value of the specified property.
Object	getRequiredProperty(String key) Returns the value of the specified property.
void	init() Initialize this runtime instance.
Module	installModule(ClassLoader classLoader, Dictionary<String,String> headers) Installs a module with the given ClassLoader and headers dictionary.
Module	installModule(ClassLoader classLoader, org.jboss.gravia.resource.Resource resource, Dictionary<String,String> headers) Installs a module with the given ClassLoader.
Module	installModule(ClassLoader classLoader, org.jboss.gravia.resource.Resource resource, Dictionary<String,String> headers, org.jboss.gravia.resource.Attachable context) Installs a module with the given ClassLoader.
Runtime	shutdown() Shutdown the runtime.
boolean	shutdownComplete() True, if runtime shutdown has been completed
boolean	shutdownInProgress() True, if runtime shutdown has been initiated

Method Detail

init

void init()

Initialize this runtime instance. After calling this method, this Runtime must:

• Have event handling enabled.
• Have reified Module objects for all installed modules.
• Have registered any framework services.

getProperty

Object getProperty(String key)

Returns the value of the specified property. If the key is not found in the Runtime properties, the system properties are then searched. The method returns null if the property is not found.

Parameters:

key - The name of the requested property.

Returns:

The value of the requested property, or null if the property is undefined.

getRequiredProperty

Object getRequiredProperty(String key)

Returns the value of the specified property. If the key is not found in the Runtime properties, the system properties are then searched. The method throws an IllegalStateException if the property is not found.

Parameters:

key - The name of the requested property.

Returns:

The value of the requested property

Throws:

IllegalStateException - if the property is undefined.

getProperty

Object getProperty(String key,
                 Object defaultValue)

Returns the value of the specified property. If the key is not found in the Runtime properties, the system properties are then searched. The method returns provided default value if the property is not found.

Parameters:

key - The name of the requested property.

Returns:

The value of the requested property, or the provided default value if the property is undefined.

getModuleContext

ModuleContext getModuleContext()

Get the sytem module context.

getModule

Module getModule(long id)

Returns the module with the specified identifier.

Parameters:

id - The identifier of the module to retrieve.

Returns:

A Module object or null if the identifier does not match any installed module.

getModule

Module getModule(org.jboss.gravia.resource.ResourceIdentity identity)

Returns the module with the specified resource identity.

Parameters:

identity - The identifier of the module to retrieve.

Returns:

A Module object or null if the resource identity does not match any installed module.

getModule

Module getModule(ClassLoader classLoader)

Returns a module that is associated with the specified class loader.

If multiple modules are associated with the same class loader it returns the first in the natural module order (i.e. the one with the lowest module identifier)

Parameters:

classLoader - The class loader of the module to retrieve.

Returns:

A Module object or null if the class loader does not match any installed module.

getModules

Set<Module> getModules()

Returns the set of all installed modules.

This method returns a list of all modules installed in the Runtime at the time of the call to this method. However, since the Runtime is a very dynamic environment, modules can be installed or uninstalled at anytime.

Returns:

The set of Modules.

getModules

Set<Module> getModules(ClassLoader classLoader)

Returns the set of installed modules associated with the given class loader.

Returns:

The set of Modules.

getModules

Set<Module> getModules(String symbolicName,
                     org.jboss.gravia.resource.VersionRange range)

Returns the set of installed modules with a given symbolic name or version.

Both parameters are optional. If a parameter is null it matches all.

Returns:

The set of Modules that match.

installModule

Module installModule(ClassLoader classLoader,
                   Dictionary<String,String> headers)
                     throws ModuleException

Installs a module with the given ClassLoader and headers dictionary.

The module's ResourceIdentity and possible other capabilities/requirements are generated from the headers.

Throws:

ModuleException

See Also:

installModule(ClassLoader, Resource, Dictionary)

installModule

Module installModule(ClassLoader classLoader,
                   org.jboss.gravia.resource.Resource resource,
                   Dictionary<String,String> headers)
                     throws ModuleException

Installs a module with the given ClassLoader. The Resource as well as the Dictionary parameter are optional, but one of them must be given to determine the modules's identity.

Throws:

ModuleException

See Also:

installModule(ClassLoader, Resource, Dictionary, Attachable)

installModule

Module installModule(ClassLoader classLoader,
                   org.jboss.gravia.resource.Resource resource,
                   Dictionary<String,String> headers,
                   org.jboss.gravia.resource.Attachable context)
                     throws ModuleException

Installs a module with the given ClassLoader. The Resource as well as the Dictionary parameter are optional, but one of them must be given to determine the modules's identity.

An explicit Resource parameter takes priority.

An optional application context can be given

The following steps are required to install a module:

1. The module's state is set to INSTALLED.
2. A module event of type ModuleEvent.INSTALLED is fired.
3. The module's state is set to RESOLVED.
4. A module event of type ModuleEvent#RESOLVED is fired.
5. The Module object for the newly or previously installed module is returned.

Throws:

ModuleException

shutdown

Runtime shutdown()

Shutdown the runtime. Asynchronously

• Uninstall all modules
• Unregister system services

shutdownInProgress

boolean shutdownInProgress()

True, if runtime shutdown has been initiated

shutdownComplete

boolean shutdownComplete()

True, if runtime shutdown has been completed

awaitShutdown

boolean awaitShutdown(long timeout,
                    TimeUnit unit)
                      throws InterruptedException

Await shutdown complete

Returns:

true, if shutdown completed in time

Throws:

InterruptedException