IntelliJ IDEA 2018.3 Help

Add Frameworks Support dialog

From the Project Tool Window: right-click a module folder and select Add Framework Support.


Select the technologies, frameworks and languages to be supported, and specify the associated settings. For general info, see Add support for frameworks and technologies.

Web Application

Select the checkbox to enable generic Web application development support. See also, Enabling Web Application Support.

Item

Description

Version

Select the version of the Servlet specification to be supported.

Create web.xml

For version 3.0 or later: select this checkbox to create the deployment descriptor file web.xml. (For earlier versions, this file is always created.)

Struts

Select the checkbox to enable Apache Struts 1.x support. See also, Preparing to Use Struts.

Item

Description

Version

Select the Thymeleaf version to be supported.

If you also choose to download the library files that implement Thymeleaf (the Download option), the selected version will define which files you will be able to download.

Libraries

You'll need a library that implements Thymeleaf. You can choose to use an existing library, create and use a new one, download the library files if they are not yet available on your computer, or postpone setting up the library until a later time.
  • Use library. Select the library to be used from the list (if the corresponding library is already defined in IntelliJ IDEA).

    Create. If the corresponding library files (.jar) are already available on your computer, you can arrange those files in a library and use that new library. To do that, click Create and select the necessary files in the dialog that opens. (Use the Ctrl key for multiple selections.)

    Optionally, click Configure to edit the selected library. (For an existing library the Edit Library dialog will open, for the library that you have just created - the Create Library dialog.)

  • Download. Select this option to download the library files that implement the selected Thymeleaf version. (The downloaded files will be arranged in a library.)

    Optionally, click Configure to edit the library settings and contents. (The Downloading Options dialog will open.)

  • Set up library later. Select this option to postpone setting up the library until a later time.

Configure. Click this button to edit the settings for the library selected next to Use library or the one that is about to be downloaded.

Struts 2

Select the checkbox to enable Apache Struts 2 support. See also, Preparing to Use Struts 2.

You'll need a library that implements Thymeleaf. You can choose to use an existing library, create and use a new one, download the library files if they are not yet available on your computer, or postpone setting up the library until a later time.

  • Use library. Select the library to be used from the list (if the corresponding library is already defined in IntelliJ IDEA).

    Create. If the corresponding library files (.jar) are already available on your computer, you can arrange those files in a library and use that new library. To do that, click Create and select the necessary files in the dialog that opens. (Use the Ctrl key for multiple selections.)

    Optionally, click Configure to edit the selected library. (For an existing library the Edit Library dialog will open, for the library that you have just created - the Create Library dialog.)

  • Download. Select this option to download the library files that implement Thymeleaf. (The downloaded files will be arranged in a library.)

    Optionally, click Configure to edit the library settings and contents. (The Downloading Options dialog will open.)

  • Set up library later. Select this option to postpone setting up the library until a later time.

Configure. Click this button to edit the settings for the library selected next to Use library or the one that is about to be downloaded.

WebServices

Select the checkbox to enable Web Services development support. See also, Preparing to Develop a Web Service.

Item

Description

Generate sample server code

Select this checkbox to have a sample HelloWorld class created in your source folder (e.g. src).

Configure

Click this link to specify the settings for WS engines that you want to use. (The Web Services dialog will open.)

JSF

Select the checkbox to enable JavaServer Faces (JSF) support. See also, Preparing for JSF Application Development.

Item

Description

Version

Select the Thymeleaf version to be supported.

Libraries

You'll need a library that implements Thymeleaf. You can choose to use an existing library, create and use a new one, download the library files if they are not yet available on your computer, or postpone setting up the library until a later time.
  • Use library. Select the library to be used from the list (if the corresponding library is already defined in IntelliJ IDEA).

    Create. If the corresponding library files (.jar) are already available on your computer, you can arrange those files in a library and use that new library. To do that, click Create and select the necessary files in the dialog that opens. (Use the Ctrl key for multiple selections.)

    Optionally, click Configure to edit the selected library. (For an existing library the Edit Library dialog will open, for the library that you have just created - the Create Library dialog.)

  • Download. Select this option to download the library files that implement Thymeleaf. (The downloaded files will be arranged in a library.)

    Optionally, click Configure to edit the library settings and contents. (The Downloading Options dialog will open.)

  • Set up library later. Select this option to postpone setting up the library until a later time.

