[EAK-651] Introduce Relay resource provider service

all/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <groupId>com.exadel.etoolbox</groupId>
         <artifactId>etoolbox-authoring-kit</artifactId>
-        <version>2.7.1-SNAPSHOT</version>
+        <version>2.8.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>etoolbox-authoring-kit-all</artifactId>

core/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <groupId>com.exadel.etoolbox</groupId>
         <artifactId>etoolbox-authoring-kit</artifactId>
-        <version>2.7.1-SNAPSHOT</version>
+        <version>2.8.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>etoolbox-authoring-kit-core</artifactId>
@@ -74,11 +74,6 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
-                <configuration>
-                    <includes>
-                        <include>**/AllTests.class</include>
-                    </includes>
-                </configuration>
             </plugin>
         </plugins>
     </build>

core/src/main/java/com/exadel/aem/toolkit/core/configurator/models/internal/ConfigAccess.java

@@ -13,19 +13,18 @@
  */
 package com.exadel.aem.toolkit.core.configurator.models.internal;
 
-import java.util.Objects;
 import javax.servlet.http.HttpServletRequest;
 
 import org.apache.commons.lang3.StringUtils;
 import org.osgi.framework.BundleContext;
-import org.osgi.framework.FrameworkUtil;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import com.adobe.granite.ui.components.ExpressionCustomizer;
 
 import com.exadel.aem.toolkit.core.configurator.services.ConfigChangeListener;
 import com.exadel.aem.toolkit.core.configurator.utils.PermissionUtil;
 import com.exadel.aem.toolkit.core.configurator.utils.RequestUtil;
+import com.exadel.aem.toolkit.core.utils.ServiceUtil;
 
 /**
  * Enumerates possible outcomes of a configuration access request
@@ -132,16 +131,10 @@ private static ConfigAccess pick(HttpServletRequest request) {
      * @return True or false
      */
     static boolean isGrantable(HttpServletRequest request) {
-        try {
-            BundleContext context = (BundleContext) request.getAttribute(BundleContext.class.getName());
-            if (context == null) {
-                context = Objects.requireNonNull(FrameworkUtil.getBundle(ConfigAccess.class).getBundleContext());
-            }
-            ConfigChangeListener listener = Objects.requireNonNull(context.getService(context.getServiceReference(ConfigChangeListener.class)));
-            return listener.isEnabled();
-        } catch (RuntimeException e) {
-            LOG.error("Could not acquire an OSGi entity", e);
-            return false;
+        BundleContext context = (BundleContext) request.getAttribute(BundleContext.class.getName());
+        if (context != null) {
+            return ServiceUtil.withService(ConfigChangeListener.class, context, ConfigChangeListener::isEnabled, false);
         }
+        return ServiceUtil.withService(ConfigChangeListener.class, ConfigChangeListener::isEnabled, false);
     }
 }

core/src/main/java/com/exadel/aem/toolkit/core/configurator/models/internal/ConfigDefinition.java

@@ -42,6 +42,7 @@
 import com.exadel.aem.toolkit.core.configurator.ConfiguratorConstants;
 import com.exadel.aem.toolkit.core.configurator.utils.PermissionUtil;
 import com.exadel.aem.toolkit.core.configurator.utils.RequestUtil;
