-
Notifications
You must be signed in to change notification settings - Fork 340
/
dependencies.xml
236 lines (204 loc) · 11.5 KB
/
dependencies.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2010, 2024 Oracle and/or its affiliates. All rights reserved.
This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0, which is available at
http://www.eclipse.org/legal/epl-2.0.
This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the
Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
version 2 with the GNU Classpath Exception, which is available at
https://www.gnu.org/software/classpath/license.html.
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-->
<!DOCTYPE chapter [<!ENTITY % ents SYSTEM "jersey.ent"> %ents;]>
<chapter xmlns="http://docbook.org/ns/docbook"
version="5.0"
xml:lang="en"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xsi:schemaLocation="http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd"
xml:id="modules-and-dependencies">
<title>Modules and dependencies</title>
<section>
<title>Java SE Compatibility</title>
<para>
<emphasis>2.x branch: </emphasis>
<itemizedlist>
<listitem>
<para>Until version 2.6, Jersey was compiled with Java SE 6. This has changed in Jersey 2.7.</para>
</listitem>
<listitem>
<para>Up to version 2.25.x almost all Jersey components are compiled with Java SE 7 target.
It means, that you will need at least Java
SE 7 to be able to compile and run your application that is using latest Jersey.
Only <literal>core-common</literal> and <literal>core-client</literal> modules are still compiled with Java class
version runnable with Java SE 6.</para>
</listitem>
<listitem>
<para>Since Jersey 2.26, all modules are build using Java SE 8 and there is no support for running it
on older Java SE distributions.</para>
</listitem>
<listitem>
<para>Since Jersey 2.29, all modules can be built using Java SE 11 and all distributed modules provide support
for Java SE 8 and 11.</para>
</listitem>
<listitem>
<para>Since Jersey 2.30, Jersey adds support for JDK 12 and 13. Since Jersey 2.31, Jersey adds support for
JDK 14 and 15. Since Jersey 2.33, Jersey adds support for JDK 16. Since Jersey 2.35, Jersey adds
support for JDK 17. Since Jersey 2.36 Jersey adds support for JDK 18 and 19. Since Jersey 2.38,
Jersey adds support for JDK 20. Since Jersey 2.40, Jersey supports JDK 21. Since Jersey 2.41,
Jersey supports JDK 22.</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Introduction to Jersey dependencies</title>
<para>
Jersey is built, assembled and installed using <link xlink:href="http://maven.apache.org/">Apache Maven</link>.
Non-snapshot Jersey releases are deployed to the
<link xlink:href="https://search.maven.org/">Central Maven Repository</link>. Jersey is also being deployed to
<link xlink:href="https://oss.sonatype.org/">Sonatype Maven repositories</link>, which contain also Jersey SNAPSHOT
versions. In case you would want to test the latest development builds check out the
<link xlink:href="https://oss.sonatype.org/content/repositories/snapshots/org/glassfish/jersey">
Sonatype Snapshots Maven repository</link>.
</para>
<para>
An application that uses Jersey and depends on Jersey modules is in turn required to also include in the application
dependencies the set of 3rd party modules that Jersey modules depend on. Jersey is designed as a pluggable component
architecture and different applications can therefore require different sets of Jersey modules. This also means that
the set of external Jersey dependencies required to be included in the application dependencies may vary in each
application based on the Jersey modules that are being used by the application.
</para>
<para>
Developers using Maven or a Maven-aware build system in their projects are likely to find it easier to include and
manage dependencies of their applications compared to developers using ant or other build systems that are not
compatible with Maven. This document will explain to both maven and non-maven developers how to depend on
Jersey modules in their application. Ant developers are likely to find the
<link xlink:href="http://maven.apache.org/ant-tasks/index.html">Ant Tasks for Maven</link> very useful.
</para>
</section>
<section xml:id="dependencies">
<title>Common Jersey Use Cases</title>
<section xml:id="servlet-app-glassfish">
<title>Servlet based application on Glassfish</title>
<para>If you are using Glassfish application server, you don't need to package
anything with your application, everything is already included. You just need to declare
(provided) dependency on JAX-RS API to be able to compile your application.
</para>
<programlisting language="xml"><dependency>
<groupId>jakarta.ws.rs</groupId>
<artifactId>jakarta.ws.rs-api</artifactId>
<version>&jax-rs-api-jar.version;</version>
<scope>provided</scope>
</dependency></programlisting>
<para>If you are using any Jersey specific feature, you will need to depend on Jersey directly.</para>
<programlisting language="xml"><dependency>
<groupId>org.glassfish.jersey.containers</groupId>
<artifactId>jersey-container-servlet</artifactId>
<version>&version;</version>
<scope>provided</scope>
</dependency>
<!-- if you are using Jersey client specific features without the server side -->
<dependency>
<groupId>org.glassfish.jersey.core</groupId>
<artifactId>jersey-client</artifactId>
<version>&version;</version>
<scope>provided</scope>
</dependency>
</programlisting>
</section>
<section xml:id="servlet-app-general">
<title>Servlet based server-side application</title>
<para>Following dependencies apply to application server (servlet containers) without any
integrated JAX-RS implementation. Then application needs to include JAX-RS API and Jersey
implementation in deployed application.</para>
<programlisting language="xml"><dependency>
<groupId>org.glassfish.jersey.containers</groupId>
<!-- if your container implements Servlet API older than 3.0, use "jersey-container-servlet-core" -->
<artifactId>jersey-container-servlet</artifactId>
<version>&version;</version>
</dependency>
<!-- Required only when you are using JAX-RS Client -->
<dependency>
<groupId>org.glassfish.jersey.core</groupId>
<artifactId>jersey-client</artifactId>
<version>&version;</version>
</dependency></programlisting>
</section>
<section xml:id="client-jdk">
<title>Client application on JDK</title>
<para>Applications running on plain JDK using only client part of JAX-RS specification need
to depend only on client. There are various additional modules which can be added, like
for example grizzly or apache or jetty connector (see dependencies snipped below). Jersey client
runs by default with plain JDK (using HttpUrlConnection). See <xref linkend="client"/>.
for more details.
</para>
<programlisting language="xml"><dependency>
<groupId>org.glassfish.jersey.core</groupId>
<artifactId>jersey-client</artifactId>
<version>&version;</version>
</dependency>
</programlisting>
<para>Currently available connectors:</para>
<programlisting language="xml"><dependency>
<groupId>org.glassfish.jersey.connectors</groupId>
<artifactId>jersey-grizzly-connector</artifactId>
<version>&version;</version>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.connectors</groupId>
<artifactId>jersey-apache-connector</artifactId>
<version>&version;</version>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.connectors</groupId>
<artifactId>jersey-jetty-connector</artifactId>
<version>&version;</version>
</dependency></programlisting>
</section>
<section xml:id="server-jdk">
<title>Server-side application on supported containers</title>
<para>Apart for a standard JAX-RS Servlet-based deployment that works with any Servlet container that
supports Servlet 2.5 and higher,
Jersey provides support for programmatic deployment to the following containers: Grizzly 2 (HTTP and Servlet),
JDK Http server, Simple Http server and Jetty Http server. This chapter presents only required maven dependencies,
more information can be found in <xref linkend="deployment"/>.
</para>
<programlisting language="xml"><dependency>
<groupId>org.glassfish.jersey.containers</groupId>
<artifactId>jersey-container-grizzly2-http</artifactId>
<version>&version;</version>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.containers</groupId>
<artifactId>jersey-container-grizzly2-servlet</artifactId>
<version>&version;</version>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.containers</groupId>
<artifactId>jersey-container-jdk-http</artifactId>
<version>&version;</version>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.containers</groupId>
<artifactId>jersey-container-simple-http</artifactId>
<version>&version;</version>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.containers</groupId>
<artifactId>jersey-container-jetty-http</artifactId>
<version>&version;</version>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.containers</groupId>
<artifactId>jersey-container-jetty-servlet</artifactId>
<version>&version;</version>
</dependency></programlisting>
</section>
</section>
<xi:include href="modules.xml" />
</chapter>