org.jboss.set.aphrodite.repository.services.github

Class GitHubRepositoryService

java.lang.Object

org.jboss.set.aphrodite.repository.services.common.AbstractRepositoryService

org.jboss.set.aphrodite.repository.services.github.GitHubRepositoryService

All Implemented Interfaces:

RepositoryService

public class GitHubRepositoryService
extends AbstractRepositoryService

Author:

Ryan Emerson

Field Summary

Fields inherited from class org.jboss.set.aphrodite.repository.services.common.AbstractRepositoryService

baseUrl, config, REPOSITORY_TYPE

Constructor Summary

Constructors

Constructor and Description
GitHubRepositoryService()

Method Summary

Modifier and Type	Method and Description
void	addCommentToPatch(Patch patch, String comment) Add a Comment to the specified Patch object, and propagate the changes to the remote repository.
void	addLabelToPatch(Patch patch, String labelName) Attach a label to the specified patch.
List<Patch>	findPatchesRelatedTo(Patch patch) Find all the patches related to the given patch.
CommitStatus	getCommitStatusFromPatch(Patch patch) Retrieve the current CI status of the latest commit associated with a given patch.
List<Label>	getLabelsFromPatch(Patch patch) Retrieve all labels associated with the provided Patch object.
List<Label>	getLabelsFromRepository(Repository repository) Retrieve all labels associated with the provided Patch in Repository object.
protected org.apache.commons.logging.Log	getLog()
Patch	getPatch(URL url) Get the Patch located at the provided URL.
List<Patch>	getPatchesAssociatedWith(Issue issue) Retrieve all Patches associated with the provided Issue object
List<Patch>	getPatchesByState(Repository repository, PatchState state) Retrieve all Patches associated with the provided Repository object, which have a state that matches the provided PatchState object.
Repository	getRepository(URL url) Get the repository located at the provided URL.
boolean	hasModifiableLabels(Repository repository) Discover if the user logged into this RepositoryService has the correct permissions to apply/remove labels to patches in the provided Repository
boolean	init(RepositoryConfig config) Initiate this RepositoryService using the supplied RepositoryConfig.
void	removeLabelFromPatch(Patch patch, String name) Delete a label from the provided Patch object.
boolean	repositoryAccessable(URL url) Checks whether the provided URL is accessable.
void	setLabelsToPatch(Patch patch, List<Label> labels) Set the labels for the provided Patch object.

Methods inherited from class org.jboss.set.aphrodite.repository.services.common.AbstractRepositoryService

checkHost, init, urlExists

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.set.aphrodite.spi.RepositoryService

destroy

Constructor Detail

GitHubRepositoryService

public GitHubRepositoryService()

Method Detail

getLog

protected org.apache.commons.logging.Log getLog()

Specified by:

getLog in class AbstractRepositoryService

init

public boolean init(RepositoryConfig config)

Description copied from interface: RepositoryService

Initiate this RepositoryService using the supplied RepositoryConfig.

Specified by:

init in interface RepositoryService

Overrides:

init in class AbstractRepositoryService

Parameters:

config - a RepositoryConfig object containing all configuration information.

Returns:

true if the service was initialised without errors, false otherwise.

getPatch

public Patch getPatch(URL url)
               throws NotFoundException

Description copied from interface: RepositoryService

Get the Patch located at the provided URL.

Specified by:

getPatch in interface RepositoryService

Overrides:

getPatch in class AbstractRepositoryService

Parameters:

url - the URL of the patch to be retrieved.

Returns:

the Patch object.

Throws:

NotFoundException - if a Patch cannot be found at the provided base url.

getRepository

public Repository getRepository(URL url)
                         throws NotFoundException

Description copied from interface: RepositoryService

Get the repository located at the provided URL.

Specified by:

getRepository in interface RepositoryService

Overrides:

getRepository in class AbstractRepositoryService

Parameters:

url - the URL of the repository to be retrieved.

Returns:

the Repository object.

Throws:

NotFoundException - if a Repository cannot be found at the provided base url.

getPatchesAssociatedWith

public List<Patch> getPatchesAssociatedWith(Issue issue)
                                     throws NotFoundException

Description copied from interface: RepositoryService

Retrieve all Patches associated with the provided Issue object

Specified by:

getPatchesAssociatedWith in interface RepositoryService

Overrides:

getPatchesAssociatedWith in class AbstractRepositoryService

Parameters:

issue - the Issue object whose associated Patches should be returned.

Returns:

a list of all Patch objects, or an empty list if no patches can be found.

Throws:

NotFoundException - if an exception is thrown when searching the RepositoryService.

