Persisted schema

gradle/libs.versions.toml

@@ -100,6 +100,8 @@ jackson-dataformat-smile = { module = "com.fasterxml.jackson.dataformat:jackson-
 jackson-dataformat-cbor = { module = "com.fasterxml.jackson.dataformat:jackson-dataformat-cbor", version.ref = "jackson" }
 jackson-dataformat-yaml = { module = "com.fasterxml.jackson.dataformat:jackson-dataformat-yaml", version.ref = "jackson" }
 
+snakeyaml = { module = "org.yaml:snakeyaml", version = "2.4" }
+
 tika-core = { module = "org.apache.tika:tika-core", version.ref = "tika" }
 tika-bundlestandard = { module = "org.apache.tika:tika-bundle-standard", version.ref = "tika" }
 tika-parser-apple = { module = "org.apache.tika:tika-parser-apple-module", version.ref = "tika" }

modules/admin/admin-api/src/main/java/com/enonic/xp/admin/widget/WidgetDescriptor.java → modules/admin/admin-api/src/main/java/com/enonic/xp/admin/extension/AdminExtensionDescriptor.java

@@ -1,6 +1,5 @@
-package com.enonic.xp.admin.widget;
+package com.enonic.xp.admin.extension;
 
-import java.util.Collection;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Set;
@@ -13,12 +12,12 @@
 import com.enonic.xp.descriptor.Descriptor;
 import com.enonic.xp.descriptor.DescriptorKey;
 import com.enonic.xp.icon.Icon;
-import com.enonic.xp.security.PrincipalKey;
+import com.enonic.xp.schema.LocalizedText;
 import com.enonic.xp.security.PrincipalKeys;
 import com.enonic.xp.security.RoleKeys;
 
 @PublicApi
-public final class WidgetDescriptor
+public final class AdminExtensionDescriptor
     extends Descriptor
 {
     private final String displayName;
@@ -37,7 +36,7 @@ public final class WidgetDescriptor
 
     private final ImmutableMap<String, String> config;
 
-    private WidgetDescriptor( final Builder builder )
+    private AdminExtensionDescriptor( final Builder builder )
     {
         super( builder.key );
         this.displayName = builder.displayName;
@@ -46,15 +45,10 @@ private WidgetDescriptor( final Builder builder )
         this.descriptionI18nKey = builder.descriptionI18nKey;
         this.icon = builder.icon;
         this.interfaces = ImmutableSet.copyOf( builder.interfaces );
-        this.allowedPrincipals = builder.allowedPrincipals == null ? null : PrincipalKeys.from( builder.allowedPrincipals );
+        this.allowedPrincipals = builder.allowedPrincipals;
         this.config = ImmutableMap.copyOf( builder.config );
     }
 
-    public String getKeyString()
-    {
-        return getKey().toString();
-    }
-
     public String getDisplayName()
     {
         return displayName;
@@ -97,16 +91,16 @@ public PrincipalKeys getAllowedPrincipals()
 
     public boolean isAccessAllowed( final PrincipalKeys principalKeys )
     {
-        return allowedPrincipals == null || principalKeys.contains( RoleKeys.ADMIN ) || principalKeys.stream().
-            anyMatch( allowedPrincipals::contains );
+        return allowedPrincipals == null || principalKeys.contains( RoleKeys.ADMIN ) ||
+            principalKeys.stream().anyMatch( allowedPrincipals::contains );
     }
 
     public Map<String, String> getConfig()
     {
         return config;
     }
 
-    public static WidgetDescriptor.Builder create()
+    public static AdminExtensionDescriptor.Builder create()
     {
         return new Builder();
     }
@@ -127,7 +121,7 @@ public static final class Builder
 
         public final Set<String> interfaces = new TreeSet<>();
 
-        private Collection<PrincipalKey> allowedPrincipals;
+        private PrincipalKeys allowedPrincipals;
 
         public final Map<String, String> config = new HashMap<>();
 
@@ -147,6 +141,13 @@ public Builder displayName( final String displayName )
             return this;
         }
 
+        public Builder displayName( final LocalizedText text )
+        {
+            this.displayName = text.text();
+            this.displayNameI18nKey = text.i18n();
+            return this;
+        }
+
         public Builder displayNameI18nKey( final String displayNameI18nKey )
         {
             this.displayNameI18nKey = displayNameI18nKey;
@@ -165,6 +166,13 @@ public Builder descriptionI18nKey( final String descriptionI18nKey )
             return this;
         }
 
+        public Builder description( final LocalizedText text )
+        {
+            this.description = text.text();
+            this.descriptionI18nKey = text.i18n();
+            return this;
+        }
+
         public Builder setIcon( final Icon icon )
         {
             this.icon = icon;
@@ -177,7 +185,13 @@ public Builder addInterface( final String interfaceName )
             return this;
         }
 
-        public Builder setAllowedPrincipals( final Collection<PrincipalKey> allowedPrincipals )
+        public Builder addInterfaces( final Iterable<String> interfaceNames )
+        {
+            interfaceNames.forEach( this::addInterface );
+            return this;
+        }
+
+        public Builder allowedPrincipals( final PrincipalKeys allowedPrincipals )
         {
             this.allowedPrincipals = allowedPrincipals;
             return this;
@@ -189,9 +203,9 @@ public Builder addProperty( final String key, final String value )
             return this;
         }
 
-        public WidgetDescriptor build()
+        public AdminExtensionDescriptor build()
         {
-            return new WidgetDescriptor( this );
+            return new AdminExtensionDescriptor( this );
         }
     }
 }

