Custom Service Configurations availability logic

Signed-off-by: Claudio Mezzasalma <claudio.mezzasalma@eurotech.com>

commons/src/main/java/org/eclipse/kapua/commons/configuration/AbstractKapuaConfigurableService.java

@@ -50,6 +50,7 @@
 import java.util.Map.Entry;
 import java.util.Objects;
 import java.util.Properties;
+import java.util.function.Predicate;
 
 /**
  * Configurable service definition abstract reference implementation.
@@ -108,6 +109,10 @@ private void validateConfigurations(String pid, KapuaTocd ocd, Map<String, Objec
             // build a map of all the attribute definitions
             Map<String, KapuaTad> attrDefs = new HashMap<>();
             List<KapuaTad> defs = ocd.getAD();
+
+            //First of all, remove all non available properties
+            ocd.getAD().removeIf(((Predicate<KapuaTad>)this::isAvailableProperty).negate());
+
             for (KapuaTad def : defs) {
                 attrDefs.put(def.getId(), def);
             }
@@ -266,11 +271,17 @@ public KapuaTocd getConfigMetadata(KapuaId scopeId)
             if (metadata != null && metadata.getOCD() != null && !metadata.getOCD().isEmpty()) {
                 for (KapuaTocd ocd : metadata.getOCD()) {
                     if (ocd.getId() != null && ocd.getId().equals(pid)) {
+                        if (!isAvailableService()) {
+                            throw new KapuaConfigurationException(KapuaConfigurationErrorCodes.SERVICE_UNAVAILABLE, ocd.getId());
+                        }
+                        ocd.getAD().removeIf(((Predicate<KapuaTad>) this::isAvailableProperty).negate());
                         return ocd;
                     }
                 }
             }
             return null;
+        } catch (KapuaConfigurationException e) {
+            throw e;
         } catch (Exception e) {
             throw KapuaException.internalError(e);
         }
@@ -343,4 +354,13 @@ public void setConfigValues(KapuaId scopeId, KapuaId parentId, Map<String, Objec
             updateConfig(serviceConfig);
         }
     }
+
+    protected boolean isAvailableService() {
+        return true;
+    }
+
+    protected boolean isAvailableProperty(KapuaTad ad) {
+        return true;
+    }
+
 }

commons/src/main/java/org/eclipse/kapua/commons/configuration/KapuaConfigurationErrorCodes.java

@@ -47,5 +47,9 @@ public enum KapuaConfigurationErrorCodes implements KapuaErrorCode {
     /**
      * Parent limit exceeded in config
      */
-    PARENT_LIMIT_EXCEEDED_IN_CONFIG
+    PARENT_LIMIT_EXCEEDED_IN_CONFIG,
+    /**
+     * The service is not available
+     */
+    SERVICE_UNAVAILABLE
 }

commons/src/main/java/org/eclipse/kapua/commons/configuration/metatype/EmptyTocd.java

@@ -49,7 +49,7 @@ public void setId(String id) {
     }
 
     @Override
