com.toedter.spring.hateoas.jsonapi.Jackson2JsonApiModule Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.toedter.spring.hateoas.jsonapi;

import com.fasterxml.jackson.core.Version;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.databind.module.SimpleModule;
import org.springframework.hateoas.CollectionModel;
import org.springframework.hateoas.EntityModel;
import org.springframework.hateoas.Links;
import org.springframework.hateoas.PagedModel;
import org.springframework.hateoas.RepresentationModel;

/**
 * Jackson {@link SimpleModule} for {@literal JSON:API} serializers and deserializers.
 *
 * @author Kai Toedter
 */
public class Jackson2JsonApiModule extends SimpleModule {

    public Jackson2JsonApiModule() {

        super("json-api-module",
                new Version(1, 0, 0, null,
                        "com.toedter",
                        "spring-hateoas-jsonapi"));

        setMixInAnnotation(EntityModel.class, EntityModelMixin.class);
        setMixInAnnotation(RepresentationModel.class, RepresentationModelMixin.class);
        setMixInAnnotation(CollectionModel.class, CollectionModelMixin.class);
        setMixInAnnotation(PagedModel.class, PagedModelMixin.class);

        // Links has no default constructor so we cannot use a Mixin
        addSerializer(Links.class, new JsonApiLinksSerializer());
        addDeserializer(Links.class, new JsonApiLinksDeserializer());
    }

    @JsonSerialize(using = JsonApiEntityModelSerializer.class)
    @JsonDeserialize(using = JsonApiEntityModelDeserializer.class)
    abstract static class EntityModelMixin extends EntityModel {
    }

    @JsonSerialize(using = JsonApiRepresentationModelSerializer.class)
    @JsonDeserialize(using = JsonApiRepresentationModelDeserializer.class)
    abstract static class RepresentationModelMixin extends RepresentationModel {
    }

    @JsonSerialize(using = JsonApiCollectionModelSerializer.class)
    @JsonDeserialize(using = JsonApiCollectionModelDeserializer.class)
    abstract static class CollectionModelMixin extends CollectionModel {
    }

    @JsonSerialize(using = JsonApiPagedModelSerializer.class)
    @JsonDeserialize(using = JsonApiPagedModelDeserializer.class)
    abstract static class PagedModelMixin extends PagedModel {
    }
}