com.jdroid.github.service

Class RepositoryService

java.lang.Object

com.jdroid.github.service.GitHubService

com.jdroid.github.service.RepositoryService

public class RepositoryService
extends GitHubService

Repository service class.

See Also:

GitHub repository API documentation, GitHub forks API documentation

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_DESCRIPTION FIELD_DESCRIPTION
static java.lang.String	FIELD_HOMEPAGE FIELD_HOMEPAGE
static java.lang.String	FIELD_NAME FIELD_NAME
static java.lang.String	FIELD_PUBLIC FIELD_PUBLIC
static java.lang.String	FILTER_TYPE Type filter key
static java.lang.String	TYPE_ALL All repositories filter type
static java.lang.String	TYPE_MEMBER Member repository filter type
static java.lang.String	TYPE_PRIVATE Private repository filter type
static java.lang.String	TYPE_PUBLIC Public repository filter type

Fields inherited from class com.jdroid.github.service.GitHubService

ACCEPT_FULL, ACCEPT_HTML, ACCEPT_PREVIEW_DRAX, ACCEPT_PREVIEW_IRONMAN, ACCEPT_PREVIEW_LOKI, ACCEPT_RAW, ACCEPT_TEXT, client

Constructor Summary

Constructors

Constructor and Description
RepositoryService() Create repository service
RepositoryService(GitHubClient client) Create repository service

Method Summary

Modifier and Type	Method and Description
RepositoryHook	createHook(IRepositoryIdProvider repository, RepositoryHook hook) Create hook in repository
protected PagedRequest<Repository>	createPagedForkRequest(IRepositoryIdProvider repository, int start, int size) Create paged request for iterating over repositories forks
Repository	createRepository(Repository repository) Create a new repository
Repository	createRepository(java.lang.String organization, Repository repository) Create a new repository
void	deleteHook(IRepositoryIdProvider repository, int hookId) Delete hook from repository
RepositoryHook	editHook(IRepositoryIdProvider repository, RepositoryHook hook) Edit hook in repository
Repository	editRepository(IRepositoryIdProvider provider, java.util.Map<java.lang.String,java.lang.Object> fields) Edit given fields in repository
Repository	editRepository(Repository repository) Edit given repository
Repository	editRepository(java.lang.String owner, java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> fields) Edit given fields in repository
Repository	forkRepository(IRepositoryIdProvider repository) Fork given repository into new repository under the currently authenticated user.
Repository	forkRepository(IRepositoryIdProvider repository, java.lang.String organization) Fork given repository into new repository.
java.util.List<RepositoryBranch>	getBranches(IRepositoryIdProvider repository) Get branches in given repository
java.util.List<Contributor>	getContributors(IRepositoryIdProvider repository, boolean includeAnonymous) Get contributors to repository
java.util.List<Repository>	getForks(IRepositoryIdProvider repository) Get all the forks of the given repository
RepositoryHook	getHook(IRepositoryIdProvider repository, int hookId) Get hook from repository with given id
java.util.List<RepositoryHook>	getHooks(IRepositoryIdProvider repository) Get hooks for given repository
java.util.Map<java.lang.String,java.lang.Long>	getLanguages(IRepositoryIdProvider repository) Get languages used in given repository
java.util.List<Repository>	getOrgRepositories(java.lang.String organization) Get organization repositories for the given organization
java.util.List<Repository>	getOrgRepositories(java.lang.String organization, java.util.Map<java.lang.String,java.lang.String> filterData) Get organization repositories for the given organization
java.util.List<Repository>	getRepositories() Get repositories for the currently authenticated user
java.util.List<Repository>	getRepositories(java.util.Map<java.lang.String,java.lang.String> filterData) Get repositories for the currently authenticated user
java.util.List<Repository>	getRepositories(java.lang.String user) Get repositories for the given user
Repository	getRepository(IRepositoryIdProvider provider) Get repository
Repository	getRepository(java.lang.String owner, java.lang.String name) Get repository
java.util.List<RepositoryTag>	getTags(IRepositoryIdProvider repository) Get tags in given repository
PageIterator<Repository>	pageAllRepositories() Page all repositories
PageIterator<Repository>	pageAllRepositories(long since) Page all repositories
PageIterator<Repository>	pageForks(IRepositoryIdProvider repository) Page forks of given repository
PageIterator<Repository>	pageForks(IRepositoryIdProvider repository, int size) Page forks of given repository
PageIterator<Repository>	pageForks(IRepositoryIdProvider repository, int start, int size) Page forks of given repository
PageIterator<Repository>	pageOrgRepositories(java.lang.String organization) Page repositories for the given organization
PageIterator<Repository>	pageOrgRepositories(java.lang.String organization, int size) Page repositories for the given organization
PageIterator<Repository>	pageOrgRepositories(java.lang.String organization, int start, int size) Page repositories for the given organization
PageIterator<Repository>	pageOrgRepositories(java.lang.String organization, java.util.Map<java.lang.String,java.lang.String> filterData) Page repositories for the given organization
PageIterator<Repository>	pageOrgRepositories(java.lang.String organization, java.util.Map<java.lang.String,java.lang.String> filterData, int size) Page repositories for the given organization
PageIterator<Repository>	pageOrgRepositories(java.lang.String organization, java.util.Map<java.lang.String,java.lang.String> filterData, int start, int size) Page repositories for the given organization
PageIterator<Repository>	pageRepositories() Page repositories for currently authenticated user
PageIterator<Repository>	pageRepositories(int size) Page repositories for currently authenticated user
PageIterator<Repository>	pageRepositories(int start, int size) Page repositories for currently authenticated user
PageIterator<Repository>	pageRepositories(java.util.Map<java.lang.String,java.lang.String> filterData) Page repositories for currently authenticated user
PageIterator<Repository>	pageRepositories(java.util.Map<java.lang.String,java.lang.String> filterData, int size) Page repositories for currently authenticated user
PageIterator<Repository>	pageRepositories(java.util.Map<java.lang.String,java.lang.String> filterData, int start, int size) Page repositories for currently authenticated user
PageIterator<Repository>	pageRepositories(java.lang.String user) Page repositories for given user
PageIterator<Repository>	pageRepositories(java.lang.String user, int size) Page repositories for given user
PageIterator<Repository>	pageRepositories(java.lang.String user, int start, int size) Page repositories for given user
java.util.List<SearchRepository>	searchRepositories(java.util.Map<java.lang.String,java.lang.String> params) Search for repositories matching search parameters.
java.util.List<SearchRepository>	searchRepositories(java.util.Map<java.lang.String,java.lang.String> queryParams, int startPage) Search for repositories matching search parameters.
java.util.List<SearchRepository>	searchRepositories(java.lang.String query) Search for repositories matching query.
java.util.List<SearchRepository>	searchRepositories(java.lang.String query, int startPage) Search for repositories matching query.
java.util.List<SearchRepository>	searchRepositories(java.lang.String query, java.lang.String language) Search for repositories matching language and query.
java.util.List<SearchRepository>	searchRepositories(java.lang.String query, java.lang.String language, int startPage) Search for repositories matching language and query.
void	testHook(IRepositoryIdProvider repository, int hookId) Test hook in repository.

