JPF Configuration Reference

This page collects in single place all available configuration options for various parts of JPF. Parameters are grouped by corresponding classes that introduce and support them.

Note that configuration parameters will be loaded using specially extended version of Properties class, which supports parameters substitution.

Core JPF Library

org.java.plugin.ObjectFactory

org.java.plugin.ObjectFactory

Object factory implementation to use.

org.java.plugin.standard.StandardObjectFactory

org.java.plugin.registry.PluginRegistry

Plug-in registry implementation to use.

org.java.plugin.PathResolver

Path resolver implementation to use.

org.java.plugin.standard.PluginLifecycleHandler

Plug-in lifecycle handler implementation to use.

All implementation classes specific configuration parameter names should be prefixed with corresponding classes name and separating dot (.) character.

org.java.plugin.registry.xml.PluginRegistryImpl

isValidating

Regulates is registry should use validating parser when loading plug-in manifests. The default parameter value is true.

stopOnError

Regulates is registry should stop and throw RuntimeException if an error occurred while registering or un-registering plug-ins. If this is false, the registration errors will be stored in the internal report that is available with PluginRegistry.checkIntegrity(PathResolver) method. The default parameter value is false.

org.java.plugin.standard.ShadingPathResolver

shadowFolder

Path to the folder where to copy resources to prevent their locking. By default this will be System.getProperty("java.io.tmpdir") + "/.jpf-shadow". Please note that this folder will be maintained automatically by the Framework and might be cleared without any confirmation or notification. So it is strongly not recommended to use plug-ins folder (or other sensitive application directory) as shadow folder, this may lead to losing your data.

unpackMode

If always, "JAR'ed" or "ZIP'ed" plug-ins will be un-compressed to the shadow folder, if never, they will be just copied, if smart, the processing depends on plug-in content - if plug-in contains JAR libraries, it will be un-packed, otherwise just copied to shadow folder. It is also possible to add boolean "unpack" attribute to plug-in manifest, in this case, it's value will be taken into account. The default parameter value is smart.

excludes

Pipe '|' separated list of regular expression patterns to be used to exclude files to be shadowed. By default no files excluded.

includes

Pipe '|' separated list of regular expression patterns to be used to include files to be shadowed. By default all files included.

org.java.plugin.standard.StandardPluginLifecycleHandler

probeParentLoaderLast

If true, plug-in classloader will try loading classes from system (boot) classpath after trying to load them from plug-in classpath. Otherwise system classpath will be used first. Default value is false that corresponds to standard delegation model for classloaders hierarchy.

stickySynchronizing

Allows advanced configuring of classloaders synchronization in multy-threaded environment. If true then class loading will be synchronized with initial plug-in classloader instance. Otherwise this instance will be used as synchronizing monitor. Default value is false.

localClassLoadingOptimization

If true then plug-in classloader will collect local packages statistics to predict class location. This allow to optimize class look-up procedure for classes that belong to the requested plug-in. Default value is true.

foreignClassLoadingOptimization

If true then plug-in classloader will collect statistics for "foreign" classes - those which belong to depending plug-ins. This allow to optimize class look-up procedure when enumerating depending plug-ins. Default value is true.

JPF Boot Library

Note that JPF Boot library loads all System properties as default values that together with ability of extended properties class to expand parameters substitution allows you to create extremely flexible configurations.

org.java.plugin.boot.Boot

jpf.boot.mode

Application boot mode. Always available as System property also. Default value is shell.

org.java.plugin.boot.appInitializer

Application initializer class, for details see org.java.plugin.boot.ApplicationInitializer. Default is org.java.plugin.boot.DefaultApplicationInitializer.

org.java.plugin.boot.errorHandler

Error handler class, for details see org.java.plugin.boot.BootErrorHandler. Default is org.java.plugin.boot.BootErrorHandlerConsole for "service" style applications and org.java.plugin.boot.BootErrorHandlerGui for "interactive" applications.

org.java.plugin.boot.controlHost

Host to be used by background control service, no default values.

org.java.plugin.boot.controlPort

Port number to be used by background control service, no default values.

org.java.plugin.boot.splashHandler

Splash screen handler class, for details see org.java.plugin.boot.SplashHandler. Default is simple splash handler that can only display an image.

org.java.plugin.boot.splashImage

Path to an image file to be shown as splash screen. If no file and no handler given, the splash screen will not be shown.

org.java.plugin.boot.splashLeaveVisible

If set to true, the org.java.plugin.boot.Boot class will not hide splash screen at the end of boot procedure but delegate this function to application code. Default value is false.

org.java.plugin.boot.splashDisposeOnHide

If set to false, the org.java.plugin.boot.Boot class will not dispose splash screen handler when hiding it. This allows you to reuse handler and show splash screen back after it was hidden. Default value is true.

All parameters with prefix org.java.plugin.boot.splash. will be passed to splash screen handler as configuration data (prefix will be removed from parameter names).

org.java.plugin.boot.DefaultApplicationInitializer

org.java.plugin.boot.applicationPlugin

ID of plug-in to start. There is no default value for this parameter. In common scenario, this is the only parameter that you must provide.

org.java.plugin.boot.integrityCheckMode

Regulates how to check plug-ins integrity when running JPF. Possible values: full, light, off. The default value is full.

org.java.plugin.boot.pluginsCollector

Plug-ins location collector class, for details see org.java.plugin.boot.PluginsCollector. Default is org.java.plugin.boot.DefaultPluginsCollector.

org.java.plugin.boot.pluginsWhiteList

Location of the file with plug-in identifiers that should be only accepted by this application initializer. This is optional parameter.

org.java.plugin.boot.pluginsBlackList

Location of the file with plug-in identifiers that should not be accepted by this application initializer. This is optional parameter.

org.java.plugin.boot.DefaultPluginsCollector

org.java.plugin.boot.pluginsRepositories

Comma separated list of local plug-in repositories, given folders will be scanned for plug-ins. Default value is ./plugins.

org.java.plugin.boot.pluginsLocationsDescriptors

Comma separated list of URLs for XML syntax files that describe available plug-in locations (for details see file class javadoc). No default value provided.