Add method to find available manifest versions for upgrade

Author: TomasHofman

src/main/java/org/wildfly/installationmanager/AvailableManifestVersions.java

@@ -0,0 +1,37 @@
+package org.wildfly.installationmanager;
+
+import java.util.List;
+
+/**
+ * Provides list of available manifest versions for given channel.
+ */
+public class AvailableManifestVersions {
+
+    private final String channelName;
+    private final String location;
+    private final ManifestVersionPair currentVersion;
+    private final List<ManifestVersionPair> availableVersions;
+
+    public AvailableManifestVersions(String channelName, String location, ManifestVersionPair currentVersion, List<ManifestVersionPair> availableVersions) {
+        this.channelName = channelName;
+        this.location = location;
+        this.currentVersion = currentVersion;
+        this.availableVersions = availableVersions;
+    }
+
+    public String getChannelName() {
+        return channelName;
+    }
+
+    public String getLocation() {
+        return location;
+    }
+
+    public ManifestVersionPair getCurrentVersion() {
+        return currentVersion;
+    }
+
+    public List<ManifestVersionPair> getAvailableVersions() {
+        return availableVersions;
+    }
+}

src/main/java/org/wildfly/installationmanager/ManifestVersionChange.java

@@ -7,8 +7,8 @@ public class ManifestVersionChange {
 
     private final String channelName;
     private final String location;
-    private final String currentVersion;
-    private final String newVersion;
+    private final ManifestVersionPair currentVersion;
+    private final ManifestVersionPair newVersion;
     private final boolean isDowngrade;
 
     /**
@@ -20,7 +20,7 @@ public class ManifestVersionChange {
      * @param newVersion the new manifest version to be updated to
      * @param isDowngrade is this version change considered a downgrade?
      */
-    public ManifestVersionChange(String channelName, String location, String currentVersion, String newVersion, boolean isDowngrade) {
+    public ManifestVersionChange(String channelName, String location, ManifestVersionPair currentVersion, ManifestVersionPair newVersion, boolean isDowngrade) {
         this.channelName = channelName;
         this.location = location;
         this.currentVersion = currentVersion;
@@ -45,14 +45,14 @@ public String getLocation() {
     /**
      * @return current manifest version
      */
-    public String getCurrentVersion() {
+    public ManifestVersionPair getCurrentVersion() {
         return currentVersion;
     }
 
     /**
      * @return the new manifest version to be updated to
      */
-    public String getNewVersion() {
+    public ManifestVersionPair getNewVersion() {
         return newVersion;
     }
 
@@ -62,4 +62,5 @@ public String getNewVersion() {
     public boolean isDowngrade() {
         return isDowngrade;
     }
+
 }

src/main/java/org/wildfly/installationmanager/ManifestVersionPair.java

@@ -0,0 +1,61 @@
+package org.wildfly.installationmanager;
+
+import java.util.Objects;
+
+/**
+ * Wraps a pair of manifest physical/logical version strings.
+ */
+public class ManifestVersionPair {
+    private final String physicalVersion;
+    private final String logicalVersion;
+
+    /**
+     * Pair of physical / logical version strings.
+     *
+     * @param physicalVersion version string, either a maven artifact version for Maven-based channels,
+     *                        or a URL for URL-based channels
+     * @param logicalVersion  descriptive version string intended for human understanding, optional
+     */
+    public ManifestVersionPair(String physicalVersion, String logicalVersion) {
+        this.physicalVersion = physicalVersion;
+        this.logicalVersion = logicalVersion;
+    }
+
+    /**
+     * @return descriptive version string intended for human understanding, optional
+     */
+    public String getLogicalVersion() {
+        return logicalVersion;
+    }
+
+    /**
+     * @return physicalVersion version string, either a maven artifact version for Maven-based channels,
+     * or a URL for URL-based channels
+     */
+    public String getPhysicalVersion() {
+        return physicalVersion;
+    }
+
+    @Override
+    public String toString() {
+        return "ManifestVersionPair{" +
+                "physicalVersion='" + physicalVersion + '\'' +
+                ", logicalVersion='" + logicalVersion + '\'' +
+                '}';
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (o == null || getClass() != o.getClass()) return false;
+
+        ManifestVersionPair that = (ManifestVersionPair) o;
+        return Objects.equals(physicalVersion, that.physicalVersion) && Objects.equals(logicalVersion, that.logicalVersion);
+    }
+
+    @Override
+    public int hashCode() {
+        int result = Objects.hashCode(physicalVersion);
+        result = 31 * result + Objects.hashCode(logicalVersion);
+        return result;
+    }
+}

src/main/java/org/wildfly/installationmanager/spi/InstallationManager.java

@@ -19,6 +19,7 @@
 package org.wildfly.installationmanager.spi;
 
 import org.wildfly.installationmanager.ArtifactChange;
+import org.wildfly.installationmanager.AvailableManifestVersions;
 import org.wildfly.installationmanager.CandidateType;
 import org.wildfly.installationmanager.FileConflict;
 import org.wildfly.installationmanager.InstallationChanges;
@@ -127,7 +128,7 @@ public interface InstallationManager {
      *
      * @param repositories List of repositories to be used to find the available updates. If it is null or an empty list,
      *                     the default repositories will be used instead.
-     * @return {@link InstallationUpdates} collections of artifact and channels that are to be updated.
+     * @return {@link InstallationUpdates} collections of artifact and Wildfly Channel manifests that can be updated.
      * @throws Exception In case of an error.
      */
     InstallationUpdates findInstallationUpdates(List<Repository> repositories) throws Exception;
@@ -138,11 +139,22 @@ public interface InstallationManager {
      * @param repositories List of repositories to be used to find the available updates. If it is null or an empty list,
      *                     the default repositories will be used instead.
      * @param manifestVersions Manifest versions to update to. All subscribed channels have to be specified.
-     * @return {@link InstallationUpdates} collections of artifact and channels that are to be updated.
+     * @return {@link InstallationUpdates} collections of artifact and Wildfly Channel manifests that can be updated.
      * @throws Exception In case of an error.
      */
     InstallationUpdates findInstallationUpdates(List<Repository> repositories, List<ManifestVersion> manifestVersions) throws Exception;
 
+    /**
+     * Lists possible upgrades for subscribed manifests. The results may not include manifests for which no upgrades
+     * are available. Only Maven-based manifests are returned, no upgrades are be listed for URL-based manifests.
+     *
+     * @param repositories List of repositories to be used to find the available updates. If it is null or an empty list,
+     *                     the default repositories will be used instead.
+     * @param includeDowngrades If true, manifest versions lower than currently used manifest version will be listed as well.
+     * @return list of AvailableManifestVersions objects containing manifest info and list of available manifest versions.
+     */
+    List<AvailableManifestVersions> findAvailableManifestVersions(List<Repository> repositories, boolean includeDowngrades) throws Exception;
+
     /**
      * Lists channels the server installation is subscribed to.
      * If the servers is not subscribed to any channels, empty list is returned.