feat(template-plugin): adapt template plugin to stateless RoutePlugin interface

Author: christophechevalier

pom.xml

@@ -77,7 +77,7 @@
     <dependency>
       <groupId>io.github.linagora.linid.im</groupId>
       <artifactId>linid-im-api-corelib</artifactId>
-      <version>0.7.2</version>
+      <version>0.12.0</version>
       <scope>provided</scope>
     </dependency>
     <dependency>

template-plugin/src/main/java/io/github/linagora/linid/im/myplugin/MyPluginRoutePlugin.java

@@ -27,8 +27,9 @@
 package io.github.linagora.linid.im.myplugin;
 
 import io.github.linagora.linid.im.corelib.plugin.config.dto.EntityConfiguration;
-import io.github.linagora.linid.im.corelib.plugin.route.AbstractRoutePlugin;
+import io.github.linagora.linid.im.corelib.plugin.config.dto.RouteConfiguration;
 import io.github.linagora.linid.im.corelib.plugin.route.RouteDescription;
+import io.github.linagora.linid.im.corelib.plugin.route.RoutePlugin;
 import jakarta.servlet.http.HttpServletRequest;
 import java.util.List;
 import lombok.extern.slf4j.Slf4j;
@@ -41,25 +42,28 @@
  */
 @Slf4j
 @Component
-public class MyPluginRoutePlugin extends AbstractRoutePlugin {
+public class MyPluginRoutePlugin implements RoutePlugin {
 
   @Override
   public boolean supports(final @NonNull String type) {
     return "MyPlugin".equals(type);
   }
 
   @Override
-  public List<RouteDescription> getRoutes(List<EntityConfiguration> list) {
+  public List<RouteDescription> getRoutes(final RouteConfiguration configuration,
+                                          final List<EntityConfiguration> list) {
     return List.of(new RouteDescription("GET", "/myPlugin", null, List.of()));
   }
 
   @Override
-  public boolean match(final String url, final String method) {
+  public boolean match(final RouteConfiguration configuration,
+                       final String url, final String method) {
     return url.endsWith("/api/MyPlugin");
   }
 
   @Override
-  public ResponseEntity<?> execute(final HttpServletRequest request) {
+  public ResponseEntity<?> execute(final RouteConfiguration configuration,
+                                   final HttpServletRequest request) {
     log.info("Receiving request on route 'MyPlugin'");
     return ResponseEntity.ok("MyPlugin route");
   }

template-plugin/src/test/java/io/github/linagora/linid/im/myplugin/MyPluginRoutePluginTest.java

@@ -31,6 +31,7 @@
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
+import io.github.linagora.linid.im.corelib.plugin.config.dto.RouteConfiguration;
 import io.github.linagora.linid.im.corelib.plugin.route.RouteDescription;
 import java.util.List;
 import org.junit.jupiter.api.DisplayName;
@@ -57,21 +58,24 @@ void testSupports() {
   @Test
   @DisplayName("Test getRoutes: should return true only on MyPlugin")
   void testGetRoutes() {
+    var configuration = new RouteConfiguration();
     var expected = List.of(new RouteDescription("GET", "/myPlugin", null, List.of()));
-    assertEquals(expected, plugin.getRoutes(List.of()));
+    assertEquals(expected, plugin.getRoutes(configuration, List.of()));
   }
 
   @Test
   @DisplayName("Test match: should return true on valid route")
   void testMatch() {
-    assertTrue(plugin.match("/api/MyPlugin", "GET"));
-    assertFalse(plugin.match("Other", "GET"));
+    var configuration = new RouteConfiguration();
+    assertTrue(plugin.match(configuration, "/api/MyPlugin", "GET"));
+    assertFalse(plugin.match(configuration, "Other", "GET"));
   }
 
   @Test
   @DisplayName("Test execute: should return ok response")
   void testExecute() {
-    var response = plugin.execute(null);
+    var configuration = new RouteConfiguration();
+    var response = plugin.execute(configuration, null);
 
     assertNotNull(response);
     assertEquals(HttpStatus.OK.value(), response.getStatusCode().value());