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

java.lang.Object
  org.eclipse.egit.github.core.service.GitHubService
      org.eclipse.egit.github.core.service.DeployKeyService

public class DeployKeyService
extends GitHubService

Service for interacting with a repository's deploy keys

See Also:

GitHub deploy key API documentation

Field Summary

Fields inherited from class org.eclipse.egit.github.core.service.GitHubService

client

Constructor Summary

DeployKeyService()
Create deploy key service

DeployKeyService(GitHubClient client)
Create deploy key service

Method Summary

Key	createKey(IRepositoryIdProvider repository, Key key) Create deploy key to be associated with given repository
void	deleteKey(IRepositoryIdProvider repository, int id) Deploy deploy key with given id from given repository
Key	editKey(IRepositoryIdProvider repository, Key key) Edit given deploy key
Key	getKey(IRepositoryIdProvider repository, int id) Get deploy key with given id from given repository
List<Key>	getKeys(IRepositoryIdProvider repository) Get all deploys keys associated with the given 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

Constructor Detail

DeployKeyService

public DeployKeyService()

Create deploy key service

DeployKeyService

public DeployKeyService(GitHubClient client)

Create deploy key service

Parameters:

client -

Method Detail

getKeys

public List<Key> getKeys(IRepositoryIdProvider repository)
                  throws IOException

Get all deploys keys associated with the given repository

Parameters:

repository -

Returns:

non-null but possibly empty list of deploy keys

Throws:

IOException

getKey

public Key getKey(IRepositoryIdProvider repository,
                  int id)
           throws IOException

Get deploy key with given id from given repository

Parameters:

repository -

id -

Returns:

deploy key

Throws:

IOException

createKey

public Key createKey(IRepositoryIdProvider repository,
                     Key key)
              throws IOException

Create deploy key to be associated with given repository

Parameters:

repository -

key -

Returns:

created deploy key

Throws:

IOException

editKey

public Key editKey(IRepositoryIdProvider repository,
                   Key key)
            throws IOException

Edit given deploy key

Parameters:

repository -

key -

Returns:

edited deploy key

Throws:

IOException

deleteKey

public void deleteKey(IRepositoryIdProvider repository,
                      int id)
               throws IOException

Deploy deploy key with given id from given repository

Parameters:

repository -

id -

Throws:

IOException