IntelliJ IDEA 2019.1 Help

Run/Debug Configuration: Spring DM Server (Remote)

Run | Edit Configurations | icons general add svg | Spring dmServer | Local or Remote

Spring dmServer run/debug configurations let you deploy and debug your applications on SpringSource dm Server and Virgo. (The dmServer Support plugin must be enabled.)

Note that if you are starting the server by means of the default script startup.bat or startup.sh, you should properly set the environment variable JAVA_HOME.

See also, Working with Server Run/Debug Configurations.

Server tab for a remote configuration

Item

Description

Application server

 Select the server configuration to be used. Note that this is a local server configuration. (When working with a remote server, the same server version must be available locally.)

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

After launch

 Select this checkbox to start a web browser after connecting to the server and deploying the artifacts.

Select the browser from the list. Click browseButton (Shift+Enter) to configure your web browsers.

With JavaScript debugger

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

Note that JavaScript debugging is available only for Firefox and Google Chrome. When you debug your JavaScript in Firefox for the first time, the JetBrains Firefox extension is installed.

The field underneath After launch

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

On 'Update' action

 Select the necessary option for the Update application function (update icon or N/A in the Run or Debug tool window).

The options are:

  • Hot swap classes. Changed classes are recompiled and reloaded at runtime. This option works only in the debug mode.

  • Redeploy. The application artifact is rebuilt and redeployed.

Show dialog

 Select this checkbox if you want to see the Update dialog every time you use the Update application function.

The Update dialog is used to select the Update option prior to actually updating the application.

On frame deactivation

 Specify what IntelliJ IDEA should do when you switch from the IDE to a different application (for example, a web browser). (Frame deactivation means switching to a different application.)

The options other than Do nothing have the same meanings as in the case of the Update action.

JMX Port

Specify the JMX server port.

Ping

Click this button to ping the JMX port on the server.

JMX User

Specify the name of the user on whose behalf IntelliJ IDEA will connect to the JMX server port.

JMX Password

Specify the password of the JMX user.

Remote staging

This section contains the settings related to staging. An example of remote staging settings for a mounted folder is provided after this table.

Type

 Select the way the staging environment or host is accessed for transferring the application artifact or artifacts from your local computer. (In the user interface of IntelliJ IDEA this setting is also referred to as the connection type.)

The available options are:

  • Same file system. Select this option if the target server is installed on your local computer. The artifacts in this case are deployed locally and, thus, don't need to be transferred to a remote host.

  • ftp. The File Transfer Protocol or Secure FTP is used.

  • Local or mounted folder. The staging environment is a local folder or is accessed as a mounted folder.

If the list is empty, you have to enable the Remote Hosts Access plugin which supports the corresponding functionality.

Host

If Same file system is selected for Type, the only available option for Host is also Same file system.

In all other cases, the list contains the existing configurations of the selected type. So each configuration corresponds to an individual (S)FTP connection, or a local or mounted folder.

Select an existing configuration or create a new one.

To create a new configuration:

  1. Click browseButton to the right of the list.

  2. In the Deployment dialog, click icons general add svg.

  3. In the Add Server dialog, specify the configuration name, select the type, and click OK.

  4. On the Connection tab, specify the settings in the Upload/download project files section.

    The rest of the settings don't matter.

  5. Click OK in the Deployment dialog.

Deployment access

When deploying to the remote host, the application artifact or artifacts are placed into a staging folder (deployment target folder). This folder should be accessible to the server. The settings in this section define the location of this staging folder.

Path from root

The path to the staging folder relative to the local or mounted folder, or the root of the (S)FTP host.

You can use browseButton to select the folder in the Choose target path dialog.

Mapped as

 The absolute path to the staging folder in the local file system of the remote host.

The path should be specified as a URL, e.g.

file:///C:/shared/staging

Repository access

When deploying to the remote host, the plans (artifacts) are placed into a watched repository. The settings in this section describe this repository.

Path from root

The path to the repository folder relative to the local or mounted folder, or the root of the (S)FTP host.

You can use browseButton to select the folder in the Choose target path dialog.

Name

Specify the name of the watched repository the way it is defined in the configuration of the remote server.

Remote connection settings

The settings for accessing deployed applications.

Host

The fully qualified domain name or the IP address of the server host.

Port

The server HTTP port.

An example of remote staging settings for a mounted folder

Assuming that:

  • C:\shared is a shared folder on the remote host, which is mounted to the local computer as the drive X:.

  • The folder that you are going to use for staging is C:\shared\staging.

Here are the corresponding remote staging settings:

  • Type: Local or mounted folder.

  • Host: The configuration should be selected in which the value in the Folder field is X:\ (the Upload/download project files section on the Connection tab of the Deployment dialog).

  • Staging/Path from root: staging
  • Staging/Mapped as: file:///C:/shared/staging

Deployment tab

Use this tab to specify which artifacts or external resources should be deployed onto the server. An external resource means a deployable Web component such as a .war file which is not represented by a project artifact. Usually, such components are stored outside of the project scope.

To add items to the deployment list (shown under Deploy at the server startup), click the Add button (The Add button). To edit the settings for an artifact or external resource, select the corresponding item in the list and use the controls below.

Item

Description

The Add button or Alt+Insert

Add an artifact or an external resource to the list.

The Remove button or Alt+Delete

Remove the selected artifacts and external resources from the list.

Edit Artifact or F4

Configure the selected artifact. The Artifacts page of the Project Structure dialog will open.

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.

Startup/Connection tab for a remote configuration

This tab shows command-line options for starting the server JVM in the run and debug modes.

Item

Description

icons toolwindows toolWindowRun svg Run /
icons actions startDebugger svg Debug

Use to switch between the settings for the run and debug modes. The settings are shown in the area under To run/debug...

To run/debug remote server JVM...

The command-line options for starting the server JVM. These are shown just for copying elsewhere.

Transport (and all that follows)

The GUI for generating the remote debug command-line options shown in the area under To run/debug...

Common options

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

Item

Description

Name

In this field, 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 checkbox 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.

Allow running in parallel

If this checkbox is selected, it is possible to launch a run configuration multiple times in parallel instead of rerunning it. Each runner will start in its own tab of the Run Tool Window or Debug Tool Window.

When disabled, every time a new instance of the 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. If you click OK in the confirmation dialog, the first instance of the runner will be stopped, and the next one will take its place. This makes sense when launching two instances of run/debug configurations of the same type consumes too much of the CPU and memory resources..

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 buttonAlt+Insert

Create a run/debug configuration.

the Remove buttonAlt+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 toolbar shows this button only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.

Edit Templates

View and edit the template (that is, the default settings) for the selected run/debug configuration. The templates are displayed under the Templates node and used for newly created configurations.

Method up/Method down

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

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 options

In this area you can specify tasks that must 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 buttonAlt+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.

  • Launch Web Browser: select this option to have a browser started.C 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.

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

the Remove buttonAlt+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 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: 20 June 2019
Run/Debug Configuration: Spring DM Server (Local)Run/Debug Configuration: TestNG

See Also

Procedures:

Reference:

Concepts:

External Links: