org.jboss.set.aphrodite

Class Aphrodite

java.lang.Object

org.jboss.set.aphrodite.Aphrodite

All Implemented Interfaces:

AutoCloseable

public class Aphrodite
extends Object
implements AutoCloseable

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.
void	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	addCommentToPullRequest(PullRequest pullRequest, String comment) Add a Comment to the specified PullRequest object, and propagate the changes to the remote repository.
void	addLabelToPullRequest(PullRequest pullRequest, String labelName) Attach a label to the specified pull request.
void	close()
List<PullRequest>	findPullRequestsRelatedTo(PullRequest pullRequest) Retrieve all PullRequest objects related to the supplied pull request.
List<Stream>	getAllStreams() Returns the streams discovered by all of the active StreamServices
CommitStatus	getCommitStatusFromPullRequest(PullRequest pullRequest) Retrieve the current CI status of the latest commit associated with a given pull request.
StreamComponent	getComponentBy(URI repository, Codebase codebase) Deprecated.
List<URI>	getDistinctURLRepositoriesByStream(String streamName) Deprecated.
List<URI>	getDistinctURLRepositoriesFromStreams() Deprecated.
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(PullRequest pullRequest) Retrieve all Issues associated with the provided pull request object.
List<Label>	getLabelsFromPullRequest(PullRequest pullRequest) Retrieve all labels associated with the provided PullRequest object.
List<Label>	getLabelsFromRepository(Repository repository) Retrieve all labels associated with the provided PullRequest in Repository object.
PullRequest	getPullRequest(URL url) Get the PullRequest located at the provided URL.
List<PullRequest>	getPullRequestsByState(Repository repository, PullRequestState state) Retrieve all PullRequests associated with the provided Repository object, which have a state that matches the provided PullRequestState object.
Map<RepositoryType,RateLimit>	getRateLimits()
Repository	getRepository(URL url) Get the repository located at the provided URL.
Stream	getStream(String streamName) Get a specific Stream object based upon its String name.
List<Stream>	getStreamsBy(URI repository, Codebase codebase) Deprecated.
static Aphrodite	instance() Get an instance of the Aphrodite service.
static Aphrodite	instance(AphroditeConfig config) Get an instance of the Aphrodite service.
boolean	isRepositoryLabelsModifiable(Repository repository) Discover if the user logged into a RepositoryService has the correct permissions to apply/remove labels to pull request in the provided Repository
void	removeLabelFromPullRequest(PullRequest pullRequest, String name) Delete a label from the provided PullRequest object.
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.
void	setLabelsToPullRequest(PullRequest pullRequest, List<Label> labels) Set the labels for the provided PullRequest object.
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.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

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

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 void addCommentToIssue(Issue issue,
                              Comment comment)
                       throws NotFoundException

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.

Throws:

NotFoundException

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(PullRequest pullRequest)

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

Parameters:

pullRequest - the PullRequest 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, or no service exists with the same host domain as the provided URL.

getPullRequestsByState

public List<PullRequest> getPullRequestsByState(Repository repository,
                                                PullRequestState state)
                                         throws NotFoundException

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

Parameters:

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

state - the PullRequestState which the returned PullRequest objects must have.

Returns:

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

Throws:

a - NotFoundException, if an exception is encountered when trying to retrieve pullRequests from a RepositoryService

NotFoundException

getPullRequest

public PullRequest getPullRequest(URL url)
                           throws NotFoundException

Get the PullRequest located at the provided URL.

Parameters:

url - the URL of the pullRequest to be retrieved.

Returns:

the PullRequest object.

Throws:

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

getRateLimits

public Map<RepositoryType,RateLimit> getRateLimits()
                                            throws NotFoundException

Throws:

NotFoundException

getLabelsFromRepository

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

Retrieve all labels associated with the provided PullRequest 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 labels can be found.

Throws:

a - NotFoundException if an error is encountered when trying to retrieve labels from a RepositoryService

NotFoundException

getLabelsFromPullRequest

public List<Label> getLabelsFromPullRequest(PullRequest pullRequest)
                                     throws NotFoundException

Retrieve all labels associated with the provided PullRequest object.

Parameters:

pull - request the PullRequest object whose associated labels should be returned.

Returns:

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

Throws:

a - NotFoundException if an error is encountered when trying to retrieve labels from a RepositoryService

NotFoundException

isRepositoryLabelsModifiable

