Move to inject the CamelContext (Islandora#1)

* Change up instantiation/initialization slightly. * PostConstruct is allowed to apply to private methods... ... seems like a false-positive in PMD? Got example exception from: https://stackoverflow.com/a/48679770 * Changing to camel's 3.7.6 LTS.
adam-vessey · Dec 6, 2021 · 309089b · 309089b
1 parent abe052a
commit 309089b
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 49 deletions.
diff --git a/build.gradle b/build.gradle
@@ -55,7 +55,7 @@ subprojects {
         versions = [
             activemq: '5.16.0',
             asmCommons: '5.0.3',
-            camel: '3.5.0',
+            camel: '3.7.6',
             commonsIo: '2.8.0',
             fcrepoCamel: '5.0.0',
             fcrepoCamelToolbox: '5.0.0',

diff --git a/gradle/pmd/ruleset.xml b/gradle/pmd/ruleset.xml
@@ -26,7 +26,12 @@
   <rule ref="category/java/bestpractices.xml/UnusedImports" />
   <rule ref="category/java/bestpractices.xml/UnusedLocalVariable" />
   <rule ref="category/java/bestpractices.xml/UnusedPrivateField" />
-  <rule ref="category/java/bestpractices.xml/UnusedPrivateMethod" />
+  <rule ref="category/java/bestpractices.xml/UnusedPrivateMethod">
+    <properties>
+      <property name="violationSuppressXPath"
+                value="ancestor::ClassOrInterfaceBodyDeclaration/Annotation/MarkerAnnotation/Name[@Image='PostConstruct']" />
+    </properties>
+  </rule>
   <rule ref="category/java/bestpractices.xml/UseAssertEqualsInsteadOfAssertTrue" />
   <rule ref="category/java/bestpractices.xml/UseAssertNullInsteadOfAssertTrue" />
   <rule ref="category/java/bestpractices.xml/UseAssertSameInsteadOfAssertTrue" />

diff --git a/...-derivative/src/main/java/ca/islandora/alpaca/connector/derivative/DerivativeOptions.java b/...-derivative/src/main/java/ca/islandora/alpaca/connector/derivative/DerivativeOptions.java
@@ -23,14 +23,12 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 
+import javax.annotation.PostConstruct;
+
 import org.apache.camel.CamelContext;
 import org.slf4j.Logger;
-import org.springframework.beans.BeansException;
-import org.springframework.beans.factory.BeanInitializationException;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
-import org.springframework.context.ApplicationContext;
-import org.springframework.context.ApplicationContextAware;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.core.env.Environment;
 
@@ -41,7 +39,7 @@
  * @author whikloj
  */
 @Configuration
-public class DerivativeOptions extends PropertyConfig implements ApplicationContextAware {
+public class DerivativeOptions extends PropertyConfig {
 
   private static final Logger LOGGER = getLogger(DerivativeOptions.class);
 
@@ -53,11 +51,12 @@ public class DerivativeOptions extends PropertyConfig implements ApplicationCont
   private static final String DERIVATIVE_CONCURRENT_PROPERTY = "concurrent-consumers";
   private static final String DERIVATIVE_MAX_CONCURRENT_PROPERTY = "max-concurrent-consumers";
 
-  private static final int MINIMUM_NUMBER_OF_CAMEL_CONTEXTS = 1;
-
   @Autowired
   private Environment environment;
 
+  @Autowired
+  private CamelContext camelContext;
+
   @Value("${" + DERIVATIVE_LIST_PROPERTY + ":#{null}}")
   private String derivativeSystems;
 
@@ -69,7 +68,8 @@ public class DerivativeOptions extends PropertyConfig implements ApplicationCont
    * @throws Exception
    *   When unable to add routes to the camel context.
    */
-  private void processAllServices(final CamelContext camelContext) throws Exception {
+  @PostConstruct
+  private void processAllServices() throws Exception {
     if (derivativeSystems != null && !derivativeSystems.isBlank()) {
       final var systemNames = derivativeSystems.contains(",") ?
               Arrays.stream(derivativeSystems.split(",")).filter(o -> !o.isBlank()).map(String::trim)
@@ -78,7 +78,7 @@ private void processAllServices(final CamelContext camelContext) throws Exceptio
         final var enabled =
                 environment.getProperty(enabledProperty(system), Boolean.class, false);
         if (enabled) {
-          startDerivativeService(camelContext, system);
+          startDerivativeService(system);
         } else {
           LOGGER.debug("Derivative connector (" + system + ") is disabled, skipping");
         }
@@ -96,7 +96,7 @@ private void processAllServices(final CamelContext camelContext) throws Exceptio
    * @throws Exception
    *   When unable to add routes to the camel context.
    */
-  private void startDerivativeService(final CamelContext camelContext, final String serviceName) throws Exception {
+  private void startDerivativeService(final String serviceName) throws Exception {
       final var input = environment.getProperty(inputProperty(serviceName), "");
       final var output = environment.getProperty(outputProperty(serviceName), "");
       if (!input.isBlank() && !output.isBlank()) {
@@ -180,22 +180,4 @@ private String maxConcurrentConsumerProperty(final String systemName) {
     return DERIVATIVE_PREFIX + "." + systemName + "." + DERIVATIVE_MAX_CONCURRENT_PROPERTY;
   }
 
-  /**
-   * camelContext.addRoutes throws Exception, which PMD does not like you catching. So we ignore that rule.
-   */
-  @SuppressWarnings("PMD.AvoidCatchingGenericException")
-  @Override
-  public void setApplicationContext(final ApplicationContext applicationContext) throws BeansException {
-    final String[] names = applicationContext.getBeanNamesForType(CamelContext.class);
-    if (names.length >= MINIMUM_NUMBER_OF_CAMEL_CONTEXTS) {
-      final CamelContext camelContext = applicationContext.getBean(names[0], CamelContext.class);
-      try {
-        processAllServices(camelContext);
-      } catch (final Exception e) {
-        throw new BeanInitializationException("Failed to add derivative route to Camel Context", e);
-      }
-    } else {
-      LOGGER.error("No CamelContext found, unable to start derivative routes.");
-    }
-  }
 }
diff --git a/...ative/src/test/java/ca/islandora/alpaca/connector/derivative/DerivativeConnectorTest.java b/...ative/src/test/java/ca/islandora/alpaca/connector/derivative/DerivativeConnectorTest.java
@@ -26,7 +26,7 @@
 import org.apache.camel.Exchange;
 import org.apache.camel.Produce;
 import org.apache.camel.ProducerTemplate;
-import org.apache.camel.builder.AdviceWithRouteBuilder;
+import org.apache.camel.builder.AdviceWith;
 import org.apache.camel.component.mock.MockEndpoint;
 import org.apache.camel.model.ModelCamelContext;
 import org.apache.camel.spring.javaconfig.CamelConfiguration;
@@ -71,7 +71,7 @@ public void testDerivativeConnector() throws Exception {
         final String route = "IslandoraConnectorDerivative-testRoutes";
 
         final var context = camelContext.adapt(ModelCamelContext.class);
-        AdviceWithRouteBuilder.adviceWith(context, route, a -> {
+        AdviceWith.adviceWith(context, route, a -> {
             a.replaceFromWith("direct:start");
 
             // Rig Drupal REST endpoint to return canned jsonld

diff --git a/...-indexing-fcrepo/src/test/java/ca/islandora/alpaca/indexing/fcrepo/FcrepoIndexerTest.java b/...-indexing-fcrepo/src/test/java/ca/islandora/alpaca/indexing/fcrepo/FcrepoIndexerTest.java
@@ -23,7 +23,7 @@
 import org.apache.camel.Exchange;
 import org.apache.camel.Produce;
 import org.apache.camel.ProducerTemplate;
-import org.apache.camel.builder.AdviceWithRouteBuilder;
+import org.apache.camel.builder.AdviceWith;
 import org.apache.camel.builder.RouteBuilder;
 import org.apache.camel.component.mock.MockEndpoint;
 import org.apache.camel.model.ToDynamicDefinition;
@@ -70,10 +70,10 @@ public void testNode() throws Exception {
         final String nodeSubRoute = "FcrepoIndexerNodeIndex";
 
         context.disableJMX();
-        AdviceWithRouteBuilder.adviceWith(context, route, a ->
+        AdviceWith.adviceWith(context, route, a ->
             a.replaceFromWith("direct:start")
         );
-        AdviceWithRouteBuilder.adviceWith(context, nodeSubRoute, a ->
+        AdviceWith.adviceWith(context, nodeSubRoute, a ->
             a.weaveByType(ToDynamicDefinition.class).selectIndex(0).replace().toD("mock:localhost:8000" +
                     "/milliner/node/${exchangeProperty.uuid}")
         );
@@ -107,10 +107,10 @@ public void testNodeVersion() throws Exception {
         final String versionSubRoute = "FcrepoIndexerNodeVersion";
 
         context.disableJMX();
-        AdviceWithRouteBuilder.adviceWith(context, route, a ->
+        AdviceWith.adviceWith(context, route, a ->
             a.replaceFromWith("direct:start")
         );
-        AdviceWithRouteBuilder.adviceWith(context, versionSubRoute, a ->
+        AdviceWith.adviceWith(context, versionSubRoute, a ->
             a.weaveByType(ToDynamicDefinition.class).selectIndex(0).replace().toD("mock:localhost:8000" +
                     "/milliner/node/${exchangeProperty.uuid}/version")
         );
@@ -141,7 +141,7 @@ public void testNodeDelete() throws Exception {
         final String route = "FcrepoIndexerDeleteNode";
 
         context.disableJMX();
-        AdviceWithRouteBuilder.adviceWith(context, route, a -> {
+        AdviceWith.adviceWith(context, route, a -> {
             a.replaceFromWith("direct:start");
             a.weaveByType(ToDynamicDefinition.class).selectIndex(0).replace().toD("mock:localhost:8000/milliner/node" +
                     "/${exchangeProperty.uuid}");
@@ -174,7 +174,7 @@ public void testExternalFile() throws Exception {
         final String route = "FcrepoIndexerExternalFile";
 
         context.disableJMX();
-        AdviceWithRouteBuilder.adviceWith(context, route, a -> {
+        AdviceWith.adviceWith(context, route, a -> {
             a.replaceFromWith("direct:start");
             a.weaveByType(ToDynamicDefinition.class).selectIndex(0).replace().toD("mock:localhost:8000/milliner/" +
                     "external/${exchangeProperty.uuid}");
@@ -212,10 +212,10 @@ public void testMedia() throws Exception {
         final String mediaSubRoute = "FcrepoIndexerMediaIndex";
 
         context.disableJMX();
-        AdviceWithRouteBuilder.adviceWith(context, route, a ->
+        AdviceWith.adviceWith(context, route, a ->
             a.replaceFromWith("direct:start")
         );
-        AdviceWithRouteBuilder.adviceWith(context, mediaSubRoute, a->
+        AdviceWith.adviceWith(context, mediaSubRoute, a->
             a.weaveByType(ToDynamicDefinition.class).selectIndex(0).replace().toD("mock:localhost:8000/milliner/" +
                     "media/${exchangeProperty.sourceField}")
         );
@@ -250,8 +250,8 @@ public void testVersionMedia() throws Exception {
         final String versionSubRoute = "FcrepoIndexerMediaIndexVersion";
 
         context.disableJMX();
-        AdviceWithRouteBuilder.adviceWith(context, route, a -> a.replaceFromWith("direct:start"));
-        AdviceWithRouteBuilder.adviceWith(context, versionSubRoute, a ->
+        AdviceWith.adviceWith(context, route, a -> a.replaceFromWith("direct:start"));
+        AdviceWith.adviceWith(context, versionSubRoute, a ->
             a.weaveByType(ToDynamicDefinition.class).selectIndex(0).replace().toD("mock:localhost:8000/milliner/" +
                     "media/${exchangeProperty.sourceField}/version")
         );

diff --git a/...estore/src/test/java/ca/islandora/alpaca/indexing/triplestore/TriplestoreIndexerTest.java b/...estore/src/test/java/ca/islandora/alpaca/indexing/triplestore/TriplestoreIndexerTest.java
@@ -31,7 +31,7 @@
 import org.apache.camel.Exchange;
 import org.apache.camel.Produce;
 import org.apache.camel.ProducerTemplate;
-import org.apache.camel.builder.AdviceWithRouteBuilder;
+import org.apache.camel.builder.AdviceWith;
 import org.apache.camel.builder.RouteBuilder;
 import org.apache.camel.component.mock.MockEndpoint;
 import org.apache.camel.spring.javaconfig.CamelConfiguration;
@@ -80,7 +80,7 @@ public boolean isUseRouteBuilder() {
     public void testParseUrl() throws Exception {
         final String route = "IslandoraTriplestoreIndexerParseUrl";
 
-        AdviceWithRouteBuilder.adviceWith(context, route, a -> {
+        AdviceWith.adviceWith(context, route, a -> {
             a.replaceFromWith("direct:start");
             a.weaveAddLast().to(resultEndpoint);
         });
@@ -110,7 +110,7 @@ public void testParseUrl() throws Exception {
     public void testParseUrlDiesOnNoJsonld() throws Exception {
         final String route = "IslandoraTriplestoreIndexerParseUrl";
 
-        AdviceWithRouteBuilder.adviceWith(context, route, a -> {
+        AdviceWith.adviceWith(context, route, a -> {
             a.replaceFromWith("direct:start");
             a.weaveAddLast().to(resultEndpoint);
         });
@@ -133,7 +133,7 @@ public void testParseUrlDiesOnNoJsonld() throws Exception {
     public void testParseUrlDiesOnNoCanonical() throws Exception {
         final String route = "IslandoraTriplestoreIndexerParseUrl";
 
-        AdviceWithRouteBuilder.adviceWith(context, route, a -> {
+        AdviceWith.adviceWith(context, route, a -> {
             a.replaceFromWith("direct:start");
             a.weaveAddLast().to(resultEndpoint);
         });
@@ -157,7 +157,7 @@ public void testIndex() throws Exception {
         final String route = "IslandoraTriplestoreIndexer";
 
         context.disableJMX();
-        AdviceWithRouteBuilder.adviceWith(context, route, a -> {
+        AdviceWith.adviceWith(context, route, a -> {
             a.replaceFromWith("direct:start");
 
             // Rig Drupal REST endpoint to return canned jsonld
@@ -211,7 +211,7 @@ public void testDelete() throws Exception {
         final String route = "IslandoraTriplestoreIndexerDelete";
 
         context.disableJMX();
-        AdviceWithRouteBuilder.adviceWith(context, route, a -> {
+        AdviceWith.adviceWith(context, route, a -> {
             a.replaceFromWith("direct:start");
             a.mockEndpoints("broker:*");
             a.mockEndpointsAndSkip("http://localhost:8080/bigdata/namespace/islandora/sparql?" +