Deprecate loader module

europeana · May 29, 2024 · f0d5f19 · f0d5f19
1 parent 8db3b89
commit f0d5f19
Show file tree

Hide file tree

Showing 25 changed files with 47 additions and 3 deletions.
diff --git a/loader/pom.xml b/loader/pom.xml
@@ -14,8 +14,8 @@
     <version>0.9.7-SNAPSHOT</version>
     <packaging>war</packaging>
 
-    <name>Europeana Newspapers Fulltext Loader</name>
-    <description>Europeana Newspapers Fulltext Loader (Spring Boot application)</description>
+    <name>Europeana Newspapers Fulltext Loader - DEPRECATED</name>
+    <description>Europeana Newspapers Fulltext Loader (Spring Boot application) - DEPRECATED</description>
 
     <properties>
         <spring.boot.mainclass>eu.europeana.fulltext.loader.LoaderApplication</spring.boot.mainclass>

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/LoaderApplication.java b/loader/src/main/java/eu/europeana/fulltext/loader/LoaderApplication.java
@@ -10,8 +10,10 @@
  * Main application and configuration.
  *
  * @author Lúthien
+ * @deprecated since 2023
  * Created on 27-02-2018
  */
+@Deprecated
 @SpringBootApplication(scanBasePackages = {"eu.europeana.fulltext.loader", "eu.europeana.fulltext.repository"},
                        exclude = RepositoryRestMvcAutoConfiguration.class)
 

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/config/DataSourceConfig.java b/loader/src/main/java/eu/europeana/fulltext/loader/config/DataSourceConfig.java
@@ -15,8 +15,9 @@
 
 /**
  * Created by luthien on 01/10/2018.
+ * @deprecated since 2023
  */
-
+@Deprecated
 @Configuration
 @PropertySource("classpath:loader.properties")
 @PropertySource(value = "classpath:loader.user.properties", ignoreResourceNotFound = true)

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/config/LoaderDefinitions.java b/loader/src/main/java/eu/europeana/fulltext/loader/config/LoaderDefinitions.java
@@ -2,7 +2,9 @@
 
 /**
  * Created by luthien on 14/06/2018.
+ * @deprecated since 2023
  */