+import com.exadel.aem.toolkit.core.utils.ServiceUtil;
 
 /**
  * Represents a configuration definition, i.e., a set of configuration attributes united by the same PID together
@@ -293,17 +294,15 @@ public static ConfigDefinition from(HttpServletRequest request) {
      * does not exist
      */
     private static ConfigDefinition from(String pid, BundleContext context) {
-        ConfigurationAdmin configurationAdmin;
-        MetaTypeService metaTypeService;
-        try {
-            configurationAdmin = Objects.requireNonNull(context.getService(context.getServiceReference(ConfigurationAdmin.class)));
-            metaTypeService = Objects.requireNonNull(context.getService(context.getServiceReference(MetaTypeService.class)));
-        } catch (RuntimeException e) {
-            LOG.error("Could not acquire OSGi entity", e);
+        if (context == null) {
+            LOG.error("Cannot retrieve configuration for {}: no bundle context available", pid);
             return EMPTY;
         }
-
-        Configuration configuration = getConfigurationObject(configurationAdmin, pid);
+        Configuration configuration = ServiceUtil.withService(
+            ConfigurationAdmin.class,
+            context,
+            ca -> getConfigurationObject(ca, pid),
+            null);
         if (configuration == null) {
             return EMPTY;
         }
@@ -312,25 +311,31 @@ private static ConfigDefinition from(String pid, BundleContext context) {
             && !StringUtils.equals(configuration.getPid(), configuration.getFactoryPid());
         String metatypePid = isFactoryInstance ? configuration.getFactoryPid() : configuration.getPid();
 
-        for (Bundle bundle : context.getBundles()) {
-            MetaTypeInformation metaTypeInformation = metaTypeService.getMetaTypeInformation(bundle);
-            if (metaTypeInformation == null) {
-                continue;
-            }
-            ObjectClassDefinition ocd;
-            try {
-                ocd = Objects.requireNonNull(metaTypeInformation.getObjectClassDefinition(metatypePid, null));
-            } catch (IllegalArgumentException | NullPointerException e) {
-                // Not an error: this actually happens if the configuration is not present in the current bundle
-                continue;
-            }
-            ConfigDefinition result = from(configuration, ocd);
-            result.isFactory = ArrayUtils.contains(metaTypeInformation.getFactoryPids(), pid);
-            result.pid = pid;
-            result.factoryPid = configuration.getFactoryPid();
-            return result;
-        }
-        return EMPTY;
+        return ServiceUtil.withService(
+            MetaTypeService.class,
+            context,
+            mts -> {
+                for (Bundle bundle : context.getBundles()) {
+                    MetaTypeInformation metaTypeInformation = mts.getMetaTypeInformation(bundle);
+                    if (metaTypeInformation == null) {
+                        continue;
+                    }
+                    ObjectClassDefinition ocd;
+                    try {
+                        ocd = Objects.requireNonNull(metaTypeInformation.getObjectClassDefinition(metatypePid, null));
+                    } catch (IllegalArgumentException | NullPointerException e) {
+                        // Not an error: this actually happens if the configuration is not present in the current bundle
+                        continue;
+                    }
+                    ConfigDefinition result = from(configuration, ocd);
+                    result.isFactory = ArrayUtils.contains(metaTypeInformation.getFactoryPids(), pid);
+                    result.pid = pid;
+                    result.factoryPid = configuration.getFactoryPid();
+                    return result;
+                }
+                return EMPTY;
+            },
+            EMPTY);
     }
 
     /**

core/src/main/java/com/exadel/aem/toolkit/core/configurator/services/ConfigChangeListener.java

@@ -51,6 +51,7 @@
 
 import com.exadel.aem.toolkit.core.CoreConstants;
 import com.exadel.aem.toolkit.core.configurator.ConfiguratorConstants;
+import com.exadel.aem.toolkit.core.utils.ResolverUtil;
 import com.exadel.aem.toolkit.core.utils.ValueMapUtil;
 
 /**
@@ -96,7 +97,7 @@ public class ConfigChangeListener implements ResourceChangeListener, ExternalRes
     @Activate
     void activate(BundleContext context, ConfigChangeListenerConfiguration config) {
         LOG.info("Configuration change listener is {}", config.enabled() ? "enabled" : "disabled");
-        try (ResourceResolver resolver = newResolver()) {
+        try (ResourceResolver resolver = ResolverUtil.newResolver(resourceResolverFactory)) {
             if (ArrayUtils.isNotEmpty(config.cleanUp())) {
                 activateWithCleanUp(resolver, config.cleanUp());
             }
@@ -225,7 +226,7 @@ public void onChange(List<ResourceChange> list) {
             return;
         }
         asyncExecutor.submit(() -> {
-            try (ResourceResolver resolver = newResolver()) {
+            try (ResourceResolver resolver = ResolverUtil.newResolver(resourceResolverFactory)) {
                 for (String path : configsToUpdate) {
                     Resource resource = resolver.getResource(path);
                     if (resource == null) {
@@ -247,21 +248,6 @@ public void onChange(List<ResourceChange> list) {
         });
     }
 
-    /* --------------------
-       Sling instance logic
-       -------------------- */
-
-    /**
-     * Creates a new {@link ResourceResolver} instance for accessing repository resources
-     * @return New instance of {@code ResourceResolver}
-     * @throws LoginException If the resolver cannot be created
-     */
-    private ResourceResolver newResolver() throws LoginException {
-        return resourceResolverFactory.getServiceResourceResolver(
-            Collections.singletonMap(ResourceResolverFactory.SUBSERVICE, "eak-service")
-        );
-    }
-
     /* -------------------
        Configuration logic
        ------------------- */

core/src/main/java/com/exadel/aem/toolkit/core/configurator/servlets/form/ConfigDataSource.java

@@ -14,13 +14,13 @@
 
 package com.exadel.aem.toolkit.core.configurator.servlets.form;
 
+import javax.annotation.Nonnull;
 import javax.servlet.Servlet;
 
 import org.apache.sling.api.SlingHttpServletRequest;
 import org.apache.sling.api.SlingHttpServletResponse;
 import org.apache.sling.api.servlets.HttpConstants;
 import org.apache.sling.api.servlets.SlingSafeMethodsServlet;
-import org.jetbrains.annotations.NotNull;
 import org.osgi.service.component.annotations.Component;
 
 import com.exadel.aem.toolkit.core.configurator.models.internal.ConfigDefinition;
@@ -45,7 +45,7 @@ public class ConfigDataSource extends SlingSafeMethodsServlet {
      * @param response The HTTP response
      */
     @Override
-    protected void doGet(@NotNull SlingHttpServletRequest request, @NotNull SlingHttpServletResponse response) {
+    protected void doGet(@Nonnull SlingHttpServletRequest request, @Nonnull SlingHttpServletResponse response) {
         ConfigDefinition config = ConfigDefinition.from(request);
         if (config == null || !config.isValid()) {
             return;

core/src/main/java/com/exadel/aem/toolkit/core/configurator/servlets/replication/ReplicationServlet.java

@@ -15,6 +15,7 @@
 
 import java.io.IOException;
 import java.util.Objects;
+import javax.annotation.Nonnull;
 import javax.jcr.Session;
 import javax.servlet.Servlet;
 
@@ -25,7 +26,6 @@
 import org.apache.sling.api.resource.ResourceResolver;
 import org.apache.sling.api.servlets.HttpConstants;
 import org.apache.sling.api.servlets.SlingAllMethodsServlet;
-import org.jetbrains.annotations.NotNull;
 import org.osgi.framework.BundleContext;
 import org.osgi.service.component.annotations.Activate;
 import org.osgi.service.component.annotations.Component;
@@ -100,8 +100,8 @@ private void deactivate() {
      */
     @Override
     protected void doPost(
-        @NotNull SlingHttpServletRequest request,
-        @NotNull SlingHttpServletResponse response) throws IOException {
+        @Nonnull SlingHttpServletRequest request,
+        @Nonnull SlingHttpServletResponse response) throws IOException {
 
         if (!configChangeListener.isEnabled()) {
             sendError(response, SlingHttpServletResponse.SC_SERVICE_UNAVAILABLE, ConfigAccess.DISABLED.getError());

core/src/main/java/com/exadel/aem/toolkit/core/relay/models/ChangeSample.java

@@ -0,0 +1,95 @@
+/*
+ * 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 com.exadel.aem.toolkit.core.relay.models;
+
+import java.util.Objects;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * Represents a change announcement entry defining a JCR path or XPath to report as changed when the relay is enabled or
+ * disabled.
+ * <p><u>Note</u>: This class is not a part of the public API and is subject to change. Do not use it in your own
+ * code</p>
+ */
+public class ChangeSample {
+    private final String path;
+    private final int limit;
+    private final String user;
+
+    /**
+     * Creates a new {@code ChangeSample} with the provided path, limit and user values
+     * @param path  JCR path or XPath expression to report as changed
+     * @param limit Optional limit of resources to report as changed under the provided path
+     * @param user  Optional user identifier to use for reporting changes
+     */
+    @JsonCreator
+    ChangeSample(
+        @JsonProperty("path") String path,
+        @JsonProperty("limit") int limit,
+        @JsonProperty("user") String user) {
+        this.path = path;
+        this.limit = limit;
+        this.user = user;
+    }
+
+    /**
+     * Gets the JCR path or XPath expression defined in this announcement
+     * @return String value
+     */
+    public String getPath() {
+        return path;
+    }
+
+    /**
+     * Gets the optional limit of resources to report as changed under the provided path
+     * @return Integer limit value
+     */
+    public int getLimit() {
+        return limit;
+    }
+
+    /**
+     * Gets the optional user identifier to use for reporting changes
+     * @return A nullable user identifier string
+     */
+    public String getUser() {
+        return user;
+    }
+
+    /**
+     * {@inheritDoc}
+     * <p>The equality check is based solely on the {@code path} property since we do not want to report the
+     * same path as changed multiple times</p>
+     */
+    @Override
+    public final boolean equals(Object other) {
+        if (!(other instanceof ChangeSample)) {
+            return false;
+        }
+        ChangeSample announcement = (ChangeSample) other;
+        return Objects.equals(path, announcement.path);
+    }
+
+    /**
+     * {@inheritDoc}
+     * <p>The hash code is based solely on the {@code path} property since we do not want to report the same path as
+     * changed multiple times</p>
+     */
+    @Override
+    public int hashCode() {
+        return Objects.hashCode(path);
+    }
+}