IntelliJ IDEA 2021.2 Help

Run/Debug Configuration: JSR45 Compatible Server

Use this dialog to create or edit run/debug configurations for JSR45-compatible application servers.

Generally, you may want to use this type of run/debug configuration under the following conditions:

  • The server you are going to work with supports JSR-45.

  • IntelliJ IDEA doesn't provide a dedicated plugin for integration with this server.

Server tab

Item

Local/Remote

Description

Application Server

Both

Select the server configuration to be used.

If the run/debug configuration is intended for working with a remote server, the same server version should be configured locally and associated with the run/debug configuration.

Click Configure to create a new server configuration or edit an existing one. (The Application Servers dialog will open.)

Start browser

Both

Select this checkbox to run the default Web browser to study your application output there.

With JavaScript debugger

Both

If this checkbox is selected, the Web browser is started with the JavaScript debugger enabled.

Debugging of JavaScript code is only supported in Google Chrome and in other Chromium-based browsers.

Startup page

Both

In this field, specify the URL the browser should go to when started. In most typical cases, this URL will correspond to the root of your Web application or its starting page.

VM options

Local

If necessary, specify the command-line options to be passed to the server JVM at the server start.

If you need more room to type, click Icons general expand component next to the field to open the VM Options dialog where the text entry area is larger.

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}

On 'Update' action

Local

Select the action to be performed when the application is updated in the Run or the Debug tool window.

Show dialog

Local

Select this checkbox if you want to see the Update <application name> dialog every time you perform the Update action.

The Update <application name> dialog is used to view and change the current update option (for example, Restart server) prior to actually updating the application.

JSP's package

Both

Specify the Java package prefix to be used for jsp-to-servlet translation.

VM options variable

Local

If there is a variable which stores the command-line JVM options, you can specify the name of this variable in this field. In this way, you can pass the corresponding options to the server JVM at the server start.

Port

Both

Specify the HTTP server port.

Use JSP's line mapping model specific for WebSphere 5.1

Both

If the run/debug configuration is intended for working with WebSphere Server 5.1, select this checkbox to be able to debug your JSPs.

(To be able to debug JSPs, it’s necessary to maintain relationships between the lines of the source files and the corresponding positions in the compiled code. All the servers except WebSphere 5.1 form such relationships similarly.)

Host

Remote

The DNS name or the IP address of the server host (for example, localhost, 127.0.0.1, and so on).

Logs tab

Use this tab to specify which log files generated while running or debugging should be displayed in the console, that is, on the dedicated tabs of the Run or Debug tool window.

Item

Description

Is Active

Select checkboxes in this column to have the log entries displayed in the corresponding tabs in the Run tool window or Debug tool window.

Log File Entry

The read-only fields in this column list the log files to show. The list can contain:

  • Full paths to specific files.

  • Ant patterns that define the range of files to be displayed.

  • Aliases to substitute for full paths or patterns. These aliases are also displayed in the headers of the tabs where the corresponding log files are shown.

    If a log entry pattern defines more than one file, the tab header shows the name of the file instead of the log entry alias.

Skip Content

Select this checkbox to have the previous content of the selected log skipped.

Save console output to file

Select this checkbox to save the console output to the specified location. Type the path manually, or click the browse button and point to the desired location in the dialog that opens.

Show console when a message is printed to standard output stream

Select this checkbox to activate the output console and bring it forward if an associated process writes to Standard.out.

Show console when a message is printed to standard error stream

Select this checkbox to activate the output console and bring it forward if an associated process writes to Standard.err.

the Add button

Click this button to open the Edit Log Files Aliases dialog where you can select a new log entry and specify an alias for it.

the Edit button

Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.

the Delete button

Click this button to remove the selected log entry from the list.

Code Coverage tab

Use this tab to configure code coverage monitoring options.

Note that this tab is not available for remote servers.

Item

Description

Choose code coverage runner

Select the desired code coverage runner.

Sampling

Select this option to measure code coverage with minimal slow-down.

Tracing

Select this option to collect accurate branch coverage. This mode is available for the IntelliJ IDEA code coverage runner only.

Track per test coverage

Select this checkbox to detect lines covered by one test and all tests covering line.

Packages and classes to record code coverage data

If necessary, specify the classes and packages to be measured.

Use the Add Class button or the Add Package button to add classes or packages to the list.

To remove the classes or packages from the list, select the corresponding list items and click the Remove button.

Enable coverage in test folders.

Select this checkbox to include the test source folders in code coverage analysis.

Startup/Connection tab

Item

Local/Remote

Description

Icons toolwindows tool window run Run

Icons actions start debugger Debug

Both

Select Run or Debug to show settings either for the run or the debug mode.