+@Deprecated
 public class LoaderDefinitions {
 
     private LoaderDefinitions(){}

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/config/LoaderSettings.java b/loader/src/main/java/eu/europeana/fulltext/loader/config/LoaderSettings.java
@@ -8,8 +8,10 @@
 /**
  * Contains settings from loader.properties and loader.user.properties files
  * @author Lúthien
+ * @deprecated since 2023
  * Created on 31/05/2018
  */
+@Deprecated
 @Configuration
 @Component
 @PropertySource("classpath:loader.properties")

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/exception/ArchiveNotFoundException.java b/loader/src/main/java/eu/europeana/fulltext/loader/exception/ArchiveNotFoundException.java
@@ -6,9 +6,11 @@
 /**
  * Exception that's thrown when an archive file was not found
  * @author Patrick Ehlert
+ * @deprecated since 2023
  * <p>
  * Created on 12-01-2019
  */
+@Deprecated
 @ResponseStatus(HttpStatus.NOT_FOUND)
 public class ArchiveNotFoundException extends LoaderException {
 

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/exception/ArchiveReadException.java b/loader/src/main/java/eu/europeana/fulltext/loader/exception/ArchiveReadException.java
@@ -6,9 +6,11 @@
 /**
  * Exception that's thrown when there is a problem reading an archive (zip file)
  * @author Patrick Ehlert
+ * @deprecated since 2023
  * <p>
  * Created on 23-08-2018
  */
+@Deprecated
 @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
 public class ArchiveReadException extends LoaderException {
 

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/exception/ConfigurationException.java b/loader/src/main/java/eu/europeana/fulltext/loader/exception/ConfigurationException.java
@@ -6,9 +6,11 @@
 /**
  * Exception that is thrown when there is a problem with the application's configuration
  * @author Patrick Ehlert
+ * @@deprecated since 2023
  * <p>
  * Created on 24-08-2018
  */
+@Deprecated
 @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
 public class ConfigurationException extends LoaderException {
 

diff --git a/...er/src/main/java/eu/europeana/fulltext/loader/exception/DuplicateDefinitionException.java b/...er/src/main/java/eu/europeana/fulltext/loader/exception/DuplicateDefinitionException.java
@@ -6,8 +6,10 @@
 /**
  * Exception thrown we find multiple definitions of which there should be only 1
  * @author Patrick Ehlert
+ * @deprecated 2023
  * Created on 20-10-2018
  */
+@Deprecated
 @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
 public class DuplicateDefinitionException extends LoaderException {
 

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/exception/GlobalExceptionHandler.java b/loader/src/main/java/eu/europeana/fulltext/loader/exception/GlobalExceptionHandler.java
@@ -8,8 +8,10 @@
 /**
  * Global exception handler that catches all errors and logs the interesting ones
  * @author Patrick Ehlert
+ * @deprecated 2023
  * Created on 20-02-2018
  */
+@Deprecated
 @ControllerAdvice
 public class GlobalExceptionHandler {
 

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/exception/IllegalValueException.java b/loader/src/main/java/eu/europeana/fulltext/loader/exception/IllegalValueException.java
@@ -6,8 +6,10 @@
 /**
  * Exception thrown when a field or attribute value is incorrect
  * @author Patrick Ehlert
+ * @deprecated 2023
  * Created on 20-10-2018
  */
+@Deprecated
 @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
 public class IllegalValueException extends LoaderException {
 

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/exception/LoaderException.java b/loader/src/main/java/eu/europeana/fulltext/loader/exception/LoaderException.java
@@ -5,8 +5,10 @@
 /**
  * Base error class for this application (needs work)
  * @author Lúthien
+ * @deprecated since 2023
  * Created on 27-02-2018
  */
+@Deprecated
 public class LoaderException extends Exception {
 
     private static final long serialVersionUID = 1975175733718282374L;

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/exception/MissingDataException.java b/loader/src/main/java/eu/europeana/fulltext/loader/exception/MissingDataException.java
@@ -6,9 +6,11 @@
 /**
  * Exception that is thrown when required data is missing / not present
  * @author Patrick Ehlert
+ * @deprecated since 2023
  * <p>
  * Created on 23-08-2018
  */
+@Deprecated
 @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
 public class MissingDataException extends LoaderException {
 

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/repository/LoaderAnnoPageRepository.java b/loader/src/main/java/eu/europeana/fulltext/loader/repository/LoaderAnnoPageRepository.java
@@ -13,7 +13,9 @@
 /**
  * Repository for retrieving AnnoPage objects / data
  * Created by luthien on 31/05/2018.
+ * @deprecated since 2023
  */
+@Deprecated
 @Repository
 public class LoaderAnnoPageRepository extends AnnoPageRepository {
 

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/repository/LoaderResourceRepository.java b/loader/src/main/java/eu/europeana/fulltext/loader/repository/LoaderResourceRepository.java
@@ -11,7 +11,9 @@
 
 /**
  * Created by luthien on 31/05/2018.
+ * @deprecated since 2023
  */
+@Deprecated
 @Repository
 public class LoaderResourceRepository extends ResourceRepository {
 

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/service/LoadArchiveService.java b/loader/src/main/java/eu/europeana/fulltext/loader/service/LoadArchiveService.java
@@ -26,7 +26,9 @@
 
 /**
  * Created by luthien on 26/07/2018.
+ * @deprecated since 2023
  */
+@Deprecated
 @Service
 public class LoadArchiveService extends SimpleFileVisitor<Path> {
 

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/service/LogFile.java b/loader/src/main/java/eu/europeana/fulltext/loader/service/LogFile.java
@@ -10,8 +10,10 @@
  * Utility class for writing results to a logfile each time we process a dataset
  * Note that anything that is sent to the OUT is also visible in the console
  * @author Patrick Ehlert
+ * @deprecated since 2023
  * Created on 22-08-2018
  */
+@Deprecated
 public class LogFile {
 
     public static final Logger OUT = LogManager.getLogger("logFile");

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/service/MongoSaveMode.java b/loader/src/main/java/eu/europeana/fulltext/loader/service/MongoSaveMode.java
@@ -2,8 +2,10 @@
 
 /**
  * @author Patrick Ehlert
+ * @deprecated since 2023
  * Created on 22-08-2018
  */
+@Deprecated
 public enum MongoSaveMode {
 
     NONE, INSERT

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/service/MongoService.java b/loader/src/main/java/eu/europeana/fulltext/loader/service/MongoService.java
@@ -14,8 +14,10 @@
 
 /**
  * @author Lúthien
+ * @deprecated since 2023
  * Created on 27-02-2018
  */
+@Deprecated
 @Service
 public class MongoService {
 

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/service/ProgressLogger.java b/loader/src/main/java/eu/europeana/fulltext/loader/service/ProgressLogger.java
@@ -8,8 +8,10 @@
 /**
  * Utility class to log progress of long processes
  * @author Patrick Ehlert
+ * @deprecated since 2023
  * Created on 30-03-2018
  */
+@Deprecated
 public class ProgressLogger {
 
     private static final Logger LOG = LogManager.getLogger(ProgressLogger.class);

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/service/XMLParserService.java b/loader/src/main/java/eu/europeana/fulltext/loader/service/XMLParserService.java
@@ -36,7 +36,9 @@
  * Note that during parsing warnings (non-fatal problems) are logged using LogFile.OUT which is prepared in advance to
  * collect parsing output. Fatal errors are thrown exceptions, but we can recover from some of these errors for example,
  * when parsing an individual annotation fails we simply skip that annotation.
+ * @deprecated since 2023
  */
+@Deprecated
 @Service
 public class XMLParserService {
 

diff --git a/loader/src/main/java/eu/europeana/fulltext/loader/web/LoaderController.java b/loader/src/main/java/eu/europeana/fulltext/loader/web/LoaderController.java
@@ -15,8 +15,10 @@
 /**
  * Rest controller that handles incoming requests to parse full text xml files and load them into a database
  * @author Lúthien
+ * @deprecated since 2023
  * Created on 27-02-2018
  */
+@Deprecated
 @RestController
 @RequestMapping("/fulltext")
 public class LoaderController {

diff --git a/loader/src/test/java/eu/europeana/fulltext/loader/test/LoaderApplicationTest.java b/loader/src/test/java/eu/europeana/fulltext/loader/test/LoaderApplicationTest.java
@@ -4,6 +4,7 @@
 import org.junit.Test;
 import org.springframework.boot.test.context.SpringBootTest;
 
+@Deprecated
 @SpringBootTest(classes = LoaderApplication.class)
 public class LoaderApplicationTest {
 

diff --git a/loader/src/test/java/eu/europeana/fulltext/loader/test/LoaderControllerTest.java b/loader/src/test/java/eu/europeana/fulltext/loader/test/LoaderControllerTest.java
@@ -42,6 +42,7 @@
       SecurityAutoConfiguration.class,
       ManagementWebSecurityAutoConfiguration.class
     })
+@Deprecated
 public class LoaderControllerTest {
 
     private static final String ZIP_PROCESSED_OK = "Finished ok";

diff --git a/loader/src/test/java/eu/europeana/fulltext/loader/test/XMLParserServiceTest.java b/loader/src/test/java/eu/europeana/fulltext/loader/test/XMLParserServiceTest.java
@@ -35,6 +35,7 @@
  * @author Patrick Ehlert
  * Created on 20-08-2018
  */
+@Deprecated
 @RunWith(SpringJUnit4ClassRunner.class)
 @TestPropertySource(locations = "classpath:loader-test.properties")
 @SpringBootTest(classes = {LoaderSettings.class})