You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by bd...@apache.org on 2018/06/19 12:38:25 UTC

[sling-whiteboard] 02/02: Add CapabilitiesSource.getNamespace() method

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

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

commit 173325e041572c031adae40c18d24eafd7f23b13
Author: Bertrand Delacretaz <bd...@apache.org>
AuthorDate: Tue Jun 19 14:38:14 2018 +0200

    Add CapabilitiesSource.getNamespace() method
---
 .../org/apache/sling/capabilities/CapabilitiesSource.java   | 10 ++++------
 .../sling/capabilities/internal/CapabilitiesServlet.java    |  3 +--
 .../sling/capabilities/internal/JvmCapabilitiesSource.java  | 11 ++++++-----
 .../internal/OsgiFrameworkCapabilitiesSource.java           | 13 +++++++------
 4 files changed, 18 insertions(+), 19 deletions(-)

diff --git a/capabilities/src/main/java/org/apache/sling/capabilities/CapabilitiesSource.java b/capabilities/src/main/java/org/apache/sling/capabilities/CapabilitiesSource.java
index 0474de9..b2a92ab 100644
--- a/capabilities/src/main/java/org/apache/sling/capabilities/CapabilitiesSource.java
+++ b/capabilities/src/main/java/org/apache/sling/capabilities/CapabilitiesSource.java
@@ -29,13 +29,11 @@ import org.osgi.annotation.versioning.ProviderType;
  */
 @ProviderType
 public interface CapabilitiesSource {
-    /** Services that implement this interface must be registered
-     *  with a unique value for this service property. It is used
-     *  to define the namespace of the capabilities provided by this
-     *  source, and group them in the JSON output of the capabilities
-     *  servlet.
+    
+    /** @return the namespace to use to group our capabilities.
+     *  That name must be unique in a given Sling instance.
      */
-    String PREFIX_SERVICE_PROPERTY = "sling.capabilities.prefix";
+    String getNamespace();
     
     /** @return zero to N capabilities, each being represented by
      *      a key/value pair of Strings.
diff --git a/capabilities/src/main/java/org/apache/sling/capabilities/internal/CapabilitiesServlet.java b/capabilities/src/main/java/org/apache/sling/capabilities/internal/CapabilitiesServlet.java
index 8a1cab9..84fa79b 100644
--- a/capabilities/src/main/java/org/apache/sling/capabilities/internal/CapabilitiesServlet.java
+++ b/capabilities/src/main/java/org/apache/sling/capabilities/internal/CapabilitiesServlet.java
@@ -71,8 +71,7 @@ public class CapabilitiesServlet extends SlingSafeMethodsServlet {
                 values = new HashMap<>();
                 values.put("_EXCEPTION_", e.getClass().getName() + ":" + e.getMessage());
             }
-            // TODO use service property
-            jw.key(s.getClass().getName());
+            jw.key(s.getNamespace());
             jw.object();
             for(Map.Entry<String, String> e : values.entrySet()) {
                 jw.key(e.getKey());
diff --git a/capabilities/src/main/java/org/apache/sling/capabilities/internal/JvmCapabilitiesSource.java b/capabilities/src/main/java/org/apache/sling/capabilities/internal/JvmCapabilitiesSource.java
index 91d13f4..399e78d 100644
--- a/capabilities/src/main/java/org/apache/sling/capabilities/internal/JvmCapabilitiesSource.java
+++ b/capabilities/src/main/java/org/apache/sling/capabilities/internal/JvmCapabilitiesSource.java
@@ -26,14 +26,15 @@ import org.apache.sling.capabilities.CapabilitiesSource;
 /**
  * Builds Probes that provide basic JVM information, as an example.
  */
-@Component(
-    service = CapabilitiesSource.class,
-    property = {
-        CapabilitiesSource.PREFIX_SERVICE_PROPERTY + "=org.apache.sling.capabilities.examples.JvmCapabilitiesSource"
-})
+@Component(service = CapabilitiesSource.class)
 public class JvmCapabilitiesSource implements CapabilitiesSource {
 
     @Override
+    public String getNamespace() {
+        return "org.apache.sling.capabilities.demo." + getClass().getSimpleName();
+    }
+    
+    @Override
     public Map<String, String> getCapabilities() throws Exception {
         // Return semi-useful JVM properties for our proof of concept
         final Map<String, String> result = new HashMap<>();
diff --git a/capabilities/src/main/java/org/apache/sling/capabilities/internal/OsgiFrameworkCapabilitiesSource.java b/capabilities/src/main/java/org/apache/sling/capabilities/internal/OsgiFrameworkCapabilitiesSource.java
index 5442e2b..2a1a30f 100644
--- a/capabilities/src/main/java/org/apache/sling/capabilities/internal/OsgiFrameworkCapabilitiesSource.java
+++ b/capabilities/src/main/java/org/apache/sling/capabilities/internal/OsgiFrameworkCapabilitiesSource.java
@@ -31,11 +31,7 @@ import org.osgi.service.component.annotations.Activate;
 /**
  * Builds Probes that provide basic JVM information, as an example.
  */
-@Component(
-    service = CapabilitiesSource.class,
-    property = {
-        CapabilitiesSource.PREFIX_SERVICE_PROPERTY + "=org.apache.sling.capabilities.examples.OsgiFrameworkCapabilitiesSource"
-})
+@Component(service = CapabilitiesSource.class)
 public class OsgiFrameworkCapabilitiesSource implements CapabilitiesSource {
     
     private BundleContext bundleContext;
@@ -46,6 +42,11 @@ public class OsgiFrameworkCapabilitiesSource implements CapabilitiesSource {
     }
 
     @Override
+    public String getNamespace() {
+        return "org.apache.sling.capabilities.demo." + getClass().getSimpleName();
+    }
+    
+    @Override
     public Map<String, String> getCapabilities() throws Exception {
         final Map<String, String> result = new HashMap<>();
         
@@ -57,4 +58,4 @@ public class OsgiFrameworkCapabilitiesSource implements CapabilitiesSource {
 
         return result;
     }
-}
+}
\ No newline at end of file