Run/Debug Configuration: Tomcat

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 and 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 for the ones that are not shared. This check box is not available when editing the run/debug configuration defaults.

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.

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 and 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 for the ones that are not shared.

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

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 check box to run the default Web browser to study your application output there.
With JavaScript debugger	Both	If this check box is selected, the Web browser is started with the JavaScript debugger enabled. Note JavaScript debugging is available only for Firefox and Google Chrome. Note that when you debug your JavaScript in Firefox for the first time, the JetBrains Firefox extension will be installed.
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: 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\".
On 'Update' action	Both	Select the necessary option for the Update application action. 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. Note In the run/debug configurations for remote servers, the available application update options are limited to those for packed artifacts. Also, the Restart server option is not available.
Show dialog	Both	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.
JNDI port	Remote	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.
Type	Remote	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	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: Click to the right of the list. In the Deployment dialog, click . In the Add Server dialog, specify the configuration name, select the type, and click OK. 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 Tomcat run/debug configuration. Click OK in the Deployment dialog.
Staging	Remote	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

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

where <host> is the server hostname (domain name) or IP address.

If catalina.bat or 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
	Add Alt+InsertControl N; Control Enter	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.
	Remove Alt+DeleteCommand Delete	Use this icon or shortcut to remove the selected artifacts and external resources from the list.
	Edit Artifact F4F4	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.

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

Startup/Connection tab

Item	Local/Remote	Description
Run Debug	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.
Startup script	Local	Specify the script to be used to start the server. Use default: If this check box is selected, the default script is used. 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 and select the desired script in the dialog that opens. To specify the parameters, click 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. Use default: If this check box is selected, the default script is used. 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 and select the desired script in the dialog that opens. To specify the parameters, click 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 check box and specify the variables: To add a variable, click 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 .
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.

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
	Alt+InsertControl N; Control Enter	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.
	Alt+DeleteCommand Delete	Click this icon to remove the selected task from the list.
	EnterEnter	Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
	Alt+UpControl Up	Click this icon to move the selected task one line up in the list.
	Alt+DownControl Down	Click this icon to move the selected task one line 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.

Toolbar

Item	Description
(InsertInsert)	Use this icon or shortcut to create a new run/debug configuration.
(DeleteDelete)	Use this icon or shortcut to delete the selected run/debug configuration.
(Ctrl+DCtrl+D)	Use this icon or shortcut to create a copy of the selected run/debug configuration.
	Click this button to edit the default settings for run/debug configurations.
	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.

IntelliJ IDEA 12.1.0 Web Help