IntelliJ IDEA 14.0.3 Help

Run/Debug Configuration: JBoss Server

Use this dialog to create or edit run/debug configurations for JBoss Server .

Name field and Share option

Item Description
Name Use this field to edit the name of the run/debug configuration.

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

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.

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

Server tab for a local configuration

Item Description
Application server Select the server configuration to be used.

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

After launch Select this check box to start a web browser after starting 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 check box 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.
VM options 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 shift-enter-button next to the field to open the VM Options dialog where the text entry area is larger.

When specifying the 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 the spaces in double quotes, for example, some" "arg or "some arg".
  • If 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\".

Here is how you can specify a custom configuration directory and file name:

-Djboss.server.config.dir=C:/jboss-eap-6.3/custom-configuration

-Djboss.server.default.config=standalone-custom.xml

On 'Update' action Select the necessary option for the Update application function (update_icon or Ctrl+F10 in the Run or Debug tool window).

The update options are different for exploded and packed artifacts.

For exploded artifacts, the available options are:

  • Update resources. All changed resources (that is, all application components other than the classes) will be updated.
  • Update classes and resources. All changed resources will be updated; changed classes will be recompiled.

    In the debug mode, the updated classes will be hot-swapped. In the run mode, IntelliJ IDEA will just update the changed classes in the output folder. Whether such classes will actually be reloaded in the running application, depends on the capabilities of the runtime being used.

  • Redeploy. The application will be updated and redeployed.
  • Restart server. The server will be restarted. The updated version of the application will be deployed at the server startup.

For packed artifacts, the available options are:

  • Hot swap classes. Changed classes will be recompiled and reloaded at runtime. Note that this option will work only in the debug mode.
  • Redeploy. The overall application will be rebuilt and redeployed.
  • Restart server. The server will be restarted. The application will be rebuilt and deployed at the server startup.
Show dialog Select this check box 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.

Use alternative JRE By default, the server is started using the project JDK.

If you want to use a different JRE, select this check box and specify which JRE should be used.

Username Specify the name of the user on whose behalf IntelliJ IDEA will connect to the server.
Password The password of the user specified in the Username field.
Operating mode Select:
  • standalone to start JBoss as a standalone server.

    Port offset. If necessary, specify the port offset, i.e. the number by which all the server ports should be shifted. (The ports are specified by means of the <socket-binding> elements in the server configuration file standalone.xml.)

    The specified offset is passed to the server as a VM option, e.g.

    -Djboss.socket.binding.port-offset=100

  • domain to start the server as a managed domain.

    Server group. Select the server group to deploy your artifacts to. (The list items correspond to the <server-group> elements in the configuration file domain.xml. The server group doesn't matter if you don't deploy anything using this run configuration.)

    When you select other-server-group, the following message may be shown in the lower part of the dialog: Error: No single server is configured to start for server group 'other-server-group'. If this is the case and you click Fix, the configuration file host.xml is modified. (The auto-start attribute of the first <server> element in the server group is changed from false to true.)

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 check box 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 check box 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 Ctrl+F10 in the Run or Debug tool window).

The options are:

  • Hot swap classes. Changed classes will be recompiled and reloaded at runtime. Note that this option will work only in the debug mode.
  • Redeploy. The overall application will be rebuilt and redeployed.
Show dialog Select this check box 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.

Management port The native management interface port. (This port is defined in the standalone.xml configuration for a standalone server and in the host.xml configuration for a server within a managed domain.)
Operating mode The server operating mode: standalone for a standalone server and domain for a managed domain.

For the managed domain mode, specify the server group to deploy your artifacts to, e.g. main-server-group. The server group doesn't matter, if you don't deploy anything using this run configuration.

Username Specify the name of the user on whose behalf IntelliJ IDEA will connect to the server.
Password The password of the user specified in the Username field.
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 add.
  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.

    Note that the rest of the settings don't matter in the context of a remote JBoss Server run/debug configuration.

  5. Click OK in the Deployment dialog.

Staging When deploying to the remote host, the application artifact or artifacts are placed into a staging folder which should be accessible to JBoss Server. The settings in this section define the location of this staging folder.

Note that if Same file system is selected for Type and Host, no settings in this section need to be specified.

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.
Remote connection settings The settings for accessing deployed applications.
Host The fully qualified domain name or the IP address of the JBoss Server host. When the target server operates in the managed domain mode, this is the Domain Controller host.
Port The HTTP port of JBoss Server.

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: C:\shared\staging

Deployment tab

Use this tab to specify which artifacts and/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), use add. For more information, see the table below.

Item Tooltip and Shortcut Description
add Add
Alt+Insert
Use this icon or shortcut to add an artifact or an external resource to the list.
  • To add an artifact, select Artifact and choose the desired artifact in the dialog that opens.
  • To add an external resource, select External Source and choose the location of the desired resource in the dialog that opens.
delete Remove
Alt+Delete
Use this icon or shortcut to remove the selected artifacts and external resources from the list.
arrowUp Alt+Up Use this icon or shortcut to move the selected item one line up in the list.
arrowDown Alt+Down Use this icon or shortcut to move the selected item one line down in the list.
edit1 Edit Artifact
F4
Use this icon or shortcut to 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 check boxes 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 check box to have the previous content of the selected log skipped.
Save console output to file Select this check box 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 standard out changes Select this check box to activate output console and bring it forward, if associated process writes to Standard.out.
Show console when standard error changes Select this check box to activate output console and bring it forward, if associated process writes to Standard.err.
add 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.
edit1 Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.
delete Click this button to remove the selected log entry from the list.
browseButton.png Click this button to edit the select log file entry. The button is available only when an entry is selected.

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 check box 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 add-class or add-package to add classes or packages to the list.

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

Enable coverage in test folders. Select this check box to include the test source folders in code coverage analysis.

Startup/Connection tab for a local configuration

Item Description
run Run /
debug Debug /
runWithCoverage Coverage
Use to switch between the settings for the run, debug and code coverage modes.
Startup script Specify the script to be used to start the server.

Use default:

  • If this check box is selected, the default script is used.

    shift-enter-button in this case opens the Default Startup Script dialog which shows the contents of the Startup script field (readonly).

  • Clear this check box to change the parameters passed to the script or to specify a different script:
    • To specify the script, click browseButton and select the desired script in the dialog that opens.
    • To specify the parameters, click shift-enter-button 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 Specify the script to be used to stop the server.

Use default:

  • If this check box is selected, the default script is used. (For certain JBoss versions, there is no default script and the server is stopped through its management API.)

    shift-enter-button in this case opens the Default Shutdown Script dialog which shows the contents of the Shutdown script field (readonly).

  • Clear this check box to change the parameters passed to the script or to specify a different script:
    • To specify the script, click browseButton and select the desired script in the dialog that opens.
    • To specify the parameters, click shift-enter-button 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 To pass specific variables to the server environment, select this check box and specify the variables:
  • To add a variable, click 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 delete.
Port Use this field to change the debugger port.
Debugger Settings Click this button to edit the debugger options on the Debugger page of the Settings dialog.

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
run Run /
debug 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...

Before Launch options

Specify which tasks should be carried out before starting the run/debug configuration. The specified tasks are performed in the order that they appear in the list.

Item Shortcut Description
add 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, Configuring Artifacts.

  • Run Another Configuration. Select this option to have another run/debug configuration executed. In the dialog that opens, select the configuration to be run.
  • 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.
  • 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.

    For more information, see CoffeeScript Support.

  • Run Maven Goal. Select this option to have a Maven goal run. In the dialog that opens, select the goal to be run.

    For more information, see Maven.

  • Run Remote External Tool. Select this option to run a remote application which is external to IntelliJ IDEA. In the dialog that opens, select one or more remote applications to be run. If the necessary applications are not defined in IntelliJ IDEA yet, add definitions. For more information, see Configuring Third-Party Tools and External Tools.
delete Alt+Delete Click this icon to remove the selected task from the list.
edit1 Enter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
arrowUp arrowDown Alt+Up/Alt+Down Click these icons to move the selected task one line up or down in the list.
Show this page Select this check box to show the run/debug configuration settings prior to actually starting the run/debug configuration.

Toolbar

Item Shortcut Description
add Alt+Insert Use this icon or shortcut to create a new run/debug configuration.
delete Alt+Delete Use this icon or shortcut to delete the selected run/debug configuration.
copy Ctrl+D Use this icon or shortcut to create a copy of the selected run/debug configuration.
settings Click this button to edit the default settings of the selected run/debug configuration. This button it disabled for defaults.
arrowUp arrowDown Alt+Up/Alt+Down Use these buttons to 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 in the corresponding list on the main toolbar.

These buttons are disabled for defaults.

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

To create a folder, select the configurations to be grouped and click folder. Specify the name of the folder.

Then, to move a configuration into a folder, between the folders or out of a folder, use arrowUp and arrowDown. You can also drag a configuration into a folder.

To remove grouping, select a folder and click delete.

See also, Creating Folders and Grouping Run/Debug Configurations.

See Also

Web Resources:

Last modified: 30 January 2015
comments powered by Disqus