org.eclipse.egit.github.core.service
Class RepositoryService

java.lang.Object
  extended by org.eclipse.egit.github.core.service.GitHubService
      extended by org.eclipse.egit.github.core.service.RepositoryService

public class RepositoryService
extends GitHubService

Repository service class.

See Also:
GitHub repository API documentation, GitHub forks API documentation

Field Summary
static String FIELD_DESCRIPTION
          FIELD_DESCRIPTION
static String FIELD_HOMEPAGE
          FIELD_HOMEPAGE
static String FIELD_NAME
          FIELD_NAME
static String FIELD_PUBLIC
          FIELD_PUBLIC
static String FILTER_TYPE
          Type filter key
static String TYPE_ALL
          All repositories filter type
static String TYPE_MEMBER
          Member repository filter type
static String TYPE_PRIVATE
          Private repository filter type
static String TYPE_PUBLIC
          Public repository filter type
 
Fields inherited from class org.eclipse.egit.github.core.service.GitHubService
ACCEPT_FULL, ACCEPT_HTML, ACCEPT_TEXT, client
 
Constructor Summary
RepositoryService()
          Create repository service
RepositoryService(GitHubClient client)
          Create repository service
 
Method Summary
 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(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, Map<String,Object> fields)
          Edit given fields in repository
 Repository editRepository(Repository repository)
          Edit given repository
 Repository editRepository(String owner, String name, Map<String,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, String organization)
          Fork given repository into new repository.
 List<RepositoryBranch> getBranches(IRepositoryIdProvider repository)
          Get branches in given repository
 List<Contributor> getContributors(IRepositoryIdProvider repository, boolean includeAnonymous)
          Get contributors to repository
 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
 List<RepositoryHook> getHooks(IRepositoryIdProvider repository)
          Get hooks for given repository
 Map<String,Long> getLanguages(IRepositoryIdProvider repository)
          Get languages used in given repository
 List<Repository> getOrgRepositories(String organization)
          Get organization repositories for the given organization
 List<Repository> getOrgRepositories(String organization, Map<String,String> filterData)
          Get organization repositories for the given organization
 List<Repository> getRepositories()
          Get repositories for the currently authenticated user
 List<Repository> getRepositories(Map<String,String> filterData)
          Get repositories for the currently authenticated user
 List<Repository> getRepositories(String user)
          Get repositories for the given user
 Repository getRepository(IRepositoryIdProvider provider)
          Get repository
 Repository getRepository(String owner, String name)
          Get repository
 List<RepositoryTag> getTags(IRepositoryIdProvider repository)
          Get tags in given repository
 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(String organization)
          Page repositories for the given organization
 PageIterator<Repository> pageOrgRepositories(String organization, int size)
          Page repositories for the given organization
 PageIterator<Repository> pageOrgRepositories(String organization, int start, int size)
          Page repositories for the given organization
 PageIterator<Repository> pageOrgRepositories(String organization, Map<String,String> filterData)
          Page repositories for the given organization
 PageIterator<Repository> pageOrgRepositories(String organization, Map<String,String> filterData, int size)
          Page repositories for the given organization
 PageIterator<Repository> pageOrgRepositories(String organization, Map<String,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(Map<String,String> filterData)
          Page repositories for currently authenticated user
 PageIterator<Repository> pageRepositories(Map<String,String> filterData, int size)
          Page repositories for currently authenticated user
 PageIterator<Repository> pageRepositories(Map<String,String> filterData, int start, int size)
          Page repositories for currently authenticated user
 PageIterator<Repository> pageRepositories(String user)
          Page repositories for given user
 PageIterator<Repository> pageRepositories(String user, int size)
          Page repositories for given user
 PageIterator<Repository> pageRepositories(String user, int start, int size)
          Page repositories for given user
 List<SearchRepository> searchRepositories(Map<String,String> params)
          Search for repositories matching search parameters.
 List<SearchRepository> searchRepositories(Map<String,String> queryParams, int startPage)
          Search for repositories matching search parameters.
 List<SearchRepository> searchRepositories(String query)
          Search for repositories matching query.
 List<SearchRepository> searchRepositories(String query, int startPage)
          Search for repositories matching query.
 List<SearchRepository> searchRepositories(String query, String language)
          Search for repositories matching language and query.
 List<SearchRepository> searchRepositories(String query, 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 org.eclipse.egit.github.core.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 String FIELD_NAME
FIELD_NAME

See Also:
Constant Field Values

FIELD_DESCRIPTION

public static final String FIELD_DESCRIPTION
FIELD_DESCRIPTION

See Also:
Constant Field Values

FIELD_HOMEPAGE

public static final String FIELD_HOMEPAGE
FIELD_HOMEPAGE

See Also:
Constant Field Values

FIELD_PUBLIC

public static final String FIELD_PUBLIC
FIELD_PUBLIC

See Also:
Constant Field Values

FILTER_TYPE

public static final String FILTER_TYPE
Type filter key

See Also:
Constant Field Values

TYPE_PUBLIC

public static final String TYPE_PUBLIC
Public repository filter type

See Also:
Constant Field Values

TYPE_PRIVATE

public static final String TYPE_PRIVATE
Private repository filter type

See Also:
Constant Field Values

TYPE_MEMBER

public static final String TYPE_MEMBER
Member repository filter type

See Also:
Constant Field Values

TYPE_ALL

public static final 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 List<Repository> getRepositories()
                                 throws IOException
Get repositories for the currently authenticated user

Returns:
list of repositories
Throws:
IOException

getRepositories

public List<Repository> getRepositories(Map<String,String> filterData)
                                 throws IOException
Get repositories for the currently authenticated user

Parameters:
filterData -
Returns:
list of repositories
Throws:
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(Map<String,String> filterData)
Page repositories for currently authenticated user

Parameters:
filterData -
Returns:
iterator over pages of repositories

pageRepositories

public PageIterator<Repository> pageRepositories(Map<String,String> filterData,
                                                 int size)
Page repositories for currently authenticated user

Parameters:
filterData -
size -
Returns:
iterator over pages of repositories

pageRepositories

public PageIterator<Repository> pageRepositories(Map<String,String> filterData,
                                                 int start,
                                                 int size)
Page repositories for currently authenticated user

Parameters:
filterData -
start -
size -
Returns:
iterator over pages of repositories

getRepositories

public List<Repository> getRepositories(String user)
                                 throws IOException
Get repositories for the given user

Parameters:
user -
Returns:
list of repositories
Throws:
IOException

pageRepositories

public PageIterator<Repository> pageRepositories(String user)
Page repositories for given user

Parameters:
user -
Returns:
iterator over pages of repositories

pageRepositories

public PageIterator<Repository> pageRepositories(String user,
                                                 int size)
Page repositories for given user

Parameters:
user -
size -
Returns:
iterator over pages of repositories

pageRepositories

public PageIterator<Repository> pageRepositories(String user,
                                                 int start,
                                                 int size)
Page repositories for given user

Parameters:
user -
start -
size -
Returns:
iterator over repository page

getOrgRepositories

public List<Repository> getOrgRepositories(String organization)
                                    throws IOException
Get organization repositories for the given organization

Parameters:
organization -
Returns:
list of repositories
Throws:
IOException

pageOrgRepositories

public PageIterator<Repository> pageOrgRepositories(String organization)
Page repositories for the given organization

Parameters:
organization -
Returns:
iterator over pages of repositories

pageOrgRepositories

public PageIterator<Repository> pageOrgRepositories(String organization,
                                                    int size)
Page repositories for the given organization

Parameters:
organization -
size -
Returns:
iterator over pages of repositories

pageOrgRepositories

public PageIterator<Repository> pageOrgRepositories(String organization,
                                                    int start,
                                                    int size)
Page repositories for the given organization

Parameters:
organization -
start -
size -
Returns:
iterator over pages of repositories

getOrgRepositories

public List<Repository> getOrgRepositories(String organization,
                                           Map<String,String> filterData)
                                    throws IOException
Get organization repositories for the given organization

Parameters:
organization -
filterData -
Returns:
list of repositories
Throws:
IOException

pageOrgRepositories

public PageIterator<Repository> pageOrgRepositories(String organization,
                                                    Map<String,String> filterData)
Page repositories for the given organization

Parameters:
organization -
filterData -
Returns:
iterator over pages of repositories

pageOrgRepositories

public PageIterator<Repository> pageOrgRepositories(String organization,
                                                    Map<String,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(String organization,
                                                    Map<String,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 List<SearchRepository> searchRepositories(String query)
                                          throws IOException
Search for repositories matching query.

Parameters:
query -
Returns:
list of repositories
Throws:
IOException

searchRepositories

public List<SearchRepository> searchRepositories(String query,
                                                 int startPage)
                                          throws IOException
Search for repositories matching query.

Parameters:
query -
startPage -
Returns:
list of repositories
Throws:
IOException

searchRepositories

public List<SearchRepository> searchRepositories(String query,
                                                 String language)
                                          throws IOException
Search for repositories matching language and query.

Parameters:
query -
language -
Returns:
list of repositories
Throws:
IOException

searchRepositories

public List<SearchRepository> searchRepositories(String query,
                                                 String language,
                                                 int startPage)
                                          throws IOException
Search for repositories matching language and query.

Parameters:
query -
language -
startPage -
Returns:
list of repositories
Throws:
IOException

searchRepositories

public List<SearchRepository> searchRepositories(Map<String,String> params)
                                          throws IOException
Search for repositories matching search parameters.

Parameters:
params -
Returns:
list of repositories
Throws:
IOException

searchRepositories

public List<SearchRepository> searchRepositories(Map<String,String> queryParams,
                                                 int startPage)
                                          throws IOException
Search for repositories matching search parameters.

Parameters:
queryParams -
startPage -
Returns:
list of repositories
Throws:
IOException

createRepository

public Repository createRepository(Repository repository)
                            throws IOException
Create a new repository

Parameters:
repository -
Returns:
created repository
Throws:
IOException

createRepository

public Repository createRepository(String organization,
                                   Repository repository)
                            throws IOException
Create a new repository

Parameters:
organization -
repository -
Returns:
created repository
Throws:
IOException

getRepository

public Repository getRepository(String owner,
                                String name)
                         throws IOException
Get repository

Parameters:
owner -
name -
Returns:
repository
Throws:
IOException

getRepository

public Repository getRepository(IRepositoryIdProvider provider)
                         throws IOException
Get repository

Parameters:
provider -
Returns:
repository
Throws:
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 List<Repository> getForks(IRepositoryIdProvider repository)
                          throws IOException
Get all the forks of the given repository

Parameters:
repository -
Returns:
non-null but possibly empty list of repository
Throws:
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 IOException
Edit given repository

Parameters:
repository -
Returns:
edited repository
Throws:
IOException

editRepository

public Repository editRepository(String owner,
                                 String name,
                                 Map<String,Object> fields)
                          throws 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:
IOException

editRepository

public Repository editRepository(IRepositoryIdProvider provider,
                                 Map<String,Object> fields)
                          throws 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:
IOException

forkRepository

public Repository forkRepository(IRepositoryIdProvider repository)
                          throws IOException
Fork given repository into new repository under the currently authenticated user.

Parameters:
repository -
Returns:
forked repository
Throws:
IOException

forkRepository

public Repository forkRepository(IRepositoryIdProvider repository,
                                 String organization)
                          throws 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:
IOException

getLanguages

public Map<String,Long> getLanguages(IRepositoryIdProvider repository)
                              throws IOException
Get languages used in given repository

Parameters:
repository -
Returns:
map of language names mapped to line counts
Throws:
IOException

getBranches

public List<RepositoryBranch> getBranches(IRepositoryIdProvider repository)
                                   throws IOException
Get branches in given repository

Parameters:
repository -
Returns:
list of branches
Throws:
IOException

getTags

public List<RepositoryTag> getTags(IRepositoryIdProvider repository)
                            throws IOException
Get tags in given repository

Parameters:
repository -
Returns:
list of tags
Throws:
IOException

getContributors

public List<Contributor> getContributors(IRepositoryIdProvider repository,
                                         boolean includeAnonymous)
                                  throws IOException
Get contributors to repository

Parameters:
repository -
includeAnonymous -
Returns:
list of contributors
Throws:
IOException

getHooks

public List<RepositoryHook> getHooks(IRepositoryIdProvider repository)
                              throws IOException
Get hooks for given repository

Parameters:
repository -
Returns:
list of hooks
Throws:
IOException

getHook

public RepositoryHook getHook(IRepositoryIdProvider repository,
                              int hookId)
                       throws IOException
Get hook from repository with given id

Parameters:
repository -
hookId -
Returns:
repository hook
Throws:
IOException

createHook

public RepositoryHook createHook(IRepositoryIdProvider repository,
                                 RepositoryHook hook)
                          throws IOException
Create hook in repository

Parameters:
repository -
hook -
Returns:
created repository hook
Throws:
IOException

editHook

public RepositoryHook editHook(IRepositoryIdProvider repository,
                               RepositoryHook hook)
                        throws IOException
Edit hook in repository

Parameters:
repository -
hook -
Returns:
edited hook
Throws:
IOException

deleteHook

public void deleteHook(IRepositoryIdProvider repository,
                       int hookId)
                throws IOException
Delete hook from repository

Parameters:
repository -
hookId -
Throws:
IOException

testHook

public void testHook(IRepositoryIdProvider repository,
                     int hookId)
              throws IOException
Test hook in repository. This will trigger the hook to run for the latest push to the repository.

Parameters:
repository -
hookId -
Throws:
IOException


Copyright © 2012. All Rights Reserved.