com.aliction.gitproviders.bitbucket.client.BitbucketV2API Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bitbucket-client Show documentation
Java Implementation to Bitbucket REST API
There is a newer version: 0.2.1
package com.aliction.gitproviders.bitbucket.client;

import java.util.Map;

import javax.ws.rs.client.Entity;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.aliction.gitproviders.bitbucket.resources.CommitAPI;
import com.aliction.gitproviders.bitbucket.resources.RepositoryAPI;
import com.aliction.gitproviders.bitbucket.resources.TeamAPI;
import com.aliction.gitproviders.bitbucket.resources.UserAPI;

/**
 * This class is the main entry to all V2 Resources and APIs
 * @author Aly Ibrahim
 * Date: Oct 23, 2019
 *
 */
public class BitbucketV2API {

    private static final Logger LOGGER = LoggerFactory.getLogger(BitbucketV2API.class);

    private String username;
    private String token;
    private String hostURL;
    private static final String API_VERSION = "2.0";

    private BitbucketCloudClient client;

    private RepositoryAPI repositoryAPI;
    private UserAPI userAPI;
    private TeamAPI teamAPI;
    private CommitAPI commitAPI;
    private WebTarget apiRootContext;
    private int maxPageReturned = 5;

    /**
     * This is the constructor for creating V2 API instance to connect to all other APIs
     * @param hostURL - URL for bitbucket server
     * @param username - Username
     * @param token - API Token generated by Bitbucket
     */
    public BitbucketV2API(final String hostURL, final String username, final String token) {
        this.hostURL = hostURL.endsWith("/") ? hostURL.replaceAll("/$", "") : hostURL;
        this.username = username;
        this.token = token;
        this.client = getClient();
        this.apiRootContext = this.client.createRootContext(API_VERSION, this.username, this.token);
    }

    /**
     * The method build a client and returns it
     * @return client
     */
    private BitbucketCloudClient getClient() {
        if (client == null) {
            client = new BitbucketCloudClient().Build(hostURL);
        }
        return this.client;
    }

    /**
     * The method is used to configure the API for max number of pages returned 
     * The default is 5 pages, and increasing this value will affect the performance and response time
     * @param numberOfPages - The global max number of pages returned by the all the API calls
     */
    public void setMaxPagesReturned(int numberOfPages) {
        this.maxPageReturned = numberOfPages;
    }

    /**
     * The method is used to show the current configuration of maximum number of pages to be returned
     * @return the global max number of pages returned by the all the API calls
     */
    public int getMaxPagesReturned() {
        return this.maxPageReturned;
    }

    /**
     * This is the base Create request
     * @param requestURL - The relative resource URL
     * @param urlValues - URL template values
     * @param object - Entity object
     * @return response - Returns server response object
     */
    public Response Create(final String requestURL, final Map urlValues, final Object object) {
        WebTarget requestTartget = apiRootContext.path(requestURL);
        Response response = requestTartget.request(MediaType.APPLICATION_JSON).post(Entity.entity(object, MediaType.APPLICATION_JSON));
        return response;
    }

    /**
     * This is the base Get request
     * @param requestURL - The relative resource URL
     * @param urlValues - URL template values
     * @param params - URL parameters
     * @return response - Returns server response object
     */
    public Response Get(final String requestURL, final Map urlValues, final Map params) {
        WebTarget requestTarget = apiRootContext.path(requestURL);
        if (urlValues != null) {
            requestTarget = requestTarget.resolveTemplates(urlValues);
        }
        if(params != null) {
            for (Map.Entry queryParam : params.entrySet())
                requestTarget = requestTarget.queryParam(queryParam.getKey(), queryParam.getValue());
        }
        Response response = requestTarget.request(MediaType.APPLICATION_JSON).get();
        return response;
    }

    /**
     * This is the base Delete request
     * @param requestURL - The relative resource URL
     * @param urlValues - URL template values
     * @param object - Entity object
     * @return response - Returns server response object
     */
    public Response Delete(String requestURL, final Map urlValues, Object object) {
        WebTarget requestTartget;
        requestTartget = apiRootContext.path(requestURL);
        Response response = requestTartget.request(MediaType.APPLICATION_JSON).delete();
        return response;
    }

    /**
     * Creates or Gets RepositoryAPI object
     * @return - Repository API object
     */
    public RepositoryAPI RepositoryAPI() {
        if (repositoryAPI == null) {
            repositoryAPI = new RepositoryAPI(this);
        }
        return repositoryAPI;
    }

    /**
     * Creates or Gets UserAPI object
     * @return - User API object
     */
    public UserAPI UserAPI() {
        if (userAPI == null) {
            userAPI = new UserAPI(this);
        }
        return userAPI;
    }

    /**
     * Creates or Gets TeamAPI object
     * @return - Team API object
     */
    public TeamAPI TeamAPI() {
        if (teamAPI == null) {
            teamAPI = new TeamAPI(this);
        }
        return teamAPI;
    }

    /**
     * Creates or Gets CommitsAPI object
     * @return - Commit API object
     */
    public CommitAPI CommitAPI() {
        if (commitAPI == null) {
            commitAPI = new CommitAPI(this);
        }
        return commitAPI;
    }

    /**
     * The method is used to disconnect and close client connnections
     */
    public void disconnect() {
        this.client.disconnect();
    }
}