Merge branch 'main' into xxx

# Conflicts:
#	README.md
#	gradle.properties

Author: jmini

build.gradle

@@ -1,11 +1,12 @@
 plugins {
     id 'com.diffplug.spotless' version '6.25.0' apply false
-    id 'io.github.gradle-nexus.publish-plugin' version '1.3.0'
-    id 'net.researchgate.release' version '3.0.2'
+    id 'org.kordamp.gradle.jandex' version '2.1.0' apply false
+    id 'io.github.gradle-nexus.publish-plugin' version '2.0.0'
+    id 'net.researchgate.release' version '3.1.0'
 }
 
 wrapper {
-    gradleVersion = '7.6.2'
+    gradleVersion = '8.10.1'
 }
 
 String groupId = 'org.gitlab4j'
@@ -15,6 +16,7 @@ subprojects {
     apply plugin: 'signing'
     apply plugin: 'com.diffplug.spotless'
     apply plugin: 'maven-publish'
+    apply plugin: 'org.kordamp.gradle.jandex'
 
     group = groupId
 
@@ -55,6 +57,10 @@ subprojects {
     tasks.named('test') {
         useJUnitPlatform()
     }
+
+    tasks.named("javadoc") {
+        inputs.files(tasks.getByPath("jandex").outputs.files)
+    }
 }
 
 nexusPublishing {

gitlab4j-api/src/main/java/org/gitlab4j/api/BoardsApi.java

@@ -11,6 +11,7 @@
 import org.gitlab4j.api.models.AccessLevel;
 import org.gitlab4j.api.models.Variable;
 import org.gitlab4j.models.GitLabForm;
+import org.gitlab4j.models.GitLabFormValue;
 import org.gitlab4j.models.utils.ISO8601;
 
 /**
@@ -35,13 +36,33 @@ public GitLabApiForm(MultivaluedHashMap<String, String> map) {
     public GitLabApiForm(int page, int perPage) {
         super();
         withParam(AbstractApi.PAGE_PARAM, page);
-        withParam(AbstractApi.PER_PAGE_PARAM, (Integer) perPage);
+        withParam(AbstractApi.PER_PAGE_PARAM, perPage);
     }
 
     public GitLabApiForm(GitLabForm form) {
         super();
-        for (Entry<String, String> e : form.getFormValues().entrySet()) {
-            this.param(e.getKey(), e.getValue());
+        for (Entry<String, GitLabFormValue> e : form.getFormValues().entrySet()) {
+            GitLabFormValue value = e.getValue();
+            switch (value.getType()) {
+                case ACCESS_LEVEL:
+                    withParam(e.getKey(), (AccessLevel) value.getValue(), value.isRequired());
+                    break;
+                case DATE:
+                    withParam(e.getKey(), (Date) value.getValue(), value.isRequired());
+                    break;
+                case LIST:
+                    withParam(e.getKey(), (List<?>) value.getValue(), value.isRequired());
+                    break;
+                case MAP:
+                    @SuppressWarnings("unchecked")
+                    Map<String, ?> mapValue = (Map<String, ?>) value.getValue();
+                    withParam(e.getKey(), mapValue, value.isRequired());
+                    break;
+                case OBJECT:
+                default:
+                    withParam(e.getKey(), value.getValue(), value.isRequired());
+                    break;
+            }
         }
     }
 
@@ -52,8 +73,8 @@ public GitLabApiForm(GitLabForm form) {
      * @param value the value of the field/attribute to add
      * @return this GitLabAPiForm instance
      */
-    public GitLabApiForm withParam(String name, Object value) throws IllegalArgumentException {
-        return (withParam(name, value, false));
+    public GitLabApiForm withParam(String name, Object value) {
+        return withParam(name, value, false);
     }
 
     /**
@@ -63,8 +84,8 @@ public GitLabApiForm withParam(String name, Object value) throws IllegalArgument
      * @param date the value of the field/attribute to add
      * @return this GitLabAPiForm instance
      */
-    public GitLabApiForm withParam(String name, Date date) throws IllegalArgumentException {
-        return (withParam(name, date, false));
+    public GitLabApiForm withParam(String name, Date date) {
+        return withParam(name, date, false);
     }
 
     /**
@@ -76,8 +97,8 @@ public GitLabApiForm withParam(String name, Date date) throws IllegalArgumentExc
      * @return this GitLabAPiForm instance
      * @throws IllegalArgumentException if a required parameter is null or empty
      */
-    public GitLabApiForm withParam(String name, Date date, boolean required) throws IllegalArgumentException {
-        return (withParam(name, (date == null ? null : ISO8601.toString(date)), required));
+    public GitLabApiForm withParam(String name, Date date, boolean required) {
+        return withParam(name, date == null ? null : ISO8601.toString(date), required);
     }
 
     /**
@@ -87,8 +108,8 @@ public GitLabApiForm withParam(String name, Date date, boolean required) throws
      * @param level the value of the field/attribute to add
      * @return this GitLabAPiForm instance
      */
-    public GitLabApiForm withParam(String name, AccessLevel level) throws IllegalArgumentException {
-        return (withParam(name, level, false));
+    public GitLabApiForm withParam(String name, AccessLevel level) {
+        return withParam(name, level, false);
     }
 
     /**
@@ -100,49 +121,47 @@ public GitLabApiForm withParam(String name, AccessLevel level) throws IllegalArg
      * @return this GitLabAPiForm instance
      * @throws IllegalArgumentException if a required parameter is null or empty
      */
-    public GitLabApiForm withParam(String name, AccessLevel level, boolean required) throws IllegalArgumentException {
-        return (withParam(name, (level == null ? null : level.toValue()), required));
+    public GitLabApiForm withParam(String name, AccessLevel level, boolean required) {
+        return withParam(name, level == null ? null : level.toValue(), required);
     }
 
     /**
      * Fluent method for adding a List type query and form parameters to a get() or post() call.
      *
-     * @param <T> the type contained by the List
      * @param name the name of the field/attribute to add
      * @param values a List containing the values of the field/attribute to add
      * @return this GitLabAPiForm instance
      */
-    public <T> GitLabApiForm withParam(String name, List<T> values) {
-        return (withParam(name, values, false));
+    public GitLabApiForm withParam(String name, List<?> values) {
+        return withParam(name, values, false);
     }
 
     /**
      * Fluent method for adding a List type query and form parameters to a get() or post() call.
      *
-     * @param <T> the type contained by the List
      * @param name the name of the field/attribute to add
      * @param values a List containing the values of the field/attribute to add
      * @param required the field is required flag
      * @return this GitLabAPiForm instance
      * @throws IllegalArgumentException if a required parameter is null or empty
      */
-    public <T> GitLabApiForm withParam(String name, List<T> values, boolean required) throws IllegalArgumentException {
+    public GitLabApiForm withParam(String name, List<?> values, boolean required) {
 
         if (values == null || values.isEmpty()) {
             if (required) {
                 throw new IllegalArgumentException(name + " cannot be empty or null");
             }
 
-            return (this);
+            return this;
         }
 
-        for (T value : values) {
+        for (Object value : values) {
             if (value != null) {
                 this.param(name + "[]", value.toString());
             }
         }
 
-        return (this);
+        return this;
     }
 
     /**
@@ -154,15 +173,14 @@ public <T> GitLabApiForm withParam(String name, List<T> values, boolean required
      * @return this GitLabAPiForm instance
      * @throws IllegalArgumentException if a required parameter is null or empty
      */
-    public GitLabApiForm withParam(String name, Map<String, ?> variables, boolean required)
-            throws IllegalArgumentException {
+    public GitLabApiForm withParam(String name, Map<String, ?> variables, boolean required) {
 
         if (variables == null || variables.isEmpty()) {
             if (required) {
                 throw new IllegalArgumentException(name + " cannot be empty or null");
             }
 
-            return (this);
+            return this;
         }
 
         for (Entry<String, ?> variable : variables.entrySet()) {
@@ -172,7 +190,7 @@ public GitLabApiForm withParam(String name, Map<String, ?> variables, boolean re
             }
         }
 
-        return (this);
+        return this;
     }
 
     /**
@@ -185,14 +203,14 @@ public GitLabApiForm withParam(String name, Map<String, ?> variables, boolean re
      * @return this GitLabAPiForm instance
      * @throws IllegalArgumentException if a required parameter is null or empty
      */
-    public GitLabApiForm withParam(String name, Object value, boolean required) throws IllegalArgumentException {
+    public GitLabApiForm withParam(String name, Object value, boolean required) {
 
         if (value == null) {
             if (required) {
                 throw new IllegalArgumentException(name + " cannot be empty or null");
             }
 
-            return (this);
+            return this;
         }
 
         String stringValue = value.toString();
@@ -201,7 +219,7 @@ public GitLabApiForm withParam(String name, Object value, boolean required) thro
         }
 
         this.param(name.trim(), stringValue);
-        return (this);
+        return this;
     }
 
     /**
@@ -213,7 +231,7 @@ public GitLabApiForm withParam(String name, Object value, boolean required) thro
     public GitLabApiForm withParam(List<Variable> variables) {
 
         if (variables == null || variables.isEmpty()) {
-            return (this);
+            return this;
         }
 
         variables.forEach(v -> {
@@ -223,6 +241,6 @@ public GitLabApiForm withParam(List<Variable> variables) {
             }
         });
 
-        return (this);
+        return this;
     }
 }

gitlab4j-api/src/main/java/org/gitlab4j/api/GitLabApiForm.java

@@ -636,7 +636,7 @@ public Optional<Group> getOptionalGroup(Object groupIdOrPath) {
      * @throws GitLabApiException if any exception occurs
      */
     public Group createGroup(GroupParams params) throws GitLabApiException {
-        Response response = post(Response.Status.CREATED, params.getForm(true), "groups");
+        Response response = post(Response.Status.CREATED, new GitLabApiForm(params.getForm(true)), "groups");
         return (response.readEntity(Group.class));
     }
 
@@ -651,8 +651,11 @@ public Group createGroup(GroupParams params) throws GitLabApiException {
      * @throws GitLabApiException at any exception
      */
     public Group updateGroup(Object groupIdOrPath, GroupParams params) throws GitLabApiException {
-        Response response =
-                putWithFormData(Response.Status.OK, params.getForm(false), "groups", getGroupIdOrPath(groupIdOrPath));
+        Response response = putWithFormData(
+                Response.Status.OK,
+                new GitLabApiForm(params.getForm(false)),
+                "groups",
+                getGroupIdOrPath(groupIdOrPath));
         return (response.readEntity(Group.class));
     }
 
@@ -2372,16 +2375,42 @@ public GroupAccessToken getGroupAccessToken(Object groupIdOrPath, Long tokenId)
      * @param accessLevel Access level. Valid values are {@link AccessLevel#GUEST}, {@link AccessLevel#REPORTER}, {@link AccessLevel#DEVELOPER}, {@link AccessLevel#MAINTAINER}, and {@link AccessLevel#OWNER}.
      * @return the created GroupAccessToken instance
      * @throws GitLabApiException if any exception occurs
+     * @deprecated use {@link #createGroupAccessToken(Object, String, String, Date, Scope[], AccessLevel)}
      */
+    @Deprecated
     public GroupAccessToken createGroupAccessToken(
             Object groupIdOrPath, String name, Date expiresAt, Scope[] scopes, AccessLevel accessLevel)
             throws GitLabApiException {
+        return createGroupAccessToken(groupIdOrPath, name, null, expiresAt, scopes, accessLevel);
+    }
+    /**
+     * Create a group access token. You must have the Owner role for the group to create group access tokens.
+     *
+     * <pre><code>GitLab Endpoint: POST /groups/:id/access_tokens</code></pre>
+     *
+     * @param groupIdOrPath the group in the form of an Long(ID), String(path), or Group instance
+     * @param name the name of the group access token, required
+     * @param expiresAt the expiration date of the group access token, optional
+     * @param scopes an array of scopes of the group access token
+     * @param accessLevel Access level. Valid values are {@link AccessLevel#GUEST}, {@link AccessLevel#REPORTER}, {@link AccessLevel#DEVELOPER}, {@link AccessLevel#MAINTAINER}, and {@link AccessLevel#OWNER}.
+     * @return the created GroupAccessToken instance
+     * @throws GitLabApiException if any exception occurs
+     */
+    public GroupAccessToken createGroupAccessToken(
+            Object groupIdOrPath,
+            String name,
+            String description,
+            Date expiresAt,
+            Scope[] scopes,
+            AccessLevel accessLevel)
+            throws GitLabApiException {
         if (scopes == null || scopes.length == 0) {
             throw new RuntimeException("scopes cannot be null or empty");
         }
 
         GitLabApiForm formData = new GitLabApiForm()
                 .withParam("name", name, true)
+                .withParam("description", description)
                 .withParam("scopes", Arrays.asList(scopes))
                 .withParam("expires_at", ISO8601.dateOnly(expiresAt))
                 .withParam("access_level", accessLevel);
@@ -2455,7 +2484,11 @@ public void revokeGroupAccessToken(Object groupIdOrPath, Long tokenId) throws Gi
      */
     public GroupHook addWebhook(Object groupIdOrPath, GroupHookParams groupHookParams) throws GitLabApiException {
         Response response = post(
-                Response.Status.CREATED, groupHookParams.getForm(), "groups", getGroupIdOrPath(groupIdOrPath), "hooks");
+                Response.Status.CREATED,
+                new GitLabApiForm(groupHookParams.getForm()),
+                "groups",
+                getGroupIdOrPath(groupIdOrPath),
+                "hooks");
         return (response.readEntity(GroupHook.class));
     }
 

gitlab4j-api/src/main/java/org/gitlab4j/api/GroupApi.java

@@ -291,6 +291,19 @@ public Stream<Job> getJobsStream(Object projectIdOrPath, long pipelineId, Boolea
         return (getJobsForPipeline(projectIdOrPath, pipelineId, getDefaultPerPage(), includeRetried).stream());
     }
 
+    /**
+     * Retrieve the job corresponding to the <code>$CI_JOB_TOKEN</code> environment variable (Using a {@link org.gitlab4j.models.Constants.TokenType#JOB_TOKEN} authentication).
+     *
+     * <pre><code>GitLab Endpoint: GET /job</code></pre>
+     *
+     * @return a single job
+     * @throws GitLabApiException if any exception occurs during execution
+     */
+    public Job getJob() throws GitLabApiException {
+        Response response = get(Response.Status.OK, null, "job");
+        return (response.readEntity(Job.class));
+    }
+
     /**
      * Get single job in a project.
      *

gitlab4j-api/src/main/java/org/gitlab4j/api/JobApi.java

@@ -455,7 +455,7 @@ public Note getMergeRequestNote(Object projectIdOrPath, Long mergeRequestIid, Lo
      * @throws GitLabApiException if any exception occurs
      */
     public Note createMergeRequestNote(
-            Object projectIdOrPath, Long mergeRequestIid, String body, Date createdAt, boolean internal)
+            Object projectIdOrPath, Long mergeRequestIid, String body, Date createdAt, Boolean internal)
             throws GitLabApiException {
         GitLabApiForm formData =
                 new GitLabApiForm().withParam("body", body, true).withParam("internal", internal);

gitlab4j-api/src/main/java/org/gitlab4j/api/NotesApi.java

@@ -1,7 +1,9 @@
 package org.gitlab4j.api;
 
 import java.util.Date;
+import java.util.List;
 
+import jakarta.ws.rs.core.GenericType;
 import jakarta.ws.rs.core.Response;
 
 import org.gitlab4j.api.models.PersonalAccessToken;
@@ -66,6 +68,20 @@ public PersonalAccessToken rotatePersonalAccessToken(String id, Date expiresAt)
         return (response.readEntity(PersonalAccessToken.class));
     }
 
+    /**
+     * Get information about the personal access token used in the request header.
+     * Only working with GitLab 16.0 and above.
+     *
+     * <pre><code>GitLab Endpoint: GET /personal_access_tokens</code></pre>
+     *
+     * @return the specified PersonalAccessToken.
+     * @throws GitLabApiException if any exception occurs
+     */
+    public List<PersonalAccessToken> getPersonalAccessTokens() throws GitLabApiException {
+        Response response = get(Response.Status.OK, null, "personal_access_tokens");
+        return response.readEntity(new GenericType<List<PersonalAccessToken>>() {});
+    }
+
     /**
      * Get information about the personal access token used in the request header.
      * Only working with GitLab 16.0 and above.