de.ingogriebsch.spring.hateoas.siren.SirenEntityModelSerializer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-hateoas-siren Show documentation

A library implementing Siren as a custom Spring HATEOAS hypermedia type. Siren is a hypermedia specification for representing entities.

The newest version!

/*-
 * Copyright 2019-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 de.ingogriebsch.spring.hateoas.siren;

import static com.google.common.collect.Lists.newArrayList;
import static de.ingogriebsch.spring.hateoas.siren.RepresentationModelUtils.isRepresentationModel;
import static de.ingogriebsch.spring.hateoas.siren.RepresentationModelUtils.isRepresentationModelSubclass;

import java.io.IOException;
import java.util.List;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.BeanProperty;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import org.springframework.hateoas.EntityModel;
import org.springframework.lang.Nullable;

/**
 * {@link JsonSerializer} implementation which is able to serialize a {@link EntityModel} into a Siren entity.
 * 
 * @author Ingo Griebsch
 * @since 1.0.0
 * @see EntityModel
 */
class SirenEntityModelSerializer extends AbstractSirenSerializer> {

    private static final long serialVersionUID = 2893716845519287714L;

    SirenEntityModelSerializer(SirenConfiguration configuration, SirenSerializerFacilities serializerFacilities) {
        this(configuration, serializerFacilities, null);
    }

    SirenEntityModelSerializer(SirenConfiguration configuration, SirenSerializerFacilities serializerFacilities,
        @Nullable BeanProperty property) {
        super(EntityModel.class, configuration, serializerFacilities, property);
    }

    @Override
    public JsonSerializer createContextual(SerializerProvider prov, @Nullable BeanProperty property) {
        return new SirenEntityModelSerializer(configuration, serializerFacilities, property);
    }

    @Override
    public void serialize(EntityModel model, JsonGenerator gen, SerializerProvider provider) throws IOException {
        assertSubclassingIsEnabledIfModelIsSubclassed(model);

        SirenNavigables navigables = getLinkConverter().to(model.getLinks());

        SirenEntity sirenEntity = SirenEntity.builder() //
            .actions(navigables.getActions()) //
            .classes(classes(model)) //
            .links(navigables.getLinks()) //
            .entities(entities(model)) //
            .properties(properties(model)) //
            .rels(rels(model, provider)) //
            .title(title(model)) //
            .build();

        JsonSerializer