modules/admin/admin-api/src/main/java/com/enonic/xp/admin/extension/AdminExtensionDescriptorService.java

@@ -0,0 +1,16 @@
+package com.enonic.xp.admin.extension;
+
+import com.enonic.xp.annotation.PublicApi;
+import com.enonic.xp.app.ApplicationKey;
+import com.enonic.xp.descriptor.Descriptors;
+import com.enonic.xp.descriptor.DescriptorKey;
+
+@PublicApi
+public interface AdminExtensionDescriptorService
+{
+    Descriptors<AdminExtensionDescriptor> getByInterfaces( String... interfaceName );
+
+    Descriptors<AdminExtensionDescriptor> getByApplication( ApplicationKey applicationKey );
+
+    AdminExtensionDescriptor getByKey( DescriptorKey descriptorKey );
+}

modules/admin/admin-api/src/main/java/com/enonic/xp/admin/tool/AdminToolDescriptor.java

@@ -10,6 +10,7 @@
 import com.enonic.xp.descriptor.DescriptorKey;
 import com.enonic.xp.descriptor.DescriptorKeys;
 import com.enonic.xp.resource.ResourceKey;
+import com.enonic.xp.schema.LocalizedText;
 import com.enonic.xp.security.PrincipalKey;
 import com.enonic.xp.security.PrincipalKeys;
 import com.enonic.xp.security.RoleKeys;
@@ -107,7 +108,7 @@ public DescriptorKeys getApiMounts()
 
     public static ResourceKey toResourceKey( final DescriptorKey key )
     {
-        return ResourceKey.from( key.getApplicationKey(), "admin/tools/" + key.getName() + "/" + key.getName() + ".xml" );
+        return ResourceKey.from( key.getApplicationKey(), "admin/tools/" + key.getName() + "/" + key.getName() + ".yml" );
     }
 
     public static ResourceKey toIconResourceKey( final DescriptorKey key )
@@ -161,6 +162,13 @@ public Builder displayNameI18nKey( final String displayNameI18nKey )
             return this;
         }
 
+        public Builder displayName( final LocalizedText text )
+        {
+            this.displayName = text.text();
+            this.displayNameI18nKey = text.i18n();
+            return this;
+        }
+
         public Builder description( final String description )
         {
             this.description = description;
@@ -173,6 +181,19 @@ public Builder descriptionI18nKey( final String descriptionI18nKey )
             return this;
         }
 
+        public Builder description( final LocalizedText text )
+        {
+            this.description = text.text();
+            this.descriptionI18nKey = text.i18n();
+            return this;
+        }
+
+        public Builder addAllowedPrincipals( final PrincipalKeys allowedPrincipals )
+        {
+            this.allowedPrincipals.addAll( allowedPrincipals );
+            return this;
+        }
+
         public Builder addAllowedPrincipals( final PrincipalKey allowedPrincipal )
         {
             this.allowedPrincipals.add( allowedPrincipal );
@@ -191,6 +212,12 @@ public Builder addInterface( final String interfaceName )
             return this;
         }
 
