org.jboss.set.aphrodite.issue.trackers.jira

Class JiraIssueTracker

java.lang.Object

org.jboss.set.aphrodite.issue.trackers.common.AbstractIssueTracker

org.jboss.set.aphrodite.issue.trackers.jira.JiraIssueTracker

All Implemented Interfaces:

IssueTrackerService

public class JiraIssueTracker
extends AbstractIssueTracker

An implementation of the IssueTrackerService for the JIRA issue tracker.

Author:

Ryan Emerson

Field Summary

Fields inherited from class org.jboss.set.aphrodite.issue.trackers.common.AbstractIssueTracker

baseUrl, config, TRACKER_TYPE, URL_REGEX

Constructor Summary

Constructors

Constructor and Description
JiraIssueTracker()

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.
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.
org.apache.commons.logging.Log	getLog()
boolean	init(IssueTrackerConfig config) Initiate this IssueTrackerService using the supplied IssueTrackerConfig.
List<Issue>	searchIssues(SearchCriteria searchCriteria) Return all issues which match the passed SearchCriteria.
List<Issue>	searchIssues(String jql, int maxResults)
List<Issue>	searchIssuesByFilter(URL filterUrl) Return all issues which match the provided filter.
boolean	updateIssue(Issue issue) Known limitations: - Jira api does not allow an issue type to be update (WTF?) - Jira api does not allow project to be changed

Methods inherited from class org.jboss.set.aphrodite.issue.trackers.common.AbstractIssueTracker

checkHost, filterIssuesByHost, filterIssuesByHost, filterUrlsByHost, getIssuesAssociatedWith, init, issueExistsAtHost

Methods inherited from class java.lang.Object

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

Constructor Detail

JiraIssueTracker

public JiraIssueTracker()

Method Detail

init

public boolean init(IssueTrackerConfig config)

Description copied from interface: IssueTrackerService

Initiate this IssueTrackerService using the supplied IssueTrackerConfig.

Specified by:

init in interface IssueTrackerService

Overrides:

init in class AbstractIssueTracker

Parameters:

config - a IssueTrackerConfig object containing all configuration information.

Returns:

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

getIssue

public Issue getIssue(URL url)
               throws NotFoundException

Description copied from interface: IssueTrackerService

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.

getIssues

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

Description copied from interface: IssueTrackerService

Retrieve all issues associated with the provided URLs. This method simply logs any issue URLs that cannot be retrieved from this 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)

Description copied from interface: IssueTrackerService

Return all issues 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.

searchIssues

public List<Issue> searchIssues(String jql,
                                int maxResults)

searchIssuesByFilter

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

Description copied from interface: IssueTrackerService

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.

updateIssue

public boolean updateIssue(Issue issue)
                    throws NotFoundException,
                           AphroditeException

Known limitations: - Jira api does not allow an issue type to be update (WTF?) - Jira api does not allow project to be changed

Parameters:

issue - the issue to be updated at the 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)
                          throws NotFoundException

Description copied from interface: IssueTrackerService

Adds a new comment to the specified issue.

Specified by:

addCommentToIssue in interface IssueTrackerService

Overrides:

addCommentToIssue in class AbstractIssueTracker

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.

Throws:

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

addCommentToIssue

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

Description copied from interface: IssueTrackerService

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)

Description copied from interface: IssueTrackerService

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.

getLog

public org.apache.commons.logging.Log getLog()

Specified by:

getLog in class AbstractIssueTracker