how to add the servlet api to my pom.xml

Question

How do I add the servlets API to my project's pom.xml

mvnrepository.com has lots of servlet api and similarly named projects, that I don't know which is the right one. Or are all of them ok?

For some version --> http://mvnrepository.com/artifact/javax.servlet/javax.servlet-api/3.1.0 . On that link you will find XML snippets that allow to add it as a dependency. You can choose another version, of course, just take note of "Note: There is a new version for this artifact" — Andrejs, Mar 18 '16 at 17:35

score 50 · Accepted Answer · edited Oct 26 '16 at 14:58

50

I believe most web/app servers come bundled with a version of the servlet api, so you won't want to bundle the api in your .war file. You will need to find out which version is included with your server, then you can use

<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>servlet-api</artifactId>
    <version>${servlet-api-version}</version>
    <scope>provided</scope>
</dependency>

replacing servlet-api-version with your version. You will want to specify the "provided" scope so the api.jar isn't included in your war file.

edited Oct 26 '16 at 14:58

Mr. Polywhirl

42,981
12
84
132

answered Sep 02 '09 at 23:44

digitaljoel

26,265
15
89
115

you have to add the servlet-api-version in the properties tag also ? – Neil May 30 '13 at 07:59
preferably, yes, or you could just put the version directly in the version tag if you prefer. – digitaljoel May 30 '13 at 15:17

score 4 · Answer 2 · answered May 30 '13 at 07:58

4

    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>servlet-api</artifactId>
        <version>2.5</version>
        <scope>provided</scope>
    </dependency>

answered May 30 '13 at 07:58

Neil

5,919
15
58
85

score 3 · Answer 3 · edited Feb 18 '16 at 13:41

3

For servlet-api 3.1.0, here is the declaration :

<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>3.1.0</version>
</dependency>

edited Feb 18 '16 at 13:41

Adam

5,215
5
51
90

answered Dec 03 '15 at 07:12

amgohan

1,358
3
14
24

2

On [mvnrepository](http://mvnrepository.com) on the entry for `javax.servlet:servlet-api:3.0-alpha-1` someone has written (and I have no idea who): _Note: This artifact was moved to: New Group javax.servlet New Artifact javax.servlet-api_ . So the seemingly more correct `javax.servlet:servlet-api` is not actually the correct one. – Adam Feb 18 '16 at 12:55
Awesome, thanks, still begs the question, how did _you_ know? Kindly share the maven-fu :) – John Jan 07 '17 at 14:52

Michael Rutherfurd · Answer 4 · 2009-09-03T05:37:55.993

2

We use

<dependency>
    <groupId>javax</groupId>
    <artifactId>j2ee</artifactId>
    <version>1.4</version>
    <scope>provided</scope>
</dependency>

but if you only need the servlet api you might want to use

<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>servlet-api</artifactId>
    <version>?</version>
    <scope>provided</scope>
</dependency>

edited Sep 03 '09 at 05:37

answered Sep 02 '09 at 23:31

Michael Rutherfurd

13,815
5
29
40

score 0 · Answer 5 · edited Oct 20 '12 at 03:12

0

Scope provided can be used when you dont want to put jar file inside the WEB-INF/lib folder instead you are supplying it at runtime either by container or JDK.

edited Oct 20 '12 at 03:12

TheCodeArtist

21,479
4
69
130

answered Jun 21 '12 at 10:30

Rajkumar Singh

29
2

score 0 · Answer 6 · answered Sep 02 '09 at 23:23

0

It depends on which version of the servlet API you are using.

The javax.servlet artifact will provide jars for all of the servlet API versions.

answered Sep 02 '09 at 23:23

Vineet Reynolds

76,006
17
150
174

Basil Bourque · Answer 7 · 2022-02-20T07:55:12.730

Jakarta EE

In recent years, Oracle transferred the Java EE technologies to the Eclipse Foundation. There the technologies have been renamed to Jakarta EE. So Java Servlet is now known as Jakarta Servlet.

This name change was done to respect Oracle’s trademarks. Do a Web search to find many articles and videos discussing this transition.

This name change includes changing the package naming of the classes from javax.* to jakarta.*. This is a breaking change, though updating your project may be as simple as merely changing your import statements. But check that any libraries you depend on have versions available using the new naming as well.

Servlet 5

This transition has brought new versions of the Servlet specification. Version 5 of the spec is the same as Servlet 4 but with the new naming.

For the current version, edit your POM file to use the following Maven dependency. Check for updates in a Maven repository of your choice in the version numbering.

You can deploy web apps built with Servlet 5 to web containers such as Tomcat 10.0.x, Jetty 11.0.x, Glassfish 6, and several more.

<dependency>
    <groupId>jakarta.servlet</groupId>
    <artifactId>jakarta.servlet-api</artifactId>
    <version>5.0.0</version>
    <scope>provided</scope>
</dependency>

Servlet 6

Jakarta Servlet 6 specification is currently in development, and will contain significant changes. The spec will be finalized later this year 2022.

See the overview page, the product page, project links page, and repository coordinates page.

<dependency>
    <groupId>jakarta.servlet</groupId>
    <artifactId>jakarta.servlet-api</artifactId>
    <version>6.0.0</version>
    <scope>provided</scope>
</dependency>

how to add the servlet api to my pom.xml

7 Answers7

Jakarta EE

Servlet 5

Servlet 6

Linked