Ultimate

Run/Debug Configuration: Spring Boot

VM options

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

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

• If an option includes spaces, enclose the spaces or the argument itself 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:

  -Dfoo=${MY_ENV_VAR}

Program arguments

Specify arguments to be passed to the program in the format that you use in the command line. Use the same rules as for specifying the VM options.

Working directory

If necessary, specify a directory that will be used by the running application. This directory is the starting point for all relative input and output paths. The project directory is specified by default.

Environment variables

Click Browse to create variables and specify their values.

Use classpath of module

Select the module whose classpath will be used to run the application.

Add dependencies with “provided” scope to classpath

Enable this option to add dependencies with the Provided scope to the runtime classpath.

JRE

By default, the newest JDK from the module dependencies is used to run applications. You can specify an alternative JDK or JRE.

Shorten command line

Select a method that will be used to shorten the command line if the classpath gets too long or you have many VM arguments that exceed your OS command line length limitation:

• none: IntelliJ IDEA will not shorten a long classpath. If the command line exceeds the OS limitation, IntelliJ IDEA will be unable to run your application and will display a message suggesting you to specify the shortening method.

• JAR manifest: IntelliJ IDEA will pass a long classpath via a temporary classpath.jar. The original classpath is defined in the manifest file as a class-path attribute in classpath.jar. Note that you will be able to preview the full command line if it was shortened using this method, not just the classpath of the temporary classpath.jar.

• classpath.file: IntelliJ IDEA will write a long classpath into a text file.

Enable debug output

Enables logging of the debug output by adding the -Ddebug VM option.

Hide banner

Hides the Spring Boot startup banner by adding the -Dspring.main.banner-mode=OFF VM option (for Spring Boot 1.4.x and earlier, the option is -Dspring.main.banner=false).

Enable launch optimization

Select this option to speed up application launch. The -XX:TieredStopAtLevel=1 and -noverify VM options will be added.

Enable JMX agent

tip

Using the Enable JMX agent option might slow down the application startup.

Enables JMX agent that shows application endpoints data by adding the following VM options (requires Spring Boot 1.3.0 or later):

• -Dcom.sun.management.jmxremote

• -Dspring.jmx.enabled=true

• -DSpring.liveBeansView.mbeanDomain

• -Dspring.application.admin.enabled=true

note

The Spring Boot endpoints feature is not available by default for Windows users with the FAT file system. To enable it, add -XX:+PerfBypassFileSystemCheck to VM options, and make sure that %TMP%\hsperfdata_username has permissions for full folder access.

IntelliJ IDEA uses local JMX connector for retrieving Spring Boot actuator endpoint's data. However, it is impossible to get local JMX connector address if Spring Boot application and IntelliJ IDEA JVMs have different bitness and you are using OpenJ9 JDK. In this case, add the following lines to VM options:

• -Dcom.sun.management.jmxremote.port={some_port}

• -Dcom.sun.management.jmxremote.authenticate=false

• -Dcom.sun.management.jmxremote.ssl=false

note

As mentioned in the official Oracle documentation, this configuration is insecure. Any remote user who knows (or guesses) your port number and host name will be able to monitor and control your Java applications and platform.

On 'Update' action

Specify an action that the IDE will do after you click Update <application name> Application:

• Update resources — compile all modified and dependent resource files.

• Update classes and resources — compile all modified and dependent files.

• Update trigger file — update the trigger file. Set up the trigger filename by adding the -Dspring VM option.

• Hot swap classes and update trigger file if failed — (available only in the debug mode) compile all modified and dependent files, hot swap classes, update the trigger file if the hot swap failed. Specify the trigger filename by adding the -Dspring.devtools.restart.trigger-file=.restartTriggerFile VM option.

On frame deactivation

Specify an action that the IDE will do after you switch to another application (other than IntelliJ IDEA):

• Update resources — compile all modified and dependent resource files.

• Update classes and resources — compile all modified and dependent files.

Active profiles

Specify active Spring profiles that you want to use in this run/debug configuration.

Override parameters

Use this table to specify Spring Boot configuration parameters that you want to override. Such parameters are normally defined in configuration files. Listing them in a run/debug configuration allows you to easily switch parameters by modifying the run/debug configuration instead of config files, or have multiple run/debug configurations with different parameter values.