org.jboss.set.aphrodite

Class Aphrodite

java.lang.Object

org.jboss.set.aphrodite.Aphrodite

public class Aphrodite
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_PROPERTY

Method Summary

Modifier and Type	Method and Description
boolean	addCommentToIssue(Collection<Issue> issues, Comment comment) Adds the Comment to all of the provided Issue objects.
boolean	addCommentToIssue(Issue issue, Comment comment) Adds a new comment to the specified issue.
boolean	addCommentToIssue(Map<Issue,Comment> commentMap) Adds the Comment to the associated Issue object for all Issue/Comment pairs in the Map.
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.
Issue	getIssue(URL url) Retrieve an issue object associated with the given URL.
List<Issue>	getIssues(Collection<URL> urls) Retrieve all issues associated with the provided URLs.
List<Issue>	getIssuesAssociatedWith(Patch patch) Retrieve all Issues associated with the provided patch 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>	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.
static Aphrodite	instance() Get an instance of the Aphrodite service.
static Aphrodite	instance(AphroditeConfig config) Get an instance of the Aphrodite service.
List<Issue>	searchIssues(SearchCriteria searchCriteria) Return all issues, across all Issue Trackers, which match the passed SearchCriteria.
List<Issue>	searchIssuesByFilter(URL filterUrl) Return all issues which match the provided filter.
boolean	updateIssue(Issue issue) Update a specific Issue at the remote issue tracker service.

Methods inherited from class java.lang.Object

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

Field Detail

FILE_PROPERTY

public static final String FILE_PROPERTY

See Also:

Constant Field Values

Method Detail

instance

public static Aphrodite instance()
                          throws AphroditeException

Get an instance of the Aphrodite service. If the service has not yet been initialised, then a new service is created. This service will use the JSON configuration file specified in the "aphrodite.config" environment variable.

Returns:

instance the singleton instance of the Aphrodite service.

Throws:

AphroditeException - if the specified configuration file cannot be opened.

instance

public static Aphrodite instance(AphroditeConfig config)
                          throws AphroditeException

Get an instance of the Aphrodite service. If the service has not yet been initialised, then a new service is created using config. If the service has already been initialised then an IllegalStateException is thrown if a different AphroditeConfig object is passed.

Parameters:

config - an AphroditeConfig object containing all configuration data.

Returns:

instance the singleton instance of the Aphrodite service.

Throws:

AphroditeException

IllegalStateException - if an Aphrodite service has already been initialised.

getIssue

public Issue getIssue(URL url)
               throws NotFoundException

Retrieve an issue object associated with the given URL.

Parameters:

url - the URL of the issue to be retrieved.

Returns:

the Issue associated with the provided URK.

Throws:

NotFoundException - if the provided URL is not associated with an issue at any of the active issue trackers.

getIssues

public List<Issue> getIssues(Collection<URL> urls)

Retrieve all issues associated with the provided URLs. This method simply logs any issue URLs that cannot be retrieved from a IssueTrackerServer. If the provided URLs collection is empty, or no issues are found, then an empty List is returned.

Parameters:

urls - a collection of issue URLs.

Returns:

a list of Issue objects associated with the provided urls.

searchIssues

public List<Issue> searchIssues(SearchCriteria searchCriteria)

Return all issues, across all Issue Trackers, which match the passed SearchCriteria.

Parameters:

searchCriteria - all set fields will be search for.

Returns:

a list of all Issue objects which match the specified searchCriteria, or an empty list if no issues match the searched criteria.

searchIssuesByFilter

public List<Issue> searchIssuesByFilter(URL filterUrl)
                                 throws NotFoundException

Return all issues which match the provided filter.

Parameters:

filterUrl - the url of the issue tracker filtered to be applied.

Returns:

a list of all Issue objects which are returned by the provided filter.

Throws:

NotFoundException - if the filterURL is not associated with any filters at any of the Issue Trackers.

updateIssue

public boolean updateIssue(Issue issue)
                    throws NotFoundException,
                           AphroditeException

Update a specific Issue at the remote issue tracker service. Note, this does not update issue comments or an issues description. To add a new comment, use addCommentToIssue(Issue, Comment)

Parameters:

issue - the issue to be updated at the associated IssueTrackerService

Returns:

true if the issue was successfully updated, false otherwise.

Throws:

NotFoundException - if the provided Issue cannot be found at the IssueTracker.

AphroditeException - if the user credentials supplied for this issue track do not have permission to update this issue, or a field within this issue.

addCommentToIssue

public boolean addCommentToIssue(Issue issue,
                                 Comment comment)

Adds a new comment to the specified issue.

Parameters:

issue - the issue to add a new comment to.

comment - the comment to be added to the issue.

Returns:

true if the comment was successfully added to the issue, false otherwise.

addCommentToIssue

public boolean addCommentToIssue(Map<Issue,Comment> commentMap)

Adds the Comment to the associated Issue object for all Issue/Comment pairs in the Map. Null comments are ignored.

Parameters:

commentMap - the map containing all Issues that are to be updated and the associated comments.

Returns:

true if all comments are successfully added to their associated Issue, otherwise false.

addCommentToIssue

public boolean addCommentToIssue(Collection<Issue> issues,
                                 Comment comment)

Adds the Comment to all of the provided Issue objects.

Parameters:

issues - a collection of all issues that the comment should be added to.

comment - the comment to be added to all issues.

Returns:

true if the comment is successfully added to all issues.

getIssuesAssociatedWith

public List<Issue> getIssuesAssociatedWith(Patch patch)

Retrieve all Issues associated with the provided patch object. Implementations of this method assume that the urls of the related issues are present in the patch's description field.

Parameters:

patch - the Patch object whoms associated Issues should be returned.

Returns:

a list of all Issue objects, or an empty list if no issues can be found.

getRepository

public 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.

getPatchesAssociatedWith

public List<Patch> getPatchesAssociatedWith(Issue issue)

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.

getPatchesByStatus

public 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.

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.

getPatch

public 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.

addCommentToPatch

public 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

public void addLabelToPatch(Patch patch,
                            String labelName)

Attach a label to the specified patch. Note the label must already exist at remote repository, otherwise it will not be applied. 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.