getPatchesByState

public List<Patch> getPatchesByState(Repository repository,
                                     PatchState state)
                              throws NotFoundException

Description copied from interface: RepositoryService

Retrieve all Patches associated with the provided Repository object, which have a state that matches the provided PatchState object.

Specified by:

getPatchesByState in interface RepositoryService

Overrides:

getPatchesByState in class AbstractRepositoryService

Parameters:

repository - the Repository object whose associated Patches should be returned.

state - the PatchState which the returned Patch objects must have.

Returns:

a list of all matching Patch objects, or an empty list if no patches can be found.

Throws:

NotFoundException - if the provided Repository cannot be found at the RepositoryService.

addCommentToPatch

public void addCommentToPatch(Patch patch,
                              String comment)
                       throws NotFoundException

Description copied from interface: RepositoryService

Add a Comment to the specified Patch object, and propagate the changes to the remote repository.

Specified by:

addCommentToPatch in interface RepositoryService

Overrides:

addCommentToPatch in class AbstractRepositoryService

Parameters:

patch - the Patch on which the comment will be made.

comment - the new Comment.

Throws:

NotFoundException - if the Patch cannot be found at the remote repository.

hasModifiableLabels

public boolean hasModifiableLabels(Repository repository)
                            throws NotFoundException

Description copied from interface: RepositoryService

Discover if the user logged into this RepositoryService has the correct permissions to apply/remove labels to patches in the provided Repository

Parameters:

repository - the Repository whose permissions are to be checked

Returns:

true if the user has permission, otherwise false.

Throws:

NotFoundException - if the specified Repository cannot be found.

addLabelToPatch

public void addLabelToPatch(Patch patch,
                            String labelName)
                     throws NotFoundException

Description copied from interface: RepositoryService

Attach a label to the specified patch. Note the label must already exist at remote repository, otherwise a NotFoundException will be thrown. If the specified label is already associated with the provided patch then no further action is taken.

Parameters:

patch - the Patch to which the label will be applied.

labelName - the name of the label to be applied.

Throws:

NotFoundException - if the specified labelName has not been defined at the remote repository.

getLabelsFromRepository

public List<Label> getLabelsFromRepository(Repository repository)
                                    throws NotFoundException

Description copied from interface: RepositoryService

Retrieve all labels associated with the provided Patch in Repository object.

Parameters:

repository - the Repository object whose associated labels should be returned.

Returns:

a list of all matching Label objects, or an empty list if no label can be found.

Throws:

NotFoundException - if the provided Repository url not consistent with the baseURL.

getLabelsFromPatch

public List<Label> getLabelsFromPatch(Patch patch)
                               throws NotFoundException

Description copied from interface: RepositoryService

Retrieve all labels associated with the provided Patch object.

Parameters:

patch - the Patch object whose associated labels should be returned.

Returns:

a list of all matching Label objects, or an empty list if no patches can be found.

Throws:

NotFoundException - if the provided Patch url not consistent with the baseURL.

setLabelsToPatch

public void setLabelsToPatch(Patch patch,
                             List<Label> labels)
                      throws NotFoundException

Description copied from interface: RepositoryService

Set the labels for the provided Patch object.

Parameters:

patch - the Patch object whose will be set.

labels - the Label apply to the Patch

Throws:

NotFoundException - if the Label can not be found in the provided Patch

removeLabelFromPatch

public void removeLabelFromPatch(Patch patch,
                                 String name)
                          throws NotFoundException

Description copied from interface: RepositoryService

Delete a label from the provided Patch object.

Parameters:

patch - the Patch whose label will be removed.

name - the Label name will be removed.

Throws:

NotFoundException - if the Label name can not be found in the provided Patch

findPatchesRelatedTo

public List<Patch> findPatchesRelatedTo(Patch patch)

Description copied from interface: RepositoryService

Find all the patches related to the given patch.

Parameters:

patch - the Patch on which patches related are being searched

Returns:

list of patches related.

getCommitStatusFromPatch

public CommitStatus getCommitStatusFromPatch(Patch patch)
                                      throws NotFoundException

Description copied from interface: RepositoryService

Retrieve the current CI status of the latest commit associated with a given patch.

Parameters:

patch - the Patch object whose status is to be queried

Returns:

the CI status of the latest commit associated with the given patch

Throws:

NotFoundException - if no commit status can be found for the provided patch

repositoryAccessable

public boolean repositoryAccessable(URL url)

Description copied from interface: RepositoryService

Checks whether the provided URL is accessable.

Parameters:

url - the URL to check.

Returns:

true if the provided URL is accessable, otherwise false.