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.
default void	destroy() allows to destroy and deallocate resources
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.
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(AphroditeConfig config) Initiate this RepositoryService using the supplied AphroditeConfig.
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.
boolean	urlExists(URL url) Checks whether the provided URL is on the same host as this service.

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.

urlExists

boolean urlExists(URL url)

Checks whether the provided URL is on the same host as this service.

Parameters:

url - the URL to check.

Returns:

true if the provided URL has the same host as this service, otherwise false.

Throws:

NullPointerException - if the provided URL is null.

repositoryAccessable

boolean repositoryAccessable(URL url)

Checks whether the provided URL is accessable.

Parameters:

url - the URL to check.

Returns:

true if the provided URL is accessable, otherwise false.

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 an exception is thrown when searching the RepositoryService.

getPatchesByState

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

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

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.

getLabelsFromRepository

List<Label> getLabelsFromRepository(Repository repository)
                             throws NotFoundException

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

List<Label> getLabelsFromPatch(Patch patch)
                        throws NotFoundException

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.

hasModifiableLabels

boolean hasModifiableLabels(Repository repository)
                     throws NotFoundException

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.

setLabelsToPatch

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

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

AphroditeException - if add the Label is not consistent with get labels

removeLabelFromPatch

void removeLabelFromPatch(Patch patch,
                          String name)
                   throws NotFoundException

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

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.

findPatchesRelatedTo

List<Patch> findPatchesRelatedTo(Patch patch)

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

CommitStatus getCommitStatusFromPatch(Patch patch)
                               throws NotFoundException

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

destroy

default void destroy()

allows to destroy and deallocate resources