Configure. Click this button to edit the settings for the library selected next to Use library or the one that is about to be downloaded.

Primefaces, Richfaces, Openfaces, or Icefaces

Select the checkbox to be able to use the corresponding JSF component library (PrimeFaces, RichFaces, OpenFaces, or ICEfaces). See also, Preparing for JSF Application Development.

  • Use library. Select the library to be used from the list (if the corresponding library is already defined in IntelliJ IDEA).

    Create. If the corresponding library files (.jar) are already available on your computer, you can arrange those files in a library and use that new library. To do that, click Create and select the necessary files in the dialog that opens. (Use the Ctrl key for multiple selections.)

    Optionally, click Configure to edit the selected library. (For an existing library the Edit Library dialog will open, for the library that you have just created - the Create Library dialog.)

  • Download. Select this option to download the corresponding JSF component library files. (The downloaded files will be arranged in a library.)

    Optionally, click Configure to edit the library settings and contents. (The Downloading Options dialog will open.)

Configure. Click this button to edit the settings for the library selected next to Use library or the one that is about to be downloaded.

Google App Engine

Select the checkbox to be able to use Google App Engine. See also, Creating Google App Engine Project.

Item

Description

Google App Engine SDK

Specify the path to the Google App Engine SDK for Java installation directory. You can click browseButton and select the corresponding directory in the dialog that opens.

Persistence

If necessary, select the App Engine Datastore implementation to be supported (JDO or JPA).

Download

If the path to Google App Engine SDK is not specified, you can click this link to open the Google App Engine Downloads page. (This page lets you download the latest version of Google App Engine SDK for Java.)

Groovy

Select the checkbox to enable Groovy support.

Select an existing Groovy library or create a new library for Groovy:

  • Use library. Select the Groovy library to be used from the list (if the corresponding library is already defined in IntelliJ IDEA).

  • Create. If Groovy is already installed on your computer, you can create a library for Groovy and use that new library. To do that, click Create and select the Groovy installation directory in the dialog that opens.

Optionally, click Configure to edit the selected library. (For an existing library the Edit Library dialog will open, for the library that you have just created - the Create Library dialog.)

Hibernate

Select the checkbox to enable Hibernate support. See also, Enabling Hibernate Support.

Item

Description

Create default hibernate configuration and main class

Select this checkbox to have a Hibernate configuration file hibernate.cfg.xml and a class with the main() method created.

Import database schema

Select this checkbox to have a database schema imported automatically.

Libraries

You'll need a library that implements Thymeleaf. You can choose to use an existing library, create and use a new one, download the library files if they are not yet available on your computer, or postpone setting up the library until a later time.
  • Use library. Select the library to be used from the list (if the corresponding library is already defined in IntelliJ IDEA).

    Create. If the corresponding library files (.jar) are already available on your computer, you can arrange those files in a library and use that new library. To do that, click Create and select the necessary files in the dialog that opens. (Use the Ctrl key for multiple selections.)

    Optionally, click Configure to edit the selected library. (For an existing library the Edit Library dialog will open, for the library that you have just created - the Create Library dialog.)

  • Download. Select this option to download the library files that implement Thymeleaf. (The downloaded files will be arranged in a library.)

    Optionally, click Configure to edit the library settings and contents. (The Downloading Options dialog will open.)

  • Set up library later. Select this option to postpone setting up the library until a later time.

Configure. Click this button to edit the settings for the library selected next to Use library or the one that is about to be downloaded.

JavaEE Persistence

Select the checkbox to enable Java Persistence API (JPA) support. See also, Enabling JPA Support.

Item

Description

persistence.xml version

Select the version of the persistence.xml file that you want to use.

If you also choose to download the library files that implement JPA (the Download option), the selected version will define which files you will be able to download.

Import database schema

Select this checkbox to have a database schema imported automatically. Optionally, select the JPA implementation-specific database scheme to be imported from the list above the checkbox.

Libraries

