From 4374414031490ca3b4bd338596227222a22768db Mon Sep 17 00:00:00 2001 From: Greg Messner Date: Fri, 3 May 2019 19:34:02 -0700 Subject: [PATCH] Updated title. --- README.md | 931 +++++++++++++++++++++++++++--------------------------- 1 file changed, 465 insertions(+), 466 deletions(-) diff --git a/README.md b/README.md index ca7adc70..a2bfada0 100644 --- a/README.md +++ b/README.md @@ -1,466 +1,465 @@ -GitlLab API for Java (gitlab4j-api) -=================================== -[![Maven Central](https://img.shields.io/maven-central/v/org.gitlab4j/gitlab4j-api.svg)](http://mvnrepository.com/artifact/org.gitlab4j/gitlab4j-api) - -GitLab API for Java (gitlab4j-api) provides a full featured and easy to consume Java API for working with GitLab repositories via the GitLab REST API. Additionally, full support for working with GitLab webhooks and system hooks is also provided. - ---- - -To utilize the GitLab API for Java in your 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: '4.10.9' -} -``` - -**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 - 4.10.9 - -``` - -**Ivy and SBT**
-There have been reports of problems resolving some dependencies when using Ivy or SBT, for help resolving those issues see:
-JAX-RS API Issue #571
-JAX-RS API Issue #572 - ---- - -## Javadocs -Javadocs are available here: Javadocs - ---- - -## Java 8 Requirement -As of GitLab4J-API 4.8.0, Java 8+ is now required to use GitLab4J-API. - ---- - -## Using GitLab4J - -GitLab4J-API is quite simple to use, all you need is the URL to your GitLab server and the Private Token from your GitLab Account Settings page. Once you have that info it is as simple as: -```java -// Create a GitLabApi instance to communicate with your GitLab server -GitLabApi gitLabApi = new GitLabApi("http://your.gitlab.server.com", "YOUR_PRIVATE_TOKEN"); - -// Get the list of projects your account has access to -List projects = gitLabApi.getProjectApi().getProjects(); -``` - -You can also login to your GitLab server with username, and password: -```java -// Log in to the GitLab server using a username and password -GitLabApi gitLabApi = GitLabApi.login("http://your.gitlab.server.com", "your-username", "your-password"); -``` -As of GitLab4J-API 4.6.6, all API requests support performing the API call as if you were another user, provided you are authenticated as an administrator: -```java -// Create a GitLabApi instance to communicate with your GitLab server (must be an administrator) -GitLabApi gitLabApi = new GitLabApi("http://your.gitlab.server.com", "YOUR_PRIVATE_TOKEN"); - -// sudo as as a different user, in this case the user named "johndoe", all future calls will be done as "johndoe" -gitLabApi.sudo("johndoe") - -// To turn off sudo mode -gitLabApi.unsudo(); -``` - ---- -## Connecting Through a Proxy Server -As of GitLab4J-API 4.8.2 support has been added for connecting to the GitLab server using an HTTP proxy server: -```java -// Log in to the GitLab server using a proxy server (with basic auth on proxy) -Map proxyConfig = ProxyClientConfig.createProxyClientConfig( - "http://your-proxy-server", "proxy-username", "proxy-password"); -GitLabApi gitLabApi = new GitLabApi("http://your.gitlab.com", "YOUR_PRIVATE_TOKEN", null, proxyConfig); - -// Log in to the GitLab server using a proxy server (no auth on proxy) -Map proxyConfig = ProxyClientConfig.createProxyClientConfig("http://your-proxy-server"); -GitLabApi gitLabApi = new GitLabApi("http://your.gitlab.com", "YOUR_PRIVATE_TOKEN", null, proxyConfig); -``` -See the Javadoc on the GitLabApi class for a complete list of methods accepting the proxy configuration (clientConfiguration parameter) - ---- -## GitLab API V3 and V4 Support -As of GitLab4J-API 4.2.0 support has been added for GitLab API V4. If your application requires GitLab API V3, -you can still use GitLab4J-API by creating your GitLabApi instance as follows: -```java -// Create a GitLabApi instance to communicate with your GitLab server using GitLab API V3 -GitLabApi gitLabApi = new GitLabApi(ApiVersion.V3, "http://your.gitlab.server.com", "YOUR_PRIVATE_TOKEN"); -``` - -**NOTICE**: -As of GitLab 11.0 support for the GitLab API v3 has been removed (see https://about.gitlab.com/2018/06/01/api-v3-removal-impending/). Support for GitLab API v3 will be removed from this library in January 2019. If you are utilizing the v3 support, please update your code before January 2019. - - ---- -## Logging of API Requests and Responses -As of GitLab4J-API 4.8.39 support has been added to log the requests to and the responses from the -GitLab API. Enable logging using one of the following methods on the GitLabApi instance: -```java -GitLabApi gitLabApi = new GitLabApi("http://your.gitlab.server.com", "YOUR_PRIVATE_TOKEN"); - -// Log using the shared logger and default level of FINE -gitLabApi.enableRequestResponseLogging(); - -// Log using the shared logger and the INFO level -gitLabApi.enableRequestResponseLogging(java.util.logging.Level.INFO); - -// Log using the specified logger and the INFO level -gitLabApi.enableRequestResponseLogging(youtLoggerInstance, java.util.logging.Level.INFO); - -// Log using the shared logger, at the INFO level, and include up to 1024 bytes of entity logging -gitLabApi.enableRequestResponseLogging(java.util.logging.Level.INFO, 1024); - -// Log using the specified logger, at the INFO level, and up to 1024 bytes of entity logging -gitLabApi.enableRequestResponseLogging(youtLoggerInstance, java.util.logging.Level.INFO, 1024); -``` - ---- -## Results Paging -GitLab4J-API provides an easy to use paging mechanism to page through lists of results from the GitLab API. -Here are a couple of examples on how to use the Pager: -```java -// Get a Pager instance that will page through the projects with 10 projects per page -Pager projectPager = gitlabApi.getProjectsApi().getProjects(10); - -// Iterate through the pages and print out the name and description -while (projectsPager.hasNext())) { - for (Project project : projectPager.next()) { - System.out.println(project.getName() + " -: " + project.getDescription()); - } -} -``` - -As of GitLab4J-API 4.9.2, you can also fetch all the items as a single list using a Pager instance: -```java -// Get a Pager instance so we can load all the projects into a single list, 10 items at a time: -Pager projectPager = gitlabApi.getProjectsApi().getProjects(10); -List allProjects = projectPager.all(); -``` - ---- -## Java 8 Stream Support -As of GitLab4J-API 4.9.2, all GitLabJ-API methods that return a List result have a similarlly named method that returns a Java 8 Stream. The Stream returning methods use the following naming convention: ```getXxxxxStream()```. - - -**IMPORTANT** -The built-in methods that return a Stream do so using ___eager evaluation___, meaning all items are pre-fetched from the GitLab server and a Stream is returned which will stream those items. **Eager evaluation does NOT support paralell reading of data from ther server, it does however allow for paralell processing of the Stream post data fetch.** - -To stream using ___lazy evaluation___, use the GitLab4J-API methods that return a ```Pager``` instance, and then call the ```lazyStream()``` method on the ```Pager``` instance to create a lazy evaluation Stream. The Stream utilizes the ```Pager``` instance to page through the available items. **A lazy Stream does NOT support parallel operations or skipping.** - - -**Eager evaluation example usage:** - -```java -// Stream the visible projects printing out the project name. -Stream projectStream = gitlabApi.getProjectApi().getProjectsStream(); -projectStream.map(Project::getName).forEach(name -> System.out.println(name)); - -// Operate on the stream in parallel, this example sorts User instances by username -// NOTE: Fetching of the users is not done in paralell, -// only the sorting of the users is a paralell operation. -Stream stream = gitlabApi.getUserApi().getUsersStream(); -List users = stream.parallel().sorted(comparing(User::getUsername)).collect(toList()); -``` - -**Lazy evaluation example usage:** - -```java -// Get a Pager instance to that will be used to lazily stream Project instances. -// In this example, 10 Projects per page will be pre-fetched. -Pager projectPager = gitlabApi.getProjectApi().getProjects(10); - -// Lazily stream the Projects, printing out each project name, limit the output to 5 project names -projectPager.lazyStream().limit(5).map(Project::getName).forEach(name -> System.out.println(name)); -``` - - ---- -## Java 8 Optional<T> Support -GitLab4J-API supports Java 8 Optional<T> for API calls that result in the return of a single item. Here is an example on how to use the Java 8 Optional<T> API calls: -```java -Optional optionalGroup = gitlabApi.getGroupApi().getGroup("my-group-path"); -if (optionalGroup.isPresent()) - return optionalGroup.get(); - -return gitlabApi.getGroupApi().addGroup("my-group-name", "my-group-path"); -``` - ---- -## Issue Time Estimates -GitLab issues allow for time tracking. The following time units are currently available: - -* months (mo) -* weeks (w) -* days (d) -* hours (h) -* minutes (m) - -Conversion rates are 1mo = 4w, 1w = 5d and 1d = 8h. - ---- -## Making API Calls -The API has been broken up into sub API classes to make it easier to consume and to separate concerns. The GitLab4J sub API classes typically have a one-to-one relationship with the API documentation at [GitLab API](https://docs.gitlab.com/ce/api/). Following is a sample of the GitLab4J sub API class mapping to the GitLab API documentation: - -```org.gitlab4j.api.GroupApi``` -> https://docs.gitlab.com/ce/api/groups.html
-```org.gitlab4j.api.MergeRequestApi``` -> https://docs.gitlab.com/ce/api/merge_requests.html
-```org.gitlab4j.api.ProjectApi``` -> https://docs.gitlab.com/ce/api/projects.html
-```org.gitlab4j.api.UserApi``` -> https://docs.gitlab.com/ce/api/users.html
- -The following is a list of the available sub APIs along with a sample use of each API. See the Javadocs for a complete list of available methods for each sub API. - -### Available Sub APIs ------------------- -  [AwardEmojiApi](#awardemojiapi)
-  [BoardsApi](#boardsapi)
-  [CommitsApi](#commitsapi)
-  [DeployKeysApi](#deploykeysapi)
-  [DiscussionsApi](#discussionsapi)
-  [EpicsApi](#epicsapi)
-  [EventsApi](#eventsapi)
-  [GroupApi](#groupapi)
-  [HealthCheckApi](#healthcheckapi)
-  [IssuesApi](#issuesapi)
-  [JobApi](#jobapi)
-  [LabelsApi](#labelsapi)
-  [MergeRequestApi](#mergerequestapi)
-  [MilestonesApi](#milestonesapi)
-  [NamespaceApi](#namespaceapi)
-  [NotesApi](#notesapi)
-  [NotificationSettingsApi](#notificationsettingsapi)
-  [PackagesApi](#packagesapi)
-  [PipelineApi](#pipelineapi)
-  [ProjectApi](#projectapi)
-  [ProtectedBranchesApi](#protectedbranchesapi)
-  [RepositoryApi](#repositoryapi)
-  [RepositoryFileApi](#repositoryfileapi)
-  [RunnersApi](#runnersapi)
-  [ServicesApi](#servicesapi)
-  [SessionApi](#sessionapi)
-  [SnippetsApi](#snippetsapi)
-  [SystemHooksApi](#systemhooksapi)
-  [UserApi](#userapi)
-  [WikisApi](#wikisapi) - - -### Sub API Examples ----------------- - -#### AwardEmojiApi -```java -// Get a list of AwardEmoji belonging to the specified issue (group ID = 1, issues IID = 1) -List awardEmojis = gitLabApi.getAwardEmojiApi().getIssuAwardEmojis(1, 1); -``` - -#### BoardsApi -```java -// Get a list of the Issue Boards belonging to the specified project -List boards = gitLabApi.getBoardsApi().getBoards(projectId); -``` - -#### CommitsApi -```java -// Get a list of commits associated with the specified branch that fall within the specified time window -// This uses the ISO8601 date utilities the in org.gitlab4j.api.utils.ISO8601 class -Date since = ISO8601.toDate("2017-01-01T00:00:00Z"); -Date until = new Date(); // now -List commits = gitLabApi.getCommitsApi().getCommits(1234, "new-feature", since, until); -``` - -#### DeployKeysApi -```java -// Get a list of DeployKeys for the authenticated user -List deployKeys = gitLabApi.getDeployKeysApi().getDeployKeys(); -``` - -#### DiscussionsApi -```java -// Get a list of Discussions for the specified merge request -List deployKeys = gitLabApi.getDiscussionsApi().getMergeRequestDiscussions(projectId, mergeRequestIid); -``` - -#### EpicsApi -```java -// Get a list epics of the requested group and its subgroups. -List epics = gitLabApi.getEpicsApi().getEpics(1); -``` - -#### EventsApi -```java -// Get a list of Events for the authenticated user -Date after = new Date(0); // After Epoch -Date before = new Date(); // Before now -List events = gitLabApi.getEventsApi().getAuthenticatedUserEvents(null, null, before, after, DESC); -``` - -#### GroupApi -```java -// Get a list of groups that you have access to -List groups = gitLabApi.getGroupApi().getGroups(); -``` - -#### HealthCheckApi -```java -// Get the liveness endpoint health check results. Assumes ip_whitelisted per: -// https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html -HealthCheckInfo healthCheck = gitLabApi.getHealthCheckApi().getLiveness(); -``` - -#### IssuesApi -```java -// Get a list of issues for the specified project ID -List issues = gitLabApi.getIssuesApi().getIssues(1234); -``` - -#### JobApi -```java -// Get a list of jobs for the specified project ID -List jobs = gitLabApi.getJobApi().getJobs(1234); -``` - -#### LabelsApi -```java -// Get a list of labels for the specified project ID -List