#1529 added first implementation of extensible artifact search REST API

cobigen/cobigen-core-api/pom.xml

@@ -27,7 +27,7 @@
       <groupId>com.google.guava</groupId>
       <artifactId>guava</artifactId>
     </dependency>
-    
+
     <!-- Proper process reader -->
     <dependency>
       <groupId>org.zeroturnaround</groupId>
@@ -40,11 +40,43 @@
       <artifactId>core-test</artifactId>
       <scope>test</scope>
     </dependency>
+
     <dependency>
       <groupId>commons-io</groupId>
       <artifactId>commons-io</artifactId>
       <scope>test</scope>
     </dependency>
+
+    <dependency>
+      <groupId>org.glassfish.jersey.media</groupId>
+      <artifactId>jersey-media-json-jackson</artifactId>
+      <version>3.0.7</version>
+    </dependency>
+
+    <dependency>
+      <groupId>org.glassfish.jersey.core</groupId>
+      <artifactId>jersey-client</artifactId>
+      <version>3.0.7</version>
+    </dependency>
+
+    <dependency>
+      <groupId>org.glassfish.jersey.inject</groupId>
+      <artifactId>jersey-hk2</artifactId>
+      <version>3.0.7</version>
+    </dependency>
+
+    <dependency>
+      <groupId>org.glassfish.jersey.security</groupId>
+      <artifactId>oauth2-client</artifactId>
+      <version>3.0.7</version>
+    </dependency>
+
+    <dependency>
+      <groupId>com.github.tomakehurst</groupId>
+      <artifactId>wiremock-standalone</artifactId>
+      <version>2.27.2</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <build>

cobigen/cobigen-core-api/src/main/java/com/devonfw/cobigen/api/constants/MavenSearchRepositoryConstants.java

@@ -0,0 +1,58 @@
+package com.devonfw.cobigen.api.constants;
+
+/**
+ * Constants needed for handling the maven search REST APIs
+ */
+public class MavenSearchRepositoryConstants {
+
+  /**
+   * Maven repository URL
+   */
+  public static String MAVEN_REPOSITORY_URL = "https://search.maven.org";
+
+  /**
+   * Maven repository download link
+   */
+  public static String MAVEN_REPOSITORY_DOWNLOAD_LINK = "https://repo1.maven.org/maven2";
+
+  /**
+   * Maven target link
+   */
+  public static String MAVEN_TARGET_LINK = "solrsearch/select";
+
+  /**
+   * Nexus2 repository URL
+   */
+  public static String NEXUS2_REPOSITORY_URL = "https://s01.oss.sonatype.org";
+
+  /**
+   * Nexus2 repository link
+   */
+  public static String NEXUS2_REPOSITORY_LINK = "service/local/repositories/releases/content";
+
+  /**
+   * Nexus2 target link
+   */
+  public static String NEXUS2_TARGET_LINK = "service/local/lucene/search";
+
+  /**
+   * Nexus3 target link
+   */
+  public static String NEXUS3_TARGET_LINK = "service/rest/v1/search";
+
+  /**
+   * Nexus3 repository URL
+   */
+  public static String NEXUS3_REPOSITORY_URL = "";
+
+  /**
+   * Jfrog repository URL
+   */
+  public static String JFROG_REPOSITORY_URL = "http://localhost:8082/artifactory";
+
+  /**
+   * Jfrog target link
+   */
+  public static String JFROG_TARGET_LINK = "api/search/gavc";
+
+}

cobigen/cobigen-core-api/src/main/java/com/devonfw/cobigen/api/constants/MavenSearchRepositoryType.java

@@ -0,0 +1,28 @@
+package com.devonfw.cobigen.api.constants;
+
+/**
+ * Maven search repository types used to identify and name the available search REST API types (add new search
+ * repository types/versions here)
+ */
+public enum MavenSearchRepositoryType {
+
+  /**
+   * Nexus2 search repository type
+   */
+  nexus2,
+
+  /**
+   * Nexus3 search repository type
+   */
+  nexus3,
+
+  /**
+   * Maven search repository type
+   */
+  maven,
+
+  /**
+   * Jfrog search repository type
+   */
+  jfrog
+}

cobigen/cobigen-core-api/src/main/java/com/devonfw/cobigen/api/exception/RestSearchResponseException.java

