org.diet4j.core

Class AbstractScanningModuleRegistry

java.lang.Object

org.diet4j.core.ModuleRegistry

org.diet4j.core.AbstractModuleRegistry

org.diet4j.core.AbstractScanningModuleRegistry

Direct Known Subclasses:

InClasspathModuleRegistry, ScanningClasspathModuleRegistry, ScanningDirectoriesModuleRegistry

public abstract class AbstractScanningModuleRegistry
extends AbstractModuleRegistry

Collections functionality common to ModuleRegistry implementations that determine the set of available ModuleMetas through a scan. Keeps the set of available Modules in memory and does not rescan.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVATION_CLASS_PROPERTY Name of the (optional) property in pom.xml that identifies the activation/deactivation class in a Module JAR.
protected Map<String,MiniModuleMetaMap>	theMetas The set of known ModuleMetas, keyed by artifactId and then by groupId.

Fields inherited from class org.diet4j.core.AbstractModuleRegistry

DEFAULT_DO_NOT_LOAD_CLASS_PREFIXES, RESOLVE_LOCK, theDoNotLoadClassPrefixes

Fields inherited from class org.diet4j.core.ModuleRegistry

theSingleton

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractScanningModuleRegistry(Map<String,MiniModuleMetaMap> metas, String[] doNotLoadClassPrefixes) Private constructor, for subclasses only.

Method Summary

Modifier and Type	Method and Description
protected static void	addModuleMeta(ModuleMeta add, HashMap<String,MiniModuleMetaMap> metas) Add another ModuleMeta during runtime.
protected static void	addParsedModuleMetasFromDirectories(List<File> dirs, HashMap<String,MiniModuleMetaMap> result) Given a list of META-INF directories, determine the ModuleMetas that they contain.
protected static void	addParsedModuleMetasFromJars(List<JarFile> jars, HashMap<String,MiniModuleMetaMap> result) Given a list of Jar filenames, parse the JARs and determine the ModuleMetas that they contain.
ModuleMeta[]	determineResolutionCandidates(ModuleRequirement req) Determine the ModuleMetas that are candidates to resolve a Module dependency, based on the knowledge of this ModuleRegistry.
Set<String>	nameSet() Obtain the set of Module names currently contained in the registry.
Set<String>	nameSet(Pattern regex) Obtain the set of Module names currently contained in the registry that match a naming pattern.
protected static ModuleMeta	parseMetadataFiles(DocumentBuilderFactory dbf, JarFile jar, InputStream pomXmlEntryStream, InputStream pomPropertiesEntryStream, InputStream manifestEntryStream, InputStream pomFileStream) Helper method to parse metadata jar file entries into a ModuleMeta.
protected static String	replaceProperties(HashMap<String,String> prop, String s) Replace properties in Strings.
static int	rpmvercmp(String a, String b) Helper method to compare two versions the way RPM does it.

Methods inherited from class org.diet4j.core.AbstractModuleRegistry

addModuleRegistryListener, createClassLoader, determineRuntimeDependencies, determineRuntimeUses, determineSingleResolutionCandidate, fireModuleAddedEvent, getResolutionOf, removeModuleRegistryListener, resolve, resolve, toString

Methods inherited from class org.diet4j.core.ModuleRegistry

getSingleton

Methods inherited from class java.lang.Object

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

Field Detail

theMetas

protected final Map<String,MiniModuleMetaMap> theMetas

The set of known ModuleMetas, keyed by artifactId and then by groupId. Multiple versions of the ModuleMeta are ordered with the newest first.

ACTIVATION_CLASS_PROPERTY

public static final String ACTIVATION_CLASS_PROPERTY

Name of the (optional) property in pom.xml that identifies the activation/deactivation class in a Module JAR.

See Also:

Constant Field Values

Constructor Detail

AbstractScanningModuleRegistry

protected AbstractScanningModuleRegistry(Map<String,MiniModuleMetaMap> metas,
                                         String[] doNotLoadClassPrefixes)

Private constructor, for subclasses only.

Parameters:

metas - the ModuleMetas found, keyed by their artifactId, then by their groupId, and then ordered by version

doNotLoadClassPrefixes - prefixes of classes always to be loaded through the system class loader, not this one

Method Detail

determineResolutionCandidates

public ModuleMeta[] determineResolutionCandidates(ModuleRequirement req)

Determine the ModuleMetas that are candidates to resolve a Module dependency, based on the knowledge of this ModuleRegistry.

Specified by:

determineResolutionCandidates in class ModuleRegistry

Parameters:

req - the ModuleRequirement that we attempt to resolve

Returns:

the ModuleMetas that are candidates for the resolution of the ModuleRequirement, in sequence from best matched to least matched if the ModuleRegistry makes such distinctions

addModuleMeta

protected static void addModuleMeta(ModuleMeta add,
                                    HashMap<String,MiniModuleMetaMap> metas)

Add another ModuleMeta during runtime. Take care that we don't accidentally add the same one again.

Parameters:

add - the ModuleMeta to be added

metas - the existing ModuleMetas

nameSet

public Set<String> nameSet()

Obtain the set of Module names currently contained in the registry.

Specified by:

nameSet in class ModuleRegistry

Returns:

the set of Module names

nameSet

public Set<String> nameSet(Pattern regex)

Obtain the set of Module names currently contained in the registry that match a naming pattern.

Specified by:

nameSet in class ModuleRegistry

Parameters:

regex - the regular expression

Returns:

the set of Module names

addParsedModuleMetasFromJars

protected static void addParsedModuleMetasFromJars(List<JarFile> jars,
                                                   HashMap<String,MiniModuleMetaMap> result)

Given a list of Jar filenames, parse the JARs and determine the ModuleMetas that they contain. Add them to the provided hash.

Parameters:

jars - the JarFiles to parse

result - the hash to add results to

addParsedModuleMetasFromDirectories

protected static void addParsedModuleMetasFromDirectories(List<File> dirs,
                                                          HashMap<String,MiniModuleMetaMap> result)

Given a list of META-INF directories, determine the ModuleMetas that they contain. Add them to the provided hash.

Parameters:

dirs - the META-INF directories

result - the hash to add the results to

parseMetadataFiles

protected static ModuleMeta parseMetadataFiles(DocumentBuilderFactory dbf,
                                               JarFile jar,
                                               InputStream pomXmlEntryStream,
                                               InputStream pomPropertiesEntryStream,
                                               InputStream manifestEntryStream,
                                               InputStream pomFileStream)
                                        throws ParserConfigurationException,
                                               IOException,
                                               SAXException

Helper method to parse metadata jar file entries into a ModuleMeta.

Parameters:

dbf - the XML parser factory

jar - the JAR file containing the entries

pomXmlEntryStream - reading the maven pom.xml file

pomPropertiesEntryStream - reading the maven pom.properties file (if any)

manifestEntryStream - reading the MANIFEST.MF file

pomFileStream - read the POM from this stream, if given, otherwise use what's inside the JAR

Returns:

the created ModuleMeta

Throws:

ParserConfigurationException - misconfigured XML parser

IOException - I/O error

SAXException - XML syntax error

replaceProperties

protected static String replaceProperties(HashMap<String,String> prop,
                                          String s)

Replace properties in Strings.

Parameters:

prop - the map of properties

s - the String

Returns:

the replaced string

rpmvercmp

public static int rpmvercmp(String a,
                            String b)

Helper method to compare two versions the way RPM does it. Null comes first, then ordered by dot-separate

Parameters:

a: - version 1 to compare

b: - version 2 to compare