net.lecousin.framework.application.libraries.classpath

Class DefaultLibrariesManager

java.lang.Object

net.lecousin.framework.application.libraries.classpath.DefaultLibrariesManager

All Implemented Interfaces:

LibrariesManager

public class DefaultLibrariesManager
extends Object
implements LibrariesManager

Default implementation of LibrariesManager. This implementation is not capable to load libraries dynamically, and only uses those in the class path. It loads extension points and plugins from libraries present in the class path.

Constructor Summary

Constructors

Constructor and Description
DefaultLibrariesManager() Constructor.
DefaultLibrariesManager(File[] additionalClassPath) Constructor with additional files to load.

Method Summary

Modifier and Type	Method and Description
List<File>	getLibrariesLocations() Return the list of libraries loaded.
IO.Readable	getResource(String path, byte priority) Open a resource or return null if it does not exist.
IAsync<LibraryManagementException>	onLibrariesLoaded() Return a synchronization point which is blocked until this libraries manager has been initialized and has loaded all required libraries.
static void	scanDirectoryLibrary(ApplicationClassLoader classLoader, File dir, String rootPackage, boolean includeSubPackages, Predicate<String> packageFilter, Predicate<String> classFilter, Consumer<Class<?>> classScanner) Scan a directory looking for class files.
static void	scanJarLibrary(ApplicationClassLoader classLoader, File file, String rootPackage, boolean includeSubPackages, Predicate<String> packageFilter, Predicate<String> classFilter, Consumer<Class<?>> classScanner) Scan a JAR looking for class files.
static void	scanJarLibrary(ApplicationClassLoader classLoader, ZipFile jar, String rootPackage, boolean includeSubPackages, Predicate<String> packageFilter, Predicate<String> classFilter, Consumer<Class<?>> classScanner) Scan a JAR looking for class files.
void	scanLibraries(String rootPackage, boolean includeSubPackages, Predicate<String> packageFilter, Predicate<String> classFilter, Consumer<Class<?>> classScanner) Go through each library to scan its content.
DefaultApplicationClassLoader	start(Application app) This method is automatically called on application startup so this libraries manager can initialize and load libraries as needed for the given application.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultLibrariesManager

public DefaultLibrariesManager(File[] additionalClassPath)

Constructor with additional files to load.

DefaultLibrariesManager

public DefaultLibrariesManager()

Constructor.

Method Detail

start

public DefaultApplicationClassLoader start(Application app)

Description copied from interface: LibrariesManager

This method is automatically called on application startup so this libraries manager can initialize and load libraries as needed for the given application.

Specified by:

start in interface LibrariesManager

onLibrariesLoaded

public IAsync<LibraryManagementException> onLibrariesLoaded()

Description copied from interface: LibrariesManager

Return a synchronization point which is blocked until this libraries manager has been initialized and has loaded all required libraries.

Specified by:

onLibrariesLoaded in interface LibrariesManager

getResource

public IO.Readable getResource(String path,
                               byte priority)

Description copied from interface: LibrariesManager

Open a resource or return null if it does not exist.

Specified by:

getResource in interface LibrariesManager

getLibrariesLocations

public List<File> getLibrariesLocations()

Description copied from interface: LibrariesManager

Return the list of libraries loaded. Each File may be a file in case of a JAR, or a directory.

Specified by:

getLibrariesLocations in interface LibrariesManager

scanLibraries

public void scanLibraries(String rootPackage,
                          boolean includeSubPackages,
                          Predicate<String> packageFilter,
                          Predicate<String> classFilter,
                          Consumer<Class<?>> classScanner)

Description copied from interface: LibrariesManager

Go through each library to scan its content.

Specified by:

scanLibraries in interface LibrariesManager

scanDirectoryLibrary

public static void scanDirectoryLibrary(ApplicationClassLoader classLoader,
                                        File dir,
                                        String rootPackage,
                                        boolean includeSubPackages,
                                        Predicate<String> packageFilter,
                                        Predicate<String> classFilter,
                                        Consumer<Class<?>> classScanner)

Scan a directory looking for class files.

scanJarLibrary

public static void scanJarLibrary(ApplicationClassLoader classLoader,
                                  File file,
                                  String rootPackage,
                                  boolean includeSubPackages,
                                  Predicate<String> packageFilter,
                                  Predicate<String> classFilter,
                                  Consumer<Class<?>> classScanner)

Scan a JAR looking for class files.

scanJarLibrary

public static void scanJarLibrary(ApplicationClassLoader classLoader,
                                  ZipFile jar,
                                  String rootPackage,
                                  boolean includeSubPackages,
                                  Predicate<String> packageFilter,
                                  Predicate<String> classFilter,
                                  Consumer<Class<?>> classScanner)

Scan a JAR looking for class files.