Method Throttling

src/main/java/cz/cvut/kbss/termit/config/AppConfig.java

@@ -19,14 +19,17 @@
 
 import cz.cvut.kbss.termit.util.AsyncExceptionHandler;
 import org.springframework.aop.interceptor.AsyncUncaughtExceptionHandler;
+import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.EnableAspectJAutoProxy;
 import org.springframework.context.annotation.EnableMBeanExport;
+import org.springframework.context.annotation.ImportResource;
 import org.springframework.context.annotation.aspectj.EnableSpringConfigured;
 import org.springframework.retry.annotation.EnableRetry;
 import org.springframework.scheduling.annotation.AsyncConfigurer;
 import org.springframework.scheduling.annotation.EnableAsync;
 import org.springframework.scheduling.annotation.EnableScheduling;
+import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
 
 @Configuration
 @EnableMBeanExport
@@ -35,10 +38,24 @@
 @EnableAsync
 @EnableScheduling
 @EnableRetry
+@ImportResource("classpath*:spring-aop.xml")
 public class AppConfig implements AsyncConfigurer {
 
     @Override
     public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
         return new AsyncExceptionHandler();
     }
+
+    /**
+     * This thread pool is responsible for executing long-running tasks in the application.
+     */
+    @Bean(destroyMethod = "destroy")
+    public ThreadPoolTaskScheduler longRunningTaskScheduler(cz.cvut.kbss.termit.util.Configuration config) {
+        ThreadPoolTaskScheduler threadPoolTaskScheduler = new ThreadPoolTaskScheduler();
+        threadPoolTaskScheduler.setPoolSize(config.getAsyncThreadCount());
+        threadPoolTaskScheduler.setThreadNamePrefix("TermItScheduler-");
+        threadPoolTaskScheduler.setWaitForTasksToCompleteOnShutdown(true);
+        threadPoolTaskScheduler.setRemoveOnCancelPolicy(true);
+        return threadPoolTaskScheduler;
+    }
 }

src/main/java/cz/cvut/kbss/termit/config/WebAppConfig.java

