[sling-whiteboard] 02/05: rename sitemap Externalizer

[di...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

diru pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-whiteboard.git

commit cd904940290e93ef78d5a5f5da665e6a4e84d515
Author: Dirk Rudolph <di...@apache.org>
AuthorDate: Mon Jun 7 10:29:45 2021 +0200

    rename sitemap Externalizer
    
    In order to better reflect its purpose, rename the Externalizer interface
    to SitemapLinkExternalizer.
---
 sitemap/src/main/java/org/apache/sling/sitemap/SitemapService.java  | 4 ++--
 .../common/{Externalizer.java => SitemapLinkExternalizer.java}      | 6 +++---
 .../main/java/org/apache/sling/sitemap/impl/SitemapServiceImpl.java | 4 ++--
 .../src/main/java/org/apache/sling/sitemap/impl/SitemapServlet.java | 4 ++--
 .../test/java/org/apache/sling/sitemap/impl/SitemapServletTest.java | 1 -
 5 files changed, 9 insertions(+), 10 deletions(-)

diff --git a/sitemap/src/main/java/org/apache/sling/sitemap/SitemapService.java b/sitemap/src/main/java/org/apache/sling/sitemap/SitemapService.java
index 10cf7f7..190db7f 100644
--- a/sitemap/src/main/java/org/apache/sling/sitemap/SitemapService.java
+++ b/sitemap/src/main/java/org/apache/sling/sitemap/SitemapService.java
@@ -19,7 +19,7 @@
 package org.apache.sling.sitemap;
 
 import org.apache.sling.api.resource.Resource;
-import org.apache.sling.sitemap.common.Externalizer;
+import org.apache.sling.sitemap.common.SitemapLinkExternalizer;
 import org.jetbrains.annotations.NotNull;
 import org.osgi.annotation.versioning.ProviderType;
 
@@ -43,7 +43,7 @@ public interface SitemapService {
      * Numbers for size and entries can only be provided for sitemaps served from storage. For sitemap index or
      * on-demand sitemaps {@code -1} will be returned.
      * <p>
-     * The default implementation uses {@link Externalizer#externalize(Resource)} to create absolute urls.
+     * The default implementation uses {@link SitemapLinkExternalizer#externalize(Resource)} to create absolute urls.
      *
      * @param sitemapRoot a {@link Resource} having {@link SitemapService#PROPERTY_SITEMAP_ROOT} set to true
      * @return the url, or null
diff --git a/sitemap/src/main/java/org/apache/sling/sitemap/common/Externalizer.java b/sitemap/src/main/java/org/apache/sling/sitemap/common/SitemapLinkExternalizer.java
similarity index 90%
rename from sitemap/src/main/java/org/apache/sling/sitemap/common/Externalizer.java
rename to sitemap/src/main/java/org/apache/sling/sitemap/common/SitemapLinkExternalizer.java
index 74e3c0f..0354d9f 100644
--- a/sitemap/src/main/java/org/apache/sling/sitemap/common/Externalizer.java
+++ b/sitemap/src/main/java/org/apache/sling/sitemap/common/SitemapLinkExternalizer.java
@@ -27,12 +27,12 @@ import org.osgi.annotation.versioning.ConsumerType;
  * Consumers may implement this interface to override the default externalisation behaviour.
  */
 @ConsumerType
-public interface Externalizer {
+public interface SitemapLinkExternalizer {
 
     /**
-     * A default implementation of the {@link Externalizer} which may be used as fallback.
+     * A default implementation of the {@link SitemapLinkExternalizer} which may be used as fallback.
      */
-    Externalizer DEFAULT = new Externalizer() {
+    SitemapLinkExternalizer DEFAULT = new SitemapLinkExternalizer() {
         @Override
         public @Nullable String externalize(SlingHttpServletRequest context, String uri) {
             return context.getResourceResolver().map(context, uri);
diff --git a/sitemap/src/main/java/org/apache/sling/sitemap/impl/SitemapServiceImpl.java b/sitemap/src/main/java/org/apache/sling/sitemap/impl/SitemapServiceImpl.java
index 6cbee90..22e6111 100644
--- a/sitemap/src/main/java/org/apache/sling/sitemap/impl/SitemapServiceImpl.java
+++ b/sitemap/src/main/java/org/apache/sling/sitemap/impl/SitemapServiceImpl.java
@@ -23,7 +23,7 @@ import org.apache.sling.event.jobs.Job;
 import org.apache.sling.event.jobs.JobManager;
 import org.apache.sling.sitemap.SitemapInfo;
 import org.apache.sling.sitemap.SitemapService;
-import org.apache.sling.sitemap.common.Externalizer;
+import org.apache.sling.sitemap.common.SitemapLinkExternalizer;
 import org.jetbrains.annotations.NotNull;
 import org.osgi.service.component.annotations.*;
 import org.osgi.service.metatype.annotations.AttributeDefinition;
@@ -58,7 +58,7 @@ public class SitemapServiceImpl implements SitemapService {
     private static final Logger LOG = LoggerFactory.getLogger(SitemapServiceImpl.class);
 
     @Reference(cardinality = ReferenceCardinality.OPTIONAL, policyOption = ReferencePolicyOption.GREEDY)
-    private Externalizer externalizer = Externalizer.DEFAULT;
+    private SitemapLinkExternalizer externalizer = SitemapLinkExternalizer.DEFAULT;
     @Reference
     private JobManager jobManager;
     @Reference
diff --git a/sitemap/src/main/java/org/apache/sling/sitemap/impl/SitemapServlet.java b/sitemap/src/main/java/org/apache/sling/sitemap/impl/SitemapServlet.java
index 15ff464..a254a10 100644
--- a/sitemap/src/main/java/org/apache/sling/sitemap/impl/SitemapServlet.java
+++ b/sitemap/src/main/java/org/apache/sling/sitemap/impl/SitemapServlet.java
@@ -23,7 +23,7 @@ import org.apache.sling.api.SlingHttpServletResponse;
 import org.apache.sling.api.resource.Resource;
 import org.apache.sling.api.servlets.ServletResolverConstants;
 import org.apache.sling.api.servlets.SlingSafeMethodsServlet;
-import org.apache.sling.sitemap.common.Externalizer;
+import org.apache.sling.sitemap.common.SitemapLinkExternalizer;
 import org.apache.sling.sitemap.SitemapException;
 import org.apache.sling.sitemap.generator.SitemapGenerator;
 import org.apache.sling.sitemap.impl.builder.extensions.ExtensionProviderManager;
@@ -79,7 +79,7 @@ public class SitemapServlet extends SlingSafeMethodsServlet {
     };
 
     @Reference(cardinality = ReferenceCardinality.OPTIONAL, policyOption = ReferencePolicyOption.GREEDY)
-    private Externalizer externalizer = Externalizer.DEFAULT;
+    private SitemapLinkExternalizer externalizer = SitemapLinkExternalizer.DEFAULT;
     @Reference
     private SitemapGeneratorManager generatorManager;
     @Reference
diff --git a/sitemap/src/test/java/org/apache/sling/sitemap/impl/SitemapServletTest.java b/sitemap/src/test/java/org/apache/sling/sitemap/impl/SitemapServletTest.java
index b2e5b7f..02b4172 100644
--- a/sitemap/src/test/java/org/apache/sling/sitemap/impl/SitemapServletTest.java
+++ b/sitemap/src/test/java/org/apache/sling/sitemap/impl/SitemapServletTest.java
@@ -23,7 +23,6 @@ import org.apache.sling.api.resource.Resource;
 import org.apache.sling.event.jobs.JobManager;
 import org.apache.sling.serviceusermapping.ServiceUserMapped;
 import org.apache.sling.sitemap.TestResourceTreeSitemapGenerator;
-import org.apache.sling.sitemap.common.Externalizer;
 import org.apache.sling.sitemap.generator.SitemapGenerator;
 import org.apache.sling.sitemap.impl.builder.SitemapImplTest;
 import org.apache.sling.sitemap.impl.builder.extensions.ExtensionProviderManager;