jax-rs Updated June 26, 2021 by mkyong 109 comments

Jersey hello world example

This article shows how to start a Grizzly HTTP server to run a JAX-RS or Eclipse Jersey application.

Tested with

Jersey 3.0.2
Grizzly 3 HTTP server
Java 8
Maven
JUnit 5

Table of contents

1. Project Directory
2. Jersey dependencies
3. Jersey and HK2 dependency injection
4. Jersey endpoints
5. Start Jersey application
6. Demo
7. Jersey and unit test
8. Download Source Code
9. References

Jersey basics

Many Java-based HTTP servers deploy Jersey applications, for example, JDK HTTP Server, Grizzly, Simple, Jetty and Netty. Read this Jersey and HTTP servers.
Jersey uses HK2 dependency injection framework.
Jersey uses Java APIs logging, or JUL, or java.util.logging.*.

1. Project Directory

A standard Maven project directory.

2. Jersey dependencies

The main Jersey dependencies are the jersey-bom and jersey-hk2, others are optional, read the comment for self-explanatory.

pom.xml


<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
      http://maven.apache.org/maven-v4_0_0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <groupId>com.mkyong</groupId>
    <artifactId>jersey-hello-world</artifactId>
    <packaging>jar</packaging>
    <version>1.0</version>
    <name>jersey-hello-world</name>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <java.version>1.8</java.version>
        <junit.version>5.4.0</junit.version>
        <jsonassert.version>1.5.0</jsonassert.version>
        <jersey.version>3.0.2</jersey.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.glassfish.jersey</groupId>
                <artifactId>jersey-bom</artifactId>
                <version>${jersey.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>

        <!-- Grizzly2 HTTP Server -->
        <dependency>
            <groupId>org.glassfish.jersey.containers</groupId>
            <artifactId>jersey-container-grizzly2-http</artifactId>
        </dependency>

        <!-- Jersey related and HK2 dependency injection -->
        <dependency>
            <groupId>org.glassfish.jersey.inject</groupId>
            <artifactId>jersey-hk2</artifactId>
        </dependency>

        <!-- add jackson for json conversion
        <dependency>
            <groupId>org.glassfish.jersey.media</groupId>
            <artifactId>jersey-media-json-jackson</artifactId>
        </dependency>
        -->

        <!-- generates the META-INF/hk2-locator/default files for auto scan and discovery -->
        <dependency>
            <groupId>org.glassfish.hk2</groupId>
            <artifactId>hk2-metadata-generator</artifactId>
            <version>3.0.2</version>
        </dependency>

        <!-- Need this to hide warning for jakarta.activation.DataSource -->
        <dependency>
            <groupId>jakarta.activation</groupId>
            <artifactId>jakarta.activation-api</artifactId>
            <version>2.0.1</version>
        </dependency>

        <!-- JUnit 5 -->
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-params</artifactId>
            <version>${junit.version}</version>
            <scope>test</scope>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                </configuration>
            </plugin>

            <!-- JUnit 5 need at least 2.22.0 to support -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>3.0.0-M5</version>
            </plugin>

            <!-- create a thin-jar -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.2.0</version>
                <configuration>
                    <archive>
                        <manifest>
                            <addClasspath>true</addClasspath>
                            <classpathPrefix>lib/</classpathPrefix>
                            <mainClass>com.mkyong.MainApp</mainClass>
                        </manifest>
                    </archive>
                </configuration>
            </plugin>

            <!-- copy project dependencies -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-dependency-plugin</artifactId>
                <version>3.1.2</version>
                <executions>
                    <execution>
                        <id>copy-dependencies</id>
                        <phase>package</phase>
                        <goals>
                            <goal>copy-dependencies</goal>
                        </goals>
                        <configuration>
                            <!-- we need runtime dependency only -->
                            <includeScope>runtime</includeScope>
                            <outputDirectory>${project.build.directory}/lib/</outputDirectory>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

        </plugins>
    </build>

</project>

Review the complete Jersey dependencies for a simple Jersey application.

Terminal


$ mvn dependency:tree

[INFO] Scanning for projects...
[INFO]
[INFO] -------------------< com.mkyong:jersey-hello-world >--------------------
[INFO] Building jersey-hello-world 1.0
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-dependency-plugin:3.1.2:tree (default-cli) @ jersey-hello-world ---
[INFO] com.mkyong:jersey-hello-world:jar:1.0
[INFO] +- org.glassfish.jersey.containers:jersey-container-grizzly2-http:jar:3.0.2:compile
[INFO] |  +- jakarta.inject:jakarta.inject-api:jar:2.0.0:compile
[INFO] |  +- org.glassfish.grizzly:grizzly-http-server:jar:3.0.0:compile
[INFO] |  |  \- org.glassfish.grizzly:grizzly-http:jar:3.0.0:compile
[INFO] |  |     \- org.glassfish.grizzly:grizzly-framework:jar:3.0.0:compile
[INFO] |  +- org.glassfish.jersey.core:jersey-common:jar:3.0.2:compile
[INFO] |  |  \- org.glassfish.hk2:osgi-resource-locator:jar:1.0.3:compile
[INFO] |  +- org.glassfish.jersey.core:jersey-server:jar:3.0.2:compile
[INFO] |  |  +- org.glassfish.jersey.core:jersey-client:jar:3.0.2:compile
[INFO] |  |  \- jakarta.validation:jakarta.validation-api:jar:3.0.0:compile
[INFO] |  \- jakarta.ws.rs:jakarta.ws.rs-api:jar:3.0.0:compile
[INFO] +- org.glassfish.jersey.inject:jersey-hk2:jar:3.0.2:compile
[INFO] |  +- org.glassfish.hk2:hk2-locator:jar:3.0.1:compile
[INFO] |  |  \- org.glassfish.hk2.external:aopalliance-repackaged:jar:3.0.1:compile
[INFO] |  \- org.javassist:javassist:jar:3.25.0-GA:compile
[INFO] +- org.glassfish.hk2:hk2-metadata-generator:jar:3.0.2:compile
[INFO] |  +- org.glassfish.hk2:hk2-api:jar:3.0.2:compile
[INFO] |  +- org.glassfish.hk2:hk2-utils:jar:3.0.2:compile
[INFO] |  \- jakarta.annotation:jakarta.annotation-api:jar:2.0.0:compile
[INFO] +- jakarta.activation:jakarta.activation-api:jar:2.0.1:compile
[INFO] \- org.junit.jupiter:junit-jupiter-params:jar:5.4.0:test
[INFO]    +- org.apiguardian:apiguardian-api:jar:1.0.0:test
[INFO]    \- org.junit.jupiter:junit-jupiter-api:jar:5.4.0:test
[INFO]       +- org.opentest4j:opentest4j:jar:1.1.1:test
[INFO]       \- org.junit.platform:junit-platform-commons:jar:1.4.0:test
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.280 s
[INFO] Finished at: 2021-06-17T16:23:29+08:00
[INFO] ------------------------------------------------------------------------

3. Jersey and HK2 dependency injection

3.1 Jersey uses HK2 as the dependency injection framework. The below are @Contract and @Service components, and later we will inject them into the Jersey application.

MessageService.java


package com.mkyong.service;

import org.jvnet.hk2.annotations.Contract;

@Contract
public interface MessageService {
  String getHello();
}

MessageServiceImpl.java


package com.mkyong.service;

import org.jvnet.hk2.annotations.Service;

@Service
public class MessageServiceImpl implements MessageService {

  @Override
  public String getHello() {
      return "Hello World Jersey from HK2";
  }

}

3.2 This Feature enables the auto-scanning components.

AutoScanFeature.java


package com.mkyong.config;

import jakarta.inject.Inject;
import jakarta.ws.rs.core.Feature;
import jakarta.ws.rs.core.FeatureContext;
import org.glassfish.hk2.api.DynamicConfigurationService;
import org.glassfish.hk2.api.MultiException;
import org.glassfish.hk2.api.Populator;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.hk2.utilities.ClasspathDescriptorFileFinder;
import org.glassfish.hk2.utilities.DuplicatePostProcessor;

import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;

/* Auto scan the JAX-RS @Contract and @Service  */
public class AutoScanFeature implements Feature {

  @Inject
  ServiceLocator serviceLocator;

  @Override
  public boolean configure(FeatureContext context) {

      DynamicConfigurationService dcs =
              serviceLocator.getService(DynamicConfigurationService.class);
      Populator populator = dcs.getPopulator();
      try {
          // Populator - populate HK2 service locators from inhabitants files
          // ClasspathDescriptorFileFinder - find files from META-INF/hk2-locator/default
          populator.populate(
                  new ClasspathDescriptorFileFinder(this.getClass().getClassLoader()),
                  new DuplicatePostProcessor());

      } catch (IOException | MultiException ex) {
          Logger.getLogger(AutoScanFeature.class.getName()).log(Level.SEVERE, null, ex);
      }
      return true;
  }
}

Note
More Jersey and HK2 examples.

4. Jersey endpoints

The below is a Jersey application that exposed a few endpoints to produce different output in text format.

MyResource.java


package com.mkyong.resource;

import com.mkyong.service.MessageService;
import jakarta.inject.Inject;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.PathParam;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;

@Path("/hello")
public class MyResource {

  // DI via HK2
  @Inject
  private MessageService messageService;

  // output text
  @GET
  @Produces(MediaType.TEXT_PLAIN)
  public String hello() {
      return "Jersey hello world example.";
  }

  // output text with argument
  @Path("/{name}")
  @GET
  @Produces(MediaType.TEXT_PLAIN)
  public String hello(@PathParam("name") String name) {
      return "Jersey: hello " + name;
  }

  // for dependency injection
  @Path("/hk2")
  @GET
  @Produces(MediaType.TEXT_PLAIN)
  public String helloHK2() {
      return messageService.getHello();
  }

}

5. Start Jersey application

There is no magic here; we need to manually configure the HTTP server and start and end the HTTP Server and the Jersey application. Read the code comments for self-explanatory.

MainApp.java


package com.mkyong;

import com.mkyong.config.AutoScanFeature;
import com.mkyong.resource.MyResource;
import org.glassfish.grizzly.http.server.HttpServer;
import org.glassfish.jersey.grizzly2.httpserver.GrizzlyHttpServerFactory;
import org.glassfish.jersey.server.ResourceConfig;

import java.net.URI;
import java.util.logging.Level;
import java.util.logging.Logger;

public class MainApp {

  private static final Logger LOGGER = Logger.getLogger(MainApp.class.getName());

  // we start at port 8080
  public static final String BASE_URI = "http://localhost:8080/";

  // Starts Grizzly HTTP server
  public static HttpServer startServer() {

      // scan packages
      final ResourceConfig config = new ResourceConfig();
      // config.packages(true, "com.mkyong");
      config.register(MyResource.class);

      // enable auto scan @Contract and @Service
      config.register(AutoScanFeature.class);

      LOGGER.info("Starting Server........");

      final HttpServer httpServer =
              GrizzlyHttpServerFactory.createHttpServer(URI.create(BASE_URI), config);

      return httpServer;

  }

  public static void main(String[] args) {

      try {

          final HttpServer httpServer = startServer();

          // add jvm shutdown hook
          Runtime.getRuntime().addShutdownHook(new Thread(() -> {
              try {
                  System.out.println("Shutting down the application...");

                  httpServer.shutdownNow();

                  System.out.println("Done, exit.");
              } catch (Exception e) {
                  Logger.getLogger(MainApp.class.getName()).log(Level.SEVERE, null, e);
              }
          }));

          System.out.println(String.format("Application started.%nStop the application using CTRL+C"));

          // block and wait shut down signal, like CTRL+C
          Thread.currentThread().join();

      } catch (InterruptedException ex) {
          Logger.getLogger(MainApp.class.getName()).log(Level.SEVERE, null, ex);
      }

  }
}

6. Demo

6.1 Start the MainApp directly, or pack it into a single jar and run it.

Terminal


$ cd {project}

$ mvn package

$ java -jar target/jersey-hello-world-1.0.jar

Jun 17, 2021 3:34:56 PM com.mkyong.MainApp startServer
INFO: Starting Server........
Jun 17, 2021 3:34:57 PM org.glassfish.jersey.server.wadl.WadlFeature configure
WARNING: JAX-B API not found . WADL feature is disabled.
Jun 17, 2021 3:34:57 PM org.glassfish.grizzly.http.server.NetworkListener start
INFO: Started listener bound to [localhost:8080]
Jun 17, 2021 3:34:57 PM org.glassfish.grizzly.http.server.HttpServer start
INFO: [HttpServer] Started.
Application started.
Stop the application using CTRL+C

6.2 We can use a simple cURL to test the Jersey endpoints.

Terminal


$ curl http://localhost:8080/hello
Jersey hello world example.

$ curl http://localhost:8080/hello/mkyong
Jersey: hello mkyong

$ curl http://localhost:8080/hello/hk2
Hello World Jersey from HK2

$ curl -v http://localhost:8080/hello/hk2
*   Trying ::1...
* TCP_NODELAY set
*   Trying 127.0.0.1...
* TCP_NODELAY set
* Connected to localhost (127.0.0.1) port 8080 (#0)
> GET /hello/hk2 HTTP/1.1
> Host: localhost:8080
> User-Agent: curl/7.55.1
> Accept: */*
>
< HTTP/1.1 200 OK
< Content-Type: text/plain
< Content-Length: 27
<
Hello World Jersey from HK2

7. Jersey and unit test

A JAX-RS standard Client and WebTarget class to test the Jersey endpoints.

MyResourceTest.java


package com.mkyong;

import jakarta.ws.rs.client.Client;
import jakarta.ws.rs.client.ClientBuilder;
import jakarta.ws.rs.client.WebTarget;

import org.glassfish.grizzly.http.server.HttpServer;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertEquals;

public class MyResourceTest {

  private static HttpServer httpServer;
  private static WebTarget target;

  @BeforeAll
  public static void beforeAllTests() {
      httpServer = MainApp.startServer();
      Client c = ClientBuilder.newClient();
      target = c.target(MainApp.BASE_URI);
  }

  @AfterAll
  public static void afterAllTests() {
      httpServer.stop();
  }

  @Test
  public void testHello() {
      String response = target.path("hello").request().get(String.class);
      assertEquals("Jersey hello world example.", response);
  }

  @Test
  public void testHelloName() {
      String response = target.path("hello/mkyong").request().get(String.class);
      assertEquals("Jersey: hello mkyong", response);
  }

  @Test
  public void testHelloHK2() {
      String response = target.path("hello/hk2").request().get(String.class);
      assertEquals("Hello World Jersey from HK2", response);
  }

}

8. Download Source Code

$ git clone https://github.com/mkyong/jax-rs

$ cd jax-rs/jersey/jersey-hello-world

$ mvn package

$ java -jar target/jersey-hello-world-1.0.jar

9. References

Written by mkyong

Software Engineer • Writer • Dad

20+ years hands-on, writing about Java, Spring, and AI. Every code example here is tested.

All posts by mkyong

109 comments on “Jersey hello world example”

Rithik
December 21, 2022 at 1:02 pm

Hi Mkyong, is it possible to import library files into tomcat

Reply
Sharad Ladkat
April 17, 2020 at 11:13 am

Tried the code. Able to download. Added as a existing maven project. Created .war file from eclipse. Deployed on apache tomcat 9. Restart the server. by using
URL : http://localhost:8080/RESTfulExample/rest/hello/mkyong
I am able to print sysout on server.
Thanks. It worked for me.

Reply
Viktor
November 29, 2019 at 4:21 pm

how to config – open index.html ????? i’m break my head

Reply
Dima
November 10, 2019 at 9:01 pm

Mkyong you save me again! Thank you!

Reply
John the Truth Teller
July 17, 2019 at 12:40 am

Does not work !
How does this tutorial, not work with maven… please update it, so many people seem to have the same issue.

Reply
Dany Wehbe
March 7, 2019 at 8:50 pm

Many thanks for this clear demonstration

Reply
Leonidas
January 20, 2019 at 10:10 am

In the pom.xml file add the dependencies if you are using Java 11.
(https://stackoverflow.com/questions/43574426/how-to-resolve-java-lang-noclassdeffounderror-javax-xml-bind-jaxbexception-in-j)

javax.xml.bind
jaxb-api
2.2.11

com.sun.xml.bind
jaxb-core
2.2.11

com.sun.xml.bind
jaxb-impl
2.2.11

javax.activation
activation
1.1.1

Reply
Mrin
October 22, 2018 at 2:45 am

for a complete example using Java 11, Jersey and VueJs for frontend checkout https://github.com/mrin9/Angular-SpringBoot-REST-JWT

Reply
Pool
October 12, 2018 at 5:36 am

Having issues with running the application on the Tomcat Server in IntelliJ. The exploded war is successfully created. Also, it gets successfully deployed on the server. But, no subset of the url seems to work (404 error for all). Any ideas?

Reply
anon
February 25, 2018 at 1:40 pm

IF you are using TOmcat 8.5 and Jersey 1.19 then you need to add the below 2 dependecies:

com.sun.jersey
jersey-server
1.19

com.sun.jersey
jersey-servlet
1.19

Reply
Sure Law
January 18, 2018 at 4:22 pm

To run the demo, do as following steps: 1. Get a servlet container. I use eclipse jetty to do this, and of course tomcat is fine too. 2. cd into base dir of this example and run “mvn clean install”. If you are luck enough, you will get a file named as “RESTfulExample.war” in the target folder. 3. move this file into jetty_home/webapps, and start jetty using command ” java -jar start.jar”. 4 Now, you can access the url refered in author’s blog.

Reply
Karthick A S
September 15, 2017 at 10:07 pm

hi Mkyong, I am trying above sample in my weblogic server….i am facing some issue. Is there i need to add any new jars related to weblogic server.

Reply
Und
September 12, 2017 at 9:38 am

Not work

Reply
Nitish
July 20, 2017 at 6:21 am

Changing http://localhost:8080/RESTfulExample/rest/hello/mkyong to
http://localhost:8080/rest/hello/mkyong
made it work for me!
Thanks so much mkyong

Reply
Nitish
July 20, 2017 at 5:46 am

If you download his project folder and try to run his, make sure that you spec’s match his, especially the jdk, Jersey and Tomcat version.

CORRECTION:
http://localhost:8080/RESTfulExample/rest/hello/mkyong
(returns a 404 for me)
SHOULD BE
http://localhost:8080/rest/hello/mkyong
(works fine)

This is what got mine to work.
Thanks so much mkyong!

Reply
Dorababu
June 20, 2017 at 12:53 am

Hi mkyong I had my XML which was generated using SOAP UI, where I am having some global parameters set. I am trying to execute that XML from maven using continuous integration process I am getting the following error GET – Request_GetAllUsers FailedSubmitException: com.eviware.soapui.model.iface.Request$SubmitException: com.eviware.soapui.impl.wsdl.submit.RequestTransportRegistry$MissingTransportException: Missing protocol in endpoint [${Endpoint}]

Can you help me to over come this

Reply
Sathish Kumar
May 19, 2017 at 1:41 am

Hi mkyong,
I am getting the following exception. I am completely blocked can you please help me here.
com.sun.jersey.api.container.ContainerException: No WebApplication provider is present
com.sun.jersey.spi.container.WebApplicationFactory.createWebApplication(WebApplicationFactory.java:69)
com.sun.jersey.spi.container.servlet.ServletContainer.create(ServletContainer.java:412)
com.sun.jersey.spi.container.servlet.ServletContainer$InternalWebComponent.create(ServletContainer.java:327)

Reply
Anderson Nguy?n
November 7, 2016 at 3:50 pm

awesome ! thank you so much

Reply
shred lesnar
November 5, 2016 at 6:53 pm

When I am trying to run the same example. I am getting 404 error on server.

Reply
neeraj bansal
November 3, 2016 at 2:28 pm

works for me, thanks

Reply
Sydney
September 21, 2016 at 5:23 pm

And I forgot to configure my server 🙁 Done it now and the example is working perfectly 🙂 … Big-ups to Mkyong

Reply
Sydney
September 21, 2016 at 5:13 pm

Hi, MK, Thanks for delivering such great work. I have been benefiting from your tutorials for a while now. I am currently trying to get this one to work and be able to understand thoroughly. If I may ask, where do we configure the port number? ‘8080’ in your example?

Reply
1. Rishi Prakash
  April 30, 2018 at 11:50 am
  
  By default your server will be configured with 8080 port.
  
  Reply
Michael Njoroge
September 9, 2016 at 11:54 am

its a cool one..

Reply
Arno Jan Sta Nimus
April 21, 2016 at 9:23 pm

Why are you all using this com.sun packages?? they are likely to be removed from api!!

Reply
Juan Marco
September 4, 2015 at 2:50 am

For those of you having trouble:
1. Make sure you are not mixing jersey 1 with jersey 2.
2. The maven dependency for jersey 1 used in this tutorial INCLUDES
javax.ws.rs, so if you have this dependency below in your pom.xml,
you are in for trouble due to library collisions.

javax.ws.rs
javax.ws.rs-api

The error you get won’t be indicative that this is the problem.

More on stack overflow:
http://stackoverflow.com/questions/23277429/exception-in-rest-jersey

Reply
Capricorn1
July 25, 2015 at 3:47 am

This was all I needed to get started in the right direction. Thanks!

Reply
RAYO
July 18, 2015 at 12:22 am

This example to uses qith JBoss 6 I need to change the web.xml

jersey-serlvet
com.sun.jersey.spi.container.servlet.ServletContainer

com.sun.jersey.config.property.packages
mx.com.sia.tutorial.rest

1

jersey-serlvet
/*

resteasy.scan
false

resteasy.scan.providers
false

resteasy.scan.resources
false

Saludos!!!!

Reply
Java Pro
July 12, 2015 at 8:55 pm

Good jersey tutorial

http://www.javaproficiency.com/2015/03/jersey-tutorial-for-beginners.html

Reply
Nagarjuna
July 12, 2015 at 6:42 pm

Hi Sir, This is nagarjuna working for MNC, i have copied this project into my eclipse and converted into maven .
it is not working, am referring to different url. can you provide settings .xml for this project

Reply
Praveen
June 26, 2015 at 5:04 am

I am getting this error when I try to run, HTTP Status 500 – Servlet.init() for servlet jersey-serlvet threw exception

The ResourceConfig instance does not contain any root resource classes.

Anyone can help me here to sort out the issue??.

Reply
Eduardo Oportus
June 18, 2015 at 2:44 am

very helpfull, thank you.

Reply
Johaness
May 26, 2015 at 10:22 am

No provider classes found.

Reply
Johaness
May 26, 2015 at 9:58 am

GRAVE: Servlet [jersey-serlvet] in web application [/restSample] threw load() exception

java.lang.ClassNotFoundException: com.sun.jersey.spi.container.servlet.ServletContainer

at org.apache.catalina.loader.WebappClassLoader.loadClass(WebappClassLoader.java:1720)

at org.apache.catalina.loader.WebappClassLoader.loadClass(WebappClassLoader.java:1571)

at org.apache.catalina.core.DefaultInstanceManager.loadClass(DefaultInstanceManager.java:506)

at org.apache.catalina.core.DefaultInstanceManager.loadClassMaybePrivileged(DefaultInstanceManager.java:488)

at org.apache.catalina.core.DefaultInstanceManager.newInstance(DefaultInstanceManager.java:115)

at org.apache.catalina.core.StandardWrapper.loadServlet(StandardWrapper.java:1148)

at org.apache.catalina.core.StandardWrapper.load(StandardWrapper.java:1087)

at org.apache.catalina.core.StandardContext.loadOnStartup(StandardContext.java:5266)

at org.apache.catalina.core.StandardContext.startInternal(StandardContext.java:5554)

at org.apache.catalina.util.LifecycleBase.start(LifecycleBase.java:150)

at org.apache.catalina.core.ContainerBase$StartChild.call(ContainerBase.java:1575)

at org.apache.catalina.core.ContainerBase$StartChild.call(ContainerBase.java:1565)

at java.util.concurrent.FutureTask.run(FutureTask.java:266)

at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)

at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)

at java.lang.Thread.run(Thread.java:745)

Reply
Johaness
May 26, 2015 at 9:56 am

as usual an incomplete broken sample!

Reply
1. Nitish
  July 20, 2017 at 5:46 am
  
  Not true
  
  Reply
Murali Mohan
May 21, 2015 at 12:47 pm

Hi, i am getting the below deployment exception when i deployed in websphere 8.0, but it works well in tomcat server. Could you please let me know what was the issue?
java.lang.NoSuchMethodError: javax/ws/rs/core/Application.getProperties()Ljava/util/Map;

at org.glassfish.jersey.server.ApplicationHandler.(

java.lang.NoSuchMethodError: javax/ws/rs/core/Application.getProperties()Ljava/util/Map;

at org.glassfish.jersey.server.ApplicationHandler.(

ApplicationHandler.java:287)

Reply
RAJ
May 4, 2015 at 12:20 pm

Hi everyone,

i just created this example in my machine, and when i tried to access it via the example URL mentioned below, i am getting Bad request 400 error in all the browsers.

http://localhost:8080/RESTfulExample/rest/hello/Raj

Did anyone faced this issue? If so, any help would be great.

Find below the request from browser:

Remote Address: [::1]:8080
Request URL: http://localhost:8080/RESTfulExample/rest/hello/Rajkumar
Request Method: GET
Status Code: 400 Bad Request

Thanks in advance…

Reply
Guest
March 19, 2015 at 12:16 am

Is it jersey-servlet or jersey-servlvet

Reply
hbeira
August 23, 2014 at 9:54 pm

Thanks!

Reply
Jayani
July 25, 2014 at 3:16 pm

Thank you! 🙂 This works.

Reply
Rahul Gonnade
July 19, 2014 at 3:34 am

this service runs perfectly on local server(localhost:8080).. but hen deployed on actual webserver(xyz.com) shows error

The requested URL “rest/hello/mkyong” was not found on this server.

Please help me out

Followed up the deployment process but still getting same error

Reply
Aaditya Kumar
June 22, 2014 at 12:59 am

Thanks Mkyong! unblocked me bigtime…

Reply
karthik
May 20, 2014 at 5:10 pm

Dear Friends,Spring Boot vs Spring Web Services vs Jersey web services Which one is better to develop Web Services to develop application

Check on
1)Performance wise
2)Configuration wise
3)Writing Coding wise

Reply
smayurk
May 11, 2014 at 2:22 am

Troubleshooting class not found:
you should have appropriate servlet container, param

For Jersey 1.x, example:

com.sun.jersey.spi.container.servlet.ServletContainer

com.sun.jersey.config.property.packages
sample.hello.resources

1

For Jersey 2.x, example:
org.glassfish.jersey.servlet.ServletContainer
and jersey.config.server.provider.packages

Troubleshooting 404 error:
-Make sure your jars are in webapp/lib

Reply
1. Johaness
  May 26, 2015 at 9:59 am
  
  why if you are using maven???
  
  Reply
Claudius Gothicus
May 8, 2014 at 3:07 am

Very good example; downloading and unzipping the attachment, then importing the resultant Eclipse project worked for me. Then I just added it to the Tomcat project in Eclipse and I was on my way. 🙂

Reply
I. shalik
February 6, 2014 at 8:10 pm

Help me to create restful webservice with database in netbeans

Reply
Raj
November 29, 2013 at 3:03 am

This example is not working and doesn’t help on how all the defined software usage. May be this can be better enhanced

Reply
ilan
November 21, 2013 at 12:00 am

java.lang.ClassNotFoundException:com.sun.jersey.spi.container.servlet.ServletContainer

fix: add more dependencies
jersey-server, jersey-core, jersey-servlet, all 1.17.1 and it should work. Have fun.

Reply
1. saumyaraj
  March 19, 2014 at 6:05 pm
  
  add jersey-servlet-1.xx.jar
  
  Reply
kineret
October 22, 2013 at 10:37 pm

Hi
I take this code and run it, but without success.
The browser open with blank page. and if I look at the “edit component” I see “atatus: 404 not found”.
I use Intellij, I need to change something in the code?

Thank you

Reply
David
October 22, 2013 at 5:20 pm

Good introduction to get started, and mess around. It takes a bit of messing around to get it working, but you should have basic j2ee / maven / eclipse experience before starting to use REST

Reply
1. kineret
  October 22, 2013 at 10:36 pm
  
  Hi
  I take this code and run it, but without success.
  The browser open with blank page. and if I look at the “edit component” I see “atatus: 404 not found”.
  I use Intellij, I need to change something in the code?
  
  Thank you
  
  Reply
  1. David
    October 22, 2013 at 11:06 pm
    
    In the context of a local test environment, it is not that easy to work out what exactly is wrong.
    More than likely it is a configuration error.
    Is the rest class on the build path?
    Is it in the correct package? check: com.sun.jersey.config.property.packages param in web.xml
    Have you initiated the request correctly from the browser?
    
    Might be easier to build the project from a new intellij web project, maybe keep maven out while you try to get it working
    
    Reply
Yomesh
October 18, 2013 at 1:37 am

Thanks Mkyong. Your blogs are very helpful.

Reply
samba
October 14, 2013 at 2:21 pm

This is very useful site for freshers.

Reply
sunder
August 19, 2013 at 6:42 am

thanks for a simple example to get me started.

Reply
Karthik
July 17, 2013 at 2:28 pm

Hi Mkyong,

Tried this example in RAD (with WebSphere App Server), when I try to access the url “*/rest/json/metallic/get”, I get “Error 404: Not Found”, below are the logs when the application is starting,

Scanning for root resource and provider classes in the packages:
org.kary.core
[7/17/13 14:19:07:226 SGT] 00000017 ScanningResou I Root resource classes found:
class org.kary.core.JSONService
[7/17/13 14:19:07:230 SGT] 00000017 ScanningResou I No provider classes found.
[7/17/13 14:19:07:347 SGT] 00000017 WebApplicatio I Initiating Jersey application, version ‘Jersey: 1.8 06/24/2011 12:17 PM’

Reply
yeshwant
June 25, 2013 at 4:24 pm

Hi MKYONG & Other friends of this site:

I am using JDK 1.5. I have to use this version of JDK. Can you tell me from where to download JDK 1.5 compatible version of JERSEY?

Reply
Ayan
May 12, 2013 at 12:36 pm

Hi MK,
It was my wife,who heard about ur site from her office-java lecturer and initially (like every husband) I ignored her praise for ur site (u? 😉

But for the last 1 month I’m referring your site for setting intrvw qustns as well as giving intervws to top MNCs in d world..

I must say MK, u rock like MJ (Thriller!)
😉
Ayan

Reply
David Balme
March 27, 2013 at 9:21 am

I just wanted to say that I find your website to be very helpful.

I have come to your site many times for help with various maven issues.

Thank you for doing this.

Cheers,
David

Reply
Munish kumar
March 19, 2013 at 12:19 pm

Hi mkyoung,

I want to expose restfull services which exist in more than one package. Please suggest the required web.xml configuration for it.

Reply
Pawan
March 7, 2013 at 8:51 am

Hi, I am not able to figure out how to deploy this app. When I try mvn clean deploy I get the error: [ERROR] Failed to execute goal org.apache.maven.plugins:maven-deploy-plugin:2.5:deploy (default-deploy) on project parserclient: Deployment failed: repository element was not specified in the POM inside distributionManagement element or in -DaltDeploymentRepository=id::layout::url parameter -> [Help 1]

Will appreciate any hints on how to fix this one.

Thanks,

Pawan

Reply
1. suleman
  December 4, 2013 at 7:30 pm
  
  you can deploy it on tomcat using command line type “mvn tomcat:run”
  
  Note: if some service already run on port 8080 then first kill that process first.
  
  Reply
Corgan
December 24, 2012 at 9:33 am

Hi mkyong,
I see that your last reply is very old but I want to try ask you something abount Jersey implementation. First of all: thanks for this example.I succeded doing it,it’s work except when large string is passed as parameter.Is it possible to specify in a simple project like this some property like maxReceivedMessageSize? Whitout any specification server return 404 bad request. Can you (or anyone)help me , please?

Reply
Michael
December 22, 2012 at 9:21 pm

Nice one… Thanks for this sample

Reply
ismail hakki turan
November 28, 2012 at 3:30 am
```
mvn eclipse:eclipse -Dwtpversion=2.0
```
command must be run in project’s path. Users might be type this command like
```
mvn archetype:generate -DgroupId=com.mkyong.rest -DartifactId=RESTfulExample -DarchetypeArtifactId=maven-archetype-webapp -DinteractiveMode=false
```
in user path.
Reply
1. ismail hakki turan
  November 28, 2012 at 3:32 am
  
  and thanks so much for the example.
  
  Reply
Luis
November 26, 2012 at 7:22 pm

It works! Brilliant, as usual…

Thanks,

Luis

Reply

October 13, 2012 at 5:53 am

Read through the “How to use mkyong tutorial”, I am a newbe. I am getting the error when I run the above application with the url “http://localhost:8080/RESTfulExample/rest/hello/mkyong”, Manifest error. A more verbose content of that error follows; Any heads up appreciated.
——–

PLATFORM VERSION INFO
	Windows 			: 6.1.7601.65536 (Win32NT)
	Common Language Runtime 	: 4.0.30319.17929
	System.Deployment.dll 		: 4.0.30319.17929 built by: FX45RTMREL
	clr.dll 			: 4.0.30319.17929 built by: FX45RTMREL
	dfdll.dll 			: 4.0.30319.17929 built by: FX45RTMREL
	dfshim.dll 			: 4.0.41209.0 (Main.041209-0000)

SOURCES
	Deployment url			: http://localhost:8080/RESTfulExample/rest/hello/mkyong

ERROR SUMMARY
	Below is a summary of the errors, details of these errors are listed later in the log.
	* Activation of http://localhost:8080/RESTfulExample/rest/hello/mkyong resulted in exception. Following failure messages were detected:
		+ Exception reading manifest from http://localhost:8080/RESTfulExample/rest/hello/mkyong: the manifest may not be valid or the file could not be opened.
		+ Data at the root level is invalid. Line 1, position 1.

COMPONENT STORE TRANSACTION FAILURE SUMMARY
	No transaction error was detected.

WARNINGS
	There were no warnings during this operation.

OPERATION PROGRESS STATUS
	* [10/12/2012 5:41:03 PM] : Activation of http://localhost:8080/RESTfulExample/rest/hello/mkyong has started.

ERROR DETAILS
	Following errors were detected during this operation.
	* [10/12/2012 5:41:03 PM] System.Deployment.Application.InvalidDeploymentException (ManifestParse)
		- Exception reading manifest from http://localhost:8080/RESTfulExample/rest/hello/mkyong: the manifest may not be valid or the file could not be opened.
		- Source: System.Deployment
		- Stack trace:
			at System.Deployment.Application.ManifestReader.FromDocument(String localPath, ManifestType manifestType, Uri sourceUri)
			at System.Deployment.Application.DownloadManager.DownloadDeploymentManifestDirectBypass(SubscriptionStore subStore, Uri& sourceUri, TempFile& tempFile, SubscriptionState& subState, IDownloadNotification notification, DownloadOptions options, ServerInformation& serverInformation)
			at System.Deployment.Application.DownloadManager.DownloadDeploymentManifestBypass(SubscriptionStore subStore, Uri& sourceUri, TempFile& tempFile, SubscriptionState& subState, IDownloadNotification notification, DownloadOptions options)
			at System.Deployment.Application.ApplicationActivator.PerformDeploymentActivation(Uri activationUri, Boolean isShortcut, String textualSubId, String deploymentProviderUrlFromExtension, BrowserSettings browserSettings, String& errorPageUrl)
			at System.Deployment.Application.ApplicationActivator.ActivateDeploymentWorker(Object state)
		--- Inner Exception ---
		System.Xml.XmlException
		- Data at the root level is invalid. Line 1, position 1.
		- Source: System.Xml
		- Stack trace:
			at System.Xml.XmlTextReaderImpl.Throw(String res, String arg)
			at System.Xml.XmlTextReaderImpl.ParseRootLevelWhitespace()
			at System.Xml.XmlTextReaderImpl.ParseDocumentContent()
			at System.Deployment.Application.ManifestValidatingReader.XmlFilteredReader.Read()
			at System.Xml.XmlCharCheckingReader.Read()
			at System.Xml.XsdValidatingReader.Read()
			at System.Deployment.Application.ManifestReader.FromDocument(String localPath, ManifestType manifestType, Uri sourceUri)

COMPONENT STORE TRANSACTION DETAILS
	No transaction information is available.


--------

LL
October 25, 2012 at 10:26 pm

I have exactly same issue. Any suggestion on this?

Reply
LL
October 25, 2012 at 11:26 pm
Solve this issue: by adding @Produces
```
package com.mkyong.rest;
 
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
 
@Path("/hello")
public class HelloWorldService {
 
	@GET
	@Path("/{param}")
	@Produces(MediaType.TEXT_PLAIN)
	public Response getMsg(@PathParam("param") String msg) { 
		String output = "Jersey say : " + msg;
 		return Response.status(200).entity(output).build();
	}
}
```
Reply
1. anon
  November 8, 2012 at 12:12 am
  
  adding @Produces worked for me too.
  
  Reply
  1. Jason
    March 14, 2014 at 4:08 am
    
    Added @Produces, working fine. Thanks.
    
    Reply
2. Sam
  November 11, 2014 at 1:33 pm
  
  its working by adding @Produces
  
  Reply

Joe-Z
October 12, 2012 at 4:19 pm

I’m sorry, but this example is absolutely useless.
I mean, yes you could probably copy all the sources in files and get it wo work. But to me the point of a helloworld-example is getting useres to understand what they are doing and not just what cody to copy in what files (a bit of a ‘teach a man to fish’-thing). From this perspective this introduction really lacks some fundamental explaining of the used components (e.g.: why do i need the ‘web.xml’-file? what do the parameters in ‘pom.xml’ mean? what could be wrong if I’m still getting a 404?)
I still appreciate that you want to give something back to the community. Only when you do that, do it right.

Reply
1. Joe-Z
  October 12, 2012 at 4:21 pm
  
  code* (not cody)
  
  Reply
franjo
September 11, 2012 at 3:40 am

Doesn’t work man, 404 error. Any hint?

Reply
1. thurman
  February 27, 2013 at 11:56 pm
  
  I had this problem as well and it was related to how to deploy this app to your tomcat server.
  
  My problem was fixed by adding a lib folder to the WEB-INF directory.
  Then I copied three jar files into the lib folder:
  asm-3.1
  jersey-core-1.8
  jersey-server-1.8
  
  I got these jars from my local .m2 folder after I used maven to bring them down for Jersey.
  I’m assuming that you can use google to find them directly, download them, then place them in this folder.
  Remember this ‘lib’ folder is in the {tomcat-home}/webapps/your-app-folder/web-inf folder.
  
  Another thing that mite seem obvious except for new Tomcat users is that you also have to include a classes folder that contains your class files. This folder is located at
  tomcat-home}/webapps/your-app-folder/web-inf/classes.
  
  After I added these this demo worked fine.
  
  One way to really know that you’re on the right track is that after you start Tomcat you should see messages in the console indicating that the Jersey application is being initiated.
  
  Thurman
  
  Reply
2. Vivek
  October 29, 2013 at 1:21 pm
  
  Worthless example .It didn’t work..If you are reading that tutorial ..it seems good and simple but if you are just implementing this example ..it failed .Worthless .
  
  I recommand to put the example on the site until it is in running stage .
  
  Reply
Ramana Reddy
September 6, 2012 at 7:10 pm

Hi Mkyong
I am a great fan of you. Your examples are too good. I use lot of your examples while teaching JSF, Struts, Jax-ws, Jax-rs and all other technologies. You are a great help. Thank you for your service

……. Ramana

Reply
Priyanka
September 2, 2012 at 11:26 pm

Thanks MKYONG………
Highly appreciate your this effort …
very useful for beginners like us……

go ahead…good luck…!!!

Reply
Vince
August 29, 2012 at 11:50 am

4.0.0
com.foo.fcm
server
war
1.0-SNAPSHOT
server Maven Webapp
http://maven.apache.org

junit
junit
3.8.1
test

com.sun.jersey
jersey-server
1.8

maven2-repository.java.net
Java.net Repository for Maven
http://download.java.net/maven/2/
default

server

[INFO] ————————————————————————
[ERROR] BUILD ERROR
[INFO] ————————————————————————
[INFO] Error building POM (may not be this project’s POM).

Project ID: null:jersey-server:bundle:null

Reason: Cannot find parent: com.sun.jersey:jersey-project for project: null:jersey-server:bundle:null for project null:jersey-server:bundle:null

Reply
s3rcl
August 5, 2012 at 5:58 pm

Thanks,
I have gone through couple of Jersey tutorials,
but I have to admit that this is the best one.
Thanks again Mr. Yong

Reply
vas
August 1, 2012 at 6:14 am

Thanks…
Does the above example can be deployed on JBoss server and works?
I have created JAXRS webservices using HTTPDispatcherServlet. what is the diff between ServletContainer & HTTPDispatcherServlet? JAX RS webservices servlet entry in web.xml vary based on application server?

Reply
Lin Yang
July 28, 2012 at 2:38 pm

why I run into ‘WARNING: EXCEPTION
java.lang.ClassNotFoundException: com.sun.jersey.spi.container.servlet.ServletContainer’ error in eclipse even though I added all jersey ans jaxb related jars under war/WEB-INF/lib and Project Properties / Libraries?

Reply
Lin Yang
July 28, 2012 at 2:37 pm

why I run into ‘WARNING: EXCEPTION
java.lang.ClassNotFoundException: com.sun.jersey.spi.container.servlet.ServletContainer’ error in eclipse even though I added all jersey and jaxb related jars under GAE war/WEB-INF/lib and Project Properties / Libraries?

Reply
1. marsChen
  September 4, 2012 at 9:57 pm
  
  if you use jersey1.13 version,you should add dependency
  
  com.sun.jersey
  jersey-bundle
  1.13
  
  in pom.xml?Or add jersey-bundle-1.13.jar in the/WEB-INF/lib
  
  Reply
Pal Ram
July 28, 2012 at 1:00 pm

Hello Mr.Yong,
In recent days, I happen to get perfect answers from your site for most of my Google searches. This is just one of them! So I want to thank you for everything.

Thank you so much for providing such a great help.

Regards,
Ram.

Reply
1. mkyong Author
  July 28, 2012 at 1:08 pm
  
  Welcome, good to know it help 🙂 keep in touch.
  
  Reply
babak
July 26, 2012 at 12:04 am

hello and thanks for your articles.
a question: when I search for Jersey-Server in Maven Central Repo I get the latest version number of 1.3
http://search.maven.org/#search|ga|1|a%3A%22jersey-server%22
but in your example you are using 1.8? I am confused, could you please explain this a little bit.

Thanks.

Reply
jaya
July 12, 2012 at 5:21 am

Please let me know the procedure to test this.
I’m getting HTTP Status 404 – error

Reply
Chandra
July 10, 2012 at 3:30 pm

Great Work!!! and Thanks from heart

Reply
Alejandro
July 4, 2012 at 7:08 am

THANK YOU SO MUCH!!! First step-by-step to get this done in less than 5 minutes!!! Thanks… I tried a different site but it seems that the repository was missing. Thanks

Reply
ranjit
June 20, 2012 at 11:14 pm

Can you provide us a valuable example for creating a RESTFUL web service using Eclipse and Tomcat. I dont want to use third party tool like jersey that needs license as I dont want to pay annual fees.

Reply
Henrik
June 14, 2012 at 8:26 pm

Thank you so much, you made my day!
I could apply this for an endpoint in Mule-ESB (2.28). However I had a small problem, I got a class not found exception for “import com.sun.jersey.spi.service.ComponentProvider”.

However, in the pom, I changed the dependency to the following:

com.sun.jersey.contribs
jersey-simple-server
1.12

and it works nicely. Cheers mate

Reply
vishwanath
June 11, 2012 at 5:53 pm

i have compiled and successfully installed the project but when i try to run it using mvn tomcat:run it doesn’t open any server and just ends .

Reply
Lila Devi
March 17, 2012 at 12:50 am

Hi,

How can I use ant to build Jax-rs. Is it a simple war file or is there some wsgen tasks that I have to run as with Jax-ws. Please could you provide me with a sample as I do not want to start using Maven just now.

Thanks

Reply
verygood
January 13, 2012 at 12:24 am

I’m not sure what we could do without you. your tutorials are just perfect. I have never seen anyone on the web who has written such a good and perfect tutorial.
keep up the good work.

Reply
C
December 18, 2011 at 12:08 am

Took a while to get this to work. I noticed along the way that the latest Jersey release does not work like this, the servlet moved. Another great tutorial though, thank you.

Reply
M.A.
September 25, 2011 at 10:43 pm

Hello and thank you for this tutorial. I haven’t started it yet, because I’m not sure if Maven is required and I don’t want to learn it now. So, will I be able to complete this tutorial without using Maven? All I want is to create a web service (rest + json).
Waiting for your reply. Thank you in advance.

Reply
1. mkyong Author
  September 26, 2011 at 7:55 am
  
  In this tutorial, Maven is nothing but a build tool, you can get all the dependencies manually and build it manually or via Ant.
  
  Reply
Rahi Akela
July 20, 2011 at 1:30 pm

Thanks Mr. Yong,
For your valuable WS-RS tutorials.I had been hunting such a nice WS-RS example since a long time.So thanks a lot.

Reply
1. mkyong Author
  July 21, 2011 at 9:48 am
  
  your comment is motivated 🙂
  
  Reply
Kyle
July 19, 2011 at 1:23 am

Just so you know, your site is blocking it’s own images ‘Hotlinking detected’

Reply
1. mkyong Author
  July 19, 2011 at 8:45 am
  
  Hi, could you explains it in detail? How to simulate it?
  
  Reply
  1. Corgan
    December 19, 2012 at 12:33 am
    
    Hi mkyong,
    I see that last reply is very old but I want to try ask you something abount Jersey implementation. Is it possible to specify in a simple project like this some property like maxReceivedMessageSize? I realized a simple project but with large data passed in input , server return 404 bad request. Can you help me , please?
    
    Reply
    1. Corgan
      March 7, 2013 at 5:45 pm
      
      Hi mkyong,
      If param is a string too long I receive a server exception. For example if I read a String from a file and send it with the service and file is too big…
      
      Reply

Jersey hello world example

1. Project Directory

2. Jersey dependencies

3. Jersey and HK2 dependency injection

4. Jersey endpoints

5. Start Jersey application

6. Demo

7. Jersey and unit test

8. Download Source Code

9. References

109 comments on “Jersey hello world example”

Leave a Comment Cancel reply