Run/Debug Configuration: Jetty

Name field

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

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\".
Perform 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 and reloaded. Note that this option will work only in the debug mode. 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.
JNDI port	Both	Specify the port to be used for exchanging the JNDI information with the server.
Active	Local	Use the check boxes next to the corresponding Jetty configuration files to select or deselect these files. The selected (active) configuration files are used to configure the server at its start. For Jetty versions before version 7, only the files that are active in the run configuration are taken into account. For Jetty 7 and later versions, the files that are active in the associated server configuration are used in addition to the files that are active in the run configuration. (In technical terms, the files that are active in the run configuration correspond to command-line arguments passed to <jetty_home>\start.jar which is used to start the server. For Jetty 7 and later versions, additionally, the file <jetty_home>\start.ini containing the arguments for start.jar is used. The files that are active in the server configuration correspond to the entries instart.ini.) For the run configuration to be functional, the configuration files jetty.xml and jetty-jmx.xml must be active. If you are using the Jetty version 7 or later, the configuration file jetty.xml may be set active either in the run configuration or in the associated server configuration. If the set of active configuration files seems problematic, IntelliJ IDEA will inform you about that and suggest a quick fix. Examples of problematic cases are: The configuration file jetty.xml or jetty-jmx.xml or both are inactive in the run configuration and the associated server configuration (for Jetty 7 and later versions). One or more configuration files are active in the run configuration and, at the same time, in the associated server configuration (for Jetty 7 and later versions). The configuration file jetty.xml or jetty-jmx.xml or both are inactive in the run configuration (for Jetty versions before version 7).
Path	Local	The paths to the corresponding Jetty configuration files are shown (readonly). For the files located within the Jetty installation directory and its subdirectories, the paths are relative to Jetty home (that is, the installation directory). For all the rest of the configuration files, the absolute paths are shown.
Add / Edit / Remove / Move up/down	Local	Initially, the configuration file list contains the configuration files located in the directory <jetty_home>\etc. Use the buttons to the right of the list to manage this list: Add. Click this button to add a configuration file to the list. In the Select Path dialog, select the necessary Jetty configuration file and clickOK. Edit. Click this button to replace the selected file with a different Jetty configuration file. In the Select Path dialog, select the replacement configuration file and clickOK. Remove. Click this button to remove the selected file from the list. Note that this operation does not delete the file physically. Move up/down. Click this button to move the selected file one line up or down in the list. Note that the order of files in the list is important because it corresponds to the order of arguments passed to start.jar when the server is started.
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 Jetty run/debug configuration. Click OK in the Deployment dialog.
contexts	Remote	When deploying the application artifact, the deployment descriptor file is created and placed into the directory <jetty_home>\contexts. The settings in this section define the location of this directory.
Local path or Path from root	Remote	If Same file system is selected for Type and Host, specify the absolute path to the folder contexts. In all other cases, specify the path to contexts relative to the local or mounted folder, or the root of the (S)FTP host. You can use to select the folder in the Select Path or the Choose target path 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 Jetty. 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 the deployed applications. In Jetty run/debug configurations, these are used just to form the URL for the Startup Page field.
Host	Remote	The fully qualified domain name or the IP address of the Jetty host.
Port	Remote	The HTTP port of Jetty.

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:.
Jetty is installed in C:\shared\jetty-distribution-8.0.1.v20110908.
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).
contexts/Path from root: jetty-distribution-8.0.1.v20110908\contexts
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 on the server.

Item	Description
(Alt+InsertControl N )	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 Select Path dialog.
(Alt+DeleteCommand Delete)	Use this icon or shortcut to remove the selected artifacts and external resources from the list.
(F4F4)	Use this icon or shortcut to configure the selected artifact. (The Artifacts page of the Project Structure dialog will open.)
Use custom context root	If you want to assign a particular context root to an artifact or external resource, select the artifact or the resource, select the check box and specify the desired context root in the field underneath the check box.

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 this check box to have the selected log file displayed.
Log File Entry	This read-only field lists 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.
Add	Click this button to add another log file entry. Specify the associated properties in the Edit Log Files Aliases dialog.
Edit	Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.
Remove	Click this button to remove the selected log entry from the list.
Save console output to file	Select this check box to save the console output in a specified file. In the field underneath the check box, specify the absolute path to the file. Alternatively, use (Shift+EnterShift Enter) and select the necessary file in the Select Path dialog.

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 Remove.
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	Remote	Select Run or Debug to show the settings either for the run or the debug mode.
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.

Item

Local/Remote

Description

Run /

Debug

Remote

Select Run or Debug to show the settings either for the run or the debug mode.

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 and Share configuration options

Item	Description
Before Launch	Specify which activities should be performed before starting the run/debug configuration: Make. If this check box is selected, the project is compiled automatically prior to running or debugging. This option helps you ensure that all changes are included and compiled. Build Artifacts. If this check box is selected, the specified artifacts will be built prior to running or debugging. To define the artifacts to be built, click and select the desired artifacts. Run Ant target. If this check box is selected, the specified Ant target will be built prior to running or debugging. To define the Ant target, click and select the desired target. To learn more about Ant support, refer to the Ant Support section. Run Maven goal. If this check box is selected, the specified Maven goal will be executed prior to running or debugging. To define the Maven goal to be executed, click and select the desired goal. To learn more about Maven support, refer to the Maven Support section. Show settings. Select this check box if you want the Run/Debug Configurations dialog to be shown every time you launch this run/debug configuration. Note The Before Launch actions are performed in the order they appear in the Run/Debug Configurations dialog. Thus, the artifacts are built before running the Ant targets, etc.
Share configuration	If this check box is selected, the run/debug configuration is available to other team members. In the case of the standard project format, the run/debug configuration will be stored in a .ipr file which is usually shared through version control. In the case of the directory-based project format, the shared run/debug configurations are kept in separate xml files in the .idea\runConfigurations folder, while the local run/debug configurations are kept in .idea\workspace.xml.

Item

Description

Before Launch

Specify which activities should be performed before starting the run/debug configuration:

Make. If this check box is selected, the project is compiled automatically prior to running or debugging. This option helps you ensure that all changes are included and compiled.
Build Artifacts. If this check box is selected, the specified artifacts will be built prior to running or debugging. To define the artifacts to be built, click and select the desired artifacts.
Run Ant target. If this check box is selected, the specified Ant target will be built prior to running or debugging. To define the Ant target, click and select the desired target.
To learn more about Ant support, refer to the Ant Support section.
Run Maven goal. If this check box is selected, the specified Maven goal will be executed prior to running or debugging. To define the Maven goal to be executed, click and select the desired goal.
To learn more about Maven support, refer to the Maven Support section.
Show settings. Select this check box if you want the Run/Debug Configurations dialog to be shown every time you launch this run/debug configuration.

Note

The Before Launch actions are performed in the order they appear in the Run/Debug Configurations dialog. Thus, the artifacts are built before running the Ant targets, etc.

Share configuration

If this check box is selected, the run/debug configuration is available to other team members.

In the case of the standard project format, the run/debug configuration will be stored in a .ipr file which is usually shared through version control.
In the case of the directory-based project format, the shared run/debug configurations are kept in separate xml files in the .idea\runConfigurations folder, while the local run/debug configurations are kept in .idea\workspace.xml.

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