com.synopsys.integration.jira.common.server.service.CustomFieldService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of int-jira-common Show documentation

A library for using various capabilities of Jira.

There is a newer version: 4.1.1

/*
 * int-jira-common
 *
 * Copyright (c) 2024 Synopsys, Inc.
 *
 * Use subject to the terms and conditions of the Synopsys End User Software License and Maintenance Agreement. All rights reserved worldwide.
 */
package com.synopsys.integration.jira.common.server.service;

import com.synopsys.integration.exception.IntegrationException;
import com.synopsys.integration.jira.common.model.request.JiraRequestFactory;
import com.synopsys.integration.jira.common.rest.model.JiraRequest;
import com.synopsys.integration.jira.common.rest.service.JiraApiClient;
import com.synopsys.integration.jira.common.server.model.CustomFieldPageResponseModel;
import com.synopsys.integration.rest.HttpUrl;

// https://docs.atlassian.com/software/jira/docs/api/REST/8.4.0/#api/2/customFields-getCustomFields
public class CustomFieldService {
    public static final String API_PATH = "/rest/api/2/customFields";

    private final JiraApiClient jiraApiClient;

    public CustomFieldService(JiraApiClient jiraApiClient) {
        this.jiraApiClient = jiraApiClient;
    }

    public CustomFieldPageResponseModel getCustomFields() throws IntegrationException {
        JiraRequest request = JiraRequestFactory.createDefaultGetRequest(createApiUri());
        return jiraApiClient.get(request, CustomFieldPageResponseModel.class);
    }

    public CustomFieldPageResponseModel getCustomFields(int startAt, int maxResults, String search) throws IntegrationException {
        JiraRequest.Builder requestBuilder = JiraRequestFactory.createDefaultBuilder()
                                                 .url(createApiUri())
                                                 .addQueryParamIfValueNotBlank("search", search);
        JiraRequest request = JiraRequestFactory.populatePageRequestBuilder(requestBuilder, maxResults, startAt)
                                  .build();
        return jiraApiClient.get(request, CustomFieldPageResponseModel.class);
    }

    private HttpUrl createApiUri() throws IntegrationException {
        return new HttpUrl(jiraApiClient.getBaseUrl() + API_PATH);
    }

}