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.
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>	getPatchesByStatus(Repository repository, PatchStatus status) Retrieve all Patches associated with the provided Repository object, which have a status that matches the provided PatchStatus object.
Repository	getRepository(URL url) Get the repository located at the provided URL.
boolean	init(RepositoryConfig config) Initiate this RepositoryService using the supplied RepositoryConfig.

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

checkHost, init

Methods inherited from class java.lang.Object

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

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 the provided Repository cannot be found at the RepositoryService.

getPatchesByStatus

public List<Patch> getPatchesByStatus(Repository repository,
                                      PatchStatus status)
                               throws NotFoundException

Description copied from interface: RepositoryService

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

Specified by:

getPatchesByStatus in interface RepositoryService

Overrides:

getPatchesByStatus in class AbstractRepositoryService

Parameters:

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

status - the PatchStatus 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.

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.