Run/Debug Configuration: Jetty Server

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 checkbox to start a web browser after starting the server and deploying the artifacts.

Select the browser from the list. Click 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.

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 next to the field to open the VM Options dialog where the text entry area is larger.

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

• If an option includes double quotes (as part of the argument), escape the double quotes using backslashes, for example, -Dmy.prop=\"quoted_value\".

• You can pass environment variable values to custom Java properties. For example, if you define a variable MY_ENV_VAR, you can pass it to the foo property as follows:

  -Dfoo=${MY_ENV_VAR}

On 'Update' action

Select the necessary option for the Update application function ( 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 are updated (HTML, JSP, JavaScript, CSS and image files).

• Update classes and resources. Changed resources are updated; changed Java classes (EJBs, servlets, etc.) are recompiled.

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

• Redeploy. The application artifact is rebuilt and redeployed.

• Restart server. The server is restarted. The application artifact is rebuilt and redeployed.

For packed artifacts, the available 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.

• Restart server. The server is restarted. 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.

JRE

By default, the project JDK is used to run the application. If you want to specify an alternative JDK or JRE here, select it from the drop-down list.

JMX port

The server JMX port.

Active

Select the checkboxes to make the corresponding files active.

For Jetty versions before 9, the list contains the server XML configuration files. For Jetty 9, the module .mod files are listed.

The selected files are passed as command-line arguments to <jetty_home>\start.jar which is used to start the server.

Path

The paths to the corresponding Jetty configuration or module files are shown (readonly).

For the files located within the Jetty installation directory, the paths are relative to the installation directory. For all the rest of the configuration files, the absolute paths are shown.

Initially, the list contains the files located in <jetty_home>\etc or <jetty_home>\modules.

Use the following icons to manage the list:

Click this icon to add a file to the list. In the dialog that opens, select the necessary Jetty configuration or module file and click OK.

Click this icon to remove the selected file from the list. Note that this operation does not delete the file physically.

Click this icon to replace the selected file. In the dialog that opens, select the replacement file and click OK.

and . Click the icon to move the selected file one line up or down in the list.

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 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 ( or Ctrl+F10 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

The server JMX port.

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 FTP/SFTP Connectivity 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 to the right of the list.

2. In the Deployment dialog, click .

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.

contexts

Location of one of the following directories:

• For Jetty 9: <jetty_home>\webapps

• For Jetty versions before 9: <jetty_home>\contexts

(This is where IntelliJ IDEA generates the deployment descriptor XML file for the application artifact.)

Local path or Path from root

If Same file system is selected for Type and Host, specify the absolute path.

In all other cases, specify the path 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

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

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

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.

In Jetty run/debug configurations, these are used just to form the starting URL.

Host

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

Port

The server HTTP port.