Methods inherited from class com.jdroid.github.service.GitHubService

check, createPagedRequest, createPagedRequest, createPageIterator, createRequest, getAll, getAll, getClient, getId, verifyRepository

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_NAME

public static final java.lang.String FIELD_NAME

FIELD_NAME

See Also:

Constant Field Values

FIELD_DESCRIPTION

public static final java.lang.String FIELD_DESCRIPTION

FIELD_DESCRIPTION

See Also:

Constant Field Values

FIELD_HOMEPAGE

public static final java.lang.String FIELD_HOMEPAGE

FIELD_HOMEPAGE

See Also:

Constant Field Values

FIELD_PUBLIC

public static final java.lang.String FIELD_PUBLIC

FIELD_PUBLIC

See Also:

Constant Field Values

FILTER_TYPE

public static final java.lang.String FILTER_TYPE

Type filter key

See Also:

Constant Field Values

TYPE_PUBLIC

public static final java.lang.String TYPE_PUBLIC

Public repository filter type

See Also:

Constant Field Values

TYPE_PRIVATE

public static final java.lang.String TYPE_PRIVATE

Private repository filter type

See Also:

Constant Field Values

TYPE_MEMBER

public static final java.lang.String TYPE_MEMBER

Member repository filter type

See Also:

Constant Field Values

TYPE_ALL

public static final java.lang.String TYPE_ALL

All repositories filter type