You'll need a library that implements Thymeleaf. You can choose to use an existing library, create and use a new one, download the library files if they are not yet available on your computer, or postpone setting up the library until a later time.
  • Use library. Select the library to be used from the list (if the corresponding library is already defined in IntelliJ IDEA).

    Create. If the corresponding library files (.jar) are already available on your computer, you can arrange those files in a library and use that new library. To do that, click Create and select the necessary files in the dialog that opens. (Use the Ctrl key for multiple selections.)

    Optionally, click Configure to edit the selected library. (For an existing library the Edit Library dialog will open, for the library that you have just created - the Create Library dialog.)

  • Download. Select this option to download the library files that implement the selected Thymeleaf version. (The downloaded files will be arranged in a library.)

    Optionally, click Configure to edit the library settings and contents. (The Downloading Options dialog will open.)

  • Set up library later. Select this option to postpone setting up the library until a later time.

Configure. Click this button to edit the settings for the library selected next to Use library or the one that is about to be downloaded.

JBoss Drools

Select the checkbox to enable JBoss Drools support.

You'll need a library that implements Thymeleaf. You can choose to use an existing library, create and use a new one, or download the library files if they are not yet available on your computer.

  • Use library. Select the library to be used from the list (if the corresponding library is already defined in IntelliJ IDEA).

    Create. If the corresponding library files (.jar) are already available on your computer, you can arrange those files in a library and use that new library. To do that, click Create and select the necessary files in the dialog that opens. (Use the Ctrl key for multiple selections.)

    Optionally, click Configure to edit the selected library. (For an existing library the Edit Library dialog will open, for the library that you have just created - the Create Library dialog.)

  • Download. Select this option to download the library files that implement Thymeleaf. (The downloaded files will be arranged in a library.)

    Optionally, click Configure to edit the library settings and contents. (The Downloading Options dialog will open.)

Configure. Click this button to edit the settings for the library selected next to Use library or the one that is about to be downloaded.

OSGi

Select the checkbox to enable OSGi support.

You'll need a library that implements Thymeleaf. You can choose to use an existing library, create and use a new one, download the library files if they are not yet available on your computer, or postpone setting up the library until a later time.

  • Use library. Select the library to be used from the list (if the corresponding library is already defined in IntelliJ IDEA).

    Create. If the corresponding library files (.jar) are already available on your computer, you can arrange those files in a library and use that new library. To do that, click Create and select the necessary files in the dialog that opens. (Use the Ctrl key for multiple selections.)

    Optionally, click Configure to edit the selected library. (For an existing library the Edit Library dialog will open, for the library that you have just created - the Create Library dialog.)

  • Download. Select this option to download the library files that implement Thymeleaf. (The downloaded files will be arranged in a library.)

    Optionally, click Configure to edit the library settings and contents. (The Downloading Options dialog will open.)

  • Set up library later. Select this option to postpone setting up the library until a later time.

Configure. Click this button to edit the settings for the library selected next to Use library or the one that is about to be downloaded.

SQL Support

Select the checkbox to enable SQL support.

Item

Description

Default Dialect

Select the SQL dialect to be used by default for the module. Select Project Default to use the default project SQL dialect.

Thymeleaf

Select the checkbox to enable Thymeleaf support.

You'll need a library that implements Thymeleaf. You can choose to use an existing library, create and use a new one, download the library files if they are not yet available on your computer, or postpone setting up the library until a later time.

  • Use library. Select the library to be used from the list (if the corresponding library is already defined in IntelliJ IDEA).

    Create. If the corresponding library files (.jar) are already available on your computer, you can arrange those files in a library and use that new library. To do that, click Create and select the necessary files in the dialog that opens. (Use the Ctrl key for multiple selections.)

    Optionally, click Configure to edit the selected library. (For an existing library the Edit Library dialog will open, for the library that you have just created - the Create Library dialog.)

  • Download. Select this option to download the library files that implement Thymeleaf. (The downloaded files will be arranged in a library.)

    Optionally, click Configure to edit the library settings and contents. (The Downloading Options dialog will open.)

  • Set up library later. Select this option to postpone setting up the library until a later time.

Configure. Click this button to edit the settings for the library selected next to Use library or the one that is about to be downloaded.

WebServices Client