+        public Builder addInterfaces( final Iterable<String> interfaceNames )
+        {
+            this.interfaces.addAll( interfaceNames );
+            return this;
+        }
+
         public AdminToolDescriptor build()
         {
             return new AdminToolDescriptor( this );

modules/admin/admin-impl/build.gradle

@@ -3,6 +3,7 @@ dependencies {
     implementation project( ':portal:portal-api' )
     implementation project( ':jaxrs:jaxrs-api' )
     implementation project( ':core:core-internal' )
+    implementation project( ':core:core-schema' )
 
     testImplementation( testFixtures( project(":core:core-api") ) )
     testImplementation( testFixtures( project(":core:core-app") ) )

modules/admin/admin-impl/src/main/java/com/enonic/xp/admin/impl/widget/WidgetDescriptorLoader.java → modules/admin/admin-impl/src/main/java/com/enonic/xp/admin/impl/extension/AdminExtensionDescriptorLoader.java

@@ -1,43 +1,43 @@
-package com.enonic.xp.admin.impl.widget;
+package com.enonic.xp.admin.impl.extension;
 
 import java.time.Instant;
 
 import org.osgi.service.component.annotations.Activate;
 import org.osgi.service.component.annotations.Component;
 import org.osgi.service.component.annotations.Reference;
 
-import com.enonic.xp.admin.widget.WidgetDescriptor;
+import com.enonic.xp.admin.extension.AdminExtensionDescriptor;
 import com.enonic.xp.app.ApplicationKey;
+import com.enonic.xp.descriptor.DescriptorKey;
 import com.enonic.xp.descriptor.DescriptorKeyLocator;
 import com.enonic.xp.descriptor.DescriptorKeys;
 import com.enonic.xp.descriptor.DescriptorLoader;
 import com.enonic.xp.icon.Icon;
-import com.enonic.xp.descriptor.DescriptorKey;
 import com.enonic.xp.resource.Resource;
 import com.enonic.xp.resource.ResourceKey;
 import com.enonic.xp.resource.ResourceService;
 
 @Component(immediate = true)
-public final class WidgetDescriptorLoader
-    implements DescriptorLoader<WidgetDescriptor>
+public final class AdminExtensionDescriptorLoader
+    implements DescriptorLoader<AdminExtensionDescriptor>
 {
-    private static final String PATH = "/admin/widgets";
+    private static final String PATH = "/admin/extensions";
 
     private final ResourceService resourceService;
 
     private final DescriptorKeyLocator descriptorKeyLocator;
 
     @Activate
-    public WidgetDescriptorLoader( @Reference final ResourceService resourceService )
+    public AdminExtensionDescriptorLoader( @Reference final ResourceService resourceService )
     {
         this.resourceService = resourceService;
         this.descriptorKeyLocator = new DescriptorKeyLocator( this.resourceService, PATH, false );
     }
 
     @Override
-    public Class<WidgetDescriptor> getType()
+    public Class<AdminExtensionDescriptor> getType()
     {
-        return WidgetDescriptor.class;
+        return AdminExtensionDescriptor.class;
     }
 
     @Override
@@ -49,43 +49,30 @@ public DescriptorKeys find( final ApplicationKey key )
     @Override
     public ResourceKey toResource( final DescriptorKey key )
     {
-        return ResourceKey.from( key.getApplicationKey(), PATH + "/" + key.getName() + "/" + key.getName() + ".xml" );
+        return ResourceKey.from( key.getApplicationKey(), PATH + "/" + key.getName() + "/" + key.getName() + ".yml" );
     }
 
     @Override
-    public WidgetDescriptor load( final DescriptorKey key, final Resource resource )
+    public AdminExtensionDescriptor load( final DescriptorKey key, final Resource resource )
     {
-        final WidgetDescriptor.Builder builder = WidgetDescriptor.create();
-        builder.key( key );
-
-        final String descriptorXml = resource.readString();
-        parseXml( key.getApplicationKey(), builder, descriptorXml );
-        final Icon icon = loadIcon( key );
-        builder.setIcon( icon );
-        return builder.build();
+        return YmlAdminExtensionDescriptorParser.parse( resource.readString(), key.getApplicationKey() )
+            .key( key )
+            .setIcon( loadIcon( key ) )
+            .build();
     }
 
     @Override
-    public WidgetDescriptor createDefault( final DescriptorKey key )
+    public AdminExtensionDescriptor createDefault( final DescriptorKey key )
     {
-        return WidgetDescriptor.create().key( key ).displayName( key.getName() ).build();
+        return AdminExtensionDescriptor.create().key( key ).displayName( key.getName() ).build();
     }
 
     @Override
-    public WidgetDescriptor postProcess( final WidgetDescriptor descriptor )
+    public AdminExtensionDescriptor postProcess( final AdminExtensionDescriptor descriptor )
     {
         return descriptor;
     }
 
-    private void parseXml( final ApplicationKey applicationKey, final WidgetDescriptor.Builder builder, final String xml )
-    {
-        final XmlWidgetDescriptorParser parser = new XmlWidgetDescriptorParser();
-        parser.builder( builder );
-        parser.currentApplication( applicationKey );
-        parser.source( xml );
-        parser.parse();
-    }
-
     private Icon loadIcon( final DescriptorKey key )
     {
         final String iconPath = PATH + "/" + key.getName() + "/" + key.getName() + ".svg";