com.toolsverse.ext.loader

Class UnitLoader

Object

com.toolsverse.ext.loader.UnitLoader

Direct Known Subclasses:

LocalUnitLoader, SharedUnitLoader

public abstract class UnitLoader
extends Object

The instance of this class dynamically loads Units and all its extensions at run time. There is a hierarchy of folders where units and extension can be found. Usually loader examines CLASSES folder first, then plugin, then lib folder. It parses all .class and .jar files and looks for classes located under provided class path. It loads Units first, then actual extensions.

Since:

2.0

Version:

2.0

See Also:

Unit, LocalUnitLoader, SharedUnitLoader

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnitLoader.StoredExtension The Class StoredExtension.

Constructor Summary

Constructors

Constructor and Description
UnitLoader() Instantiates a new UnitLoader.

Method Summary

Modifier and Type	Method and Description
void	addExtension(ExtensionModule ext) Adds the ExtensionModule.
void	free() Frees the memory.
Map<String,String>	getAddedJars() Gets the map of the added jars.
List<ExtensionModule>	getExtensions() Gets the list of extensions.
Unit<?>	getUnit(Class<?> objClass) Gets the Unit by class.
abstract Unit<?>	getUnit(String unitClass) Gets the Unit by unitClass.
List<Unit<?>>	getUnits() Gets the list of units.
void	load(Collection<Unit<?>> units, FilterContext filterContext) Loads all extensions for the collection of units.
void	load(FilterContext filterContext) Loads all extensions for the registered units.
void	loadOthers(String classPath, FilterContext filterContext) Loads all extensions for the units located in the classPath.
void	register(Unit<?> unit, String path, String jarPath) Registers unit, using provided path and jar path.
Collection<Unit<?>>	registerAll(String path, String jarPath, String classPath, FilterContext filterContext) Registers all units.

Methods inherited from class Object

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

Constructor Detail

UnitLoader

public UnitLoader()

Instantiates a new UnitLoader.

Method Detail

addExtension

public void addExtension(ExtensionModule ext)

Adds the ExtensionModule.

Parameters:

ext - the ExtensionModule

free

public void free()

Frees the memory.

getAddedJars

public Map<String,String> getAddedJars()

Gets the map of the added jars.

Returns:

the added jars

getExtensions

public List<ExtensionModule> getExtensions()

Gets the list of extensions.

Returns:

the list of extensions

getUnit

public Unit<?> getUnit(Class<?> objClass)

Gets the Unit by class.

Parameters:

objClass - the class

Returns:

the Unit

getUnit

public abstract Unit<?> getUnit(String unitClass)
                         throws Exception

Gets the Unit by unitClass.

Parameters:

unitClass - the unit class

Returns:

the Unit

Throws:

Exception - in case of any error

getUnits

public List<Unit<?>> getUnits()

Gets the list of units.

Returns:

the list of units

load

public void load(Collection<Unit<?>> units,
                 FilterContext filterContext)

Loads all extensions for the collection of units. If extension implements Filter interface it filters itself using provided filterContext.

Parameters:

units - the collection of units

filterContext - the FilterContext

See Also:

Filter

load

public void load(FilterContext filterContext)

Loads all extensions for the registered units. If extension implements Filter interface it filters itself using provided filterContext.

Parameters:

filterContext - the FilterContext

loadOthers

public void loadOthers(String classPath,
                       FilterContext filterContext)

Loads all extensions for the units located in the classPath. The classPath can be a ";" separated string where each token is an individual class path. If extension implements Filter interface it filters itself using provided filterContext. The path and jar path are respectfully SystemConfig.instance().getPluginsPath() and SystemConfig.instance().getLibsPath() + "*.jar".

Parameters:

classPath - the class path

filterContext - the filter context

register

public void register(Unit<?> unit,
                     String path,
                     String jarPath)

Registers unit, using provided path and jar path.

Parameters:

unit - the unit

path - the path

jarPath - the jar path

registerAll

public Collection<Unit<?>> registerAll(String path,
                                       String jarPath,
                                       String classPath,
                                       FilterContext filterContext)

Registers all units. Unit itself is a dynamically loaded module so it examines path folder first, then jar path and loads all units in the classPath.

Parameters:

path - the path

jarPath - the jar path

classPath - the class path

filterContext - the filter context

Returns:

the collection