IntelliJ IDEA 2016.3 Help

Application Servers

File | Settings | Build, Execution, Deployment | Application Servers for Windows and Linux
IntelliJ IDEA | Preferences | Build, Execution, Deployment | Application Servers for OS X
From the Run/Debug Configurations dialog: Configure when editing a run/debug configuration for an application server.


Use this page or dialog to manage configurations for the supported application servers and their settings.

The servers that are already defined in IntelliJ IDEA are shown in the pane under /help/img/idea/2016.3/new.png and /help/img/idea/2016.3/delete.png. When you select a server in this pane, the corresponding configuration settings and associated controls are shown in the area to the right. (If you are editing a run configuration for a particular server (e.g. Tomcat), only the existing configurations for this particular server are shown.)

Use /help/img/idea/2016.3/new.png to create server configurations and /help/img/idea/2016.3/delete.png to remove them.

By the time you start creating a server configuration, the corresponding server must already be installed on your computer. (This isn't necessary for CloudBees.)

Note that the list of servers you can work with depends on which server integration plugins are currently enabled. See Enabling Application Server Integration Plugins.

Toolbar

ItemDescription
/help/img/idea/2016.3/new.png or Alt+Insert Use this icon or shortcut to create a server configuration (i.e. to define a server in IntelliJ IDEA):
  1. If the server list is shown, select the server of interest.
  2. In the dialog that opens, specify the server settings and click OK.

    For most of the servers, you just need to specify the server installation directory (referred to as the server home). For more information, see Main settings and controls.

/help/img/idea/2016.3/delete.png or Alt+Delete Use this icon or shortcut to remove the selected application server configuration.

Main settings and controls

ItemDescription
NameThe server configuration name.
<Server> HomeThe path to the application server installation folder.

Click /help/img/idea/2016.3/browseButton.png and select the folder in the dialog that opens.

<Server> VersionThe detected application server version (readonly).
<Server> base directory (for Jetty, Tomcat and TomEE)The path to the server base directory.

Click /help/img/idea/2016.3/browseButton.png and select the directory in the dialog that opens.

Register schemas (for JBoss) To be able to validate JBoss XML configuration files (such as standalone.xml, domain.xml, etc.) when editing them in IntelliJ IDEA, you can register XML schemas (XSDs) available in the JBoss installation:
  1. Click Register schemas.
  2. To register all the schemas, just click OK in the dialog that opens.

    If there are schemas that you don't want to register, select those schemas under External Schemas and DTDs, click /help/img/idea/2016.3/delete.png and then click OK.

To view or edit the schema list at a later time, use the Schemas and DTDs page in the Settings dialog.

Download client libraries (for CloudBees)The Tomcat instance embedded in CloudBees is used as a server. This Tomcat instance is included in the CloudBees client libraries which you can download.

If the button is inactive, the client libraries (along with the corresponding Tomcat instance) are already available in IntelliJ IDEA.

See also, Libraries, Additional Libraries for Frameworks and Configuration file list (for Jetty 7 or later versions).

Libraries

When you create a server configuration, normally, an associated application server library is created. As a rule, this library includes Servlet, JSP and EJB implementations available in the server distribution.

Use the controls under Libraries to manage the contents of the library.

ItemDescription
/help/img/idea/2016.3/new.png or Alt+Insert Use this icon or shortcut to add items (classes, sources, documentation, etc.) to the library.

In the dialog that opens, select the necessary files and folders. These may be individual .class and .java files as well as directories and archives (.jar and .zip) containing such files.

IntelliJ IDEA will analyze the selected files and folders, and automatically assign their contents to the appropriate library categories (Classes, Sources, Documentation, etc.).

When IntelliJ IDEA cannot guess the category (e.g. when you select an empty folder), a dialog will be shown, in which you will be able to specify the category yourself.

/help/img/idea/2016.3/icon_doc_url.png To be able to use external documentation available online, click this icon and specify the URL of the external documentation in the dialog that opens.
/help/img/idea/2016.3/iconLibExclude.pngClick this icon to make certain library items "excluded" (see Excluded library items). In the dialog that opens, select the items that you want IntelliJ IDEA to ignore (folders, archives and folders within the archives), and click OK.
/help/img/idea/2016.3/delete.png or Delete When you click this icon or press Delete:
  • The selected "ordinary" library items are removed from the library.
  • The selected excluded items (see Excluded library items) become "ordinary" items, i.e. their excluded status is cancelled. The items themselves will stay in the library.

Additional Libraries for Frameworks

For certain application server configurations (e.g. GlassFish), there is an Additional Libraries for Frameworks list with check boxes.

Each item in this list, potentially, is a library that implements the corresponding framework. (Corresponding library files are included in the server distribution.)

When you select a check box in the list, the corresponding application server library is created. The dialog that opens lets you select the modules in which this library should be used. (As a result, the library is added to dependencies of the selected modules.)

Configuration file list (for Jetty 7 or later versions)

For Jetty 7 or later versions, there is a section where the server configuration (.xml) or module (.mod) files are listed.

This section provides a GUI for editing the file <jetty_home>\start.ini. (start.ini contains the options for <jetty_home>\start.jar which is used to start Jetty.)

Use the check boxes to make the files active or inactive. Use /help/img/idea/2016.3/new.png, /help/img/idea/2016.3/delete.png, /help/img/idea/2016.3/editFlexLibraryNew.png, /help/img/idea/2016.3/arrowUp.png and /help/img/idea/2016.3/arrowDown.png to add, remove, replace and reorder the files.

ItemDescription
ActiveUse the check boxes to make the files active or inactive.

As soon as you deselect a file, the corresponding line in start.ini is commented. When you make a file active, the corresponding entry in start.ini is uncommented.

PathThe paths to the corresponding files are shown (readonly).

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

/help/img/idea/2016.3/new.png or Alt+InsertUse this icon or shortcut to add a file to the list. In the dialog that opens , select the necessary file and click OK.

Adding a file to the list leads to adding a new (commented) entry to start.ini.

/help/img/idea/2016.3/delete.png or Alt+DeleteUse this icon or shortcut to remove the selected file from the list. Note that this operation does not delete the file physically. However, the corresponding entry is removed from start.ini.
/help/img/idea/2016.3/editFlexLibraryNew.png or EnterUse this icon or shortcut to replace the selected file. In the dialog that opens , select the replacement file and click OK.
/help/img/idea/2016.3/arrowUp.png or Alt+UpUse this icon or shortcut to move the selected file one line up in the list.
/help/img/idea/2016.3/arrowDown.png or Alt+DownUse this icon or shortcut to move the selected file one line down in the list.

See Also

Last modified: 7 December 2016