Enable web service client development support

Install the Jakarta EE: Web Services (JAX-WS) plugin

This functionality relies on the plugin, which you need to install and enable.

1. Press Ctrl+Alt+S to open settings and then select Plugins.

2. Find the Jakarta EE: Web Services (JAX-WS) plugin, and click Install. Restart the IDE if prompted.

Create a new Jakarta EE project with JAX-WS

1. Open the New Project wizard:

   • If you are on the Home screen, select New | Project….

   • If you have another project open, go to File | New | Project.

2. From the Generators list on the left, select Jakarta EE.

   

3. Select the Web application template and set up the rest of the Jakarta EE project settings.

   When you are ready, click Next.

4. From the Version drop-down list, select the Jakarta EE version you want to use.

5. From the Dependencies list, select XML Web Services (JAX-WS) and any additional specifications or implementations you want to include in your project. Because of the web application template, the Servlet specification is already selected.

   

6. Click Create.

For more information about creating Jakarta EE projects, such as how to set up an application server, refer to Tutorial: Your first Jakarta EE application.

Add JAX-WS to an existing project

1. Open the build file in the editor (pom.xml or build.gradle depending on the build tool used in your project).

2. Add the JAX-WS library, and make sure its version matches the rest of your project:

   Jakarta EE

   <dependency> <groupId>jakarta.xml.ws</groupId> <artifactId>jakarta.xml.ws-api</artifactId> <version>4.0.2</version> </dependency>

   Java EE

   <dependency> <groupId>javax.xml.ws</groupId> <artifactId>jaxws-api</artifactId> <version>2.3.1</version> </dependency> <dependency> <groupId>javax.jws</groupId> <artifactId>javax.jws-api</artifactId> <version>1.1</version> </dependency>

   Jakarta EE

   implementation 'jakarta.xml.ws:jakarta.xml.ws-api:4.0.2'

   Java EE

   implementation 'javax.xml.ws:jaxws-api:2.3.1' implementation 'javax.jws:javax.jws-api:1.1'

   Jakarta EE

   implementation("jakarta.xml.ws:jakarta.xml.ws-api:4.0.2")

   Java EE

   implementation("javax.xml.ws:jaxws-api:2.3.1") implementation("javax.jws:javax.jws-api:1.1")

3. Press Ctrl+Shift+O to import the changes.

For more information about working with build tools, refer to Maven or Gradle.

Enable support for any web service engine

IntelliJ IDEA uses facets to enable support for the most common web service engines. However, you can enable any web service engine or implementation version, even if it is not supported by IntelliJ IDEA facets.

1. Download the desired web service engine implementation.

2. Press Ctrl+Alt+S to open settings and then select Tools | Web Services. Specify the path to the external web service engine, desired server name and port, and other options For more information, refer to Web Services.