org.jboss.gravia.runtime.spi

Interface ModuleEntriesProvider

public interface ModuleEntriesProvider

A provider for module entries.

To discover and return module entries the runtime must delegate to specifc module type dependent implementations

• OSGi: The Bundle entries API
• Tomcat: The ServletContext resource API
• WildFly: The JBoss Modules entries API

Since:

27-Sep-2013

Author:

thomas.diesler@jboss.com

Method Summary

Methods

Modifier and Type	Method and Description
Enumeration<URL>	findEntries(String path, String filePattern, boolean recurse) Find entries in this module.
URL	getEntry(String path) Returns a URL to the entry at the specified path in this module.
Enumeration<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.

Method Detail

getEntryPaths

Enumeration<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. 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 "/".

Note: Jar and zip files are not required to include directory entries. Paths to directory entries will not be returned if the module contents do not contain directory entries.

Parameters:

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

Returns:

An Enumeration of the entry paths (String objects) or null if no entry could be found.

Throws:

IllegalStateException - If this module has been uninstalled.

getEntry

URL getEntry(String path)

Returns a URL to the entry at the specified path in this module. This module'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.

Note: Jar and zip files are not required to include directory entries. URLs to directory entries will not be returned if the module contents do not contain directory entries.

Parameters:

path - The path name of the entry.

Returns:

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

Throws:

IllegalStateException - If this module has been uninstalled.

findEntries

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

Find 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. If this module's state is INSTALLED, this method must attempt to resolve this module before attempting to find entries.

This method is intended to be used to obtain configuration, setup, localization and other information from this module. This "module space" is not a namespace with unique members; the same entry name can be present multiple times. This method therefore returns an enumeration of URL objects. These URLs can come from different JARs but have the same path name. This method can either return only entries in the specified path or recurse into subdirectories returning entries in the directory tree beginning at the specified path.

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

Note: Jar and zip files are not required to include directory entries. URLs to directory entries will not be returned if the module contents do not contain directory entries.

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:

An enumeration of URL objects for each matching entry, or null if no matching entry could be found.

Throws:

IllegalStateException - If this module has been uninstalled.