org.jboss.gravia.runtime.spi

Class AbstractRuntime

java.lang.Object

org.jboss.gravia.runtime.spi.AbstractRuntime

All Implemented Interfaces:

Runtime

public abstract class AbstractRuntime
extends Object
implements Runtime

The abstract base implementation for a Runtime

Since:

27-Sep-2013

Author:

thomas.diesler@jboss.com

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRuntime(PropertiesProvider propertiesProvider)

Method Summary

Modifier and Type	Method and Description
<A> A	adapt(Class<A> type)
protected void	assertNoShutdown()
boolean	awaitShutdown(long timeout, TimeUnit unit) Await shutdown complete
protected abstract AbstractModule	createModule(ClassLoader classLoader, org.jboss.gravia.resource.Resource resource, Dictionary<String,String> headers, org.jboss.gravia.resource.Attachable context)
protected void	doShutdown()
protected abstract ModuleEntriesProvider	getDefaultEntriesProvider(Module module, org.jboss.gravia.resource.Attachable context)
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 propName) Returns the value of the specified property.
protected org.jboss.gravia.resource.ResourceIdentity	getSystemIdentity()
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
protected void	uninstallModule(Module module)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.gravia.runtime.Runtime

init

Constructor Detail

AbstractRuntime

protected AbstractRuntime(PropertiesProvider propertiesProvider)

Method Detail

createModule

protected abstract AbstractModule createModule(ClassLoader classLoader,
                                               org.jboss.gravia.resource.Resource resource,
                                               Dictionary<String,String> headers,
                                               org.jboss.gravia.resource.Attachable context)

getDefaultEntriesProvider

protected abstract ModuleEntriesProvider getDefaultEntriesProvider(Module module,
                                                                   org.jboss.gravia.resource.Attachable context)

getProperty

public final Object getProperty(String key)

Description copied from interface: Runtime

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.

Specified by:

getProperty in interface Runtime

Parameters:

key - The name of the requested property.

Returns:

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

getRequiredProperty

public Object getRequiredProperty(String propName)

Description copied from interface: Runtime

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.

Specified by:

getRequiredProperty in interface Runtime

Parameters:

propName - The name of the requested property.

Returns:

The value of the requested property

getProperty

public final Object getProperty(String key,
                                Object defaultValue)

Description copied from interface: Runtime

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.

Specified by:

getProperty in interface Runtime

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.

adapt

public <A> A adapt(Class<A> type)

getSystemIdentity

protected final org.jboss.gravia.resource.ResourceIdentity getSystemIdentity()

getModuleContext

public ModuleContext getModuleContext()

Description copied from interface: Runtime

Get the sytem module context.

Specified by:

getModuleContext in interface Runtime

getModule

public final Module getModule(long id)

Description copied from interface: Runtime

Returns the module with the specified identifier.

Specified by:

getModule in interface Runtime

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

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

Description copied from interface: Runtime

Returns the module with the specified resource identity.

Specified by:

getModule in interface Runtime

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

public final Module getModule(ClassLoader classLoader)

Description copied from interface: Runtime

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)

Specified by:

getModule in interface Runtime

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

public final Set<Module> getModules()

Description copied from interface: Runtime

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.

Specified by:

getModules in interface Runtime

Returns:

The set of Modules.

getModules

public final Set<Module> getModules(ClassLoader classLoader)

Description copied from interface: Runtime

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

Specified by:

getModules in interface Runtime

Returns:

The set of Modules.

getModules

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

Description copied from interface: Runtime

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.

Specified by:

getModules in interface Runtime

Returns:

The set of Modules that match.

installModule

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

Description copied from interface: Runtime

Installs a module with the given ClassLoader and headers dictionary.

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

Specified by:

installModule in interface Runtime

Throws:

ModuleException

See Also:

Runtime.installModule(ClassLoader, Resource, Dictionary)

installModule

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

Description copied from interface: Runtime

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.

Specified by:

installModule in interface Runtime

Throws:

ModuleException

See Also:

Runtime.installModule(ClassLoader, Resource, Dictionary, Attachable)

installModule

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

Description copied from interface: Runtime

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.

Specified by:

installModule in interface Runtime

Throws:

ModuleException

uninstallModule

protected void uninstallModule(Module module)

shutdown

public Runtime shutdown()

Description copied from interface: Runtime

Shutdown the runtime. Asynchronously

• Uninstall all modules
• Unregister system services

Specified by:

shutdown in interface Runtime

shutdownInProgress

public boolean shutdownInProgress()

Description copied from interface: Runtime

True, if runtime shutdown has been initiated

Specified by:

shutdownInProgress in interface Runtime

awaitShutdown

public boolean awaitShutdown(long timeout,
                             TimeUnit unit)
                      throws InterruptedException

Description copied from interface: Runtime

Await shutdown complete

Specified by:

awaitShutdown in interface Runtime

Returns:

true, if shutdown completed in time

Throws:

InterruptedException

shutdownComplete

public boolean shutdownComplete()

Description copied from interface: Runtime

True, if runtime shutdown has been completed

Specified by:

shutdownComplete in interface Runtime

assertNoShutdown

protected void assertNoShutdown()

doShutdown

protected void doShutdown()