org.jboss.gravia.runtime.spi

Class AbstractModule

java.lang.Object

org.jboss.gravia.runtime.spi.AbstractModule

All Implemented Interfaces:

org.jboss.gravia.resource.Attachable, Module

public abstract class AbstractModule
extends Object
implements Module, org.jboss.gravia.resource.Attachable

The abstract base implementaiton for all Modules.

Since:

27-Sep-2013

Author:

thomas.diesler@jboss.com

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.gravia.runtime.Module

Module.State

Field Summary

Fields

Modifier and Type	Field and Description
static org.jboss.gravia.resource.AttachmentKey<ModuleEntriesProvider>	MODULE_ENTRIES_PROVIDER_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractModule(AbstractRuntime runtime, ClassLoader classLoader, org.jboss.gravia.resource.Resource resource, Dictionary<String,String> headers)

Method Summary

Methods

Modifier and Type	Method and Description
<A> A	adapt(Class<A> type) Addapt this module to another type.
void	addServiceInUse(ServiceReference<?> serviceState)
protected void	assertNotUninstalled()
<T> T	getAttachment(org.jboss.gravia.resource.AttachmentKey<T> key)
protected abstract Bundle	getBundleAdaptor(Module module)
protected ClassLoader	getClassLoader()
Dictionary<String,String>	getHeaders() Returns this module's headers and values that where given on module installation.
org.jboss.gravia.resource.ResourceIdentity	getIdentity() Get the identity of this module.
protected AbstractRuntime	getRuntime()
Set<ServiceReference<?>>	getServicesInUseInternal()
Class<?>	loadClass(String className) Loads the specified class using this module's class loader.
<T> T	putAttachment(org.jboss.gravia.resource.AttachmentKey<T> key, T value)
<T> T	removeAttachment(org.jboss.gravia.resource.AttachmentKey<T> key)
int	removeServiceInUse(ServiceReference<?> serviceState)
protected abstract void	setState(Module.State newState)
String	toString()

Methods inherited from class java.lang.Object

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

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

getDataFile, getModuleContext, getModuleId, getState, start, stop, uninstall

Field Detail

MODULE_ENTRIES_PROVIDER_KEY

public static org.jboss.gravia.resource.AttachmentKey<ModuleEntriesProvider> MODULE_ENTRIES_PROVIDER_KEY

Constructor Detail

AbstractModule

protected AbstractModule(AbstractRuntime runtime,
              ClassLoader classLoader,
              org.jboss.gravia.resource.Resource resource,
              Dictionary<String,String> headers)

Method Detail

setState

protected abstract void setState(Module.State newState)

getRuntime

protected AbstractRuntime getRuntime()

getClassLoader

protected ClassLoader getClassLoader()

getIdentity

public org.jboss.gravia.resource.ResourceIdentity getIdentity()

Description copied from interface: Module

Get the identity of this module.

Specified by:

getIdentity in interface Module

adapt

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

Description copied from interface: Module

Addapt this module to another type.

All modules support

• Runtime
• ClassLoader
• Resource
• ModuleContext

Specified by:

adapt in interface Module

Returns:

Null if the module cannot be adapted to the requested type

getBundleAdaptor

protected abstract Bundle getBundleAdaptor(Module module)

putAttachment

public <T> T putAttachment(org.jboss.gravia.resource.AttachmentKey<T> key,
                  T value)

Specified by:

putAttachment in interface org.jboss.gravia.resource.Attachable

getAttachment

public <T> T getAttachment(org.jboss.gravia.resource.AttachmentKey<T> key)

Specified by:

getAttachment in interface org.jboss.gravia.resource.Attachable

removeAttachment

public <T> T removeAttachment(org.jboss.gravia.resource.AttachmentKey<T> key)

Specified by:

removeAttachment in interface org.jboss.gravia.resource.Attachable

loadClass

public Class<?> loadClass(String className)
                   throws ClassNotFoundException

Description copied from interface: Module

Loads the specified class using this module's class loader.

If this module's state is UNINSTALLED, then an IllegalStateException is thrown.

Specified by:

loadClass in interface Module

Parameters:

className - The name of the class to load.

Returns:

The Class object for the requested class.

Throws:

ClassNotFoundException

getHeaders

public Dictionary<String,String> getHeaders()

Description copied from interface: Module

Returns this module's headers and values that where given on module installation.

These values may be mapped to manifest headers, but this is not a requirement. The module's header values do not change durint the lifecycle of the module.

Header names are case-insensitive. The methods of the returned Dictionary object must operate on header names in a case-insensitive manner.

This method must continue to return header information while this module is in the UNINSTALLED state.

Specified by:

getHeaders in interface Module

Returns:

An unmodifiable Dictionary object containing this module's Manifest headers and values.

getServicesInUseInternal

public Set<ServiceReference<?>> getServicesInUseInternal()

addServiceInUse

public void addServiceInUse(ServiceReference<?> serviceState)

removeServiceInUse

public int removeServiceInUse(ServiceReference<?> serviceState)

assertNotUninstalled

protected void assertNotUninstalled()

toString

public String toString()

Overrides:

toString in class Object