Run/Debug Configuration: OSGi Bundles

Use this dialog box to set up options for running and debugging applications that use OSGi Bundles.

The dialog box consists of the following tabs:

Framework & Bundles
Parameters
Additional Framework Properties

Click here for the description of the options that are common for all run/debug configurations.

Framework & Bundles Tab

In this tab, select a framework that you need, compose a list of bundles to be installed, specify whether each bundle should be started upon installation, and define the order in which you want the bundles to be started.

Item	Description
OSGi Framework	From a drop-down list choose your framework.
Framework Start Level	Use this field to define a state of the execution in which a framework exists. You can modify the start level of the framework. This start level is used for managing the order of OSGi bundles' execution. If the bundle has a start level grater than the one for the framework, then it will be executed first.
Default Start Level	This field shows the default start level of bundles. In this case, the bundles are added after the framework's execution has started. You can modify the default start level for bundles.
Bundles Name	This read-only field shows the names of the OSGi bundles to be installed.
Start Level	In this text box, specify the default start level for newly installed bundles and thus determine the start order of bundles. The default value is 1. An OSGi system has a current level (called the active start level). If a bundle has a start level higher than the active start level it will not start when the OSGi system starts. The bundle will start as soon as the active start level reaches or exceeds the start level of the bundle. Accordingly, if the active start level becomes below the level of a bundle, the bundle will be shutdown.
Start After Install	Select this checkbox to have the selected bundle after installation.
Add	Click this button to open the Select Bundles dialog box, which displays all the currently available bundles. If the list is large, start typing the bundle name Search field - the contents of the list change as you type and show only the matching entries.
Remove	Click this button to delete the selected bundle from the list.

Parameters Tab

In these tab, customize the framework run or debug procedure by specifying additional parameters.

Item	Description
VM Options	In this text box, specify the string to be passed to the Virtual Machine for launching the bundles. If the string is too long and does not fit in the text box, click and type the desired string in the VM Options dialog. When specifying JVM options, follow these rules: Use spaces to separate individual options, for example, `-client -ea -Xmx1024m`. If an option includes spaces, enclose the spaces or the argument that contains spaces in double quotes, for example, `some" "arg` or `"some arg"`. If an option includes double quotes (as part of the argument), escape the double quotes using backslashes, for example, `-Dmy.prop=\"quoted_value\"`. You can pass environment variable values to custom Java properties. For example, if you define a variable `MY_ENV_VAR`, you can pass it to the `foo` property as follows: `-Dfoo=${MY_ENV_VAR}` The `-classpath` option specified in this field overrides the classpath of the module.
Program Parameters	In this text box, type a list of arguments to be passed to the program in the format you would use in the command line. If the string is too long and does not fit in the text box, click the button and type the desired arguments in the Program Parameters dialog box. Use the same rules as for specifying the VM options.
JRE	By default, the project JDK is used to run the bundles. If you want to specify an alternative JDK or JRE here, select it from the drop-down list.
Runtime Directory	Use this area to specify the runtime path of the framework. You can select from the following options: Recreate each time - select this option if you want to have all previous information deleted from the directory before the execution of the framework. Use this directory - use this field to specify the directory that the framework will use each time it executes. The execution time is faster. However, the directory might contain the unnecessary information such as artifacts from previous runs. Type the path to the desired folder manually or click Browse and choose the folder in the dialog that opens.
Include All Bundles in Class Path	Select this checkbox to have all the selected bundles included in the classpath.

Additional Framework Properties

Item	Description
Debug Mode	Select this checkbox to enable debugging.
System Packages	In this text box, specify the system packages to be exposed inside the OSGi framework. Type the names of the packages using commas as separators. Wildcards are welcome.
Boot Delegation	In this text box, specify `java` packages for which the framework must delegate class loading to the boot class path. Type the names of the packages using commas as separators. Wildcards are welcome.
Start OSGi Console	Select this checkbox to run a prompt for the specified framework. For example, for the Equinox framework it is `osgi>`.
Run	Use this area to indicate what target you need to run. You can select from the following options: Just the bundles - select this option if you need to run just the bundles. Product - select this option if you need to run the product. Application - select this option if you need to run the application.

Toolbar

Item	Shortcut	Description
	`Alt+Insert`	Click this button to add a new configuration to the list.
	`Alt+Delete`	Click this button to remove the selected configuration from the list.
	`Ctrl+D`	Click this button to create a copy of the selected configuration.
	Edit defaults	Click this button to edit the default configuration templates. The defaults are used for newly created configurations.
or	`Alt+Up` or `Alt+Down`	Use these buttons to move the selected configuration or folder up and down in the list. The order of configurations or folders in the list defines the order in which configurations appear in the Run/Debug drop-down list on the main toolbar.
	Move into new folder / Create new folder	Use this button to create a new folder. If one or more run/debug configurations are in focus, the selected run/debug configurations are automatically moved to the newly created folder. If only a category is in focus, an empty folder is created. Move run/debug configurations to a folder using drag-and-drop, or the buttons.
	Sort configurations	Click this button to sort configurations in alphabetical order.

