Options
Bellow you can find a set of options that allow you to control runner behavior.
| Option key |
Description |
Default |
| args |
URL of a text file that contains startup options on each line. If extra options / arguments are present in the command line beside the --args option then the command line options will have precedence. By default (if the argument is not specified) Pax Runner will use (if available) a file named runner.args from the current directory. |
runner.args |
| noArgs |
If specified no arguments file will be searched or used. In this case the arguments considered are just those from the command line. |
—
Starting with 0.16.0 |
| bcp/p |
since 0.15.0; specify an url of a library to be part of boot (system) class path; the library will be prepended to framework jar |
see details |
| bcp/a |
since 0.15.0; specify an url of a library to be part of boot (system) class path; the library will be appended to framework jar |
see details |
| bootDelegation|bd |
since 0.8.0; see org.ops4j.pax.runner.platform.bootDelegation |
see option |
| bundleStartLevel|bsl |
see org.ops4j.pax.runner.platform.bundleStartLevel |
see option |
| certificateCheck|noCertificateCheck |
see org.ops4j.pax.runner.handler.mvn.certicateCheck |
see option |
| clean|noClean |
see org.ops4j.pax.runner.platform.clean |
see option |
| classpath|cp |
see org.ops4j.pax.runner.platform.classpath |
see option |
| console|noConsole |
see org.ops4j.pax.runner.platform.console |
see option |
| config |
an url to a configuration file |
classpath:META-INF/runner.properties |
| debugClassLoading|noDebugClassLoading |
see org.ops4j.pax.runner.platform.debugClassLoading (supported on Equinox only) |
false |
| definitionURL |
see org.ops4j.pax.runner.platform.definitionURL |
see option |
| downloadFeedback|noDownloadFeedback |
see org.ops4j.pax.runner.platform.downloadFeedback |
true |
| ee |
see org.ops4j.pax.runner.platform.ee |
see option |
| frameworkProfile|fp |
see org.ops4j.pax.runner.platform.frameworkProfile |
see option |
| handlers |
comma separated list of handlers (mvn, classpath,...) |
mvn |
| javaHome|home |
see org.ops4j.pax.runner.platform.javaHome |
see option |
| localRepository|lr |
see org.ops4j.pax.runner.handler.mvn.localRepository |
see option |
| log |
the logging level to be used by runner (NONE,FATAL,ERROR,WARNING,INFO,DEBUG,TRACE) |
INFO |
| obrRepositories|obrRepos |
list of OBR repositories to use. This is an alias for obr.repository.url. |
see option |
| overwrite|noOverwrite |
see org.ops4j.pax.runner.platform.overwrite |
see option |
| overwriteUserBundles |
see org.ops4j.pax.runner.platform.overwriteUserBundles |
see option |
| overwriteSystemBundles |
see org.ops4j.pax.runner.platform.overwriteSystemBundles |
see option |
| platform|p |
the platform to be started (equinox/e/eq, felix/f, knopflerfish/k/kf, concierge/c |
felix |
| profiles |
see org.ops4j.pax.runner.platform.profiles |
see option |
| profileStartLevel|psl |
see org.ops4j.pax.runner.platform.profileStartLevel |
see option |
| repositories|repos |
see org.ops4j.pax.runner.handler.mvn.repositories |
see option |
| scanners |
comma separated list of scanners (file, pom,...) |
file |
| settings |
see org.ops4j.pax.runner.handler.mvn.settings |
see option |
| start|noStart |
see org.ops4j.pax.runner.scanner.file.start
see org.ops4j.pax.runner.scanner.dir.start
see org.ops4j.pax.runner.scanner.bundle.start |
see file option
see dir option
see bundle option |
| startLevel|sl |
see org.ops4j.pax.runner.platform.startLevel |
see option |
| systemPackages|sp |
see org.ops4j.pax.runner.platform.systemPackages |
see option |
| usePersistedState|ups |
see org.ops4j.pax.runner.platform.usePersistedState |
see option |
| vmOptions|vmo |
see org.ops4j.pax.runner.platform.vmOptions |
see option |
| version|v |
version of the platform to be started. See platforms for details about supported versions |
1.2.2 (felix) |
| workingDirectory|dir |
see org.ops4j.pax.runner.platform.workingDirectory |
see option |
Beside this options, from which some are just a shortcut (mentioned in the description) to options you could find in handlers, scanners and platforms, any option from the just mentioned modules of runner could be used.
Specify boot classpath libraries
By default the only library available in the boot classpath is the framework jar. If your usage require that additional jar files should be available in the boot (system) classpath, Pax Runner can manage thse availability of this bundles via the --bcp options. This means that you can specify one or more jar files (as URL) in the command line and Pax Runner will download them into the local cache (under the same conditions as for any other provisioned bundles) and it will setup the java boot classpath option prior launching the framework runtime.
The value of --bcp/p or --bcp/a option should be a valid url of the required library. The url can be any of the "standard" supported urls or the additional ones supported by Pax Runner such as mvn:, wrap:, obr:, ...
In order to control the order of the classpath (ordr of jar files), one can use the /p or /a option flavor. By using --bcp/p the jar will be setup before the framework jar, when using --bcp/a, the jar will setup after the framework jar. This options can be specified as many times as needed. In case of more then one --bcp option is specified, the jars will be ordered in the order of declaration.
The following is an virtual example: Lets say that we need to have in the boot classpath 3 jars, a.jar, b.jar and c.jar. where the a and b jars should prepend the framework jar and c should follow it.
pax-run --bcp/p=mvn:foo/a/1.0 --bcp/p=mvn/foo/b --bcp/a=file:/lib/c.jar
This will make Pax Runner download the jars in the cache and setup a boot classpath as a.jar:b.jar:<framework jar>:c.jar.
Note, that by adding extra libraries to boot classpath, the options bootDelegation and systemPackages can now be set to delegate and/or export packages from this additional libraries.