Select the checkbox to enable Web Services client development support. See also, Enabling Web Service Client Development Support.

Item

Description

Generate sample client code

Select this checkbox to have sample client code generated in your source folder (e.g. src).

To generate the code, IntelliJ IDEA will ask you to specify the corresponding WSDL file.

Configure

Click this link to specify the settings for WS engines that you want to use. (The Web Services dialog will open.)

Batch Applications

Select the checkbox to enable Batch Applications development support.

Item

Description

Create batch.xml

Select the checkbox to create a META-INF\batch.xml mappings file (one with the <batch-artifacts> root element).

Create Sample Job Xml

Select the checkbox to create a sample job XML file (META-INF\batch-jobs\job.xml).

Libraries

You'll need a library that implements the batch framework. You can choose to use an existing library, create and use a new one, download the library files if they are not yet available on your computer, or postpone setting up the library until a later time.
  • Use library. Select the library to be used from the list (if the corresponding library is already defined in IntelliJ IDEA).

    Create. If the corresponding library files (.jar) are already available on your computer, you can arrange those files in a library and use that new library. To do that, click Create and select the necessary files in the dialog that opens. (Use the Ctrl key for multiple selections.)

    Optionally, click Configure to edit the selected library. (For an existing library the Edit Library dialog will open, for the library that you have just created - the Create Library dialog.)

  • Download. Select this option to download the files that implement the batch framework. (The downloaded files will be arranged in a library.)

    Optionally, click Configure to edit the library settings and contents. (The Downloading Options dialog will open.)

  • Set up library later. Select this option to postpone setting up the library until a later time.

Configure. Click this button to edit the settings for the library selected next to Use library or the one that is about to be downloaded.

CDI: Contexts and Dependency Injection

Select the checkbox to enable Contexts and Dependency Injection (CDI) support.

You'll need a library that implements Thymeleaf. You can choose to use an existing library, create and use a new one, or download the library files if they are not yet available on your computer.

  • Use library. Select the library to be used from the list (if the corresponding library is already defined in IntelliJ IDEA).

    Create. If the corresponding library files (.jar) are already available on your computer, you can arrange those files in a library and use that new library. To do that, click Create and select the necessary files in the dialog that opens. (Use the Ctrl key for multiple selections.)

    Optionally, click Configure to edit the selected library. (For an existing library the Edit Library dialog will open, for the library that you have just created - the Create Library dialog.)

  • Download. Select this option to download the library files that implement Thymeleaf. (The downloaded files will be arranged in a library.)

    Optionally, click Configure to edit the library settings and contents. (The Downloading Options dialog will open.)

Configure. Click this button to edit the settings for the library selected next to Use library or the one that is about to be downloaded.

DM Server

Select the checkbox to be able to use SpringSource dm Server and develop dm Server-targeted applications.

Item

Description

Server

Select the server to be used from the list (if the corresponding server is already defined in IntelliJ IDEA).

To define a server in IntelliJ IDEA, click Add and specify the server settings in the Spring dmServer dialog that opens.

Facet

Select the deployment artifact type that the module will implement (the Spring DM facet type in IntelliJ IDEA terms):

For more information on dm Server deployment artifacts, see "Deployment Architecture" and "Developing Applications" in SpringSource dm Server Programmer Guide.

Bundle options

Spring DM Support

Select this checkbox to enable Spring support (to create a Spring facet in IntelliJ IDEA terms). As a result, IntelliJ IDEA will create the following files:
  • META-INF\spring\module-context.xml

  • META-INF\spring\osgi-context.xml

At this step you are not suggested to download the library files that implement Spring. However, you will be able to do that after the module has been created by using the corresponding quick fix in the Project Structure dialog.

Web module

Select this checkbox to enable generic Web application development support (to create a Web facet in IntelliJ IDEA terms). Specify the associated settings:
  • Version. Select the version of the Servlet specification to be supported.

  • Create web.xml. For version 3.0 or later: select this checkbox to create the deployment descriptor file web.xml. (For earlier versions, this file is always created.)

As a result, IntelliJ IDEA will create web\WEB-INF\web.xml (for version 3.0 or later - if so specified).

PAR or Plan options

Name

