com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration Maven / Gradle / Ivy
/*
* 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.databind.ObjectMapper;
import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.With;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.function.Consumer;
/**
* JSON:API specific configuration.
*
* @author Kai Toedter
*/
@AllArgsConstructor(access = AccessLevel.PRIVATE)
public class JsonApiConfiguration {
/**
* Indicates if the JSON:API type attribute of resource objects is pluralized.
*
* @param pluralizedTypeRendered The new value of this configuration's pluralizedTypeRendered
* @return The default is {@literal true}.
*/
@With
@Getter
private final boolean pluralizedTypeRendered;
/**
* Indicates if the JSON:API type attribute of resource objects is lower-cased.
*
* @param lowerCasedTypeRendered The new value of this configuration's lowerCasedTypeRendered
* @return The default is {@literal true}.
*/
@With
@Getter
private final boolean lowerCasedTypeRendered;
/**
* Indicates if the JSON:API version is rendered.
*
* If set to true, each rendered JSON:API document will start with
*
*
* "jsonapi": {
* "version": "1.0"
* }
*
*
* @param jsonApiVersionRendered The new value of this configuration's jsonApiVersionRendered
* @return The default is {@literal false}.
*/
@With
@Getter
private final boolean jsonApiVersionRendered;
/**
* Indicates if page meta data (rendered as top level JSON:API meta)
* for a paged model is created automatically.
*
* @param pageMetaAutomaticallyCreated The new value of this configuration's paginationLinksAutomaticallyCreated
* @return The default is {@literal true}.
*/
@With
@Getter
private final boolean pageMetaAutomaticallyCreated;
/**
* You can pass a lambda expression to customize the ObjectMapper used
* for serialization.
*
* @param objectMapperCustomizer the ObjectMapper customizer
*/
@With
private final Consumer objectMapperCustomizer;
@With(AccessLevel.PRIVATE)
private final Map, String> typeForClass;
/**
* Customizes the object mapper if a customizer was set with
* {@literal withObjectMapperCustomizer}.
*
* @param objectMapper the object mapper to be customized
* @return this JsonApiConfiguration
*/
public JsonApiConfiguration customize(ObjectMapper objectMapper) {
this.objectMapperCustomizer.accept(objectMapper);
return this;
}
/**
* Creates a mapping for a given class to get the JSON:API resource object {@literal type}
* when rendered.
*
* @param clazz must not be {@literal null}.
* @param type must not be {@literal null}.
* @return a clone of this object, except with this updated property
*/
public JsonApiConfiguration withTypeForClass(Class clazz, String type) {
Assert.notNull(clazz, "class must not be null!");
Assert.notNull(type, "type must not be null!");
Map, String> map = new LinkedHashMap<>(typeForClass);
map.put(clazz, type);
return withTypeForClass(map);
}
/**
* Returns the {@literal JSON:API resource object type}
* for a given class, when it was added with {@link #withTypeForClass(Class, String)}.
*
* @param clazz must not be {@literal null}.
* @return can return {@literal null}.
*/
public @Nullable
String getTypeForClass(Class clazz) {
Assert.notNull(clazz, "class must not be null!");
return typeForClass.get(clazz);
}
/**
* Creates a new default {@link JsonApiConfiguration}.
*/
public JsonApiConfiguration() {
this.pluralizedTypeRendered = true;
this.lowerCasedTypeRendered = true;
this.jsonApiVersionRendered = false;
this.pageMetaAutomaticallyCreated = true;
this.typeForClass = new LinkedHashMap<>();
this.objectMapperCustomizer = objectMapper -> {
}; // Default to no action.
}
}