You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ro...@apache.org on 2017/11/07 09:19:35 UTC

[sling-org-apache-sling-caconfig-spi] 04/23: SLING-6060 Context-Aware Config: Configuration property override providers

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

rombert pushed a commit to annotated tag org.apache.sling.caconfig.spi-1.2.0
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-caconfig-spi.git

commit b31b6b6e7f55df593f73c231531e2ca7bc7945a0
Author: Stefan Seifert <ss...@apache.org>
AuthorDate: Fri Nov 18 23:42:02 2016 +0000

    SLING-6060 Context-Aware Config: Configuration property override providers
    
    git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/contextaware-config/spi@1770448 13f79535-47bb-0310-9956-ffa450edef68
---
 pom.xml                                            |  2 +-
 .../spi/ConfigurationMetadataProvider.java         |  2 +-
 ...der.java => ConfigurationOverrideProvider.java} | 26 ++++++++++------------
 3 files changed, 14 insertions(+), 16 deletions(-)

diff --git a/pom.xml b/pom.xml
index 6bb7870..5009463 100644
--- a/pom.xml
+++ b/pom.xml
@@ -54,7 +54,7 @@
             <groupId>org.apache.sling</groupId>
             <artifactId>org.apache.sling.caconfig.api</artifactId>
             <version>1.0.0</version>
-            <scope>provided</scope>
+            <scope>compile</scope>
         </dependency>
         <dependency>
             <groupId>com.google.code.findbugs</groupId>
diff --git a/src/main/java/org/apache/sling/caconfig/spi/ConfigurationMetadataProvider.java b/src/main/java/org/apache/sling/caconfig/spi/ConfigurationMetadataProvider.java
index 28d99b1..e552310 100644
--- a/src/main/java/org/apache/sling/caconfig/spi/ConfigurationMetadataProvider.java
+++ b/src/main/java/org/apache/sling/caconfig/spi/ConfigurationMetadataProvider.java
@@ -26,7 +26,7 @@ import org.apache.sling.caconfig.spi.metadata.ConfigurationMetadata;
 import org.osgi.annotation.versioning.ConsumerType;
 
 /**
- * Allows application to provide the necessary metadata for configurations.
+ * Allows applications to provide the necessary metadata for configurations.
  */
 @ConsumerType
 public interface ConfigurationMetadataProvider {
diff --git a/src/main/java/org/apache/sling/caconfig/spi/ConfigurationMetadataProvider.java b/src/main/java/org/apache/sling/caconfig/spi/ConfigurationOverrideProvider.java
similarity index 61%
copy from src/main/java/org/apache/sling/caconfig/spi/ConfigurationMetadataProvider.java
copy to src/main/java/org/apache/sling/caconfig/spi/ConfigurationOverrideProvider.java
index 28d99b1..290fa24 100644
--- a/src/main/java/org/apache/sling/caconfig/spi/ConfigurationMetadataProvider.java
+++ b/src/main/java/org/apache/sling/caconfig/spi/ConfigurationOverrideProvider.java
@@ -18,30 +18,28 @@
  */
 package org.apache.sling.caconfig.spi;
 
-import java.util.SortedSet;
+import java.util.Collection;
 
 import javax.annotation.Nonnull;
 
-import org.apache.sling.caconfig.spi.metadata.ConfigurationMetadata;
 import org.osgi.annotation.versioning.ConsumerType;
 
 /**
- * Allows application to provide the necessary metadata for configurations.
+ * Provide information to override configuration data.
  */
 @ConsumerType
-public interface ConfigurationMetadataProvider {
+public interface ConfigurationOverrideProvider {
 
     /**
-     * Get all configuration names.
-     * @return Configuration names
+     * Get override strings. Syntax examples:
+     * <ul>
+     * <li><code>{configName}/{propertyName}={propertyJsonValue}</code></li>
+     * <li><code>{configName}={propertyJsonObject}</code></li>
+     * <li><code>[{contextPath}]{configName}/{propertyName}={propertyJsonValue}</code></li>
+     * <li><code>[{contextPath}]{configName}={propertyJsonObject}</code></li>
+     * </ul>
+     * @return Override strings
      */
-    @Nonnull SortedSet<String> getConfigurationNames();
-
-    /**
-     * Get configuration metadata.
-     * @param configName Configuration name
-     * @return Configuration metadata or null if none exists for the given name.
-     */
-    ConfigurationMetadata getConfigurationMetadata(String configName);
+    @Nonnull Collection<String> getOverrideStrings();
 
 }

-- 
To stop receiving notification emails like this one, please contact
"commits@sling.apache.org" <co...@sling.apache.org>.