For a PAR, this is the application identifier (Application-SymbolicName), for a plan - the plan name (the name attribute of the <plan> element).

Version

The application or the plan version (Application-Version or the version attribute of the <plan> element).

Plan

Select this option to create a plan. IntelliJ IDEA will create:
  • A .plan XML file.

  • A dm Plan artifact specification.

Platform Archive (PAR)

Select this option to create a PAR. IntelliJ IDEA will create:
  • The META-INF\MANIFEST.MF file for the PAR.

  • A dm Platform Archive artifact specification.

Scoped

For a plan: select this checkbox to make the plan scoped (corresponds to scoped="true" within the <plan> element).

Atomic

For a plan: select this checkbox to make the plan atomic (corresponds to atomic="true" within the <plan> element).

Nested bundles

Use the controls in this area to manage other dm Server deployment artifacts within the PAR or plan. (In IntelliJ IDEA, these are represented by other modules within the same project if those modules have suitable dm Server facets. A PAR may include OSGi bundles and configuration artifacts; a plan - OSGi bundles, configuration artifacts, PARs and other plans).
  • Add. Use this button to add the artifacts to the list. Select the necessary artifacts (IntelliJ IDEA modules) in the dialog that opens.

  • Remove. Use this button to remove the selected artifacts from the list.

  • Up. For a plan: use this button to move the selected artifact one line up in the list. (The order of artifacts defines their deployment order.)

  • Down. For a plan: use this button to move the selected artifact one line down in the list.

  • Versions. For a plan: use this button to specify the version or the range of versions for the selected artifact (corresponds to the version attribute of the <artifact> element).

Configuration option

Name

Specify the OSGi name of the artifact (at the deployment stage, corresponds to the name of the file).

EJB: Enterprise JavaBeans

Select the checkbox to enable Enterprise JavaBeans (EJB) support. See also, Enabling EJB Support.

Item

Description

Version

Select the Thymeleaf version to be supported.

If you also choose to download the library files that implement Thymeleaf (the Download option), the selected version will define which files you will be able to download.

Libraries

You'll need a library that implements Thymeleaf. You can choose to use an existing library, create and use a new one, download the library files if they are not yet available on your computer, or postpone setting up the library until a later time.
  • Use library. Select the library to be used from the list (if the corresponding library is already defined in IntelliJ IDEA).

    Create. If the corresponding library files (.jar) are already available on your computer, you can arrange those files in a library and use that new library. To do that, click Create and select the necessary files in the dialog that opens. (Use the Ctrl key for multiple selections.)

    Optionally, click Configure to edit the selected library. (For an existing library the Edit Library dialog will open, for the library that you have just created - the Create Library dialog.)

  • Download. Select this option to download the library files that implement the selected Thymeleaf version. (The downloaded files will be arranged in a library.)

    Optionally, click Configure to edit the library settings and contents. (The Downloading Options dialog will open.)

  • Set up library later. Select this option to postpone setting up the library until a later time.

Configure. Click this button to edit the settings for the library selected next to Use library or the one that is about to be downloaded.

Google Web Toolkit

Select the checkbox to be able to use Google Web Toolkit (GWT). See also, Enabling GWT Support.

Item

Description

GWT SDK

Specify the path to the GWT SDK installation directory. You can click browseButton and select the corresponding directory in the dialog that opens.

Create sample application

Select this checkbox to have a sample application created. Specify the package for the application classes in the field underneath.

Download GWT

If the path to GWT SDK is not specified: you can click this link to open the Google Web Toolkit Downloads page. (This page lets you download a GWT SDK.)

JavaEE Application

The features that become available when you select this checkbox are mainly related to packaging your Java EE application in an Enterprise Application Archive (EAR). For more information, see Enabling Java EE Application Support.

Item

Description

Version

The Java EE version.

RESTful WebServices

Select the checkbox to enable RESTful Web Services (client and server) development support. See also, RESTful WebServices.

Item

Description

Generate server code

Select this checkbox to have a sample HelloWorld server class created in your source folder (e.g. src).

Generate client code

Select this checkbox to have a sample HelloWorldClient class created in your source folder (e.g. src).

Libraries