See Also:

Constant Field Values

Constructor Detail

RepositoryService

public RepositoryService()

Create repository service

RepositoryService

public RepositoryService(GitHubClient client)

Create repository service

Parameters:

client - cannot be null

Method Detail

getRepositories

public java.util.List<Repository> getRepositories()
                                           throws java.io.IOException

Get repositories for the currently authenticated user

Returns:

list of repositories

Throws:

java.io.IOException

getRepositories

public java.util.List<Repository> getRepositories(java.util.Map<java.lang.String,java.lang.String> filterData)
                                           throws java.io.IOException

Get repositories for the currently authenticated user

Parameters:

filterData -

Returns:

list of repositories

Throws:

java.io.IOException

pageRepositories

public PageIterator<Repository> pageRepositories()

Page repositories for currently authenticated user

Returns:

iterator over pages of repositories

pageRepositories

public PageIterator<Repository> pageRepositories(int size)

Page repositories for currently authenticated user

Parameters:

size -

Returns:

iterator over pages of repositories

pageRepositories

public PageIterator<Repository> pageRepositories(int start,
                                                 int size)

Page repositories for currently authenticated user

Parameters:

start -

size -

Returns:

iterator over pages of repositories

pageRepositories

public PageIterator<Repository> pageRepositories(java.util.Map<java.lang.String,java.lang.String> filterData)

Page repositories for currently authenticated user

Parameters:

filterData -

Returns:

iterator over pages of repositories

pageRepositories

public PageIterator<Repository> pageRepositories(java.util.Map<java.lang.String,java.lang.String> filterData,
                                                 int size)

Page repositories for currently authenticated user

Parameters:

filterData -

size -

Returns:

iterator over pages of repositories

pageRepositories

public PageIterator<Repository> pageRepositories(java.util.Map<java.lang.String,java.lang.String> filterData,
                                                 int start,
                                                 int size)

Page repositories for currently authenticated user

Parameters:

filterData -

start -

size -

Returns:

iterator over pages of repositories

pageAllRepositories

public PageIterator<Repository> pageAllRepositories()

Page all repositories

Returns:

iterator over pages of repositories

pageAllRepositories

public PageIterator<Repository> pageAllRepositories(long since)

Page all repositories

Parameters:

since -

Returns:

iterator over pages of repositories

getRepositories

public java.util.List<Repository> getRepositories(java.lang.String user)
                                           throws java.io.IOException

Get repositories for the given user

Parameters:

user -

Returns:

list of repositories

Throws:

java.io.IOException

pageRepositories

public PageIterator<Repository> pageRepositories(java.lang.String user)

Page repositories for given user

Parameters:

user -

Returns:

iterator over pages of repositories

pageRepositories

public PageIterator<Repository> pageRepositories(java.lang.String user,
                                                 int size)

Page repositories for given user

Parameters:

user -

size -

Returns:

iterator over pages of repositories

pageRepositories

public PageIterator<Repository> pageRepositories(java.lang.String user,
                                                 int start,
                                                 int size)

Page repositories for given user

Parameters:

user -

start -

size -

Returns:

iterator over repository page

getOrgRepositories

public java.util.List<Repository> getOrgRepositories(java.lang.String organization)
                                              throws java.io.IOException

Get organization repositories for the given organization

Parameters:

organization -

Returns:

list of repositories

Throws:

java.io.IOException

pageOrgRepositories

public PageIterator<Repository> pageOrgRepositories(java.lang.String organization)

Page repositories for the given organization

Parameters:

organization -

Returns:

iterator over pages of repositories

pageOrgRepositories

public PageIterator<Repository> pageOrgRepositories(java.lang.String organization,
                                                    int size)

Page repositories for the given organization

Parameters:

organization -

size -

Returns:

iterator over pages of repositories

pageOrgRepositories

public PageIterator<Repository> pageOrgRepositories(java.lang.String organization,
                                                    int start,
                                                    int size)

Page repositories for the given organization

Parameters:

organization -

start -

size -

Returns:

iterator over pages of repositories

getOrgRepositories

public java.util.List<Repository> getOrgRepositories(java.lang.String organization,
                                                     java.util.Map<java.lang.String,java.lang.String> filterData)
                                              throws java.io.IOException

Get organization repositories for the given organization

Parameters:

organization -

filterData -

Returns:

list of repositories

