diff --git a/.github/workflows/ci-build.yml b/.github/workflows/ci-build.yml index 6e53632ca..d6c0f869d 100644 --- a/.github/workflows/ci-build.yml +++ b/.github/workflows/ci-build.yml @@ -16,11 +16,11 @@ jobs: - uses: actions/checkout@v4 with: fetch-depth: 0 - - name: Setup JDK 8 + - name: Setup JDK 11 uses: actions/setup-java@v3 with: distribution: temurin - java-version: 8 + java-version: 11 - name: Setup Gradle uses: gradle/actions/setup-gradle@v3 - name: GitLab4j verify diff --git a/README.md b/README.md index 7416b01ad..22fd2125f 100644 --- a/README.md +++ b/README.md @@ -7,37 +7,9 @@ GitLab4J™ API (gitlab4j-api) provides a full featured and easy to consume Java library for working with GitLab repositories via the GitLab REST API. Additionally, full support for working with GitLab webhooks and system hooks is also provided. --- -## Table of Contents -* [GitLab Server Version Support](#gitLab-server-version-support)
-* [Using GitLab4J-API](#using-gitlab4j-api)
- * [Java 8 Requirement](#java-8-requirement)
- * [Javadocs](#javadocs)
- * [Project Set Up](#project-set-up)
- * [Usage Examples](#usage-examples)
- * [Setting Request Timeouts](#setting-request-timeouts)
- * [Connecting Through a Proxy Server](#connecting-through-a-proxy-server)
- * [GitLab API V3 and V4 Support](#gitLab-api-v3-and-v4-support)
- * [Logging of API Requests and Responses](#logging-of-api-requests-and-responses)
- * [Results Paging](#results-paging)
- * [Java 8 Stream Support](#java-8-stream-support)
- * [Eager evaluation example usage](#eager-evaluation-example-usage)
- * [Lazy evaluation example usage](#lazy%20evaluation-example-usage)
- * [Java 8 Optional<T> Support](#java-8-optional-support)
- * [Issue Time Estimates](#issue-time-estimates)
-* [Making API Calls](#making-api-calls)
- * [Available Sub APIs](#available-sub-apis) - ---- - -> **Warning** -> If you are looking for our next major version `6.x.x` which is requiring **Java 11** as mimimal version and which is using Jakarta EE components using the `jakarta.*` packages instead of `javax.*` check the [`6.x` branch](https://github.com/gitlab4j/gitlab4j-api/tree/6.x). -> The `6.x.x` version is the one you need if you are using Spring Boot 3 and Spring Framework 6.0, . - ## GitLab Server Version Support -GitLab4J-API supports version 11.0+ of GitLab Community Edition [(gitlab-ce)](https://gitlab.com/gitlab-org/gitlab-ce/) and GitLab Enterprise Edition [(gitlab-ee)](https://gitlab.com/gitlab-org/gitlab-ee/). - -GitLab released GitLab Version 11.0 in June of 2018 which included many major changes to GitLab. If you are using GitLab server earlier than version 11.0, it is highly recommended that you either update your GitLab install or use a version of this library that was released around the same time as the version of GitLab you are using. +GitLab4J-API supports both GitLab Community Edition [(gitlab-ce)](https://gitlab.com/gitlab-org/gitlab-ce/) and GitLab Enterprise Edition [(gitlab-ee)](https://gitlab.com/gitlab-org/gitlab-ee/). **NOTICE**: As of GitLab 11.0 support for the GitLab API v3 has been removed from the GitLab server (see https://about.gitlab.com/2018/06/01/api-v3-removal-impending/). Support for GitLab API v3 will be removed from this library sometime in 2019. If you are utilizing the v3 support, please update your code to use GitLab API v4. @@ -45,8 +17,8 @@ As of GitLab 11.0 support for the GitLab API v3 has been removed from the GitLab --- ## Using GitLab4J-API -### **Java 8 Requirement** -As of GitLab4J-API 4.8.0, Java 8+ is now required to use GitLab4J-API. +### **Java 11 Requirement** +As of GitLab4J-API 6.0.0, Java 11+ is now required to use GitLab4J-API. ### **Javadocs** Javadocs are available here: [![javadoc.io](https://javadoc.io/badge2/org.gitlab4j/gitlab4j-api/javadoc.io.svg)](https://javadoc.io/doc/org.gitlab4j/gitlab4j-api) @@ -54,22 +26,21 @@ Javadocs are available here: [![javadoc.io](https://javadoc.io/badge2/org.gitlab ### **Project Set Up** To utilize GitLab4J™ API in your Java project, simply add the following dependency to your project's build file:
+ **Gradle: build.gradle** ```java dependencies { ... - compile group: 'org.gitlab4j', name: 'gitlab4j-api', version: '5.7.0' + implementation group: 'org.gitlab4j', name: 'gitlab4j-api', version: '6.0.0-rc.6' } ``` -**NOTE:** Pulling dependencies may fail when using Gradle prior to 4.5. See [Gradle issue 3065](https://github.com/gradle/gradle/issues/3065#issuecomment-364092456) - **Maven: pom.xml** ```xml org.gitlab4j gitlab4j-api - 5.7.0 + 6.0.0-rc.6 ``` @@ -80,7 +51,7 @@ dependencies { Just add this line at the top of your script: ```java -//DEPS org.gitlab4j:gitlab4j-api:5.7.0 +//DEPS org.gitlab4j:gitlab4j-api:6.0.0-rc.6 ``` **Ivy and SBT**
@@ -641,7 +612,7 @@ List runners = gitLabApi.getRunnersApi().getAllRunners(); #### SearchApi ```java // Do a global search for Projects -List projects = gitLabApi.getSearchApi().globalSearch(SearchScope.PROJECTS, "text-to-search-for"); +List projects = gitLabApi.getSearchApi().globalSearch(SearchScope.PROJECTS, "text-to-search-for"); ``` #### ServicesApi diff --git a/build.gradle b/build.gradle index 37d9c458d..053aecef2 100644 --- a/build.gradle +++ b/build.gradle @@ -1,7 +1,7 @@ plugins { id 'java-library' - id 'com.diffplug.spotless' version '6.2.0' + id 'com.diffplug.spotless' version '6.25.0' id 'signing' id 'maven-publish' id 'io.github.gradle-nexus.publish-plugin' version '1.3.0' @@ -15,17 +15,17 @@ wrapper { group = 'org.gitlab4j' dependencies { - api 'jakarta.activation:jakarta.activation-api:1.2.2' - api 'org.glassfish.jersey.inject:jersey-hk2:2.39.1' - api 'org.glassfish.jersey.core:jersey-client:2.39.1' - api 'org.glassfish.jersey.connectors:jersey-apache-connector:2.39.1' - api 'org.glassfish.jersey.media:jersey-media-multipart:2.39.1' - api 'org.glassfish.jersey.media:jersey-media-json-jackson:2.39.1' - api 'jakarta.servlet:jakarta.servlet-api:4.0.4' - testImplementation 'org.mockito:mockito-core:4.4.0' - testImplementation 'org.mockito:mockito-junit-jupiter:4.4.0' + api 'jakarta.activation:jakarta.activation-api:2.1.1' + api 'org.glassfish.jersey.inject:jersey-hk2:3.1.1' + api 'org.glassfish.jersey.core:jersey-client:3.1.1' + api 'org.glassfish.jersey.connectors:jersey-apache-connector:3.1.1' + api 'org.glassfish.jersey.media:jersey-media-multipart:3.1.1' + api 'org.glassfish.jersey.media:jersey-media-json-jackson:3.1.1' + api 'jakarta.servlet:jakarta.servlet-api:6.0.0' + testImplementation 'org.mockito:mockito-core:5.2.0' + testImplementation 'org.mockito:mockito-junit-jupiter:5.2.0' testImplementation 'org.hamcrest:hamcrest-all:1.3' - testImplementation 'uk.org.webcompere:system-stubs-jupiter:1.2.0' + testImplementation 'uk.org.webcompere:system-stubs-jupiter:2.0.2' testImplementation "org.junit.jupiter:junit-jupiter-api:5.10.4" testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:5.10.4" } @@ -47,7 +47,7 @@ java { compileJava.options.encoding = "UTF-8" toolchain { - languageVersion = JavaLanguageVersion.of(8) + languageVersion = JavaLanguageVersion.of(11) } } @@ -122,7 +122,7 @@ publishing { release { buildTasks = ['doRelease'] git { - requireBranch.set('main') + requireBranch.set('6.x') } } diff --git a/gradle.properties b/gradle.properties index 48df42d5d..326dd5cfe 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,5 +1,5 @@ -version=5.8.1-SNAPSHOT -lastVersion=5.8.0 +version=6.0.0-SNAPSHOT +lastVersion=6.0.0-rc.6 githubRepositoryOwner=gitlab4j githubRepositoryName=gitlab4j-api diff --git a/jitpack.yml b/jitpack.yml index 169b98ab8..adb3fe10c 100644 --- a/jitpack.yml +++ b/jitpack.yml @@ -1,2 +1,2 @@ jdk: - - openjdk8 \ No newline at end of file + - openjdk11 diff --git a/src/main/java/org/gitlab4j/api/AbstractApi.java b/src/main/java/org/gitlab4j/api/AbstractApi.java index a6d89a397..18875281e 100644 --- a/src/main/java/org/gitlab4j/api/AbstractApi.java +++ b/src/main/java/org/gitlab4j/api/AbstractApi.java @@ -4,11 +4,11 @@ import java.io.InputStream; import java.net.URL; -import javax.ws.rs.NotAuthorizedException; -import javax.ws.rs.core.Form; -import javax.ws.rs.core.MultivaluedMap; -import javax.ws.rs.core.Response; -import javax.ws.rs.core.StreamingOutput; +import jakarta.ws.rs.NotAuthorizedException; +import jakarta.ws.rs.core.Form; +import jakarta.ws.rs.core.MultivaluedMap; +import jakarta.ws.rs.core.Response; +import jakarta.ws.rs.core.StreamingOutput; import org.gitlab4j.api.GitLabApi.ApiVersion; import org.gitlab4j.api.models.Group; diff --git a/src/main/java/org/gitlab4j/api/ApplicationSettingsApi.java b/src/main/java/org/gitlab4j/api/ApplicationSettingsApi.java index 708932de4..518849af9 100644 --- a/src/main/java/org/gitlab4j/api/ApplicationSettingsApi.java +++ b/src/main/java/org/gitlab4j/api/ApplicationSettingsApi.java @@ -3,7 +3,7 @@ import java.text.ParseException; import java.util.Iterator; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.ApplicationSettings; import org.gitlab4j.api.models.Setting; diff --git a/src/main/java/org/gitlab4j/api/ApplicationsApi.java b/src/main/java/org/gitlab4j/api/ApplicationsApi.java index c20101831..fc4e58c3e 100644 --- a/src/main/java/org/gitlab4j/api/ApplicationsApi.java +++ b/src/main/java/org/gitlab4j/api/ApplicationsApi.java @@ -5,8 +5,8 @@ import java.util.stream.Collectors; import java.util.stream.Stream; -import javax.ws.rs.core.GenericType; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.GenericType; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.Application; @@ -43,7 +43,8 @@ public List getApplications() throws GitLabApiException { * @throws GitLabApiException if any exception occurs */ public List getApplications(int page, int perPage) throws GitLabApiException { - Response response = get(javax.ws.rs.core.Response.Status.OK, getPageQueryParams(page, perPage), "applications"); + Response response = + get(jakarta.ws.rs.core.Response.Status.OK, getPageQueryParams(page, perPage), "applications"); return (response.readEntity(new GenericType>() {})); } diff --git a/src/main/java/org/gitlab4j/api/AuditEventApi.java b/src/main/java/org/gitlab4j/api/AuditEventApi.java index 08400f09a..0970e45f1 100644 --- a/src/main/java/org/gitlab4j/api/AuditEventApi.java +++ b/src/main/java/org/gitlab4j/api/AuditEventApi.java @@ -4,8 +4,8 @@ import java.util.List; import java.util.stream.Stream; -import javax.ws.rs.core.Form; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.Form; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.AuditEvent; import org.gitlab4j.api.utils.ISO8601; diff --git a/src/main/java/org/gitlab4j/api/AwardEmojiApi.java b/src/main/java/org/gitlab4j/api/AwardEmojiApi.java index 207dfcd89..00c367551 100644 --- a/src/main/java/org/gitlab4j/api/AwardEmojiApi.java +++ b/src/main/java/org/gitlab4j/api/AwardEmojiApi.java @@ -2,8 +2,8 @@ import java.util.List; -import javax.ws.rs.core.GenericType; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.GenericType; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.AwardEmoji; diff --git a/src/main/java/org/gitlab4j/api/BoardsApi.java b/src/main/java/org/gitlab4j/api/BoardsApi.java index 09047b1b6..2cf0fe78a 100644 --- a/src/main/java/org/gitlab4j/api/BoardsApi.java +++ b/src/main/java/org/gitlab4j/api/BoardsApi.java @@ -4,8 +4,8 @@ import java.util.Optional; import java.util.stream.Stream; -import javax.ws.rs.core.GenericType; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.GenericType; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.Board; import org.gitlab4j.api.models.BoardList; @@ -50,7 +50,7 @@ public List getBoards(Object projectIdOrPath) throws GitLabApiException { */ public List getBoards(Object projectIdOrPath, int page, int perPage) throws GitLabApiException { Response response = get( - javax.ws.rs.core.Response.Status.OK, + jakarta.ws.rs.core.Response.Status.OK, getPageQueryParams(page, perPage), "projects", getProjectIdOrPath(projectIdOrPath), @@ -225,7 +225,7 @@ public List getBoardLists(Object projectIdOrPath, Long boardId) throw public List getBoardLists(Object projectIdOrPath, Long boardId, int page, int perPage) throws GitLabApiException { Response response = get( - javax.ws.rs.core.Response.Status.OK, + jakarta.ws.rs.core.Response.Status.OK, getPageQueryParams(page, perPage), "projects", getProjectIdOrPath(projectIdOrPath), diff --git a/src/main/java/org/gitlab4j/api/CommitsApi.java b/src/main/java/org/gitlab4j/api/CommitsApi.java index ef205cb8f..a40e371d5 100644 --- a/src/main/java/org/gitlab4j/api/CommitsApi.java +++ b/src/main/java/org/gitlab4j/api/CommitsApi.java @@ -3,14 +3,13 @@ import java.util.Arrays; import java.util.Date; import java.util.List; -import java.util.Objects; import java.util.Optional; import java.util.stream.Stream; -import javax.ws.rs.core.Form; -import javax.ws.rs.core.GenericType; -import javax.ws.rs.core.MultivaluedMap; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.Form; +import jakarta.ws.rs.core.GenericType; +import jakarta.ws.rs.core.MultivaluedMap; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.Comment; import org.gitlab4j.api.models.Commit; @@ -662,42 +661,12 @@ public Stream getCommitStatusesStream(Object projectIdOrPath, Stri * @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance (required) * @param sha a commit SHA (required) * @param state the state of the status. Can be one of the following: PENDING, RUNNING, SUCCESS, FAILED, CANCELED (required) - * @param status the CommitSatus instance hoilding the optional parms: ref, name, target_url, description, and coverage + * @param status the CommitSatus instance holding the optional parameters: ref, name, target_url, description, and coverage * @return a CommitStatus instance with the updated info * @throws GitLabApiException GitLabApiException if any exception occurs during execution */ public CommitStatus addCommitStatus(Object projectIdOrPath, String sha, CommitBuildState state, CommitStatus status) throws GitLabApiException { - return addCommitStatus(projectIdOrPath, sha, state, null, status); - } - - /** - *

Add or update the build status of a commit. The following fluent methods are available on the - * CommitStatus instance for setting up the status:

- * 

-     * withCoverage(Float)
-     * withDescription(String)
-     * withName(String)
-     * withRef(String)
-     * withTargetUrl(String)
-     *
- * - * 
GitLab Endpoint: POST /projects/:id/statuses/:sha
- * - * @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance (required) - * @param sha a commit SHA (required) - * @param state the state of the status. Can be one of the following: PENDING, RUNNING, SUCCESS, FAILED, CANCELED (required) - * @param pipelineId The ID of the pipeline to set status. Use in case of several pipeline on same SHA (optional) - * @param status the CommitSatus instance hoilding the optional parms: ref, name, target_url, description, and coverage - * @return a CommitStatus instance with the updated info - * @throws GitLabApiException GitLabApiException if any exception occurs during execution - * @deprecated use {@link #addCommitStatus(Object, String, org.gitlab4j.api.Constants.CommitBuildState, CommitStatus)} and set the pipelineId value in the {@link CommitStatus} parameter - */ - @Deprecated - public CommitStatus addCommitStatus( - Object projectIdOrPath, String sha, CommitBuildState state, Long pipelineId, CommitStatus status) - throws GitLabApiException { - if (projectIdOrPath == null) { throw new RuntimeException("projectIdOrPath cannot be null"); } @@ -714,16 +683,6 @@ public CommitStatus addCommitStatus( .withParam("description", status.getDescription()) .withParam("coverage", status.getCoverage()) .withParam("pipeline_id", status.getPipelineId()); - if (pipelineId != null - && status.getPipelineId() != null - && !Objects.equals(status.getPipelineId(), pipelineId)) { - throw new IllegalArgumentException( - "The parameter 'pipelineId' and the pipelineId value the 'status' parameter are different. Set the two values to be the same or one of the two values to null."); - } - } - - if (pipelineId != null) { - formData.withParam("pipeline_id", pipelineId); } Response response = diff --git a/src/main/java/org/gitlab4j/api/Constants.java b/src/main/java/org/gitlab4j/api/Constants.java index 09c87eea9..270e8d6aa 100644 --- a/src/main/java/org/gitlab4j/api/Constants.java +++ b/src/main/java/org/gitlab4j/api/Constants.java @@ -1,8 +1,20 @@ package org.gitlab4j.api; +import java.util.Arrays; import java.util.HashMap; import java.util.Map; - +import java.util.function.Function; +import java.util.stream.Collectors; + +import org.gitlab4j.api.models.Commit; +import org.gitlab4j.api.models.Issue; +import org.gitlab4j.api.models.MergeRequest; +import org.gitlab4j.api.models.Milestone; +import org.gitlab4j.api.models.Note; +import org.gitlab4j.api.models.Project; +import org.gitlab4j.api.models.SearchBlob; +import org.gitlab4j.api.models.Snippet; +import org.gitlab4j.api.models.User; import org.gitlab4j.api.utils.JacksonJsonEnumHelper; import com.fasterxml.jackson.annotation.JsonCreator; @@ -860,98 +872,160 @@ public String toString() { /** * Enum for the search scope when doing a globalSearch() with the SearchApi. */ - public enum SearchScope { - PROJECTS, - ISSUES, - MERGE_REQUESTS, - MILESTONES, - SNIPPET_TITLES, - SNIPPET_BLOBS, - USERS, - BLOBS, - COMMITS, - WIKI_BLOBS; - - private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(SearchScope.class); + public static class SearchScope { + + private final String jsonName; + private final Class resultType; + + private SearchScope(String jsonName, Class resultType) { + this.jsonName = jsonName; + this.resultType = resultType; + } + + public Class getResultType() { + return resultType; + } + + public static final SearchScope PROJECTS = new SearchScope<>("projects", Project.class); + public static final SearchScope ISSUES = new SearchScope<>("issues", Issue.class); + public static final SearchScope MERGE_REQUESTS = + new SearchScope<>("merge_requests", MergeRequest.class); + public static final SearchScope MILESTONES = new SearchScope<>("milestones", Milestone.class); + public static final SearchScope SNIPPET_TITLES = new SearchScope<>("snippet_titles", Snippet.class); + public static final SearchScope SNIPPET_BLOBS = new SearchScope<>("snippet_blobs", Snippet.class); + public static final SearchScope USERS = new SearchScope<>("users", User.class); + public static final SearchScope BLOBS = new SearchScope<>("blobs", SearchBlob.class); + public static final SearchScope COMMITS = new SearchScope<>("commits", Commit.class); + public static final SearchScope WIKI_BLOBS = new SearchScope<>("wiki_blobs", SearchBlob.class); + + private static final Map jsonLookup = Arrays.stream(new SearchScope[] { + PROJECTS, + ISSUES, + MERGE_REQUESTS, + MILESTONES, + SNIPPET_TITLES, + SNIPPET_BLOBS, + USERS, + BLOBS, + COMMITS, + WIKI_BLOBS + }) + .collect(Collectors.toMap(searchScope -> searchScope.jsonName, Function.identity())); @JsonCreator - public static SearchScope forValue(String value) { - return enumHelper.forValue(value); + public static SearchScope forValue(String value) { + return (SearchScope) jsonLookup.get(value); } @JsonValue public String toValue() { - return (enumHelper.toString(this)); + return jsonName; } @Override public String toString() { - return (enumHelper.toString(this)); + return jsonName; } } /** * Enum for the search scope when doing a groupSearch() with the SearchApi. */ - public enum GroupSearchScope { - PROJECTS, - ISSUES, - MERGE_REQUESTS, - MILESTONES, - WIKI_BLOBS, - COMMITS, - BLOBS, - NOTES, - USERS; - - private static JacksonJsonEnumHelper enumHelper = - new JacksonJsonEnumHelper<>(GroupSearchScope.class); + public static class GroupSearchScope { + + private final String jsonName; + private final Class resultType; + + public GroupSearchScope(String jsonName, Class resultType) { + this.jsonName = jsonName; + this.resultType = resultType; + } + + public Class getResultType() { + return resultType; + } + + public static final GroupSearchScope PROJECTS = new GroupSearchScope<>("projects", Project.class); + public static final GroupSearchScope ISSUES = new GroupSearchScope<>("issues", Issue.class); + public static final GroupSearchScope MERGE_REQUESTS = + new GroupSearchScope<>("merge_requests", MergeRequest.class); + public static final GroupSearchScope MILESTONES = + new GroupSearchScope<>("milestones", Milestone.class); + public static final GroupSearchScope WIKI_BLOBS = + new GroupSearchScope<>("wiki_blobs", SearchBlob.class); + public static final GroupSearchScope COMMITS = new GroupSearchScope<>("commits", Commit.class); + public static final GroupSearchScope BLOBS = new GroupSearchScope<>("blobs", SearchBlob.class); + public static final GroupSearchScope NOTES = new GroupSearchScope<>("notes", Note.class); + public static final GroupSearchScope USERS = new GroupSearchScope<>("users", User.class); + + private static final Map jsonLookup = Arrays.stream(new GroupSearchScope[] { + PROJECTS, ISSUES, MERGE_REQUESTS, MILESTONES, WIKI_BLOBS, COMMITS, BLOBS, NOTES, USERS, + }) + .collect(Collectors.toMap(searchScope -> searchScope.jsonName, Function.identity())); @JsonCreator - public static GroupSearchScope forValue(String value) { - return enumHelper.forValue(value); + public static GroupSearchScope forValue(String value) { + return (GroupSearchScope) jsonLookup.get(value); } @JsonValue public String toValue() { - return (enumHelper.toString(this)); + return jsonName; } @Override public String toString() { - return (enumHelper.toString(this)); + return jsonName; } } /** * Enum for the search scope when doing a projectSearch() with the SearchApi. */ - public enum ProjectSearchScope { - BLOBS, - COMMITS, - ISSUES, - MERGE_REQUESTS, - MILESTONES, - NOTES, - WIKI_BLOBS, - USERS; - - private static JacksonJsonEnumHelper enumHelper = - new JacksonJsonEnumHelper<>(ProjectSearchScope.class); + public static class ProjectSearchScope { + + private final String jsonName; + private final Class resultType; + + public ProjectSearchScope(String jsonName, Class resultType) { + this.jsonName = jsonName; + this.resultType = resultType; + } + + public Class getResultType() { + return resultType; + } + + public static final ProjectSearchScope BLOBS = new ProjectSearchScope<>("blobs", SearchBlob.class); + public static final ProjectSearchScope COMMITS = new ProjectSearchScope<>("commits", Commit.class); + public static final ProjectSearchScope ISSUES = new ProjectSearchScope<>("issues", Issue.class); + public static final ProjectSearchScope MERGE_REQUESTS = + new ProjectSearchScope<>("merge_requests", MergeRequest.class); + public static final ProjectSearchScope MILESTONES = + new ProjectSearchScope<>("milestones", Milestone.class); + public static final ProjectSearchScope NOTES = new ProjectSearchScope<>("notes", Note.class); + public static final ProjectSearchScope WIKI_BLOBS = + new ProjectSearchScope<>("wiki_blobs", SearchBlob.class); + public static final ProjectSearchScope USERS = new ProjectSearchScope<>("users", User.class); + + private static final Map jsonLookup = Arrays.stream(new ProjectSearchScope[] { + BLOBS, COMMITS, ISSUES, MERGE_REQUESTS, MILESTONES, NOTES, WIKI_BLOBS, USERS, + }) + .collect(Collectors.toMap(searchScope -> searchScope.jsonName, Function.identity())); @JsonCreator - public static ProjectSearchScope forValue(String value) { - return enumHelper.forValue(value); + public static ProjectSearchScope forValue(String value) { + return (ProjectSearchScope) jsonLookup.get(value); } @JsonValue public String toValue() { - return (enumHelper.toString(this)); + return jsonName; } @Override public String toString() { - return (enumHelper.toString(this)); + return jsonName; } } diff --git a/src/main/java/org/gitlab4j/api/ContainerRegistryApi.java b/src/main/java/org/gitlab4j/api/ContainerRegistryApi.java index ab3454f07..ed9e27655 100644 --- a/src/main/java/org/gitlab4j/api/ContainerRegistryApi.java +++ b/src/main/java/org/gitlab4j/api/ContainerRegistryApi.java @@ -27,8 +27,8 @@ import java.util.Optional; import java.util.stream.Stream; -import javax.ws.rs.core.GenericType; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.GenericType; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.RegistryRepository; import org.gitlab4j.api.models.RegistryRepositoryTag; diff --git a/src/main/java/org/gitlab4j/api/DeployKeysApi.java b/src/main/java/org/gitlab4j/api/DeployKeysApi.java index 1132a95e1..09598d98e 100644 --- a/src/main/java/org/gitlab4j/api/DeployKeysApi.java +++ b/src/main/java/org/gitlab4j/api/DeployKeysApi.java @@ -4,9 +4,9 @@ import java.util.Optional; import java.util.stream.Stream; -import javax.ws.rs.core.Form; -import javax.ws.rs.core.GenericType; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.Form; +import jakarta.ws.rs.core.GenericType; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.DeployKey; diff --git a/src/main/java/org/gitlab4j/api/DeployTokensApi.java b/src/main/java/org/gitlab4j/api/DeployTokensApi.java index 696ce34ff..a4e2e0b5c 100644 --- a/src/main/java/org/gitlab4j/api/DeployTokensApi.java +++ b/src/main/java/org/gitlab4j/api/DeployTokensApi.java @@ -4,7 +4,7 @@ import java.util.List; import java.util.stream.Stream; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.DeployToken; diff --git a/src/main/java/org/gitlab4j/api/DeploymentsApi.java b/src/main/java/org/gitlab4j/api/DeploymentsApi.java index 1f10ca620..dafde8189 100644 --- a/src/main/java/org/gitlab4j/api/DeploymentsApi.java +++ b/src/main/java/org/gitlab4j/api/DeploymentsApi.java @@ -4,7 +4,7 @@ import java.util.Optional; import java.util.stream.Stream; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.Deployment; import org.gitlab4j.api.models.DeploymentFilter; diff --git a/src/main/java/org/gitlab4j/api/DiscussionsApi.java b/src/main/java/org/gitlab4j/api/DiscussionsApi.java index 71f0c7e01..f7932039b 100644 --- a/src/main/java/org/gitlab4j/api/DiscussionsApi.java +++ b/src/main/java/org/gitlab4j/api/DiscussionsApi.java @@ -5,8 +5,8 @@ import java.util.Optional; import java.util.stream.Stream; -import javax.ws.rs.core.GenericType; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.GenericType; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.Discussion; import org.gitlab4j.api.models.Note; diff --git a/src/main/java/org/gitlab4j/api/EnvironmentsApi.java b/src/main/java/org/gitlab4j/api/EnvironmentsApi.java index 9c16b8bc6..0858b69ec 100644 --- a/src/main/java/org/gitlab4j/api/EnvironmentsApi.java +++ b/src/main/java/org/gitlab4j/api/EnvironmentsApi.java @@ -4,7 +4,7 @@ import java.util.Optional; import java.util.stream.Stream; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.Environment; @@ -103,24 +103,6 @@ public Optional getOptionalEnvironment(Object projectIdOrPath, Long } } - /** - * Create a new environment with the given name and external_url. - * - * 
GitLab Endpoint:POST /projects/:id/environments
- * - * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path - * @param name the name of the environment - * @param externalUrl the place to link to for this environment - * @return the created Environment instance - * @throws GitLabApiException if any exception occurs - * @deprecated use {@link #createEnvironment(Object, String, String, String)} instead - */ - @Deprecated - public Environment createEnvironment(Object projectIdOrPath, String name, String externalUrl) - throws GitLabApiException { - return createEnvironment(projectIdOrPath, name, externalUrl, null); - } - /** * Create a new environment with the given name, external_url and tier. * @@ -144,25 +126,6 @@ public Environment createEnvironment(Object projectIdOrPath, String name, String return (response.readEntity(Environment.class)); } - /** - * Update an existing environment. - * - * 
GitLab Endpoint:POST /projects/:id/environments
- * - * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path - * @param environmentId the ID of the environment to update - * @param name the name of the environment - * @param externalUrl the place to link to for this environment - * @return the created Environment instance - * @throws GitLabApiException if any exception occurs - * @deprecated use {@link #updateEnvironment(Object, Long, String, String, String)} instead - */ - @Deprecated - public Environment updateEnvironment(Object projectIdOrPath, Long environmentId, String name, String externalUrl) - throws GitLabApiException { - return updateEnvironment(projectIdOrPath, environmentId, name, externalUrl, null); - } - /** * Update an existing environment. * diff --git a/src/main/java/org/gitlab4j/api/EpicsApi.java b/src/main/java/org/gitlab4j/api/EpicsApi.java index b2a292fcb..75be34821 100644 --- a/src/main/java/org/gitlab4j/api/EpicsApi.java +++ b/src/main/java/org/gitlab4j/api/EpicsApi.java @@ -5,9 +5,9 @@ import java.util.Optional; import java.util.stream.Stream; -import javax.ws.rs.core.Form; -import javax.ws.rs.core.GenericType; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.Form; +import jakarta.ws.rs.core.GenericType; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.Constants.StateEvent; import org.gitlab4j.api.models.ChildEpic; diff --git a/src/main/java/org/gitlab4j/api/EventsApi.java b/src/main/java/org/gitlab4j/api/EventsApi.java index 022b1a66f..69faff812 100644 --- a/src/main/java/org/gitlab4j/api/EventsApi.java +++ b/src/main/java/org/gitlab4j/api/EventsApi.java @@ -4,8 +4,8 @@ import java.util.List; import java.util.stream.Stream; -import javax.ws.rs.core.GenericType; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.GenericType; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.Event; diff --git a/src/main/java/org/gitlab4j/api/ExternalStatusCheckApi.java b/src/main/java/org/gitlab4j/api/ExternalStatusCheckApi.java index b883a0112..9f4fbcfbf 100644 --- a/src/main/java/org/gitlab4j/api/ExternalStatusCheckApi.java +++ b/src/main/java/org/gitlab4j/api/ExternalStatusCheckApi.java @@ -4,8 +4,8 @@ import java.util.stream.Collectors; import java.util.stream.Stream; -import javax.ws.rs.core.Form; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.Form; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.ExternalStatusCheck; import org.gitlab4j.api.models.ExternalStatusCheckProtectedBranch; diff --git a/src/main/java/org/gitlab4j/api/GitLabApi.java b/src/main/java/org/gitlab4j/api/GitLabApi.java index 4a3847af6..55817f085 100644 --- a/src/main/java/org/gitlab4j/api/GitLabApi.java +++ b/src/main/java/org/gitlab4j/api/GitLabApi.java @@ -9,8 +9,8 @@ import java.util.logging.Level; import java.util.logging.Logger; -import javax.ws.rs.core.MediaType; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.MediaType; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.Constants.TokenType; import org.gitlab4j.api.models.OauthTokenResponse; @@ -542,7 +542,7 @@ public final GitLabApi duplicate() { } /** - * Close the underlying {@link javax.ws.rs.client.Client} and its associated resources. + * Close the underlying {@link jakarta.ws.rs.client.Client} and its associated resources. */ @Override public void close() { diff --git a/src/main/java/org/gitlab4j/api/GitLabApiClient.java b/src/main/java/org/gitlab4j/api/GitLabApiClient.java index 989537015..609466c50 100755 --- a/src/main/java/org/gitlab4j/api/GitLabApiClient.java +++ b/src/main/java/org/gitlab4j/api/GitLabApiClient.java @@ -21,16 +21,17 @@ import javax.net.ssl.SSLSession; import javax.net.ssl.TrustManager; import javax.net.ssl.X509ExtendedTrustManager; -import javax.ws.rs.client.Client; -import javax.ws.rs.client.ClientBuilder; -import javax.ws.rs.client.Entity; -import javax.ws.rs.client.Invocation; -import javax.ws.rs.client.WebTarget; -import javax.ws.rs.core.Form; -import javax.ws.rs.core.MediaType; -import javax.ws.rs.core.MultivaluedMap; -import javax.ws.rs.core.Response; -import javax.ws.rs.core.StreamingOutput; + +import jakarta.ws.rs.client.Client; +import jakarta.ws.rs.client.ClientBuilder; +import jakarta.ws.rs.client.Entity; +import jakarta.ws.rs.client.Invocation; +import jakarta.ws.rs.client.WebTarget; +import jakarta.ws.rs.core.Form; +import jakarta.ws.rs.core.MediaType; +import jakarta.ws.rs.core.MultivaluedMap; +import jakarta.ws.rs.core.Response; +import jakarta.ws.rs.core.StreamingOutput; import org.gitlab4j.api.Constants.TokenType; import org.gitlab4j.api.GitLabApi.ApiVersion; diff --git a/src/main/java/org/gitlab4j/api/GitLabApiException.java b/src/main/java/org/gitlab4j/api/GitLabApiException.java index c7a7feafe..d816504c2 100755 --- a/src/main/java/org/gitlab4j/api/GitLabApiException.java +++ b/src/main/java/org/gitlab4j/api/GitLabApiException.java @@ -8,10 +8,10 @@ import java.util.Map.Entry; import java.util.Objects; -import javax.ws.rs.core.MediaType; -import javax.ws.rs.core.MultivaluedMap; -import javax.ws.rs.core.Response; -import javax.ws.rs.core.Response.StatusType; +import jakarta.ws.rs.core.MediaType; +import jakarta.ws.rs.core.MultivaluedMap; +import jakarta.ws.rs.core.Response; +import jakarta.ws.rs.core.Response.StatusType; import org.gitlab4j.api.utils.JacksonJson; diff --git a/src/main/java/org/gitlab4j/api/GitLabApiForm.java b/src/main/java/org/gitlab4j/api/GitLabApiForm.java index 7d89865ca..7bda957c0 100644 --- a/src/main/java/org/gitlab4j/api/GitLabApiForm.java +++ b/src/main/java/org/gitlab4j/api/GitLabApiForm.java @@ -5,8 +5,8 @@ import java.util.Map; import java.util.Map.Entry; -import javax.ws.rs.core.Form; -import javax.ws.rs.core.MultivaluedHashMap; +import jakarta.ws.rs.core.Form; +import jakarta.ws.rs.core.MultivaluedHashMap; import org.gitlab4j.api.models.AccessLevel; import org.gitlab4j.api.models.Variable; diff --git a/src/main/java/org/gitlab4j/api/GitLabCiYamlApi.java b/src/main/java/org/gitlab4j/api/GitLabCiYamlApi.java index 5cb007739..a80246f64 100644 --- a/src/main/java/org/gitlab4j/api/GitLabCiYamlApi.java +++ b/src/main/java/org/gitlab4j/api/GitLabCiYamlApi.java @@ -2,9 +2,9 @@ import java.util.List; -import javax.ws.rs.core.GenericType; -import javax.ws.rs.core.Response; -import javax.ws.rs.core.Response.Status; +import jakarta.ws.rs.core.GenericType; +import jakarta.ws.rs.core.Response; +import jakarta.ws.rs.core.Response.Status; import org.gitlab4j.api.models.GitLabCiTemplate; import org.gitlab4j.api.models.GitLabCiTemplateElement; diff --git a/src/main/java/org/gitlab4j/api/GroupApi.java b/src/main/java/org/gitlab4j/api/GroupApi.java index 008d1081f..4a66faf6d 100644 --- a/src/main/java/org/gitlab4j/api/GroupApi.java +++ b/src/main/java/org/gitlab4j/api/GroupApi.java @@ -9,11 +9,11 @@ import java.util.Optional; import java.util.stream.Stream; -import javax.ws.rs.core.Form; -import javax.ws.rs.core.GenericType; -import javax.ws.rs.core.MediaType; -import javax.ws.rs.core.MultivaluedMap; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.Form; +import jakarta.ws.rs.core.GenericType; +import jakarta.ws.rs.core.MediaType; +import jakarta.ws.rs.core.MultivaluedMap; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.GitLabApi.ApiVersion; import org.gitlab4j.api.models.*; diff --git a/src/main/java/org/gitlab4j/api/HealthCheckApi.java b/src/main/java/org/gitlab4j/api/HealthCheckApi.java index 9a39778ae..366dadf89 100644 --- a/src/main/java/org/gitlab4j/api/HealthCheckApi.java +++ b/src/main/java/org/gitlab4j/api/HealthCheckApi.java @@ -3,7 +3,7 @@ import java.io.IOException; import java.net.URL; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.HealthCheckInfo; diff --git a/src/main/java/org/gitlab4j/api/HookManager.java b/src/main/java/org/gitlab4j/api/HookManager.java index d56a6c0f9..f9b634981 100644 --- a/src/main/java/org/gitlab4j/api/HookManager.java +++ b/src/main/java/org/gitlab4j/api/HookManager.java @@ -1,6 +1,6 @@ package org.gitlab4j.api; -import javax.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletRequest; /** * This interface provides a base class handler for processing GitLab Web Hook and System Hook callouts. diff --git a/src/main/java/org/gitlab4j/api/ImportExportApi.java b/src/main/java/org/gitlab4j/api/ImportExportApi.java index b45ee7fd4..c36f425df 100644 --- a/src/main/java/org/gitlab4j/api/ImportExportApi.java +++ b/src/main/java/org/gitlab4j/api/ImportExportApi.java @@ -9,9 +9,9 @@ import java.util.Date; import java.util.Map; -import javax.ws.rs.core.Form; -import javax.ws.rs.core.MediaType; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.Form; +import jakarta.ws.rs.core.MediaType; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.ExportStatus; import org.gitlab4j.api.models.ImportStatus; diff --git a/src/main/java/org/gitlab4j/api/IssuesApi.java b/src/main/java/org/gitlab4j/api/IssuesApi.java index 65571c896..7fca33125 100644 --- a/src/main/java/org/gitlab4j/api/IssuesApi.java +++ b/src/main/java/org/gitlab4j/api/IssuesApi.java @@ -6,8 +6,8 @@ import java.util.Optional; import java.util.stream.Stream; -import javax.ws.rs.core.GenericType; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.GenericType; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.GitLabApi.ApiVersion; import org.gitlab4j.api.models.Duration; @@ -17,6 +17,7 @@ import org.gitlab4j.api.models.IssuesStatistics; import org.gitlab4j.api.models.IssuesStatisticsFilter; import org.gitlab4j.api.models.LinkType; +import org.gitlab4j.api.models.LinkedIssue; import org.gitlab4j.api.models.MergeRequest; import org.gitlab4j.api.models.Participant; import org.gitlab4j.api.models.TimeStats; @@ -1030,7 +1031,7 @@ public Stream getClosedByMergeRequestsStream(Object projectIdOrPat * @return a list of related issues of a given issue, sorted by the relationship creation datetime (ascending) * @throws GitLabApiException if any exception occurs */ - public List getIssueLinks(Object projectIdOrPath, Long issueIid) throws GitLabApiException { + public List getIssueLinks(Object projectIdOrPath, Long issueIid) throws GitLabApiException { return (getIssueLinks(projectIdOrPath, issueIid, getDefaultPerPage()).all()); } @@ -1048,11 +1049,11 @@ public List getIssueLinks(Object projectIdOrPath, Long issueIid) throws G * @return a Pager of related issues of a given issue, sorted by the relationship creation datetime (ascending) * @throws GitLabApiException if any exception occurs */ - public Pager getIssueLinks(Object projectIdOrPath, Long issueIid, int itemsPerPage) + public Pager getIssueLinks(Object projectIdOrPath, Long issueIid, int itemsPerPage) throws GitLabApiException { - return (new Pager( + return (new Pager( this, - Issue.class, + LinkedIssue.class, itemsPerPage, null, "projects", @@ -1075,7 +1076,7 @@ public Pager getIssueLinks(Object projectIdOrPath, Long issueIid, int ite * @return a Stream of related issues of a given issue, sorted by the relationship creation datetime (ascending) * @throws GitLabApiException if any exception occurs */ - public Stream getIssueLinksStream(Object projectIdOrPath, Long issueIid) throws GitLabApiException { + public Stream getIssueLinksStream(Object projectIdOrPath, Long issueIid) throws GitLabApiException { return (getIssueLinks(projectIdOrPath, issueIid, getDefaultPerPage()).stream()); } diff --git a/src/main/java/org/gitlab4j/api/JobApi.java b/src/main/java/org/gitlab4j/api/JobApi.java index 416336041..f5d38f5b4 100644 --- a/src/main/java/org/gitlab4j/api/JobApi.java +++ b/src/main/java/org/gitlab4j/api/JobApi.java @@ -4,17 +4,16 @@ import java.io.IOException; import java.io.InputStream; import java.nio.file.Files; -import java.nio.file.Path; import java.nio.file.StandardCopyOption; import java.util.List; import java.util.Optional; import java.util.stream.Stream; -import javax.ws.rs.core.Form; -import javax.ws.rs.core.GenericType; -import javax.ws.rs.core.MediaType; -import javax.ws.rs.core.Response; -import javax.ws.rs.core.Response.Status; +import jakarta.ws.rs.core.Form; +import jakarta.ws.rs.core.GenericType; +import jakarta.ws.rs.core.MediaType; +import jakarta.ws.rs.core.Response; +import jakarta.ws.rs.core.Response.Status; import org.gitlab4j.api.models.ArtifactsFile; import org.gitlab4j.api.models.Job; @@ -544,10 +543,9 @@ public InputStream downloadArtifactsFile(Object projectIdOrPath, Long jobId, Art * @return a File instance pointing to the download of the specified artifacts file * @throws GitLabApiException if any exception occurs */ - public File downloadSingleArtifactsFile(Object projectIdOrPath, Long jobId, Path artifactPath, File directory) + public File downloadSingleArtifactsFile(Object projectIdOrPath, Long jobId, String artifactPath, File directory) throws GitLabApiException { - String path = artifactPath.toString().replace("\\", "/"); Response response = get( Response.Status.OK, getDefaultPerPageParam(), @@ -556,12 +554,12 @@ public File downloadSingleArtifactsFile(Object projectIdOrPath, Long jobId, Path "jobs", jobId, "artifacts", - path); + artifactPath); try { if (directory == null) directory = new File(System.getProperty("java.io.tmpdir")); - String filename = artifactPath.getFileName().toString(); + String filename = artifactPath; File file = new File(directory, filename); InputStream in = response.readEntity(InputStream.class); @@ -586,9 +584,8 @@ public File downloadSingleArtifactsFile(Object projectIdOrPath, Long jobId, Path * @return an InputStream to read the specified artifacts file from * @throws GitLabApiException if any exception occurs */ - public InputStream downloadSingleArtifactsFile(Object projectIdOrPath, Long jobId, Path artifactPath) + public InputStream downloadSingleArtifactsFile(Object projectIdOrPath, Long jobId, String artifactPath) throws GitLabApiException { - String path = artifactPath.toString().replace("\\", "/"); Response response = get( Response.Status.OK, getDefaultPerPageParam(), @@ -597,7 +594,7 @@ public InputStream downloadSingleArtifactsFile(Object projectIdOrPath, Long jobI "jobs", jobId, "artifacts", - path); + artifactPath); return (response.readEntity(InputStream.class)); } diff --git a/src/main/java/org/gitlab4j/api/KeysApi.java b/src/main/java/org/gitlab4j/api/KeysApi.java index dc7f912ac..a614b975d 100644 --- a/src/main/java/org/gitlab4j/api/KeysApi.java +++ b/src/main/java/org/gitlab4j/api/KeysApi.java @@ -2,9 +2,9 @@ import java.util.Collections; -import javax.ws.rs.core.MultivaluedHashMap; -import javax.ws.rs.core.MultivaluedMap; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.MultivaluedHashMap; +import jakarta.ws.rs.core.MultivaluedMap; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.Key; diff --git a/src/main/java/org/gitlab4j/api/LabelsApi.java b/src/main/java/org/gitlab4j/api/LabelsApi.java index 696214e9c..77e658d6a 100644 --- a/src/main/java/org/gitlab4j/api/LabelsApi.java +++ b/src/main/java/org/gitlab4j/api/LabelsApi.java @@ -4,8 +4,8 @@ import java.util.Optional; import java.util.stream.Stream; -import javax.ws.rs.core.GenericType; -import javax.ws.rs.core.Response; +import jakarta.ws.rs.core.GenericType; +import jakarta.ws.rs.core.Response; import org.gitlab4j.api.models.Label; @@ -420,7 +420,7 @@ public List