You'll need a library that implements the JAX-RS API. You can choose to use an existing library, create and use a new one, download the library files if they are not yet available on your computer, or postpone setting up the library until a later time.
  • Use library. Select the library to be used from the list (if the corresponding library is already defined in IntelliJ IDEA).

    Create. If the corresponding library files (.jar) are already available on your computer, you can arrange those files in a library and use that new library. To do that, click Create and select the necessary files in the dialog that opens. (Use the Ctrl key for multiple selections.)

    Optionally, click Configure to edit the selected library. (For an existing library the Edit Library dialog will open, for the library that you have just created - the Create Library dialog.)

  • Download. Select this option to download the files that implement the JAX-RS API. (The downloaded files will be arranged in a library.)

    Optionally, click Configure to edit the library settings and contents. (The Downloading Options dialog will open.)

  • Set up library later. Select this option to postpone setting up the library until a later time.

Configure. Click this button to edit the settings for the library selected next to Use library or the one that is about to be downloaded.

Tapestry

Select the checkbox to enable Apache Tapestry support. See also, Enabling Tapestry Support.

You'll need a library that implements Thymeleaf. You can choose to use an existing library, create and use a new one, download the library files if they are not yet available on your computer, or postpone setting up the library until a later time.

  • Use library. Select the library to be used from the list (if the corresponding library is already defined in IntelliJ IDEA).

    Create. If the corresponding library files (.jar) are already available on your computer, you can arrange those files in a library and use that new library. To do that, click Create and select the necessary files in the dialog that opens. (Use the Ctrl key for multiple selections.)

    Optionally, click Configure to edit the selected library. (For an existing library the Edit Library dialog will open, for the library that you have just created - the Create Library dialog.)

  • Download. Select this option to download the library files that implement Thymeleaf. (The downloaded files will be arranged in a library.)

    Optionally, click Configure to edit the library settings and contents. (The Downloading Options dialog will open.)

  • Set up library later. Select this option to postpone setting up the library until a later time.

Configure. Click this button to edit the settings for the library selected next to Use library or the one that is about to be downloaded.

Spring

Select the checkbox to enable Spring support. See also, Spring.

You'll need a library that implements Thymeleaf. You can choose to use an existing library, create and use a new one, download the library files if they are not yet available on your computer, or postpone setting up the library until a later time.

  • Use library. Select the library to be used from the list (if the corresponding library is already defined in IntelliJ IDEA).

    Create. If the corresponding library files (.jar) are already available on your computer, you can arrange those files in a library and use that new library. To do that, click Create and select the necessary files in the dialog that opens. (Use the Ctrl key for multiple selections.)

    Optionally, click Configure to edit the selected library. (For an existing library the Edit Library dialog will open, for the library that you have just created - the Create Library dialog.)

  • Download. Select this option to download the library files that implement Thymeleaf. (The downloaded files will be arranged in a library.)

    Optionally, click Configure to edit the library settings and contents. (The Downloading Options dialog will open.)

  • Set up library later. Select this option to postpone setting up the library until a later time.

Configure. Click this button to edit the settings for the library selected next to Use library or the one that is about to be downloaded.

Spring MVC, Spring Batch, or other Spring framework

Select a checkbox to add support for a particular Spring framework (e.g. Spring MVC, Spring Batch, etc.). See also, Spring.

You'll need a library that implements Thymeleaf. You can choose to use an existing library, create and use a new one, or download the library files if they are not yet available on your computer.

  • Use library. Select the library to be used from the list (if the corresponding library is already defined in IntelliJ IDEA).

    Create. If the corresponding library files (.jar) are already available on your computer, you can arrange those files in a library and use that new library. To do that, click Create and select the necessary files in the dialog that opens. (Use the Ctrl key for multiple selections.)

    Optionally, click Configure to edit the selected library. (For an existing library the Edit Library dialog will open, for the library that you have just created - the Create Library dialog.)

  • Download. Select this option to download the library files that implement Thymeleaf. (The downloaded files will be arranged in a library.)

    Optionally, click Configure to edit the library settings and contents. (The Downloading Options dialog will open.)

Configure. Click this button to edit the settings for the library selected next to Use library or the one that is about to be downloaded.

Last modified: 7 December 2018

See Also