Table of Contents
Jersey is built, assembled and installed using Maven. Jersey is deployed to the Java.Net maven repository at the following location: http://maven.java.net/. The Jersey modules can be browsed at the following location: https://maven.java.net/content/repositories/releases/com/sun/jersey. Jars, Jar sources, Jar JavaDoc and samples are all available on the java.net maven repository.
A zip file containing all maven-based samples can be obtained here. Individual zip files for each sample may be found by browsing the samples directory.
An application depending on Jersey requires that it in turn includes the set of jars that Jersey depends on. Jersey has a pluggable component architecture so the set of jars required to be include in the class path can be different for each application.
All Jersey components are built using Java SE 6 compiler. It means, you will also need at least Java SE 6 to be able to compile and run your application.
Developers using maven are likely to find it easier to include and manage dependencies of their applications than developers using ant or other build technologies. This document will explain to both maven and non-maven developers how to depend on Jersey for their application. Ant developers are likely to find the Ant Tasks for Maven very useful. For the convenience of non-maven developers the following are provided:
A zip of Jersey containing the Jersey jars, core dependencies (it does not provide dependencies for third party jars beyond those for JSON support) and JavaDoc.
A jersey bundle jar to avoid the dependency management of multiple jersey-based jars.
Jersey's runtime dependences are categorized into the following:
Core server. The minimum set of dependences that Jersey requires for the server.
Core client. The minimum set of dependences that Jersey requires for the client.
Container. The set of container dependences. Each container provider has it's own set of dependences.
Entity. The set of entity dependencies. Each entity provider has it's own set of dependences.
Tools. The set of dependencies required for runtime tooling.
Spring. The set of dependencies required for Spring.
Guice. The set of dependencies required for Guice.
All dependences in this documented are referenced by hyper-links
Maven developers require a dependency on the jersey-server module. The following dependency needs to be added to the pom:
<dependency>
<groupId>com.sun.jersey</groupId>
<artifactId>jersey-server</artifactId>
<version>1.19.1</version>
</dependency>
If you want to depend on Jersey snapshot versions the following repository needs to be added to the pom:
<repository>
<id>snapshot-repository.java.net</id>
<name>Java.net Snapshot Repository for Maven</name>
<url>https://maven.java.net/content/repositories/snapshots/</url>
<layout>default</layout>
</repository>
Non-maven developers require:
or, if using the jersey-bundle:
For Ant developers the Ant Tasks for Maven may be used to add the following to the ant document such that the dependencies do not need to be downloaded explicitly:
<artifact:dependencies pathId="dependency.classpath">
<dependency groupId="com.sun.jersey"
artifactId="jersey-server"
version="1.19.1"/>
<artifact:remoteRepository id="maven-repository.java.net"
url="http://maven.java.net/" />
<artifact:remoteRepository id="maven1-repository.java.net"
url="http://download.java.net/maven/1"
layout="legacy" />
</artifact:dependencies>The path id “dependency.classpath” may then be referenced as the classpath to be used for compiling or executing.
By default Jersey will utilize the ClasspathResourceConfig if an alternative is not specified.
Maven developers require a dependency on the jersey-client module. The following dependency needs to be added to the pom:
<dependency>
<groupId>com.sun.jersey</groupId>
<artifactId>jersey-client</artifactId>
<version>1.19.1</version>
</dependency>Non-maven developers require:
or, if using the jersey-bundle:
The use of client with the Apache HTTP client to make HTTP request and receive HTTP responses requires a dependency on the jersey-apache-client module. The following dependency needs to be added to the pom:
<dependency>
<groupId>com.sun.jersey.contribs</groupId>
<artifactId>jersey-apache-client</artifactId>
<version>1.19.1</version>
</dependency>
Maven developers, deploying an application using the Grizzly2 HTTP Web server, require a dependency on the jersey-grizzly2 module.
Non-maven developers require: jersey-grizzly2.jar, grizzly-http-server.jar, and grizzly-http.jar
Maven developers, deploying an application using the Grizzly Servlet container, require a dependency on the jersey-grizzly2-servlet module.
Non-maven developers require: jersey-grizzly2-servlet.jar, grizzly-http-servlet.jar, jersey-grizzly2.jar, javax.servlet-3.1.jar
Maven developers, deploying an application using the Simple HTTP Web server, require a dependency on the jersey-simple-server module.
Deploying an application using the light weight HTTP server requires no additional dependences, as Java SE 6 already contains everything needed.
Deploying an application on a servlet container requires a deployment dependency with that container.
See the Java documentation here on how to configure the servlet container.
Using servlet:
com.sun.jersey.spi.container.servlet.ServletContainer
requires a dependency on the jersey-servlet module.
Maven developers using servlet:
com.sun.jersey.server.impl.container.servlet.ServletAdaptor
in a non-EE 5 servlet require a dependency on the persistence-api
module in addition.
Non-Maven developers require: persistence-api.jar
XML serialization support of Java types that are JAXB beans requires a dependency on the JAXB reference implementation version 2.x or higher (see later for specific version constraints with respect to JSON support). Deploying an application for XML serialization support requires no additional dependencies, since Java SE 6 ships with JAXB 2.x support. Alternatively, instead of JAXB RI, you can use MOXy as your JAXB implementation (version of 2.3.x or higher is required)
Maven developers, using JSON serialization support of JAXB beans
when using the MIME media type application/json require a
dependency on the jersey-json
module (no explicit dependency on jaxb-impl is required). This module
depends on the JAXB reference implementation version 2.1.12 or greater,
and such a version is required when enabling support for the JAXB
natural JSON convention. For all other supported JSON conventions any
JAXB 2.x version may be utilized. The following dependency needs to be
added to the pom:
<dependency>
<groupId>com.sun.jersey</groupId>
<artifactId>jersey-json</artifactId>
<version>1.19.1</version>
</dependency>
Non-maven developers require:
and additionally, if not depending on the jersey-bundle.jar, non-maven developers require: jersey-json.jar
Note: Jersey JSON module of version 1.13 and later requires the jackson-core-asl.jar library to be present on the classpath.
Maven developers, using Fast Infoset serialization support of JAXB
beans with using the MIME media type
application/fastinfoset require a dependency on the jersey-fastinfoset
module (no dependency on jaxb-impl is required). The following
dependency needs to be added to the pom:
<dependency>
<groupId>com.sun.jersey</groupId>
<artifactId>jersey-fastinfoset</artifactId>
<version>1.19.1</version>
</dependency>
Non-maven developers require:
and additionally, if not depending on the jersey-bundle.jar, non-maven developers require: jersey-fastinfoset.jar
Maven developers, using JSON serialization support of JAXB beans
when using the MIME media type application/json require a
dependency on the jersey-json
module (explicit dependency on org.eclipse.persistence.moxy is required). The following dependencies need to be
added to the pom:
<dependency>
<groupId>com.sun.jersey</groupId>
<artifactId>jersey-json</artifactId>
<version>1.19.1</version>
<exclusions>
<exclusion>
<exclusion>com.sun.xml.bind<exclusion>
<exclusion>jaxb-impl<exclusion>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.eclipse.persistence</groupId>
<artifactId>org.eclipse.persistence.moxy</artifactId>
<version>2.3.2</version>
</dependency>
Also an additional repository should be added to the pom:
<repository>
<id>eclipselink.repository</id>
<name>Eclipse Maven Repository</name>
<url>http://www.eclipse.org/downloads/download.php?r=1&nf=1&file=/rt/eclipselink/maven.repo</url>
<layout>default</layout>
</repository>
Non-maven developers require:
and additionally, if not depending on the jersey-bundle.jar, non-maven developers require: jersey-json.jar
For further information on how to set MOXy as your JAXB provider, refer to the: Specifying EclipseLink MOXy as Your JAXB Provider
Note: Jersey JSON module of version 1.13 and later requires the jackson-core-asl.jar library to be present on the classpath.
The use of the Java types
org.apache.abdera.model.{Categories, Entry, Feed, Service}
requires a dependency on Apache Abdera.
Maven developers require a dependency on the jersey-atom-abdera module. The following dependency needs to be added to the pom:
<dependency>
<groupId>com.sun.jersey.contribs</groupId>
<artifactId>jersey-atom-abdera</artifactId>
<version>1.19.1</version>
</dependency>
The use of the Java types
com.sun.syndication.feed.atom.Entry and
com.sun.syndication.feed.atom.Feed requires a dependency on
ROME version 0.9 or higher.
Maven developers require a dependency on the jersey-atom module. The following dependency needs to be added to the pom:
<dependency>
<groupId>com.sun.jersey</groupId>
<artifactId>jersey-atom</artifactId>
<version>1.19.1</version>
</dependency>
Non-maven developers require:
and additionally, if not depending on the jersey-bundle.jar, non-maven developers require: jersey-atom.jar
The use of the Java types
org.codehaus.jettison.json.JSONObject and
org.codehaus.jettison.json.JSONArray requires Jettison
version 1.1 or higher.
Maven developers require a dependency on the jersey-json module. The following dependency needs to be added to the pom:
<dependency>
<groupId>com.sun.jersey</groupId>
<artifactId>jersey-json</artifactId>
<version>1.19.1</version>
</dependency>
Non-maven developers require: jettison.jar and additionally, if not depending on the jersey-bundle.jar non-maven developers require: jersey-json.jar
The use of the Java type
javax.mail.internet.MimeMultipart
requires Java Mail version 1.4 or higher.
Maven developers require a dependency on the java-mail module.
Non-maven developers require:
Jersey ships with a high-level MIME multipart API. Maven developers requires a dependency on the jersey-multipart module. The following dependency needs to be added to the pom:
<dependency>
<groupId>com.sun.jersey.contribs</groupId>
<artifactId>jersey-multipart</artifactId>
<version>1.19.1</version>
</dependency>
Non-maven developers require:
By default WADL for resource classes is generated dynamically at runtime. WADL support requires a dependency on the JAXB reference implementation version 2.x or higher. Deploying an application for WADL support requires no additional dependences, since Java SE 6 ships with JAXB 2.x support.
The WADL ant task requires the same set of dependences as those for runtime WADL support.
Maven developers, using Spring 2.0.x or Spring 2.5.x, require a dependency on the jersey-spring module. The following dependency needs to be added to the pom:
<dependency>
<groupId>com.sun.jersey.contribs</groupId>
<artifactId>jersey-spring</artifactId>
<version>1.19.1</version>
</dependency>
See the Java documentation here on how to integrate Jersey-based Web applications with Spring.
Maven developers, using Guice 2.0, require a dependency on the jersey-guice module. The following dependency needs to be added to the pom:
<dependency>
<groupId>com.sun.jersey.contribs</groupId>
<artifactId>jersey-guice</artifactId>
<version>1.19.1</version>
</dependency>
See the Java documentation here on how to integrate Jersey-based Web applications with Guice.
The Jersey Guice support may also be used with GuiceyFruit, a set of
extensions on top of Guice 2.0, such as support for Java EE artifacts like
@PostConstruct/@PreDestroy,
@Resource and @PersistenceContext. To avail of
GuiceyFruit features exclude the guice dependency from the maven central
repo and add the following:
<dependency>
<groupId>org.guiceyfruit</groupId>
<artifactId>guiceyfruit</artifactId>
<version>2.0</version>
</dependency>
...
<repository>
<id>guice-maven</id>
<name>guice maven</name>
<url>http://guiceyfruit.googlecode.com/svn/repo/releases/</url>
</repository>
NOTE that breaking changes have occurred between 1.1.1-ea and 1.1.2-ea. See the end of this section for details.
Jersey Test Framework allows you to test your RESTful Web Services on a wide range of containers. It supports light-weight containers such as Grizzly, Embedded GlassFish, and the Light Weight HTTP Server in addition to regular web containers such as GlassFish and Tomcat. Developers may plug in their own containers.
A developer may write tests using the Junit 4.x framework can extend from the abstract JerseyTest class.
Maven developers require a dependency on the jersey-test-framework-grizzly module. The following dependency needs to be added to the pom:
<dependency>
<groupId>com.sun.jersey.jersey-test-framework</groupId>
<artifactId>jersey-test-framework-grizzly</artifactId>
<version>1.19.1</version>
<scope>test</scope>
</dependency>
When utilizing an embedded container this framework can manage deployment and testing of your web services. However, the framework currently doesn't support instantiating and deploying on external containers.
The test framework provides the following test container factories:
com.sun.jersey.test.framework.spi.container.http.HTTPContainerFactory
for testing with the Light Weight HTTP server.
com.sun.jersey.test.framework.spi.container.inmemory.InMemoryTestContainerFactory
for testing in memory without using HTTP.
com.sun.jersey.test.framework.spi.container.grizzly.GrizzlyTestContainerFactory
for testing with low-level Grizzly.
com.sun.jersey.test.framework.spi.container.grizzly.web.GrizzlyWebTestContainerFactory
for testing with Web-based Grizzly.
com.sun.jersey.test.framework.spi.container.grizzly2.GrizzlyTestContainerFactory
for testing with low-level Grizzly2.
com.sun.jersey.test.framework.spi.container.grizzly2.web.GrizzlyWebTestContainerFactory
for testing with Web-based Grizzly2.
com.sun.jersey.test.framework.spi.container.embedded.glassfish.EmbeddedGlassFishTestContainerFactory
for testing with embedded GlassFish v3
com.sun.jersey.test.framework.spi.container.external.ExternalTestContainerFactory
for testing with application deployed externally, for example to GlassFish or Tomcat.
The system property jersey.test.containerFactory is
utilized to declare the default test container factory that shall be used
for testing, the value of which is the fully qualified class name of a
test container factory class. If the property is not declared then the
GrizzlyWebTestContainerFactory is utilized as default test container
factory.
To test a maven-based web project with an external container such as GlassFish, create the war file then deploy as follows (assuming that the pom file is set up for deployment):
mvn clean package -Dmaven.test.skip=true
Then execute the tests as follows:
mvn test \ -Djersey.test.containerFactory=com.sun.jersey.test.framework.spi.container.embedded.glassfish.external.ExternalTestContainerFactory \ -DJERSEY_HTTP_PORT=<HTTP_PORT>
Breaking changes from 1.1.1-ea to 1.1.2-ea
The maven project groupId has changed from
com.sun.jersey.test.framework to
com.sun.jersey
The extending of Jersey unit test and configuration has changed. See here for an example.
See the blog entry on Jersey Test Framework for detailed instructions on how to use 1.1.1-ea version of the framework in your application.