org.gitlab4j.api.ApplicationSettingsApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gitlab4j-api Show documentation
GitLab4J-API (gitlab4j-api) provides a full featured Java client library for working with GitLab repositories and servers via the GitLab REST API.
The newest version!
package org.gitlab4j.api;

import java.text.ParseException;
import java.util.Iterator;

import jakarta.ws.rs.core.Response;

import org.gitlab4j.api.models.ApplicationSettings;
import org.gitlab4j.api.models.Setting;
import org.gitlab4j.models.utils.ISO8601;

import com.fasterxml.jackson.databind.JsonNode;

/**
 * This class implements the client side API for the GitLab Application Settings API.
 * See Application Settings API at GitLab for more information.
 */
public class ApplicationSettingsApi extends AbstractApi {

    public ApplicationSettingsApi(GitLabApi gitLabApi) {
        super(gitLabApi);
    }

    /**
     * Get the current application settings of the GitLab instance.
     *
     * GitLab Endpoint: GET /api/v4/application/settings
     *
     * @return an ApplicationSettings instance containing the current application settings of the GitLab instance.
     * @throws GitLabApiException if any exception occurs
     */
    public ApplicationSettings getApplicationSettings() throws GitLabApiException {

        Response response = get(Response.Status.OK, null, "application", "settings");
        JsonNode root = response.readEntity(JsonNode.class);
        return (parseApplicationSettings(root));
    }

    /**
     * Update the application settings of the GitLab instance with the settings in the
     * provided ApplicationSettings instance.
     *
     * GitLab Endpoint: PUT /api/v4/application/settings
     *
     * @param appSettings the ApplicationSettings instance holding the settings and values to update
     * @return the updated application settings in an ApplicationSettings instance
     * @throws GitLabApiException if any exception occurs
     */
    public ApplicationSettings updateApplicationSettings(ApplicationSettings appSettings) throws GitLabApiException {

        if (appSettings == null || appSettings.getSettings().isEmpty()) {
            throw new GitLabApiException("ApplicationSettings cannot be null or empty.");
        }

        final GitLabApiForm form = new GitLabApiForm();
        appSettings.getSettings().forEach((s, v) -> form.withParam(s, v));
        Response response = put(Response.Status.OK, form.asMap(), "application", "settings");
        JsonNode root = response.readEntity(JsonNode.class);
        return (parseApplicationSettings(root));
    }

    /**
     * Update a single application setting of the GitLab instance with the provided settings and value.
     *
     * GitLab Endpoint: PUT /api/v4/application/settings
     *
     * @param setting the ApplicationSetting to update
     * @param value the new value for the application setting
     * @return the updated application settings in an ApplicationSettings instance
     * @throws GitLabApiException if any exception occurs
     */
    public ApplicationSettings updateApplicationSetting(Setting setting, Object value) throws GitLabApiException {

        if (setting == null) {
            throw new GitLabApiException("setting cannot be null.");
        }

        return (updateApplicationSetting(setting.toString(), value));
    }

    /**
     * Update a single application setting of the GitLab instance with the provided settings and value.
     *
     * GitLab Endpoint: PUT /api/v4/application/settings
     *
     * @param setting the ApplicationSetting to update
     * @param value the new value for the application setting
     * @return the updated application settings in an ApplicationSettings instance
     * @throws GitLabApiException if any exception occurs
     */
    public ApplicationSettings updateApplicationSetting(String setting, Object value) throws GitLabApiException {

        if (setting == null || setting.trim().isEmpty()) {
            throw new GitLabApiException("setting cannot be null or empty.");
        }

        GitLabApiForm form = new GitLabApiForm().withParam(setting, value);
        Response response = put(Response.Status.OK, form.asMap(), "application", "settings");
        JsonNode root = response.readEntity(JsonNode.class);
        return (parseApplicationSettings(root));
    }

    /**
     * Parses the returned JSON and returns an ApplicationSettings instance.
     *
     * @param root the root JsonNode
     * @return the populated ApplicationSettings instance
     * @throws GitLabApiException if any error occurs
     */
    public static final ApplicationSettings parseApplicationSettings(JsonNode root) throws GitLabApiException {

        ApplicationSettings appSettings = new ApplicationSettings();

        Iterator fieldNames = root.fieldNames();
        while (fieldNames.hasNext()) {

            String fieldName = fieldNames.next();
            switch (fieldName) {
                case "id":
                    appSettings.setId(root.path(fieldName).asLong());
                    break;

                case "created_at":
                    try {
                        String value = root.path(fieldName).asText();
                        appSettings.setCreatedAt(ISO8601.toDate(value));
                    } catch (ParseException pe) {
                        throw new GitLabApiException(pe);
                    }
                    break;

                case "updated_at":
                    try {
                        String value = root.path(fieldName).asText();
                        appSettings.setUpdatedAt(ISO8601.toDate(value));
                    } catch (ParseException pe) {
                        throw new GitLabApiException(pe);
                    }
                    break;

                default:
                    Setting setting = Setting.forValue(fieldName);
                    if (setting != null) {
                        appSettings.addSetting(setting, root.path(fieldName));
                    } else {
                        GitLabApi.getLogger()
                                .warning(String.format(
                                        "Unknown setting: %s, type: %s",
                                        fieldName,
                                        root.path(fieldName).getClass().getSimpleName()));
                        appSettings.addSetting(fieldName, root.path(fieldName));
                    }

                    break;
            }
        }

        return (appSettings);
    }
}