Throws:

java.io.IOException

pageOrgRepositories

public PageIterator<Repository> pageOrgRepositories(java.lang.String organization,
                                                    java.util.Map<java.lang.String,java.lang.String> filterData)

Page repositories for the given organization

Parameters:

organization -

filterData -

Returns:

iterator over pages of repositories

pageOrgRepositories

public PageIterator<Repository> pageOrgRepositories(java.lang.String organization,
                                                    java.util.Map<java.lang.String,java.lang.String> filterData,
                                                    int size)

Page repositories for the given organization

Parameters:

organization -

filterData -

size -

Returns:

iterator over pages of repositories

pageOrgRepositories

public PageIterator<Repository> pageOrgRepositories(java.lang.String organization,
                                                    java.util.Map<java.lang.String,java.lang.String> filterData,
                                                    int start,
                                                    int size)

Page repositories for the given organization

Parameters:

organization -

filterData -

start -

size -

Returns:

iterator over pages of repositories

searchRepositories

public java.util.List<SearchRepository> searchRepositories(java.lang.String query)
                                                    throws java.io.IOException

Search for repositories matching query.

Parameters:

query -

Returns:

list of repositories

Throws:

java.io.IOException

searchRepositories

public java.util.List<SearchRepository> searchRepositories(java.lang.String query,
                                                           int startPage)
                                                    throws java.io.IOException

Search for repositories matching query.

Parameters:

query -

startPage -

Returns:

list of repositories

Throws:

java.io.IOException

searchRepositories

public java.util.List<SearchRepository> searchRepositories(java.lang.String query,
                                                           java.lang.String language)
                                                    throws java.io.IOException

Search for repositories matching language and query.

Parameters:

query -

language -

Returns:

list of repositories

Throws:

java.io.IOException

searchRepositories

public java.util.List<SearchRepository> searchRepositories(java.lang.String query,
                                                           java.lang.String language,
                                                           int startPage)
                                                    throws java.io.IOException

Search for repositories matching language and query.

Parameters:

query -

language -

startPage -

Returns:

list of repositories

Throws:

java.io.IOException

searchRepositories

public java.util.List<SearchRepository> searchRepositories(java.util.Map<java.lang.String,java.lang.String> params)
                                                    throws java.io.IOException

Search for repositories matching search parameters.

Parameters:

params -

Returns:

list of repositories

Throws:

java.io.IOException

searchRepositories

public java.util.List<SearchRepository> searchRepositories(java.util.Map<java.lang.String,java.lang.String> queryParams,
                                                           int startPage)
                                                    throws java.io.IOException

Search for repositories matching search parameters.

Parameters:

queryParams -

startPage -

Returns:

list of repositories

Throws:

java.io.IOException

createRepository

public Repository createRepository(Repository repository)
                            throws java.io.IOException

Create a new repository

Parameters:

repository -

Returns:

created repository

Throws:

java.io.IOException

createRepository

public Repository createRepository(java.lang.String organization,
                                   Repository repository)
                            throws java.io.IOException

Create a new repository

Parameters:

organization -

repository -

Returns:

created repository

Throws:

java.io.IOException

getRepository

public Repository getRepository(java.lang.String owner,
                                java.lang.String name)
                         throws java.io.IOException

Get repository

Parameters:

owner -

name -

Returns:

repository

Throws:

java.io.IOException

getRepository

public Repository getRepository(IRepositoryIdProvider provider)
                         throws java.io.IOException

Get repository

Parameters:

provider -

Returns:

repository

Throws:

java.io.IOException

createPagedForkRequest

protected PagedRequest<Repository> createPagedForkRequest(IRepositoryIdProvider repository,
                                                          int start,
                                                          int size)

Create paged request for iterating over repositories forks

Parameters:

repository -

start -

size -

Returns:

paged request

getForks

public java.util.List<Repository> getForks(IRepositoryIdProvider repository)
                                    throws java.io.IOException

Get all the forks of the given repository

Parameters:

repository -

Returns:

non-null but possibly empty list of repository

Throws:

java.io.IOException

pageForks

public PageIterator<Repository> pageForks(IRepositoryIdProvider repository)

Page forks of given repository

Parameters:

repository -

Returns:

iterator over repositories

pageForks

public PageIterator<Repository> pageForks(IRepositoryIdProvider repository,
                                          int size)

