feat(QTDI-1449): add CacheClear class

Author: undx

component-server-parent/component-server-api/src/main/java/org/talend/sdk/component/server/api/CacheResource.java

@@ -15,13 +15,16 @@
  */
 package org.talend.sdk.component.server.api;
 
+import static javax.ws.rs.core.MediaType.APPLICATION_JSON;
+
 import javax.ws.rs.GET;
 import javax.ws.rs.Path;
-import javax.ws.rs.core.Response;
 
 import org.eclipse.microprofile.openapi.annotations.Operation;
+import org.eclipse.microprofile.openapi.annotations.media.Content;
 import org.eclipse.microprofile.openapi.annotations.responses.APIResponse;
 import org.eclipse.microprofile.openapi.annotations.tags.Tag;
+import org.talend.sdk.component.server.front.model.CacheClear;
 
 @Path("cache")
 @Tag(name = "Cache", description = "Endpoints related to caches management.")
@@ -30,6 +33,7 @@ public interface CacheResource {
     @GET
     @Path("clear")
     @Operation(operationId = "clearCaches", description = "Clear all caches.")
-    @APIResponse(responseCode = "200", description = "Cleared caches.")
-    Response clearCaches();
+    @APIResponse(responseCode = "200", description = "Cleared caches.",
+            content = @Content(mediaType = APPLICATION_JSON))
+    CacheClear clearCaches();
 }

component-server-parent/component-server-model/src/main/java/org/talend/sdk/component/server/front/model/CacheClear.java

@@ -0,0 +1,28 @@
+/**
+ * Copyright (C) 2006-2025 Talend Inc. - www.talend.com
+ *
+ * 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.talend.sdk.component.server.front.model;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@AllArgsConstructor
+@NoArgsConstructor
+public class CacheClear {
+
+    private long clearedCacheCount;
+}

component-server-parent/component-server/src/main/java/org/talend/sdk/component/server/service/jcache/FrontCacheResolver.java

@@ -16,11 +16,8 @@
 package org.talend.sdk.component.server.service.jcache;
 
 import static java.util.Optional.ofNullable;
-import static javax.ws.rs.core.MediaType.APPLICATION_JSON_TYPE;
 
 import java.lang.annotation.Annotation;
-import java.util.Collections;
-import java.util.Map;
 import java.util.concurrent.TimeUnit;
 import java.util.stream.StreamSupport;
 
@@ -35,7 +32,6 @@
 import javax.cache.configuration.Configuration;
 import javax.enterprise.context.ApplicationScoped;
 import javax.inject.Inject;
-import javax.ws.rs.core.Response;
 
 import org.apache.geronimo.jcache.simple.cdi.CacheResolverImpl;
 import org.eclipse.microprofile.config.inject.ConfigProperty;
@@ -44,6 +40,7 @@
 import org.talend.sdk.component.server.front.ComponentResourceImpl;
 import org.talend.sdk.component.server.front.ConfigurationTypeResourceImpl;
 import org.talend.sdk.component.server.front.EnvironmentResourceImpl;
+import org.talend.sdk.component.server.front.model.CacheClear;
 import org.talend.sdk.component.server.front.model.Environment;
 import org.talend.sdk.component.server.service.ComponentManagerService;
 import org.talend.sdk.components.vault.jcache.CacheConfigurationFactory;
@@ -147,14 +144,10 @@ public void cleanupCaches() {
     }
 
     @Override
-    public Response clearCaches() {
+    public CacheClear clearCaches() {
         final long clearedCacheCount = countActiveCaches();
-        Map<String, Long> stringStringMap = Collections.singletonMap("clearedCacheCount", clearedCacheCount);
         service.redeployPlugins();
-        return Response
-                .ok(stringStringMap)
-                .type(APPLICATION_JSON_TYPE)
-                .build();
+        return new CacheClear(clearedCacheCount);
     }
 
     /**

component-server-parent/component-server/src/test/java/org/talend/sdk/component/server/service/jcache/FrontCacheResolverTest.java

@@ -18,18 +18,16 @@
 import static javax.ws.rs.core.MediaType.APPLICATION_JSON_TYPE;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
-import java.util.Map;
-
 import javax.inject.Inject;
 import javax.ws.rs.client.WebTarget;
 import javax.ws.rs.core.Response;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.ObjectMapper;
 
 import org.apache.meecrowave.junit5.MonoMeecrowaveConfig;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.talend.sdk.component.server.front.model.CacheClear;
 import org.talend.sdk.component.server.service.ComponentManagerService;
 import org.talend.sdk.component.server.test.ComponentClient;
 
@@ -77,11 +75,9 @@ void clearCaches() throws JsonProcessingException {
                 .request(APPLICATION_JSON_TYPE)
                 .get();
         assertEquals(200, resp.getStatus());
+        final CacheClear cleared = resp.readEntity(CacheClear.class);
 
-        ObjectMapper objectMapper = new ObjectMapper();
-        Map<String, Object> responseMap = objectMapper.readValue(resp.readEntity(String.class), Map.class);
-
-        assertEquals(2, (Integer) responseMap.get("clearedCacheCount"));
+        assertEquals(2, cleared.getClearedCacheCount());
         assertEquals(0, cacheResolver.countActiveCaches());
         assertEquals(connectors, service.getConnectors().getPluginsList().size());
     }