@@ -0,0 +1,40 @@
+package com.devonfw.cobigen.api.exception;
+
+/** Exception to indicate that the REST search API encountered a problem while accessing the server. */
+public class RestSearchResponseException extends CobiGenRuntimeException {
+
+  private static final long serialVersionUID = 1L;
+
+  /**
+   * Creates a new {@link RestSearchResponseException} with the given message
+   *
+   * @param message error message of the exception
+   */
+  public RestSearchResponseException(String message) {
+
+    super(message);
+  }
+
+  /**
+   * Creates a new {@link RestSearchResponseException} with the specified message and the causing {@link Throwable}
+   *
+   * @param message describing the exception
+   * @param cause the causing Throwable
+   */
+  public RestSearchResponseException(String message, Throwable cause) {
+
+    super(message, cause);
+  }
+
+  /**
+   * Creates a new {@link RestSearchResponseException} with the specified message and the causing {@link Throwable}
+   *
+   * @param message describing the exception
+   * @param statusCode status code causing the {@link RestSearchResponseException} or null if not available
+   */
+  public RestSearchResponseException(String message, String statusCode) {
+
+    super(message + statusCode);
+  }
+
+}

cobigen/cobigen-core-api/src/main/java/com/devonfw/cobigen/api/util/MavenUtil.java

@@ -27,6 +27,9 @@
 
 import com.devonfw.cobigen.api.constants.MavenConstants;
 import com.devonfw.cobigen.api.exception.CobiGenRuntimeException;
+import com.devonfw.cobigen.api.exception.RestSearchResponseException;
+import com.devonfw.cobigen.api.util.to.SearchResponseFactory;
+import com.fasterxml.jackson.core.JsonProcessingException;
 import com.google.common.collect.Lists;
 import com.google.common.hash.Hashing;
 import com.google.common.io.ByteSource;
@@ -340,4 +343,26 @@ public static Path getProjectRoot(Path inputFile, boolean topLevel) {
     LOG.debug("Project root could not be found.");
     return null;
   }
+
+  /**
+   * Retrieves a list of download URLs by groupId from the specified repository search REST API using authentication
+   * with bearer token
+   *
+   * @param baseURL String of the repository server URL
+   * @param groupId the groupId to search for
+   * @param authToken bearer token to use for authentication
+   * @return List of artifact download URLS or null if an error occurred
+   */
+  public static List<URL> retrieveMavenArtifactsByGroupId(String baseURL, String groupId, String authToken) {
+
+    try {
+      return SearchResponseFactory.searchArtifactDownloadLinks(baseURL, groupId, authToken);
+    } catch (RestSearchResponseException | JsonProcessingException | MalformedURLException e) {
+      LOG.error("Unable to get artifacts from " + baseURL + " by groupId " + groupId, e);
+      // TODO: Handle Eclipse, CLI and MavenPlugin here (f.e. with a new Exception)
+      return null;
+    }
+
+  }
+
 }

cobigen/cobigen-core-api/src/main/java/com/devonfw/cobigen/api/util/to/AbstractSearchResponse.java

