Add config builder

Author: pcastornii

README.md

@@ -50,12 +50,11 @@ include:
 Techsenger Alpha is a framework designed to work with module layers. The framework resides in the boot layer and handles
 all the work of managing the other layers. To facilitate this, the concept of a component is introduced.
 
-A component is a logical part of the system that can be dynamically added or removed. Each component is deployed in
-a separate module layer and has a clearly defined lifecycle. The configuration of a component is specified via an XML
-file (with plans to add a ConfigBuilder), which describes the component's modules (groupId, artifactId, version),
-module directives (opens, reads, exports, etc.), repositories from which modules can be loaded, and other information.
-For flexibility, the XML configuration supports properties, the `if` and `choose-when` constructs and EL
-(Expression Language).
+A component is a logical part of the system that can be dynamically added or removed. Each component is deployed in a
+separate module layer and has a clearly defined lifecycle. The configuration of a component is specified via a `Builder`
+or an XML, which describes the component's modules (groupId, artifactId, version), module directives
+(opens, reads, exports, etc.), repositories from which modules can be loaded, and other related information.
+For flexibility, the XML configuration supports properties, if and choose-when constructs, and EL (Expression Language).
 
 All loaded modules are stored in the framework's internal repository, which is by default a Maven repository.
 
@@ -277,21 +276,48 @@ configuration. During deactivation, they are called in reverse order (the last a
 
 #### Configuration <a name="usage-component-config"></a>
 
-At the moment, the configuration is set using an XML file. In the future, `ConfigBuilder` is planned to be added.
+The configuration can be set using a `Builder` or an XML.
+
+```java
+var config = ComponentConfig.builder()
+        .title("The Best Foo")
+        .name("foo")
+        .version(Version.of("1.0.0"))
+        .metadata("License", "Apache 2")
+        .repositories(
+            r -> r.name("local").url("file://...."),
+            r -> r.name("central").url("https://repo1.maven.org/maven2/")
+        )
+        .parents(
+            p -> p.name(...).version(...).versionMatch(VersionMatch.MAJOR)
+        )
+        .modules(
+            m -> m.groupId(...).artifactId(....).version(...).classifier(fxClsfr).active(...)
+                .directives(
+                    d -> d.type(...).pkg(...).layer(...).module(...)
+                )
+        )
+        .build();
+```
 
-A configuration template with all supported tags:
+A XML configuration template with all supported tags:
 
-```
+```xml
 <?xml version="1.0" encoding="UTF-8" ?>
 <Configuration title="The Best Foo" name="foo" version="1.0.0" type="notBar">
     <Metadata>
         <Entry key="License" value="Apache 2"/>
     </Metadata>
 
     <Repositories>
+        <Repository name="local" url="file://...."/>
         <Repository name="central" url="https://repo1.maven.org/maven2/"/>
     </Repositories>
 
+    <Parents>
+        <Parent name="... " version="..." versionMatch="major/minor/patch"/>
+    </Parents>
+
     <Choose>
         <When test="${info['os.family'] == 'linux'}">
             <Property name="modVersion" value="2.0.0"/>

alpha-assembly/alpha-assembly-maven-plugin/src/main/resources/com/techsenger/alpha/assembly/maven/plugin/cli-config.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<Configuration title="Alpha CLI" name="alpha-cli" version="${project.version}" type="base">
+<Configuration title="Alpha CLI" name="alpha-cli" version="${project.version}">
     <Repositories>
         <Repository name="local" url="file://${settings.localRepository}"/>
         <Repository name="central" url="${maven.central.url}"/>

alpha-assembly/alpha-assembly-maven-plugin/src/main/resources/com/techsenger/alpha/assembly/maven/plugin/gui-config.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<Configuration title="Alpha GUI" name="alpha-gui" version="${project.version}" type="base">
+<Configuration title="Alpha GUI" name="alpha-gui" version="${project.version}">
     <Repositories>
         <Repository name="local" url="file://${settings.localRepository}"/>
         <Repository name="central" url="${maven.central.url}"/>

alpha-assembly/alpha-assembly-maven-plugin/src/main/resources/com/techsenger/alpha/assembly/maven/plugin/registry.xml

@@ -1,7 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!-- AUTO-GENERATED FILE — DO NOT EDIT -->
 <Registry>
-    <InstallResult successful="true"/>
     <AddedComponents>
         <Component name="alpha-repo" version="${project.version}"/>
         <Component name="alpha-server" version="${project.version}"/>

alpha-assembly/alpha-assembly-maven-plugin/src/main/resources/com/techsenger/alpha/assembly/maven/plugin/repo-config.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<Configuration title="Alpha Repo" name="alpha-repo" version="${project.version}" type="base">
+<Configuration title="Alpha Repo" name="alpha-repo" version="${project.version}">
     <Repositories>
         <Repository name="local" url="file://${settings.localRepository}"/>
         <Repository name="central" url="${maven.central.url}"/>

alpha-assembly/alpha-assembly-maven-plugin/src/main/resources/com/techsenger/alpha/assembly/maven/plugin/server-config.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<Configuration title="Alpha Server HTTP" name="alpha-server" version="${project.version}" type="base">
+<Configuration title="Alpha Server HTTP" name="alpha-server" version="${project.version}">
     <Repositories>
         <Repository name="local" url="file://${settings.localRepository}"/>
         <Repository name="central" url="${maven.central.url}"/>

alpha-core/src/main/java/com/techsenger/alpha/core/api/ComponentManager.java

@@ -79,6 +79,16 @@ Path buildComponent(String name, Version version, Path directoryPath, String ext
      */
     ComponentConfig addComponent(String xmlConfig) throws ComponentException;
 
+
+    /**
+     * Adds a component with the specified configuration and writes its XML to disk.
+     *
+     * @param config
+     * @throws ComponentException
+     * @return the xml config of the component
+     */
+    String addComponent(ComponentConfig config) throws ComponentException;
+
     /**
      * Resolves a component by providing all its modules presence in repo.
      *
@@ -291,6 +301,16 @@ ComponentConfig unresolveComponent(String name, Version version, MessagePrinter
      */
     ComponentConfig installComponent(String xmlConfig, MessagePrinter printer) throws ComponentException;
 
+    /**
+     * Installs a component (adds and resolves it).
+     *
+     * @param config the config of the component
+     * @param printer
+     * @throws ComponentException
+     * @return the xml config of the component
+     */
+    String installComponent(ComponentConfig config, MessagePrinter printer) throws ComponentException;
+
     /**
      * Starts a component (deploys and activates it).
      *

alpha-core/src/main/java/com/techsenger/alpha/core/api/DefaultPathResolver.java

@@ -202,7 +202,7 @@ public Path resolveModule(ModuleArtifact artifact) {
                 + File.separator
                 + artifact.getVersion()
                 + File.separator
-                + artifact.getFileName();
+                + ModuleArtifact.resolveFileName(artifact);
         var resolvedPath = this.pathManager.getRepositoryDirectory().resolve(modulePath);
         logger.trace("Module {} has path {}", artifact.getArtifactId(), resolvedPath);
         return resolvedPath;

alpha-core/src/main/java/com/techsenger/alpha/core/api/component/Component.java

@@ -17,7 +17,7 @@
 package com.techsenger.alpha.core.api.component;
 
 import com.techsenger.alpha.core.api.Constants;
-import com.techsenger.alpha.core.api.module.ModuleDescriptor;
+import com.techsenger.alpha.core.api.module.ModuleConfig;
 import com.techsenger.alpha.core.api.module.ResolvedModuleDirective;
 import com.techsenger.toolkit.core.Pair;
 import com.techsenger.toolkit.core.version.Version;
@@ -41,7 +41,7 @@ static Pair<String, Version> resolveNameAndVersion(String nameAndVersion) {
             return new Pair<>(nameAndVersion.trim(), null);
         } else {
             String name = nameAndVersion.substring(0, index).trim();
-            Version version = Version.parse(nameAndVersion.substring(index + 1).trim());
+            Version version = Version.of(nameAndVersion.substring(index + 1).trim());
             return new Pair<>(name, version);
         }
     }
@@ -73,12 +73,11 @@ static Pair<String, Version> resolveNameAndVersion(String nameAndVersion) {
     ModuleLayer getLayer();
 
     /**
-     * Returns module by descriptor.
+     * Returns module by config.
      *
-     * @param descriptor
-     * @return
+     * @param config
      */
-    Module getModule(ModuleDescriptor descriptor);
+    Module getModule(ModuleConfig config);
 
     /**
      * Returns resolved modules directives. It is important to clarify that these will only be the directives

alpha-core/src/main/java/com/techsenger/alpha/core/api/component/ComponentConfig.java

@@ -17,48 +17,52 @@
 package com.techsenger.alpha.core.api.component;
 
 import com.techsenger.alpha.core.api.LayerOwner;
-import com.techsenger.alpha.core.api.module.ModuleDescriptor;
-import com.techsenger.alpha.core.api.module.ModuleType;
+import com.techsenger.alpha.core.api.module.ModuleConfig;
 import java.util.List;
 import java.util.Map;
 
 /**
+ * Provides configuration for a component.
  *
  * @author Pavel Castornii
  */
 public interface ComponentConfig extends ComponentConfigDto, LayerOwner {
 
+    static ComponentConfigBuilder builder() {
+        return new ComponentConfigBuilder();
+    }
+
     /**
-     * Returns map where key is the attribute name, and value is the attribute value. It is possible to add any
-     * metadata, for example, author, developer, license etc.
+     * Returns an unmodifiable map of metadata where the key is the attribute name and the value is the
+     * attribute value. Arbitrary metadata can be provided, for example: author, developer, license, etc.
      *
-     * @return
+     * @return the metadata map
      */
     Map<String, String> getMetadata();
 
     /**
-     * Returns the repos from which modules will be resolved.
+     * Returns an unmodifiable list of repositories from which modules will be resolved.
      *
-     * <p>Repositories will be used in the order they are specified. This means that the module will first be searched
-     * for in the first repository, then in the second, and so on. It is important to note that, by default, the central
-     * repository is not used. Therefore, if the central repository needs to be used, it must be explicitly added.
+     * <p>Repositories are used in the order they are specified. A module is searched for in the first
+     * repository, then in the next, and so on. By default, the central repository is not used and must
+     * be explicitly added if required.
      *
-     * @return
+     * @return the list of repository configurations
      */
-    List<RepositoryDescriptor> getRepositories();
+    List<RepositoryConfig> getRepositories();
 
     /**
-     * Returns module descriptors.
+     * Returns an unmodifiable list of parent component configurations to which this component can be
+     * added as a child. An empty list indicates that this component can be added to any component.
      *
-     * @return
+     * @return the list of parent configurations
      */
-    List<ModuleDescriptor> getModules();
+    List<ParentConfig> getParents();
 
     /**
-     * Returns true if this component contains modules with type {@link ModuleType#WAR}, otherwise returns false.
-     * The check is performed only once, and the result is stored.
+     * Returns an unmodifiable list of module configurations.
      *
-     * @return
+     * @return the list of module configurations
      */
-    boolean containsWarModules();
+    List<ModuleConfig> getModules();
 }