@@ -62,19 +62,13 @@
 @Configuration
 public class WebAppConfig implements WebMvcConfigurer {
 
-    private final cz.cvut.kbss.termit.util.Configuration.Repository config;
+    private final cz.cvut.kbss.termit.util.Configuration config;
 
     @Value("${application.version:development}")
     private String version;
 
     public WebAppConfig(cz.cvut.kbss.termit.util.Configuration config) {
-        this.config = config.getRepository();
-    }
-
-    @Bean(name = "objectMapper")
-    @Primary
-    public ObjectMapper objectMapper() {
-        return createJsonObjectMapper();
+        this.config = config;
     }
 
     /**
@@ -99,11 +93,6 @@ public static ObjectMapper createJsonObjectMapper() {
         return objectMapper;
     }
 
-    @Bean(name = "jsonLdMapper")
-    public ObjectMapper jsonLdObjectMapper() {
-        return createJsonLdObjectMapper();
-    }
-
     /**
      * Creates an {@link ObjectMapper} for processing JSON-LD using the JB4JSON-LD library.
      * <p>
@@ -119,9 +108,21 @@ public static ObjectMapper createJsonLdObjectMapper() {
         jsonLdModule.configure(cz.cvut.kbss.jsonld.ConfigParam.SCAN_PACKAGE, "cz.cvut.kbss.termit");
         jsonLdModule.configure(SerializationConstants.FORM, SerializationConstants.FORM_COMPACT_WITH_CONTEXT);
         mapper.registerModule(jsonLdModule);
+        mapper.registerModule(new JavaTimeModule());
         return mapper;
     }
 
+    @Bean(name = "objectMapper")
+    @Primary
+    public ObjectMapper objectMapper() {
+        return createJsonObjectMapper();
+    }
+
+    @Bean(name = "jsonLdMapper")
+    public ObjectMapper jsonLdObjectMapper() {
+        return createJsonLdObjectMapper();
+    }
+
     /**
      * Register the proxy for SPARQL endpoint.
      *
@@ -133,10 +134,11 @@ public ServletWrappingController sparqlEndpointController() throws Exception {
         controller.setServletClass(AdjustedUriTemplateProxyServlet.class);
         controller.setBeanName("sparqlEndpointProxyServlet");
         final Properties p = new Properties();
-        p.setProperty("targetUri", config.getUrl());
+        final cz.cvut.kbss.termit.util.Configuration.Repository repository = config.getRepository();
+        p.setProperty("targetUri", repository.getUrl());
         p.setProperty("log", "false");
-        p.setProperty(ConfigParam.REPO_USERNAME.toString(), config.getUsername() != null ? config.getUsername() : "");
-        p.setProperty(ConfigParam.REPO_PASSWORD.toString(), config.getPassword() != null ? config.getPassword() : "");
+        p.setProperty(ConfigParam.REPO_USERNAME.toString(), repository.getUsername() != null ? repository.getUsername() : "");
+        p.setProperty(ConfigParam.REPO_PASSWORD.toString(), repository.getPassword() != null ? repository.getPassword() : "");
         controller.setInitParameters(p);
         controller.afterPropertiesSet();
         return controller;
@@ -147,7 +149,7 @@ public SimpleUrlHandlerMapping sparqlQueryControllerMapping() throws Exception {
         SimpleUrlHandlerMapping mapping = new SimpleUrlHandlerMapping();
         mapping.setOrder(0);
         final Map<String, Object> urlMap = Collections.singletonMap(Constants.REST_MAPPING_PATH + "/query",
-                                                                    sparqlEndpointController());
+                sparqlEndpointController());
         mapping.setUrlMap(urlMap);
         return mapping;
     }
@@ -193,10 +195,10 @@ public FilterRegistrationBean<DiagnosticsContextFilter> mdcFilter() {
     @Bean
     public OpenAPI customOpenAPI() {
         return new OpenAPI().components(new Components().addSecuritySchemes("bearer-key",
-                                                                            new SecurityScheme().type(
-                                                                                                        SecurityScheme.Type.HTTP)
-                                                                                                .scheme("bearer")
-                                                                                                .bearerFormat("JWT")))
+                                    new SecurityScheme().type(
+                                                                SecurityScheme.Type.HTTP)
+                                                        .scheme("bearer")
+                                                        .bearerFormat("JWT")))
                             .info(new Info().title("TermIt REST API").description("TermIt REST API definition.")
                                             .version(version));
     }

src/main/java/cz/cvut/kbss/termit/config/WebSocketMessageBrokerConfig.java

@@ -4,19 +4,17 @@
 import cz.cvut.kbss.termit.util.Constants;
 import cz.cvut.kbss.termit.websocket.handler.StompExceptionHandler;
 import cz.cvut.kbss.termit.websocket.handler.WebSocketExceptionHandler;
-import cz.cvut.kbss.termit.websocket.handler.WebSocketMessageWithHeadersValueHandler;
-import org.jetbrains.annotations.NotNull;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Lazy;
 import org.springframework.core.Ordered;
 import org.springframework.core.annotation.Order;
+import org.springframework.lang.NonNull;
 import org.springframework.messaging.Message;
 import org.springframework.messaging.converter.MappingJackson2MessageConverter;
 import org.springframework.messaging.converter.MessageConverter;
 import org.springframework.messaging.converter.StringMessageConverter;
 import org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver;
-import org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandler;
 import org.springframework.messaging.simp.SimpMessagingTemplate;
 import org.springframework.messaging.simp.config.ChannelRegistration;
 import org.springframework.messaging.simp.config.MessageBrokerRegistry;
@@ -88,17 +86,12 @@ public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentRes
      * @see <a href="https://github.com/spring-projects/spring-security/blob/6.3.x/config/src/main/java/org/springframework/security/config/annotation/web/socket/WebSocketMessageBrokerSecurityConfiguration.java#L97">Spring security source</a>
      */
     @Override
-    public void configureClientInboundChannel(@NotNull ChannelRegistration registration) {
+    public void configureClientInboundChannel(@NonNull ChannelRegistration registration) {
         AuthorizationChannelInterceptor interceptor = new AuthorizationChannelInterceptor(messageAuthorizationManager);
         interceptor.setAuthorizationEventPublisher(new SpringAuthorizationEventPublisher(context));
         registration.interceptors(webSocketJwtAuthorizationInterceptor, new SecurityContextChannelInterceptor(), interceptor);
     }
 
-    @Override
-    public void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers) {
-        returnValueHandlers.add(new WebSocketMessageWithHeadersValueHandler(simpMessagingTemplate));
-    }
-
     @Override
     public void registerStompEndpoints(StompEndpointRegistry registry) {
         registry.addEndpoint("/ws").setAllowedOrigins(allowedOrigins.split(","));

src/main/java/cz/cvut/kbss/termit/event/FileTextAnalysisFinishedEvent.java

@@ -0,0 +1,23 @@
+package cz.cvut.kbss.termit.event;
+
+import cz.cvut.kbss.termit.model.resource.File;
+import org.springframework.lang.NonNull;
+
+import java.net.URI;
+
+/**
+ * Indicates that text analysis of a file was finished
+ */
+public class FileTextAnalysisFinishedEvent extends VocabularyEvent {
+
+    private final URI fileUri;
+
+    public FileTextAnalysisFinishedEvent(Object source, @NonNull File file) {
+        super(source, file.getDocument().getVocabulary());
+        this.fileUri = file.getUri();
+    }
+
+    public URI getFileUri() {
+        return fileUri;
+    }
+}

src/main/java/cz/cvut/kbss/termit/event/LongRunningTaskChangedEvent.java

@@ -0,0 +1,22 @@
+package cz.cvut.kbss.termit.event;
+
+import cz.cvut.kbss.termit.util.longrunning.LongRunningTaskStatus;
+import org.springframework.context.ApplicationEvent;
+import org.springframework.lang.NonNull;
+
+/**
+ * Indicates a status change of a long-running task.
+ */
+public class LongRunningTaskChangedEvent extends ApplicationEvent {
+
+    private final LongRunningTaskStatus status;
+
+    public LongRunningTaskChangedEvent(@NonNull Object source, final @NonNull LongRunningTaskStatus status) {
+        super(source);
+        this.status = status;
+    }
+
+    public @NonNull LongRunningTaskStatus getStatus() {
+        return status;
+    }
+}

src/main/java/cz/cvut/kbss/termit/event/TermDefinitionTextAnalysisFinishedEvent.java

@@ -0,0 +1,22 @@
+package cz.cvut.kbss.termit.event;
+
+import cz.cvut.kbss.termit.model.AbstractTerm;
+import org.springframework.lang.NonNull;
+
+import java.net.URI;
+
+/**
+ * Indicates that a text analysis of a term definition was finished
+ */
+public class TermDefinitionTextAnalysisFinishedEvent extends VocabularyEvent {
+    private final URI termUri;
+
+    public TermDefinitionTextAnalysisFinishedEvent(@NonNull Object source, @NonNull AbstractTerm term) {
+        super(source, term.getVocabulary());
+        this.termUri = term.getUri();
+    }
+
+    public URI getTermUri() {
+        return termUri;
+    }
+}

src/main/java/cz/cvut/kbss/termit/event/VocabularyContentModified.java → src/main/java/cz/cvut/kbss/termit/event/VocabularyContentModifiedEvent.java

@@ -17,7 +17,7 @@
  */
 package cz.cvut.kbss.termit.event;
 
-import org.springframework.context.ApplicationEvent;
+import org.springframework.lang.NonNull;
 
 import java.net.URI;
 
@@ -26,16 +26,9 @@
  * <p>
  * This typically means a term is added, removed or modified. Modification of vocabulary metadata themselves is not considered here.
  */
-public class VocabularyContentModified extends ApplicationEvent {
+public class VocabularyContentModifiedEvent extends VocabularyEvent {
 
-    private final URI vocabularyIri;
-
-    public VocabularyContentModified(Object source, URI vocabularyIri) {
-        super(source);
-        this.vocabularyIri = vocabularyIri;
-    }
-
-    public URI getVocabularyIri() {
-        return vocabularyIri;
+    public VocabularyContentModifiedEvent(@NonNull Object source, @NonNull URI vocabularyIri) {
+        super(source, vocabularyIri);
     }
 }

src/main/java/cz/cvut/kbss/termit/event/VocabularyCreatedEvent.java

@@ -17,14 +17,16 @@
  */
 package cz.cvut.kbss.termit.event;
 
-import org.springframework.context.ApplicationEvent;
+import org.springframework.lang.NonNull;
+
+import java.net.URI;
 
 /**
  * Indicates that a vocabulary has been created.
  */
-public class VocabularyCreatedEvent extends ApplicationEvent {
+public class VocabularyCreatedEvent extends VocabularyEvent {
 
-    public VocabularyCreatedEvent(Object source) {
-        super(source);
+    public VocabularyCreatedEvent(@NonNull Object source, @NonNull URI vocabularyIri) {
+        super(source, vocabularyIri);
     }
 }

src/main/java/cz/cvut/kbss/termit/event/VocabularyEvent.java

@@ -0,0 +1,28 @@
+package cz.cvut.kbss.termit.event;
+
+import org.springframework.context.ApplicationEvent;
+import org.springframework.lang.NonNull;
+
+import java.net.URI;
+import java.util.Objects;
+
+/**
+ * Base class for vocabulary related events
+ */
+public abstract class VocabularyEvent extends ApplicationEvent {
+    protected final URI vocabularyIri;
+
+    protected VocabularyEvent(@NonNull Object source, @NonNull URI vocabularyIri) {
+        super(source);
+        Objects.requireNonNull(vocabularyIri);
+        this.vocabularyIri = vocabularyIri;
+    }
+
+    /**
+     * The identifier of the vocabulary to which this event is bound
+     * @return vocabulary IRI
+     */
+    public URI getVocabularyIri() {
+        return vocabularyIri;
+    }
+}

src/main/java/cz/cvut/kbss/termit/event/VocabularyValidationFinishedEvent.java

@@ -0,0 +1,49 @@
+package cz.cvut.kbss.termit.event;
+
+import cz.cvut.kbss.termit.model.validation.ValidationResult;
+import org.springframework.lang.NonNull;
+
+import java.net.URI;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * Indicates that validation for a set of vocabularies was finished.
+ */
+public class VocabularyValidationFinishedEvent extends VocabularyEvent {
+
+    /**
+     * Vocabulary closure of {@link #vocabularyIri}.
+     * IRIs of vocabularies that are imported by {@link #vocabularyIri} and were part of the validation.
+     */
+    private final List<URI> vocabularyIris;
+
+    private final List<ValidationResult> validationResults;
+
+    /**
+     * @param source the source of the event
+     * @param originVocabularyIri Vocabulary closure of {@link #vocabularyIri}.
+     * @param vocabularyIris IRI of the vocabulary on which the validation was triggered.
+     * @param validationResults results of the validation
+     */
+    public VocabularyValidationFinishedEvent(@NonNull Object source, @NonNull URI originVocabularyIri,
+                                             @NonNull Collection<URI> vocabularyIris,
+                                             @NonNull List<ValidationResult> validationResults) {
+        super(source, originVocabularyIri);
+        // defensive copy
+        this.vocabularyIris = new ArrayList<>(vocabularyIris);
+        this.validationResults = new ArrayList<>(validationResults);
+    }
+
+    @NonNull
+    public List<URI> getVocabularyIris() {
+        return Collections.unmodifiableList(vocabularyIris);
+    }
+
+    @NonNull
+    public List<ValidationResult> getValidationResults() {
+        return Collections.unmodifiableList(validationResults);
+    }
+}