org.jboss.set.aphrodite.spi

Interface RepositoryService

All Known Implementing Classes:

AbstractRepositoryService, GitHubRepositoryService

public interface RepositoryService

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.
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(AphroditeConfig config) Initiate this RepositoryService using the supplied AphroditeConfig.
boolean	init(RepositoryConfig config) Initiate this RepositoryService using the supplied RepositoryConfig.

Method Detail

init

boolean init(AphroditeConfig config)

Initiate this RepositoryService using the supplied AphroditeConfig. The first RepositoryConfig object found in AphroditeConfig object, is used to initiate the service and is subsequently removed from the config to prevent the same service being initiated twice.

Parameters:

config - a AphroditeConfig object containing at least one RepositoryConfig object.

Returns:

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

Throws:

IllegalArgumentException - if no RepositoryConfig objects are present.

init

boolean init(RepositoryConfig config)

Initiate this RepositoryService using the supplied RepositoryConfig.

Parameters:

config - a RepositoryConfig object containing all configuration information.

Returns:

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

getRepository

Repository getRepository(URL url)
                  throws NotFoundException

Get the repository located at the provided URL.

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.

getPatch

Patch getPatch(URL url)
        throws NotFoundException

Get the Patch located at the provided URL.

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.

getPatchesAssociatedWith

List<Patch> getPatchesAssociatedWith(Issue issue)
                              throws NotFoundException

Retrieve all Patches associated with the provided Issue object

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

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

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

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

void addCommentToPatch(Patch patch,
                       String comment)
                throws NotFoundException

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

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

void addLabelToPatch(Patch patch,
                     String labelName)
              throws NotFoundException

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.