Common options

Item Description

Name In this text box, specify the name of the current run/debug configuration. This field does not appear for the default run/debug configurations.

Defaults This node in the left-hand pane of the dialog box contains the default run/debug configuration settings. Select the desired configuration to change its default settings in the right-hand pane. The defaults are applied to all newly created run/debug configurations.

Select this check box to make the run/debug configuration available to other team members.

If the directory-based project format is used, the settings for a run/debug configuration are stored in a separate .xml file in the .idea\runConfigurations folder if the run/debug configuration is shared, or in the .idea\workspace.xml file otherwise.

If the file-based format is used, the settings are stored in the .ipr file for shared configurations, or in the .iws file otherwise.

This check box is not available when editing the run/debug configuration defaults.

Single instance only

If this check box is selected, this run/debug configuration cannot be launched more than once.

Every time a new run/debug configuration is launched, IntelliJ IDEA checks the presence of the other instances of the same run/debug configuration, and displays a confirmation dialog box. If you click OK in the confirmation dialog box, the first instance of the runner will be stopped, and the next one will take its place.

This makes sense when the usage of certain resources can cause conflicts, or when launching two run/debug configurations of the same type consumes too much of the CPU and memory resources.

If this check box is not selected, it is possible to launch as many instances of the runner as required. So doing, each runner will start in its own tab of the Run tool window.

Before launch

Specify which tasks must be performed before applying the run/debug configuration. The specified tasks are performed in the order they appear in the list.

Item	Keyboard shortcut	Description
	`Alt+Insert`	Click this icon to add a task to the list. Select the task to be added: Run External tool. Select this option to run an application which is external to IntelliJ IDEA. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in IntelliJ IDEA yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools. Make Select this option to have the project or module compiled. The Make Module command will be carried out if a particular module is specified in the run/debug configuration, and the Make Project command otherwise. If an error occurs during the compilation, IntelliJ IDEA won't attempt to start the run/debug configuration. Make, no error check. The same as the Make option but IntelliJ IDEA will try to start the run/debug configuration irrespective of the compilation result. Build Artifacts. Select this option to have an artifact or artifacts built. In the dialog that opens, select the artifact or artifacts that should be built. See also Working with Artifacts. Run Another Configuration. Select this option to have another run/debug configuration executed. In the dialog that opens, select the configuration to run. This option is available only if you have already at least one run/debug configuration in the current project. Run Ant target. Select this option to have an Ant target run. In the dialog that opens, select the target to be run. For more information, see Ant. Run Grunt task. Select this option to run a Grunt task. In the Grunt task dialog box that opens, specify the `Gruntfile.js` where the required task is defined, select the task to execute, and specify the arguments to pass to the Grunt tool. Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the `grunt-cli` package. Run Gulp task. Select this option to run a Grunt task. In the Gulp task dialog box that opens, specify the `Gulpfile.js` where the required task is defined, select the task to execute, and specify the arguments to pass to the Gulp tool. Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the `gulp` package. Run npm Script. Select this option to execute an npm script. In the NPM Script dialog box that opens, specify the npm run/debug configuration settings. Compile TypeScript. Select this option to run the built-in TypeScript compiler and thus make sure that all the changes you made to your TypeScript code are reflected in the generated JavaScript files. In the TypeScript Compile Settings dialog that opens, select or clear the Check errors checkbox to configure the behaviour of the compiler in case any errors are detected: If the Check errors checkbox is selected, the compiler will show all the errors and the run configuration will not start. If the Check errors checkbox is cleared, the compiler will show all the detected errors but the run configuration still will be launched. Generate CoffeeScript Source Maps. Select this option to have the source maps for your CoffeeScript sources generated. In the dialog that opens, specify where your CoffeeScript source files are located. Run Maven Goal. Select this option to have a a href="Maven_Support.xml">Maven goal runRun/Debug Configuration: OSGi Bundles. In the dialog that opens, select the goal to be run. Run Remote External tool: Add a remote SSH external tool. Refer to the section Remote SSH External Tools for details. Run Rake task:Add a Rake task to be executed prior to running or debugging. To choose a Rake task, click the browse button , and select the desired task from the list of available tasks. Note that code completion is available here. To learn more about Rake support, refer to Rake Support section. Run JRuby compiler: choose this option to execute JRuby compiler with the specified target path, compiler process heap size, and command line parameters (if any).
	`Alt+Delete`	Click this icon to remove the selected task from the list.
	`Enter`	Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
	`Alt+Up`	Click this icon to move the selected task one line up in the list.
	`Alt+Down`	Click this icon to move the selected task one line down in the list.
Show this page		Select this check box to have the run/debug configuration settings shown prior to actually starting the run/debug configuration.
Activate tool window		Select this option if you want the Run/Debug tool windows to be activated automatically when you run/debug your application. This option is enabled by default.

Last modified: 24 July 2018

Reference:

OSGi

IntelliJ IDEA 2018.1 Help