com.jdroid.github.service

Class DeployKeyService

java.lang.Object

com.jdroid.github.service.GitHubService

com.jdroid.github.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 com.jdroid.github.service.GitHubService

ACCEPT_FULL, ACCEPT_HTML, ACCEPT_RAW, ACCEPT_TEXT, client

Constructor Summary

Constructors

Constructor and Description
DeployKeyService() Create deploy key service
DeployKeyService(GitHubClient client) Create deploy key service

Method Summary

Modifier and Type	Method and Description
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
java.util.List<Key>	getKeys(IRepositoryIdProvider repository) Get all deploys keys associated with the given 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

Constructor Detail

DeployKeyService

public DeployKeyService()

Create deploy key service

DeployKeyService

public DeployKeyService(GitHubClient client)

Create deploy key service

Parameters:

client -

Method Detail

getKeys

public java.util.List<Key> getKeys(IRepositoryIdProvider repository)
                            throws java.io.IOException

Get all deploys keys associated with the given repository

Parameters:

repository -

Returns:

non-null but possibly empty list of deploy keys

Throws:

java.io.IOException

getKey

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

Get deploy key with given id from given repository

Parameters:

repository -

id -

Returns:

deploy key

Throws:

java.io.IOException

createKey

public Key createKey(IRepositoryIdProvider repository,
                     Key key)
              throws java.io.IOException

Create deploy key to be associated with given repository

Parameters:

repository -

key -

Returns:

created deploy key

Throws:

java.io.IOException

editKey

public Key editKey(IRepositoryIdProvider repository,
                   Key key)
            throws java.io.IOException

Edit given deploy key

Parameters:

repository -

key -

Returns:

edited deploy key

Throws:

java.io.IOException

deleteKey

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

Deploy deploy key with given id from given repository

Parameters:

repository -

id -

Throws:

java.io.IOException