Merge pull request #11335 from irynamatveieva/xml-message-converter

Shaded MappingJackson2XmlHttpMessageConverter class

application/src/main/java/org/springframework/http/converter/xml/MappingJackson2XmlHttpMessageConverter.java

@@ -0,0 +1,68 @@
+/**
+ * Copyright © 2016-2024 The Thingsboard 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
+ *
+ *     http://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.http.converter.xml;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.xml.XmlMapper;
+import org.springframework.http.MediaType;
+import org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter;
+import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
+import org.springframework.util.Assert;
+
+import java.lang.reflect.Type;
+import java.nio.charset.StandardCharsets;
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * RestTemplate firstly uses MappingJackson2XmlHttpMessageConverter converter instead of MappingJackson2HttpMessageConverter.
+ * It produces error UnsupportedMediaType, so this converter had to be shadowed for read and write operations to use the correct converter
+ */
+public class MappingJackson2XmlHttpMessageConverter extends AbstractJackson2HttpMessageConverter {
+    private static final List<MediaType> problemDetailMediaTypes;
+
+    public MappingJackson2XmlHttpMessageConverter() {
+        this(Jackson2ObjectMapperBuilder.xml().build());
+    }
+
+    public MappingJackson2XmlHttpMessageConverter(ObjectMapper objectMapper) {
+        super(objectMapper, new MediaType[]{new MediaType("application", "xml", StandardCharsets.UTF_8), new MediaType("text", "xml", StandardCharsets.UTF_8), new MediaType("application", "*+xml", StandardCharsets.UTF_8)});
+        Assert.isInstanceOf(XmlMapper.class, objectMapper, "XmlMapper required");
+    }
+
+    public void setObjectMapper(ObjectMapper objectMapper) {
+        Assert.isInstanceOf(XmlMapper.class, objectMapper, "XmlMapper required");
+        super.setObjectMapper(objectMapper);
+    }
+
+    protected List<MediaType> getMediaTypesForProblemDetail() {
+        return problemDetailMediaTypes;
+    }
+
+    static {
+        problemDetailMediaTypes = Collections.singletonList(MediaType.APPLICATION_PROBLEM_XML);
+    }
+
+    @Override
+    public boolean canRead(Type type, Class<?> contextClass, MediaType mediaType) {
+        return false;
+    }
+
+    @Override
+    public boolean canWrite(Class<?> clazz, MediaType mediaType) {
+        return false;
+    }
+}

application/src/test/java/org/thingsboard/server/system/RestTemplateConvertersTest.java

@@ -17,20 +17,45 @@ package org.thingsboard.server.system;
 
 import lombok.extern.slf4j.Slf4j;
 import org.junit.Test;
-import org.junit.jupiter.api.Assertions;
+import org.springframework.http.MediaType;
+import org.springframework.mock.http.client.MockClientHttpRequest;
+import org.springframework.test.web.client.MockRestServiceServer;
 import org.springframework.util.ClassUtils;
 import org.springframework.web.client.RestTemplate;
 
+import java.nio.charset.StandardCharsets;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo;
+import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;
+
 
 @Slf4j
 public class RestTemplateConvertersTest {
 
     @Test
-    public void testJacksonXmlConverter() {
+    public void testMappingJackson2HttpMessageConverterIsUsedInsteadOfMappingJackson2XmlHttpMessageConverter() {
         ClassLoader classLoader = RestTemplate.class.getClassLoader();
         boolean jackson2XmlPresent = ClassUtils.isPresent("com.fasterxml.jackson.dataformat.xml.XmlMapper", classLoader);
-        Assertions.assertFalse(jackson2XmlPresent, "XmlMapper must not be present in classpath, please, exclude \"jackson-dataformat-xml\" dependency!");
-        //If this xml mapper will be present in classpath then we will get "Unsupported Media Type" in RestTemplate
+        assertThat(jackson2XmlPresent).isTrue();
+
+        RestTemplate restTemplate = new RestTemplate();
+        MockRestServiceServer mockServer = MockRestServiceServer.createServer(restTemplate);
+        mockServer.expect(requestTo("/test"))
+                .andExpect(request -> {
+                    MockClientHttpRequest mockRequest = (MockClientHttpRequest) request;
+                    byte[] body = mockRequest.getBodyAsBytes();
+                    String requestBody = new String(body, StandardCharsets.UTF_8);
+                    assertThat(requestBody).contains("{\"name\":\"test\",\"value\":1}");
+                })
+                .andRespond(withSuccess("{\"name\":\"test\",\"value\":1}", MediaType.APPLICATION_JSON));
+
+        TestObject requestObject = new TestObject("test", 1);
+        TestObject actualObject = restTemplate.postForObject("/test", requestObject, TestObject.class);
+        assertThat(actualObject).isEqualTo(requestObject);
+        mockServer.verify();
     }
 
+    record TestObject(String name, int value) {}
+
 }

pom.xml

@@ -2092,10 +2092,6 @@
                         <groupId>io.jsonwebtoken</groupId>
                         <artifactId>jjwt-impl</artifactId>
                     </exclusion>
-                    <exclusion>
-                        <groupId>com.fasterxml.jackson.dataformat</groupId>
-                        <artifactId>jackson-dataformat-xml</artifactId>
-                    </exclusion>
                 </exclusions>
             </dependency>
             <dependency>