Package org.gitlab4j.api

Class LicenseApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.LicenseApi

All Implemented Interfaces:

Constants

public class LicenseApi
extends AbstractApi

This class provides an entry point to all the GitLab API license calls.

See Also:

• License API

Nested Class Summary

Nested classes/interfaces inherited from interface org.gitlab4j.api.Constants

Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.AutoDevopsDeployStrategy, Constants.BuildGitStrategy, Constants.CommitBuildState, Constants.ContributorOrderBy, Constants.DeploymentOrderBy, Constants.DeploymentStatus, Constants.DeployTokenScope, Constants.Encoding, Constants.EpicOrderBy, Constants.EventScope, Constants.GroupOrderBy, Constants.GroupSearchScope, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestSearchIn, Constants.MergeRequestState, Constants.MilestoneState, Constants.PackageOrderBy, Constants.PackageStatus, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, Constants.SquashOption, Constants.StateEvent, Constants.TagOrderBy, Constants.TargetType, Constants.TodoAction, Constants.TodoState, Constants.TodoType, Constants.TokenType

Field Summary

Fields inherited from class org.gitlab4j.api.AbstractApi

gitLabApi

Fields inherited from interface org.gitlab4j.api.Constants

NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER

Constructor Summary

Constructors

Constructor	Description
LicenseApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
License	addLicense(String licenseString)	Add a new license.
License	deleteLicense(Long licenseId)	Deletes a license.
List<License>	getAllLicenses()	Retrieve information about all licenses.
Pager<License>	getAllLicenses(int itemsPerPage)	Get a Pager of all licenses.
Stream<License>	getAllLicensesStream()	Get a Stream of all licenses.
License	getLicense()	Retrieve information about the current license.
Optional<License>	getOptionalLicense()	Retrieve information about the current license as the value of an Optional.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getLabelIdOrName, getPageQueryParams, getPageQueryParams, getPerPageQueryParam, getProjectIdOrPath, getUserIdOrUsername, getWithAccepts, handle, head, isApiVersion, patch, patch, post, post, post, post, post, put, put, put, putUpload, putUpload, putWithFormData, upload, upload, upload, upload, urlEncode, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LicenseApi

public LicenseApi(GitLabApi gitLabApi)

Method Details

getLicense

public License getLicense()
                   throws GitLabApiException

Retrieve information about the current license.

GitLab Endpoint: GET /license

Returns:

a License instance holding info about the current license

Throws:

GitLabApiException - if any exception occurs

getOptionalLicense

public Optional<License> getOptionalLicense()

Retrieve information about the current license as the value of an Optional.

GitLab Endpoint: GET /license

Returns:

the current license as the value of an Optional.

getAllLicenses

public List<License> getAllLicenses()
                             throws GitLabApiException

Retrieve information about all licenses.

GitLab Endpoint: GET /licenses

Returns:

a List of License instances

Throws:

GitLabApiException - if any exception occurs

getAllLicensesStream

public Stream<License> getAllLicensesStream()
                                     throws GitLabApiException

Get a Stream of all licenses.

GitLab Endpoint: GET /licenses

Returns:

a Stream of License instances

Throws:

GitLabApiException - if any exception occurs

getAllLicenses

public Pager<License> getAllLicenses(int itemsPerPage)
                              throws GitLabApiException

Get a Pager of all licenses.

GitLab Endpoint: GET /licenses

Parameters:

itemsPerPage - the number of LicenseTemplate instances that will be fetched per page

Returns:

a Pager of license template

Throws:

GitLabApiException - if any exception occurs

addLicense

public License addLicense(String licenseString)
                   throws GitLabApiException

Add a new license.

GitLab Endpoint: POST /license

Parameters:

licenseString - the license string for the license

Returns:

a License instance for the added license

Throws:

GitLabApiException - if any exception occurs

deleteLicense

public License deleteLicense(Long licenseId)
                      throws GitLabApiException

Deletes a license.

GitLab Endpoint: DELETE /license/:id

Parameters:

licenseId - the ID of the license to delete

Returns:

a License instance for the delete license

Throws:

GitLabApiException - if any exception occurs