-    public void setIcon(List<? extends KapuaTicon> icon) {
+    public void setIcon(List<KapuaTicon> icon) {
         // No OP implementation
     }
 
@@ -64,7 +64,7 @@ public void setAny(List<Object> any) {
     }
 
     @Override
-    public void setAD(List<? extends KapuaTad> icon) {
+    public void setAD(List<KapuaTad> icon) {
         // No OP implementation
     }
 

commons/src/main/java/org/eclipse/kapua/commons/configuration/metatype/TocdImpl.java

@@ -52,8 +52,8 @@
  */
 public class TocdImpl implements KapuaTocd {
 
-    protected List<TadImpl> ad;
-    protected List<TiconImpl> icon;
+    protected List<KapuaTad> ad;
+    protected List<KapuaTicon> icon;
     protected List<Object> any;
     protected String name;
     protected String description;
@@ -85,17 +85,12 @@ public List<KapuaTad> getAD() {
         if (ad == null) {
             ad = new ArrayList<>();
         }
-        return new ArrayList<>(this.ad);
+        return this.ad;
     }
 
     @Override
-    public void setAD(List<? extends KapuaTad> ad) {
-        if (this.ad == null) {
-            this.ad = new ArrayList<>();
-        }
-        for (KapuaTad adInList : ad) {
-            this.ad.add((TadImpl) adInList);
-        }
+    public void setAD(List<KapuaTad> ad) {
+        this.ad = ad;
     }
 
     /**
@@ -108,7 +103,7 @@ public void addAD(KapuaTad ad) {
             this.ad = new ArrayList<>();
         }
 
-        this.ad.add((TadImpl) ad);
+        this.ad.add(ad);
     }
 
     /**
@@ -136,17 +131,12 @@ public List<KapuaTicon> getIcon() {
         if (icon == null) {
             icon = new ArrayList<>();
         }
-        return new ArrayList<>(this.icon);
+        return this.icon;
     }
 
     @Override
-    public void setIcon(List<? extends KapuaTicon> icon) {
-        if (this.icon == null) {
-            this.icon = new ArrayList<>();
-        }
-        for (KapuaTicon iconInList : icon) {
-            this.icon.add((TiconImpl) iconInList);
-        }
+    public void setIcon(List<KapuaTicon> icon) {
+        this.icon = icon;
     }
 
     /**

commons/src/main/resources/kapua-configuration-service-error-messages.properties

@@ -15,3 +15,4 @@ ILLEGAL_ARGUMENT=An illegal value was provided for the argument {0}. {1}
 OPERATION_NOT_ALLOWED=Operation not allowed: {0}
 ATTRIBUTE_INVALID=Configuration attribute invalid: {0}
 REQUIRED_ATTRIBUTE_MISSING=Required configuration attribute missing: {0}
+SERVICE_UNAVAILABLE=The requested service is not available for configuration. {0}

console/module/api/src/main/resources/org/eclipse/kapua/app/console/module/api/client/messages/ValidationMessages.properties

@@ -82,6 +82,7 @@ UNABLE_TO_PARSE_CRON_EXPRESSION=Unable to parse cron expression. {0}
 ENTITY_ALREADY_EXIST_IN_ANOTHER_ACCOUNT={0} already exists in another account.
 EXTERNAL_ID_ALREADY_EXIST_IN_ANOTHER_ACCOUNT=An entity with the same external id {0} already exists in another account.
 SELF_LIMIT_EXCEEDED_IN_CONFIG=Value too small, please remove some items or increase value.
+SERVICE_UNAVAILABLE=The requested service is not available for configuration. {0}
 ENTITY_NOT_FOUND=The entity of type {0} with id/name {1} was not found.
 DEVICE_NOT_FOUND=The selected devices were not found. Please refresh device list.
 BUNDLE_START_ERROR=Bundle could not be started. Please check the device log for errors.

service/api/src/main/java/org/eclipse/kapua/model/config/metatype/KapuaTocd.java

@@ -71,7 +71,7 @@ public interface KapuaTocd {
     @XmlElement(name = "AD", namespace = "http://www.osgi.org/xmlns/metatype/v1.2.0", required = true)
     List<KapuaTad> getAD();
 
-    void setAD(List<? extends KapuaTad> icon);
+    void setAD(List<KapuaTad> icon);
 
     /**
      * Gets the value of the icon property.
@@ -90,7 +90,7 @@ public interface KapuaTocd {
     @XmlElement(name = "Icon", namespace = "http://www.osgi.org/xmlns/metatype/v1.2.0")
     List<KapuaTicon> getIcon();
 
-    void setIcon(List<? extends KapuaTicon> icon);
+    void setIcon(List<KapuaTicon> icon);
 
     /**
      * Gets the value of the any property.

service/datastore/internal/src/main/java/org/eclipse/kapua/service/datastore/internal/MessageStoreServiceImpl.java

@@ -24,6 +24,7 @@
 import org.eclipse.kapua.locator.KapuaLocator;
 import org.eclipse.kapua.locator.KapuaProvider;
 import org.eclipse.kapua.message.KapuaMessage;
+import org.eclipse.kapua.model.config.metatype.KapuaTad;
 import org.eclipse.kapua.model.domain.Actions;
 import org.eclipse.kapua.model.id.KapuaId;
 import org.eclipse.kapua.service.account.AccountService;
@@ -228,4 +229,9 @@ protected void checkDataAccess(KapuaId scopeId, Actions action)
         authorizationService.checkPermission(permission);
     }
 
+    @Override
+    protected boolean isAvailableProperty(KapuaTad ad) {
+        return !ad.getId().equals("enabled");
+    }
+
 }

service/tag/internal/src/main/java/org/eclipse/kapua/service/tag/internal/TagServiceImpl.java

@@ -192,4 +192,10 @@ public long count(KapuaQuery<Tag> query) throws KapuaException {
         // Do count
         return entityManagerSession.doAction(em -> TagDAO.count(em, query));
     }
+
+    @Override
+    protected boolean isAvailableService() {
+        return false;
+    }
+
 }