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)
static AbstractModule	assertAbstractModule(Module module)
protected void	assertNotUninstalled()
List<URL>	findEntries(String path, String filePattern, boolean recurse) Returns entries in this module.
<T> T	getAttachment(org.jboss.gravia.resource.AttachmentKey<T> key)
protected abstract Bundle	getBundleAdaptor(Module module)
protected ClassLoader	getClassLoader()
URL	getEntry(String path) Returns a URL to the entry at the specified path in this module.
List<String>	getEntryPaths(String path) Returns an Enumeration of all the paths (String objects) to entries within this module whose longest sub-path matches the specified path.
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()
<T> boolean	hasAttachment(org.jboss.gravia.resource.AttachmentKey<T> key)
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

assertAbstractModule

public static AbstractModule assertAbstractModule(Module module)

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

hasAttachment

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

Specified by:

hasAttachment 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.

getEntry

public URL getEntry(String path)

Description copied from interface: Module

Returns a URL to the entry at the specified path in this module. This modules's class loader is not used to search for the entry. Only the contents of this module are searched for the entry.

The specified path is always relative to the root of this module and may begin with "/". A path value of "/" indicates the root of this module.

Specified by:

getEntry in interface Module

Parameters:

path - The path name of the entry.

Returns:

A URL to the entry, or null if no entry could be found.

getEntryPaths

public List<String> getEntryPaths(String path)

Description copied from interface: Module

Returns an Enumeration of all the paths (String objects) to entries within this module whose longest sub-path matches the specified path. This module's class loader is not used to search for entries. Only the contents of this module are searched.

The specified path is always relative to the root of this module and may begin with a "/". A path value of "/" indicates the root of this module.

Returned paths indicating subdirectory paths end with a "/". The returned paths are all relative to the root of this module and must not begin with "/".

Specified by:

getEntryPaths in interface Module

Parameters:

path - The path name for which to return entry paths.

Returns:

A list of the entry paths (String objects).

findEntries

public List<URL> findEntries(String path,
                    String filePattern,
                    boolean recurse)

Description copied from interface: Module

Returns entries in this module. This module's class loader is not used to search for entries. Only the contents of this module is searched for the specified entries.

URLs for directory entries must have their path end with "/".

Specified by:

findEntries in interface Module

Parameters:

path - The path name in which to look. The path is always relative to the root of this module and may begin with "/". A path value of "/" indicates the root of this module.

filePattern - The file name pattern for selecting entries in the specified path. The pattern is only matched against the last element of the entry path. If the entry is a directory then the trailing "/" is not used for pattern matching. Substring matching is supported, as specified in the Filter specification, using the wildcard character ("*"). If null is specified, this is equivalent to "*" and matches all files.

recurse - If true, recurse into subdirectories. Otherwise only return entries from the specified path.

Returns:

A list of URL objects for each matching entry.

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