Page forks of given repository

Parameters:

repository -

size -

Returns:

iterator over repositories

pageForks

public PageIterator<Repository> pageForks(IRepositoryIdProvider repository,
                                          int start,
                                          int size)

Page forks of given repository

Parameters:

repository -

start -

size -

Returns:

iterator over repositories

editRepository

public Repository editRepository(Repository repository)
                          throws java.io.IOException

Edit given repository

Parameters:

repository -

Returns:

edited repository

Throws:

java.io.IOException

editRepository

public Repository editRepository(java.lang.String owner,
                                 java.lang.String name,
                                 java.util.Map<java.lang.String,java.lang.Object> fields)
                          throws java.io.IOException

Edit given fields in repository

Only values in the given fields map will be updated on the repository

Parameters:

owner -

name -

fields -

Returns:

edited repository

Throws:

java.io.IOException

editRepository

public Repository editRepository(IRepositoryIdProvider provider,
                                 java.util.Map<java.lang.String,java.lang.Object> fields)
                          throws java.io.IOException

Edit given fields in repository

Only values in the given fields map will be updated on the repository

Parameters:

provider -

fields -

Returns:

edited repository

Throws:

java.io.IOException

forkRepository

public Repository forkRepository(IRepositoryIdProvider repository)
                          throws java.io.IOException

Fork given repository into new repository under the currently authenticated user.

Parameters:

repository -

Returns:

forked repository

Throws:

java.io.IOException

forkRepository

public Repository forkRepository(IRepositoryIdProvider repository,
                                 java.lang.String organization)
                          throws java.io.IOException

Fork given repository into new repository. The new repository will be under the given organization if non-null, else it will be under the currently authenticated user.

Parameters:

repository -

organization -

Returns:

forked repository

Throws:

java.io.IOException

getLanguages

public java.util.Map<java.lang.String,java.lang.Long> getLanguages(IRepositoryIdProvider repository)
                                                            throws java.io.IOException

Get languages used in given repository

Parameters:

repository -

Returns:

map of language names mapped to line counts

Throws:

java.io.IOException

getBranches

public java.util.List<RepositoryBranch> getBranches(IRepositoryIdProvider repository)
                                             throws java.io.IOException

Get branches in given repository

Parameters:

repository -

Returns:

list of branches

Throws:

java.io.IOException

getTags

public java.util.List<RepositoryTag> getTags(IRepositoryIdProvider repository)
                                      throws java.io.IOException

Get tags in given repository

Parameters:

repository -

Returns:

list of tags

Throws:

java.io.IOException

getContributors

public java.util.List<Contributor> getContributors(IRepositoryIdProvider repository,
                                                   boolean includeAnonymous)
                                            throws java.io.IOException

Get contributors to repository

Parameters:

repository -

includeAnonymous -

Returns:

list of contributors

Throws:

java.io.IOException

getHooks

public java.util.List<RepositoryHook> getHooks(IRepositoryIdProvider repository)
                                        throws java.io.IOException

Get hooks for given repository

Parameters:

repository -

Returns:

list of hooks

Throws:

java.io.IOException

getHook

public RepositoryHook getHook(IRepositoryIdProvider repository,
                              int hookId)
                       throws java.io.IOException

Get hook from repository with given id

Parameters:

repository -

hookId -

Returns:

repository hook

Throws:

java.io.IOException

createHook

public RepositoryHook createHook(IRepositoryIdProvider repository,
                                 RepositoryHook hook)
                          throws java.io.IOException

Create hook in repository

Parameters:

repository -

hook -

Returns:

created repository hook

Throws:

java.io.IOException

editHook

public RepositoryHook editHook(IRepositoryIdProvider repository,
                               RepositoryHook hook)
                        throws java.io.IOException

Edit hook in repository

Parameters:

repository -

hook -

Returns:

edited hook

Throws:

java.io.IOException

deleteHook

public void deleteHook(IRepositoryIdProvider repository,
                       int hookId)
                throws java.io.IOException

Delete hook from repository

Parameters:

repository -

hookId -

Throws:

java.io.IOException

testHook

public void testHook(IRepositoryIdProvider repository,
                     int hookId)
              throws java.io.IOException

Test hook in repository. This will trigger the hook to run for the latest push to the repository.

Parameters:

repository -

hookId -

Throws:

java.io.IOException