Package com.vividsolutions.jump.workbench.plugin

Class PlugInManager

java.lang.Object

com.vividsolutions.jump.workbench.plugin.PlugInManager

public class PlugInManager
extends Object

Loads plug-ins (or more precisely, Extensions), and any JAR files that they depend on, from the plug-in directory.

Constructor Summary

Constructors

Constructor	Description
PlugInManager(WorkbenchContext context, TaskMonitor monitor)

Method Summary

Modifier and Type	Method	Description
void	addExtensionsFolder(File dir)	add an extensions folder - adds folder root to classpath - adds all contained jars to classpath - looks for extensions in jars only in folder root (to speedup start) - looks for extensions in any jar file and as class files recursively if limit-ext-lookup is 'false'
void	addJarsFolder(File dir)	add all jar files in a folder recursively to classpath
File	findFileOrFolderInExtensionDirs(String fileOrFolder)	search extension directories in the order they were added for a given file or folder return first found or null if none exists
ClassLoader	getClassLoader()	Deprecated. use getPlugInClassLoader() instead
Collection<Configuration>	getConfigurations()
List<File>	getExtensionDirs()	fetch a list of folders holding extension jars that were added during start
PlugInClassLoader	getPlugInClassLoader()	To access extension classes, use this ClassLoader rather than the default ClassLoader.
File	getPlugInDirectory()	Deprecated. use getExtensionDirs()
void	load()
static String	message(Configuration configuration)
static String	name(Configuration configuration)
void	setLimitExtensionLookup(boolean limitExtensionLookup)
static String	version(Configuration configuration)

Methods inherited from class java.lang.Object

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

Constructor Detail

PlugInManager

public PlugInManager(WorkbenchContext context,
                     TaskMonitor monitor)
              throws Exception

Parameters:

plugInDirectory - null to leave unspecified

Throws:

Exception

Method Detail

setLimitExtensionLookup

public void setLimitExtensionLookup(boolean limitExtensionLookup)

addExtensionsFolder

public void addExtensionsFolder(File dir)

add an extensions folder - adds folder root to classpath - adds all contained jars to classpath - looks for extensions in jars only in folder root (to speedup start) - looks for extensions in any jar file and as class files recursively if limit-ext-lookup is 'false'

Parameters:

dir -

addJarsFolder

public void addJarsFolder(File dir)

add all jar files in a folder recursively to classpath

Parameters:

dir -

findFileOrFolderInExtensionDirs

public File findFileOrFolderInExtensionDirs(String fileOrFolder)

search extension directories in the order they were added for a given file or folder return first found or null if none exists

Parameters:

fileOrFolder -

Returns:

file object or null

load

public void load()
          throws Exception

Throws:

Exception

name

public static String name(Configuration configuration)

version

public static String version(Configuration configuration)

message

public static String message(Configuration configuration)

getConfigurations

public Collection<Configuration> getConfigurations()

getClassLoader

public ClassLoader getClassLoader()

Deprecated.

use getPlugInClassLoader() instead

To access extension classes, use this ClassLoader rather than the default ClassLoader. Extension classes will not be present in the latter.

getPlugInClassLoader

public PlugInClassLoader getPlugInClassLoader()

To access extension classes, use this ClassLoader rather than the default ClassLoader. Extension classes will not be present in the latter.

getExtensionDirs

public List<File> getExtensionDirs()

fetch a list of folders holding extension jars that were added during start

getPlugInDirectory

@Deprecated
public File getPlugInDirectory()

Deprecated.

use getExtensionDirs()

get extension folder, cloned to prevent modification

Returns:

possibly null