IntelliJ IDEA 2018.2 Help

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 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.

ItemDescription
OSGi FrameworkFrom a drop-down list choose your framework.
Framework Start LevelUse 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 LevelThis 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 NameThis 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.
Start After InstallSelect 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.
RemoveClick 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.

ItemDescription
VM OptionsIn 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 icons general expandComponent svg 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}
Program ParametersIn 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 icons general expandComponent svg button and type the desired arguments in the Program Parameters dialog box.

Use the same rules as for specifying the VM options.

JREBy 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 DirectoryUse 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 browseButton.png and choose the folder in the dialog that opens.
Include All Bundles in Class PathSelect this checkbox to have all the selected bundles included in the classpath.

Additional Framework Properties

ItemDescription
Debug ModeSelect 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>.
RunUse 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.

Common options

When you edit a run configuration (but not a run configuration template), you can specify the following options for it:

ItemDescription
Name In this text box, specify the name for the run/debug configuration. The name will help you identify the created configuration when you choose to edit it later, or when you invoke it, for example. from the Run popup (Shift+Alt+F10).
Share 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.

Toolbar

The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.

ItemShortcutDescription
icons general add svgAlt+InsertCreate a run/debug configuration.
icons general remove svgAlt+Delete Delete the selected run/debug configuration. Note that you cannot delete default configurations.
icons actions copy svg Ctrl+D Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.
icons general settings svg Edit Templates View and edit the default template for the selected run/debug configuration. The templates are used for newly created configurations.
icons actions moveUp svg/icons actions moveDown svgAlt+Up/Alt+Down

Move the selected run/debug configuration up and down in the list.

The order of configurations in the list defines the order, in which the configurations appear when you choose a run/debug configuration.

Default templates of run/debug configurations are always sorted alphabetically.

icons actions newFolder svg Move into new folder / Create new folder

You can group run/debug configurations by placing them into folders.

To create a folder, select the configurations within a category, click folder, and specify folder name. If only a category is in focus, an empty folder is created.

Then, to move a configuration into a folder, between the folders or out of a folder, use drag-and-drop or icons actions moveUp svg and icons actions moveDown svg buttons.

To remove grouping, select a folder and click icons general remove svg.

icons objectBrowser sorted svg Sort configurations Click this button to sort configurations in the alphabetical order.

Templates

Under the Templates node in the tree view of run configurations, you can select a run configuration template and edit its default settings. This will not affect the configurations that are already created, but will be used as defaults when creating new configurations of the corresponding type.

When you select the Templates node itself, you will be able to adjust general settings that apply to all run/debug configurations:

ItemDescription
Configurations available in Run Dashboard

In this section you can create a list of run configurations available in the Run Dashboard — a tool window that helps you execute and manage multiple run/debug configurations.

Note that the dashboard will only display the configuration types for which you have created one ore more configurations.
Thus, if you add a configuration type for which no configurations exist in the project, this type will not be displayed on the dashboard until you create a configuration of this type.

Confirm rerun with process terminationThe behavior of this checkbox depends on whether the Single instance only option is selected for a particular run/debug configuration.
  • If this checkbox is selected, in case of a single instance, launching a new process (for example, by clicking icons toolwindows toolWindowRun on the main toolbar) while another process is still running, results in showing a dialog box prompting to terminate the current process before launching a new one.
  • If this checkbox is not selected (or in case of multiple instances), IntelliJ IDEA starts the new process silently.
Temporary configurations limit Specify the maximum number of temporary configurations to be stored and shown in the Select Run/Debug Configuration drop-down list.

Before Launch options

In this area you can specify tasks that must be be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.

ItemShortcutDescription
icons general add svgAlt+Insert Click this icon to add one of the following available tasks:
  • Run External tool: select to run an external application. In the dialog that opens, select one or multiple applications you want to run. If it is not defined in IntelliJ IDEA yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
  • Run Another Configuration: select to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.
  • Build: select to compile the specified module. The Build Module command will be executed.

    If an error occurs during compilation, IntelliJ IDEA won't attempt to start the run/debug configuration.

  • Build Project: select to compile the entire project. The Build Project command will be executed.

    If an error occurs during compilation, IntelliJ IDEA won't attempt to start the run/debug configuration.

  • Build, no error check: the same as the Build option, but IntelliJ IDEA will try to start the run/debug configuration irrespective of the compilation results.
  • Build Artifacts: select this option to build an artifact or artifacts. In the dialog that opens, select the artifact or artifacts that should be built.
  • Run Ant target: select this option to run an Ant target. In the dialog that opens, select the target to be run.
  • 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 Gulp 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 Maven Goal: select this option to run a Maven goal. In the dialog that opens, select the goal to be run.
  • 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 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 generate the source maps for your CoffeeScript sources. In the dialog that opens, specify where your CoffeeScript source files are located.
  • Run Remote External tool: adds a remote SSH external tool.
  • Run Rake task: add a Rake task to be executed prior to running or debugging. To choose a Rake task, click the browse button browseButton, and select the desired task from the list of available tasks.

    Note that code completion is available here.

    runConfigRakeTask
  • 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).
icons general remove svgAlt+Delete Click this icon to remove the selected task from the list.
icons actions edit svg Enter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
icons actions moveUp svg/icons actions moveDown svgAlt+Up/Alt+DownClick these icons to move the selected task one line up or down in the list. (The tasks are performed in the order that they appear in the list.)
Show this pageSelect this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.
Activate tool window

If this checkbox is selected, which it is by default, the Run or the Debug tool window opens when you start the run/debug configuration.

Otherwise, the tool window isn't shown. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5.

Last modified: 4 September 2018

See Also

Reference: