Run/Debug Configuration: Tomcat
Name field and Share option
|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.
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
If the file-based format is used,
the settings are stored in the
This check box is not available when editing the run/debug configuration defaults.
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 check box to run the default Web browser to study your application output there.|
|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 next to the field to open the VM Options dialog where the text entry area is larger.
When specifying the options, follow these rules:
|On 'Update' action||Both||
Select the necessary option for the Update application action.
For packed artifacts, the available options are:
Select this check box if you want to see the Update <application name>
dialog every time you perform the Update application action.
The Update <application name> dialog is used to view and change the current update option prior to actually updating the application.
|On frame deactivation||Both||
Specify which application update actions should be performed when switching from IntelliJ IDEA to
a different application (for example, a Web browser).
(Frame deactivation means switching to a different application.)
If no update actions are required, select Do nothing. Otherwise, select the necessary update option. Note that the Redeploy an the Restart server options are not available.
|Deploy applications configured in Tomcat instance||Local||The Tomcat configuration files, among other things, may list the applications that should be
deployed at the server start. If this check box is selected, all the applications so listed
will be deployed on the server in addition to the artifacts specified on
the Deployment tab.
If the check box is not selected, only the artifacts and the external resources specified on the Deployment tab will be deployed.
|Preserve sessions across restarts||Local||Select this check box to preserve active HTTP sessions when restarting the server.|
|HTTP port||Local||Specify the HTTP port of Tomcat.|
Specify the port to be used for exchanging the JNDI information with the server.
Note that this port is not used if no artifacts are deployed to the server.
|Remote staging||Remote||This section contains the settings related to staging. An example of remote staging settings for a mounted folder is provided after this table.|
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:
If the list is empty, you have to enable the Remote Hosts Access plugin which supports the corresponding functionality.
|Host||Remote||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:
When deploying to the remote host, the application artifact or artifacts are placed into a staging
folder which should be accessible to Tomcat.
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||Remote||The path to the staging folder relative to the local or mounted folder,
or the root of the (S)FTP host.
You can use to select the folder in the Choose target path dialog.
|Mapped as||Remote||The absolute path to the staging folder in the local file system of the remote host.|
|Remote connection settings||Remote||The settings for accessing deployed applications.|
|Host||Remote||The fully qualified domain name or the IP address of the Tomcat host.|
|Port||Remote||The HTTP port of Tomcat.|
An example of remote staging settings for a mounted folder
C:\sharedis a shared folder on the remote host which is mounted to the local computer as the drive
The folder that you are going to use for staging is
Here are the corresponding remote staging settings:
- Type: Local or mounted folder.
The configuration should be selected in which the value in the Folder field
X:\(the Upload/download project files section on the Connection tab of the Deployment dialog).
Staging/Path from root:
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 . To edit the settings for an artifact or external resource, select the corresponding item in the list and use the controls in the right-hand part of the tab. For more information, see the table below.
Note that deployment to a remote server is supported only for Tomcat 5 or later versions. Also note that to be able to deploy applications to a remote Tomcat server with IntelliJ IDEA 12, you should enable the JMX support on the server. To do that, you should pass the following VM options to the server Java process:
-Dcom.sun.management.jmxremote= -Dcom.sun.management.jmxremote.port=1099 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false -Djava.rmi.server.hostname=<host>
<host> is the server hostname (domain name) or IP address.
catalina.sh is used to start the server,
these options may be passed to the server using the
CATALINA_OPTS environment variable.
|Item||Tooltip and Shortcut||Description|
Use this icon or shortcut to add an artifact or an external resource to the list.
|Use this icon or shortcut to remove the selected artifacts and external resources from the list.|
|Use this icon or shortcut to configure the selected artifact. (The Artifacts page of the Project Structure dialog will open.)|
|Application context||Specify the context root for an artifact or external resource: select the artifact or the resource, and type or select the context root.|
|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:
|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.|
|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.|
|Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.|
|Click this button to remove the selected log entry from the list.|
|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.
|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 or to add classes or packages to the list.
To remove the classes or packages from the list, select the corresponding list items and click .
|Enable coverage in test folders.||Select this check box to include the test source folders in code coverage analysis.|
|Both||Select Run or Debug to show settings either for the run or the debug mode.|
|Run with Coverage||Local||Select Run with Coverage to show settings for run with coverage mode.|
Specify the script to be used to start the server.
Specify the script to be used to stop the server.
|Pass environment variables||Local||To pass specific variables to the server environment, select this check box and specify the variables:
|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.|
Specify the "transport" settings for the connection with the debugger. In technical terms,
these are the parameters for the
Note that as you change the transport settings,
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.
Click this icon to add a task to the list. Select the task to be added:
|Alt+Delete||Click this icon to remove the selected task from the list.|
|Enter||Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.|
|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 have the run/debug configuration settings shown prior to actually starting the run/debug configuration.|
|Alt+Insert||Use this icon or shortcut to create a new run/debug configuration.|
|Alt+Delete||Use this icon or shortcut to delete the selected run/debug configuration.|
|Ctrl+D||Use this icon or shortcut to create a copy of the selected run/debug configuration.|
|Click this button to edit the default settings of the selected run/debug configuration. This button it disabled for defaults.|
|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.
|Use this button to create a new folder.
If one or more run/debug configurations have the focus, then the selected run/debug configurations are automatically moved to the newly created folder. If only a category has the focus, then an empty folder is created.
Move run/debug configurations to a folder using drag-and-drop, or buttons.