Error parsing JSON param in java REST

Question

I have recently upgraded my REST API to use jersey 2.x and now I am unable to retrieve JSON body params the way I used to, the methods simply do not get called anymore. My guess is I'm missing a dependency to parse the JSON to a java object but I'm not too sure what i need to add in, any help appreciated.

pom.xml

<dependencies>
    <dependency>
        <groupId>javax.ws.rs</groupId>
        <artifactId>javax.ws.rs-api</artifactId>
        <version>2.0.1</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.containers</groupId>
        <artifactId>jersey-container-servlet</artifactId>
        <version>2.19</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.core</groupId>
        <artifactId>jersey-server</artifactId>
        <version>2.19</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.core</groupId>
        <artifactId>jersey-client</artifactId>
        <version>2.19</version>
    </dependency>
    <dependency>
        <groupId>com.googlecode.json-simple</groupId>
        <artifactId>json-simple</artifactId>
        <version>1.1.1</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.media</groupId>
        <artifactId>jersey-media-multipart</artifactId>
        <version>2.22</version>
    </dependency>
</dependencies>

REST method

@POST
    @Path("/users/{userId}/friends")
    @Produces(MediaType.APPLICATION_JSON)
    @Consumes(MediaType.APPLICATION_JSON)
    public Response followUser(@PathParam("userId") Integer myUserId, FollowUserBean user) {}

FollowUserBean.java

import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class FollowUserBean {
    public Integer friendId;

    public FollowUserBean() {}
}

What exception do you get? – Justinas Jakavonis Aug 10 '16 at 07:02 — Justinas Jakavonis, Aug 10 '16 at 07:02
Consider using the same version of all Jersey artifacts. – cassiomolin Aug 10 '16 at 07:17 — cassiomolin, Aug 10 '16 at 07:17

cassiomolin · Accepted Answer · 2017-01-24T14:13:58.093

You need a JSON provider

At time of writing, Jersey 2.x integrates with the following modules to provide JSON support:

Using Jackson

See below the steps required to use Jackson as a JSON provider for Jersey 2.x:

Adding Jackson module dependencies

To use Jackson 2.x as your JSON provider you need to add jersey-media-json-jackson module to your pom.xml file:

<dependency>
    <groupId>org.glassfish.jersey.media</groupId>
    <artifactId>jersey-media-json-jackson</artifactId>
    <version>2.25.1</version>
</dependency>

To use Jackson 1.x it'll look like:

<dependency>
    <groupId>org.glassfish.jersey.media</groupId>
    <artifactId>jersey-media-json-jackson1</artifactId>
    <version>2.25.1</version>
</dependency>

Registering Jackson module

Besides adding the dependency mentioned above, you need to register JacksonFeature (or Jackson1Feature for Jackson 1.x) in your Application / ResourceConfig subclass:

@ApplicationPath("/api")
public class MyApplication extends Application {

    @Override
    public Set<Class<?>> getClasses() {
        Set<Class<?>> classes = new HashSet<Class<?>>();
        classes.add(JacksonFeature.class);
        return classes;
    }
}

@ApplicationPath("/api")
public class MyApplication extends ResourceConfig {

    public MyApplication() {
        register(JacksonFeature.class);
    }
}

If you don't have an Application / ResourceConfig subclass, you can register the JacksonFeature in your web.xml deployment descriptor. The specific resource, provider and feature fully-qualified class names can be provided in a comma-separated value of jersey.config.server.provider.classnames initialization parameter.

<init-param>
    <param-name>jersey.config.server.provider.classnames</param-name>
    <param-value>org.glassfish.jersey.jackson.JacksonFeature</param-value>
</init-param>

The MessageBodyWriter provided by Jackson is JacksonJsonProvider.

For more details, check the Jersey documentation about support for common media type representations.

Thanks for the response, I don't have an Application/ResourceConfig sub-class, did jersey 1.x not need such a file to register the JSON provider? — beerye, Aug 10 '16 at 10:57
@beerye You should create an `Application`/`ResourceConfig` sub-class. For more details, check Jersey 2.x documentation about [deployment](https://jersey.java.net/documentation/latest/deployment.html). In Jersey 1.x, [this feature can be turned on in the `web.xml` file](https://jersey.java.net/documentation/1.19.1/user-guide.html#json). — cassiomolin, Aug 10 '16 at 11:04

Justinas Jakavonis · Answer 2 · 2016-08-10T13:11:57.003

0

You may be missing Jersey JSON Jackson (2.x) entity providers support module:

<dependency>
    <groupId>org.glassfish.jersey.media</groupId>
    <artifactId>jersey-media-json-jackson</artifactId>
    <version>2.19</version>
    <scope>compile</scope>
</dependency>

It is recommended to use the same Jersey version in all libs.

edited Aug 10 '16 at 13:11

answered Aug 10 '16 at 07:08

Justinas Jakavonis

8,220
10
69
114

Error parsing JSON param in java REST

2 Answers2

You need a JSON provider

Using Jackson

Linked