Icons general run with coverage  Run with Coverage

Local

Select Run with Coverage to show settings for run with coverage mode.

Startup script

Local

Specify the script to be used to start the server. If necessary, you can also specify the script parameters and the options to be passed to the server JVM.

You can provide all the necessary information right in the field, by typing. As an alternative:

  • To specify the script, click the Browse button and select the desired script in the dialog that opens.

  • To specify the parameters, click Icons general expand component and specify the script parameters and VM options in the Configure VM and Program Parameters dialog.

    When specifying the parameters and options, follow these rules:

    • Use spaces to separate individual parameters and options, for example, -client -ea -Xmx1024m.

    • If a parameter or an option includes spaces, enclose the spaces or the argument that contains the spaces in double quotes, for example, some" "arg or "some arg".

    • If a parameter or an option includes double quotes (e.g. as part of the argument), escape the double quotes by means of the backslashes, for example, -Dmy.prop=\"quoted_value\".

Shutdown script

Local

Specify the script to be used to stop the server. If necessary, you can also specify the script parameters and the options to be passed to the server JVM.

You can provide all the necessary information right in the field, by typing. As an alternative:

  • To specify the script, click the Browse button and select the desired script in the dialog that opens.

  • To specify the parameters, click Icons general expand component and specify the script parameters and VM options in the Configure VM and Program Parameters dialog.

    When specifying the parameters and options, follow these rules:

    • Use spaces to separate individual parameters and options, for example, -client -ea -Xmx1024m.

    • If a parameter or an option includes spaces, enclose the spaces or the argument that contains the spaces in double quotes, for example, some" "arg or "some arg".

    • If a parameter or an option includes double quotes (e.g. as part of the argument), escape the double quotes by means of the backslashes, for example, -Dmy.prop=\"quoted_value\".

Pass environment variables

Local

To pass specific variables to the server environment, select this checkbox and specify the variables:

  • To add a variable, click Icons general add and specify the variable name and value in the Name and Value fields respectively.

  • To remove a variable from the list, select the variable and click Icons general remove.

Port

Local

Use this field to change the debugger port (if necessary).

Debugger Settings

Local

Click this button to edit the debugger options on the Debugger page of the Settings dialog.

Transport

Remote

Specify the "transport" settings for the connection with the debugger. In technical terms, these are the parameters for the -Xrunjdwp command-line option:

  • Socket. Specify the debugger port in the Port field. The combination of these two settings translates into

    -Xrunjdwp:transport=dt_socket,address=<port>,suspend=n,server=y
  • Shared memory. Specify the shared memory address in the corresponding field. The combination of these two settings translates into

    -Xrunjdwp:transport=dt_shmem,address=<address>,suspend=n,server=y

Note that as you change the transport settings, what follows transport= within -Xrunjdwp in the area above also changes. In this way you control the corresponding command-line debugger parameters which you cannot edit directly.

Common settings

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

Item

Description

Name

Specify a name for the run/debug configuration to quickly identify it when editing or running the configuration, for example, from the Run popup Alt+Shift+F10.

Allow parallel run

Select to allow running multiple instances of this run configuration in parallel.

By default, it is disabled, and when you start this configuration while another instance is still running, IntelliJ IDEA suggests to stop the running instance and start another one. This is helpful when a run/debug configuration consumes a lot of resources and there is no good reason to run multiple instances.

Store as project file

Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project.

By default, it is disabled, and IntelliJ IDEA stores run configuration settings in .idea/workspace.xml.

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.

Item

Shortcut

Description

the Add button

Alt+Insert

Create a run/debug configuration.

the Remove button

Alt+Delete

Delete the selected run/debug configuration. Note that you cannot delete default configurations.

Copy

Ctrl+D

Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.

Save configuration

The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.

Move into new folder / Create new folder

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 the 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 or Move Up and Move Down buttons.

To remove grouping, select a folder and click Remove Configuration.

Sort configurations

Click this button to sort configurations in the alphabetical order.

Before launch

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

Item

Shortcut

Description

the Add button

Alt+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 External 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.

  • Launch Web Browser: select this option to have a browser started. In the dialog that opens, select the type of the browser and provide the start URL. Also, specify if you want the browser be launched with JavaScript debugger.

  • 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 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 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 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 the Browse button, and select the desired task from the list of available tasks.

    Note that code completion is available here.

    Code completion for the Rake tasks

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

the Remove button

Alt+Delete

Click this icon to remove the selected task from the list.

Edit

Enter

Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.

Method up/Method down

Alt+Up/Alt+Down

Click 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 page

Select this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.

Activate tool window

By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration.

Otherwise, if the checkbox is cleared, the tool window is hidden. 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: 02 August 2022