org.springframework.hateoas.config.WebConverters Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-hateoas Show documentation
Library to support implementing representations for hyper-text driven REST web services.
There is a newer version: 2.4.0
/*
 * Copyright 2019-2024 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 org.springframework.hateoas.config;

import java.util.List;
import java.util.Map;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.util.Assert;

import com.fasterxml.jackson.databind.ObjectMapper;

/**
 * Value type to handle registration of hypermedia related {@link HttpMessageConverter}s.
 *
 * @author Oliver Drotbohm
 */
public class WebConverters {

	private static MediaType ANY_JSON = MediaType.parseMediaType("application/*+json");

	private final List infos;
	private final ObjectMapper mapper;

	/**
	 * Creates a new {@link WebConverters} from the given {@link ObjectMapper} and {@link HypermediaMappingInformation}s.
	 *
	 * @param mapper must not be {@literal null}.
	 * @param mappingInformation must not be {@literal null}.
	 */
	private WebConverters(ObjectMapper mapper, List mappingInformation) {

		this.mapper = mapper;
		this.infos = mappingInformation;
	}

	/**
	 * Creates a new {@link WebConverters} from the given {@link ObjectMapper} and {@link HypermediaMappingInformation}s.
	 *
	 * @param mapper must not be {@literal null}.
	 * @param mappingInformations must not be {@literal null}.
	 * @return
	 */
	public static WebConverters of(ObjectMapper mapper, List mappingInformations) {

		Assert.notNull(mapper, "ObjectMapper must not be null!");
		Assert.notNull(mappingInformations, "Mapping information must not be null!");

		return new WebConverters(mapper, mappingInformations);
	}

	List getSupportedMediaTypes() {

		return infos.stream() //
				.flatMap(it -> it.getMediaTypes().stream())
				.collect(Collectors.toList());
	}

	/**
	 * Augments the given {@link List} of {@link HttpMessageConverter}s with the hypermedia enabled ones.
	 *
	 * @param converters must not be {@literal null}.
	 */
	public void augmentServer(List> converters) {
		augment(converters, false);
	}

	public void augmentClient(List> converters) {
		augment(converters, true);
	}

	private void augment(List> converters, boolean includeGenericJsonTypes) {

		Assert.notNull(converters, "HttpMessageConverters must not be null!");

		MappingJackson2HttpMessageConverter converter = converters.stream()
				.filter(it -> MappingJackson2HttpMessageConverter.class.equals(it.getClass()))
				.map(MappingJackson2HttpMessageConverter.class::cast)
				.findFirst()
				.orElseGet(() -> new MappingJackson2HttpMessageConverter(mapper));

		ObjectMapper first = null;

		for (HypermediaMappingInformation info : infos) {

			Class rootType = info.getRootType();
			ObjectMapper objectMapper = info.configureObjectMapper(mapper.copy());

			if (first == null) {
				first = objectMapper;
			}

			Map mappers = info.getMediaTypes().stream().distinct()
					.collect(Collectors.toMap(Function.identity(), __ -> objectMapper));

			converter.registerObjectMappersForType(rootType, map -> map.putAll(mappers));
		}

		if (!includeGenericJsonTypes || infos.isEmpty()) {
			return;
		}

		Class rootType = infos.get(0).getRootType();
		ObjectMapper mapper = first;

		converter.registerObjectMappersForType(rootType, map -> {
			Stream.of(MediaType.APPLICATION_JSON, ANY_JSON)
					.forEach(it -> map.put(it, mapper));
		});
	}
}