@@ -0,0 +1,160 @@
+package com.devonfw.cobigen.api.util.to;
+
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import org.glassfish.jersey.client.oauth2.OAuth2ClientSupport;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.devonfw.cobigen.api.constants.MavenSearchRepositoryType;
+import com.devonfw.cobigen.api.exception.RestSearchResponseException;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import jakarta.ws.rs.client.Client;
+import jakarta.ws.rs.client.ClientBuilder;
+import jakarta.ws.rs.client.Invocation;
+import jakarta.ws.rs.client.WebTarget;
+import jakarta.ws.rs.core.Feature;
+import jakarta.ws.rs.core.MediaType;
+import jakarta.ws.rs.core.Response;
+
+/**
+ * This interface should be inherited for all maven REST search API responses to properly convert {@link JsonProperty}
+ * from responses to valid download URLs
+ */
+public abstract class AbstractSearchResponse {
+
+  /** Logger instance. */
+  @JsonIgnore
+  private static final Logger LOG = LoggerFactory.getLogger(AbstractSearchResponse.class);
+
+  /**
+   * @return the {@link MavenSearchRepositoryType} type
+   */
+  public abstract MavenSearchRepositoryType getRepositoryType();
+
+  /**
+   * Creates a list of download URLs
+   *
+   * @return List of download links
+   * @throws MalformedURLException if an URL was not valid
+   */
+  public abstract List<URL> retrieveDownloadURLs() throws MalformedURLException;
+
+  /**
+   * Removes duplicates from list of download URLs
+   *
+   * @param downloadUrls list of download URLs
+   * @return List of download links
+   * @throws MalformedURLException if an URL was not valid
+   */
+  public List<URL> removeDuplicatedDownloadURLs(List<URL> downloadUrls) throws MalformedURLException {
+
+    return downloadUrls.stream().distinct().collect(Collectors.toList());
+  }
+
+  /**
+   * Retrieves the json response from a repository URL and a group ID
+   *
+   * @param repositoryUrl URL of the repository
+   * @param groupId to search for
+   * @return String of json response
+   * @throws RestSearchResponseException if the request did not return status 200
+   */
+  public String retrieveJsonResponse(String repositoryUrl, String groupId) throws RestSearchResponseException {
+
+    return retrieveJsonResponse(repositoryUrl, groupId, null);
+  }
+
+  /**
+   * Retrieves the json response from a repository URL, a group ID and a bearer authentication token
+   *
+   * @param repositoryUrl URL of the repository
+   * @param groupId to search for
+   * @param authToken bearer token to use for authentication
+   * @return String of json response
+   * @throws RestSearchResponseException if the request did not return status 200
+   */
+  public abstract String retrieveJsonResponse(String repositoryUrl, String groupId, String authToken)
+      throws RestSearchResponseException;
+
+  /**
+   * Creates a @WebTarget with provided authentication token
+   *
+   * @param targetLink link to get response from
+   * @param token bearer token to use for authentication
+   * @return WebTarget to use as resource
+   */
+  private static WebTarget bearerAuthenticationWithOAuth2AtClientLevel(String targetLink, String token) {
+
+    Feature feature = OAuth2ClientSupport.feature(token);
+    Client client = ClientBuilder.newBuilder().register(feature).build();
+
+    WebTarget target = client.target(targetLink);
+    return target;
+  }
+
+  /**
+   * Retrieves a json response by given REST API target link using bearer authentication token
+   *
+   * @param targetLink link to get response from
+   * @param authToken bearer token to use for authentication
+   * @param searchRepositoryType the type of the search repository
+   * @return String of json response
+   * @throws RestSearchResponseException if the returned status code was not 200 OK
+   */
+  public static String retrieveJsonResponseWithAuthenticationToken(String targetLink, String authToken,
+      MavenSearchRepositoryType searchRepositoryType) throws RestSearchResponseException {
+
+    LOG.info("Starting {} search REST API request with URL: {}.", searchRepositoryType, targetLink);
+
+    WebTarget target = null;
+
+    if (authToken != null) {
+      target = bearerAuthenticationWithOAuth2AtClientLevel(targetLink, authToken);
+    } else {
+      Client client = ClientBuilder.newClient();
+      target = client.target(targetLink);
+    }
+
+    Response response = null;
+    Invocation.Builder request = target.request(MediaType.APPLICATION_JSON);
+    response = request.get();
+
+    int status = response.getStatus();
+    String jsonResponse = "";
+    if (status == 200) {
+      jsonResponse = response.readEntity(String.class);
+    } else {
+      throw new RestSearchResponseException("The search REST API returned the unexpected status code: ",
+          String.valueOf(status));
+    }
+    return jsonResponse;
+  }
+
+  /**
+   * Creates a download link (concatenates maven repository link with groupId, artifact and version)
+   *
+   * @param mavenRepo link to the maven repository to use
+   * @param groupId for the download link
+   * @param artifactId for the download link
+   * @param version for the download link
+   * @param fileEnding file ending for the download link
+   * @return concatenated download link
+   * @throws MalformedURLException if the URL was not valid
+   */
+  protected static URL createDownloadLink(String mavenRepo, String groupId, String artifactId, String version,
+      String fileEnding) throws MalformedURLException {
+
+    String parsedGroupId = groupId.replace(".", "/");
+    String downloadFile = artifactId + "-" + version + fileEnding;
+    String downloadLink = mavenRepo + "/" + parsedGroupId + "/" + artifactId + "/" + version + "/" + downloadFile;
+    URL url = new URL(downloadLink);
+    return url;
+  }
+
+}