main/src/main/java/org/onap/policy/api/main/config/WebConfig.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022 Bell Canada. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.api.main.config;
  22
  23 import com.google.gson.GsonBuilder;
  24 import com.google.gson.JsonParser;
  25 import com.google.gson.JsonSerializer;
  26 import java.util.Arrays;
  27 import java.util.List;
  28 import org.onap.policy.api.main.config.converter.StringToEnumConverter;
  29 import org.onap.policy.common.spring.utils.YamlHttpMessageConverter;
  30 import org.springframework.context.annotation.Configuration;
  31 import org.springframework.format.FormatterRegistry;
  32 import org.springframework.http.MediaType;
  33 import org.springframework.http.converter.HttpMessageConverter;
  34 import org.springframework.http.converter.json.GsonHttpMessageConverter;
  35 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
  36 import springfox.documentation.spring.web.json.Json;
  37
  38 /**
  39  * Register custom converters to Spring configuration.
  40  */
  41 @Configuration
  42 public class WebConfig implements WebMvcConfigurer {
  43     @Override
  44     public void addFormatters(FormatterRegistry registry) {
  45         registry.addConverter(new StringToEnumConverter());
  46     }
  47
  48     @Override
  49     public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
  50         var yamlConverter = new YamlHttpMessageConverter();
  51         yamlConverter.setSupportedMediaTypes(Arrays.asList(MediaType.parseMediaType("application/yaml")));
  52         converters.add(yamlConverter);
  53
  54         GsonHttpMessageConverter converter = buildGsonConverter();
  55         converters.removeIf(GsonHttpMessageConverter.class::isInstance);
  56         converters.add(0, converter);
  57     }
  58
  59     /**
  60      * Swagger uses {{@link springfox.documentation.spring.web.json.Json}} which leads to Gson serialization errors.
  61      * Hence, we customize a typeAdapter on the Gson bean in the Gson http message converter.
  62      *
  63      * @return customised GSON HttpMessageConverter instance.
  64      */
  65     private GsonHttpMessageConverter buildGsonConverter() {
  66         JsonSerializer<Json> serializer = (json, type, jsonSerializationContext) ->
  67             JsonParser.parseString(json.value());
  68         var gson = new GsonBuilder().registerTypeAdapter(Json.class, serializer).create();
  69         return new GsonHttpMessageConverter(gson);
  70     }
  71 }