public boolean isRepositoryLabelsModifiable(Repository repository)
                                     throws NotFoundException

Discover if the user logged into a RepositoryService has the correct permissions to apply/remove labels to pull request 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.

setLabelsToPullRequest

public void setLabelsToPullRequest(PullRequest pullRequest,
                                   List<Label> labels)
                            throws NotFoundException,
                                   AphroditeException

Set the labels for the provided PullRequest object.

Parameters:

pullRequest - the PullRequest object whose will be set.

labels - the Label apply to the PullRequest

Throws:

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

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

removeLabelFromPullRequest

public void removeLabelFromPullRequest(PullRequest pullRequest,
                                       String name)
                                throws NotFoundException

Delete a label from the provided PullRequest object.

Parameters:

pullRequest - the PullRequest 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 PullRequest, or an exception occurs when contacting the RepositoryService

addCommentToPullRequest

public void addCommentToPullRequest(PullRequest pullRequest,
                                    String comment)
                             throws NotFoundException

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

Parameters:

pullRequest - the PullRequest on which the comment will be made.

comment - the new Comment.

Throws:

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

addLabelToPullRequest

public void addLabelToPullRequest(PullRequest pullRequest,
                                  String labelName)
                           throws NotFoundException

Attach a label to the specified pull request. 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 pull request then no further action is taken.

Parameters:

pullRequest - the PullRequest to which the label will be applied.

labelName - the name of the label to be applied.

Throws:

a - NotFoundException if the PullRequest cannot be found, or the labelName does not exist.

NotFoundException

findPullRequestsRelatedTo

public List<PullRequest> findPullRequestsRelatedTo(PullRequest pullRequest)

Retrieve all PullRequest objects related to the supplied pull request. A pull request is related if its URL is referenced in the provided pull request object. Note, this method fails silently if a pull request cannot be retrieved from a URL, with the error message simply logged.

Parameters:

pull - request the PullRequest object to be queried against

Returns:

a list of PullRequest objects that are related to the supplied pull request object

getCommitStatusFromPullRequest

public CommitStatus getCommitStatusFromPullRequest(PullRequest pullRequest)
                                            throws NotFoundException

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

Parameters:

pullRequest - the PullRequest object whose status is to be queried

Returns:

the CI status of the latest commit associated with the given pull request

Throws:

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

getAllStreams

public List<Stream> getAllStreams()

Returns the streams discovered by all of the active StreamServices

Returns:

a list of all streams discovered by all StreamService instances.

getStream

public Stream getStream(String streamName)
                 throws NotFoundException

Get a specific Stream object based upon its String name.

Parameters:

streamName - the name of the Stream to be returned.

Returns:

Stream the first Stream object which corresponds to the specified streamName if it exists at a StreamService.

Throws:

NotFoundException - if the specified streamName does not exist at any of the loaded StreamServices.

getDistinctURLRepositoriesFromStreams

@Deprecated
public List<URI> getDistinctURLRepositoriesFromStreams()

Deprecated.

Retrieve all unique Repositories that exists across all Streams.

Returns:

a list of unique Repositories.

getDistinctURLRepositoriesByStream

@Deprecated
public List<URI> getDistinctURLRepositoriesByStream(String streamName)

Deprecated.

Retrieve all Repositories associated with a given Stream, or an empty lists if no Repositories are associated with the given streamName.

Parameters:

streamName - the name of the Stream containing the returned repositories.

Returns:

a list of unique Repositories, or an empty lists if no Repositories are associated with the given streamName.

getStreamsBy

@Deprecated
public List<Stream> getStreamsBy(URI repository,
                                             Codebase codebase)

Deprecated.

Find all streams associated with a given repository and codebase.

Parameters:

repository - the Repository to be searched against

codebase - the codebase to be searched against

Returns:

a list of Streams associated with the given repository and codebase.

getComponentBy

@Deprecated
public StreamComponent getComponentBy(URI repository,
                                                  Codebase codebase)
                                           throws NotFoundException

Deprecated.

Get the StreamComponent which specifies the given repository and codebase. Note, this returns the first matching component found in any of the loaded StreamServices.

Parameters:

repository - the Repository to be searched against.

codebase - the codebase to be searched against.

Returns:

the name of the component of this repository. If it does not exist it will return the URL of the repository.

Throws:

NotFoundException - if a StreamComponent with the specified repository and codebase does not exist at this stream service.