Package io.meeds.github.gamification.services

Interface GithubConsumerService

All Known Implementing Classes:

GithubConsumerServiceImpl

public interface GithubConsumerService

Method Summary

Modifier and Type	Method	Description
TokenStatus	checkGitHubTokenStatus(String accessToken)	Check gitHub personal access token
WebHook	createWebhook(String organizationName, String[] triggers, String accessToken)	create github organization hook.
String	deleteWebhook(WebHook webHook)	delete gitHub webhook
String	forceUpdateWebhook(WebHook webHook)	Force Update Webhook
List<RemoteRepository>	retrieveOrganizationRepos(WebHook webHook, int page, int perPage, String keyword)	Retrieve available github organization repositories.
RemoteOrganization	retrieveRemoteOrganization(long organizationRemoteId, String accessToken)	Retrieve available github organization info.
RemoteOrganization	retrieveRemoteOrganization(String organizationName, String accessToken)	Retrieve available github organization info.

Method Details

createWebhook

WebHook createWebhook(String organizationName,
 String[] triggers,
 String accessToken)
               throws IllegalAccessException

create github organization hook.

Parameters:

organizationName - github organization name

accessToken - gitHub personal access token

Throws:

IllegalAccessException - when user is not authorized to create github webhook

deleteWebhook

String deleteWebhook(WebHook webHook)

delete gitHub webhook

Parameters:

webHook - github webHook

retrieveRemoteOrganization

RemoteOrganization retrieveRemoteOrganization(long organizationRemoteId,
 String accessToken)

Retrieve available github organization info.

Parameters:

organizationRemoteId - gitHub organization remote Id

accessToken - gitHub personal access token

Returns:

RemoteOrganization

retrieveRemoteOrganization

RemoteOrganization retrieveRemoteOrganization(String organizationName,
 String accessToken)
                                       throws org.exoplatform.commons.exception.ObjectNotFoundException

Retrieve available github organization info.

Parameters:

organizationName - gitHub organization name

accessToken - gitHub personal access token

Returns:

RemoteOrganization

Throws:

org.exoplatform.commons.exception.ObjectNotFoundException - when the github organization identified by its technical name is not found

retrieveOrganizationRepos

List<RemoteRepository> retrieveOrganizationRepos(WebHook webHook,
 int page,
 int perPage,
 String keyword)

Retrieve available github organization repositories.

Parameters:

webHook - webHook

page - page

perPage - perPage

keyword - to search in repositories title

Returns:

List of RemoteRepository

forceUpdateWebhook

String forceUpdateWebhook(WebHook webHook)

Force Update Webhook

Parameters:

webHook - webHook

Returns:

response status

checkGitHubTokenStatus

TokenStatus checkGitHubTokenStatus(String accessToken)

Check gitHub personal access token

Parameters:

accessToken - gitHub personal access token

Returns:

TokenStatus