org.gitlab4j.api

Class ApplicationsApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.ApplicationsApi

All Implemented Interfaces:

Constants

public class ApplicationsApi
extends AbstractApi

This class implements the client side API for the GitLab Applications API. See Applications API at GitLab for more information.

Nested Class Summary

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

Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.CommitBuildState, Constants.Encoding, Constants.EpicOrderBy, Constants.GroupOrderBy, Constants.GroupSearchScope, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestState, Constants.MilestoneState, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, 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 and Description
ApplicationsApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method and Description
Application	createApplication(String name, String redirectUri, Constants.ApplicationScope[] scopes) Create an OAUTH Application.
Application	createApplication(String name, String redirectUri, List<Constants.ApplicationScope> scopes) Create an OAUTH Application.
void	deleteApplication(Integer applicationId) Delete the specified OAUTH Application.
List<Application>	getApplications() Get all OATH applications.
Pager<Application>	getApplications(int itemsPerPage) Get a Pager of all OAUTH applications.
List<Application>	getApplications(int page, int perPage) Get all OAUTH applications using the specified page and per page setting
Stream<Application>	getApplicationsStream() Get a Stream of all OAUTH Application instances.

Methods inherited from class org.gitlab4j.api.AbstractApi

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationsApi

public ApplicationsApi(GitLabApi gitLabApi)

Method Detail

getApplications

public List<Application> getApplications()
                                  throws GitLabApiException

Get all OATH applications.

GitLab Endpoint: GET /api/v4/applications

Returns:

a List of OAUTH Application instances

Throws:

GitLabApiException - if any exception occurs

getApplications

public List<Application> getApplications(int page,
                                         int perPage)
                                  throws GitLabApiException

Get all OAUTH applications using the specified page and per page setting

GitLab Endpoint: GET /api/v4/applications

Parameters:

page - the page to get

perPage - the number of items per page

Returns:

a list of OAUTH Applications in the specified range

Throws:

GitLabApiException - if any exception occurs

getApplications

public Pager<Application> getApplications(int itemsPerPage)
                                   throws GitLabApiException

Get a Pager of all OAUTH applications.

GitLab Endpoint: GET /api/v4/applications

Parameters:

itemsPerPage - the number of items per page

Returns:

a Pager of Application instances in the specified range

Throws:

GitLabApiException - if any exception occurs

getApplicationsStream

public Stream<Application> getApplicationsStream()
                                          throws GitLabApiException

Get a Stream of all OAUTH Application instances.

GitLab Endpoint: GET /api/v4/applications

Returns:

a Stream of OAUTH Application instances

Throws:

GitLabApiException - if any exception occurs

createApplication

public Application createApplication(String name,
                                     String redirectUri,
                                     Constants.ApplicationScope[] scopes)
                              throws GitLabApiException

Create an OAUTH Application.

GitLab Endpoint: POST /api/v4/applications

Parameters:

name - the name for the OAUTH Application

redirectUri - the redirect URI for the OAUTH Application

scopes - the scopes of the application (api, read_user, sudo, read_repository, openid, profile, email)

Returns:

the created Application instance

Throws:

GitLabApiException - if any exception occurs

createApplication

public Application createApplication(String name,
                                     String redirectUri,
                                     List<Constants.ApplicationScope> scopes)
                              throws GitLabApiException

Create an OAUTH Application.

GitLab Endpoint: POST /api/v4/applications

Parameters:

name - the name for the OAUTH Application

redirectUri - the redirect URI for the OAUTH Application

scopes - the scopes of the application (api, read_user, sudo, read_repository, openid, profile, email)

Returns:

the created Application instance

Throws:

GitLabApiException - if any exception occurs

deleteApplication

public void deleteApplication(Integer applicationId)
                       throws GitLabApiException

Delete the specified OAUTH Application.

GitLab Endpoint: DELETE /api/v4/applications/:applicationId

Parameters:

applicationId - the ID of the OUAUTH Application to delete

Throws:

GitLabApiException - if any exception occurs