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

Class AbstractIssueTracker

java.lang.Object

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

All Implemented Interfaces:

IssueTrackerService

public abstract class AbstractIssueTracker
extends Object
implements IssueTrackerService

An abstract IssueTracker which provides logic common to all issue trackers.

Author:

Ryan Emerson

Field Summary

Fields

Modifier and Type	Field and Description
protected URL	baseUrl
protected IssueTrackerConfig	config
protected ExecutorService	executorService
protected TrackerType	TRACKER_TYPE
static Pattern	URL_REGEX

Constructor Summary

Constructors

Constructor and Description
AbstractIssueTracker(TrackerType TRACKER_TYPE)

Method Summary

Modifier and Type	Method and Description
void	addCommentToIssue(Issue issue, Comment comment) Adds a new comment to the specified issue.
protected void	checkHost(URL url)
static String	convertToTrackerID(URL url)
protected Collection<Issue>	filterIssuesByHost(Collection<Issue> issues)
protected Map<Issue,Comment>	filterIssuesByHost(Map<Issue,Comment> commentMap)
protected Collection<URL>	filterUrlsByHost(Collection<URL> urls)
List<Issue>	getIssuesAssociatedWith(PullRequest pullRequest) Retrieve all Issues associated with the provided pullRequest object.
protected abstract org.apache.commons.logging.Log	getLog()
String	getTrackerID() Return string format of tracker id, this value, can be used as key/index and compared to AbstractIssueTracker#convertToTrackerID().
boolean	init(AphroditeConfig aphroditeConfig) Initiate this IssueTrackerService using the supplied AphroditeConfig.
boolean	init(IssueTrackerConfig config) Initiate this IssueTrackerService using the supplied IssueTrackerConfig.
boolean	urlExists(URL url) Checks whether the provided URL is on the same host as this service.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.set.aphrodite.spi.IssueTrackerService

addCommentToIssue, addCommentToIssue, destroy, getIssue, getIssues, searchIssues, searchIssuesByFilter, updateIssue

Field Detail

URL_REGEX

public static final Pattern URL_REGEX

TRACKER_TYPE

protected final TrackerType TRACKER_TYPE

executorService

protected ExecutorService executorService

config

protected IssueTrackerConfig config

baseUrl

protected URL baseUrl

Constructor Detail

AbstractIssueTracker

public AbstractIssueTracker(TrackerType TRACKER_TYPE)

Method Detail

getLog

protected abstract org.apache.commons.logging.Log getLog()

init

public boolean init(AphroditeConfig aphroditeConfig)

Description copied from interface: IssueTrackerService

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

Specified by:

init in interface IssueTrackerService

Parameters:

aphroditeConfig - a AphroditeConfig object containing at least one IssueTrackerConfig object.

Returns:

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

init

public boolean init(IssueTrackerConfig config)

Description copied from interface: IssueTrackerService

Initiate this IssueTrackerService using the supplied IssueTrackerConfig.

Specified by:

init in interface IssueTrackerService

Parameters:

config - a IssueTrackerConfig object containing all configuration information.

Returns:

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

getIssuesAssociatedWith

public List<Issue> getIssuesAssociatedWith(PullRequest pullRequest)

Description copied from interface: IssueTrackerService

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

Specified by:

getIssuesAssociatedWith in interface IssueTrackerService

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.

addCommentToIssue

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

Parameters:

issue - the issue to add a new comment to.

comment - the comment to be added to the issue.

Throws:

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

checkHost

protected void checkHost(URL url)
                  throws NotFoundException

Throws:

NotFoundException

urlExists

public boolean urlExists(URL url)

Description copied from interface: IssueTrackerService

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

Specified by:

urlExists in interface IssueTrackerService

Parameters:

url - the URL to check.

Returns:

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

getTrackerID

public String getTrackerID()

Description copied from interface: IssueTrackerService

Return string format of tracker id, this value, can be used as key/index and compared to AbstractIssueTracker#convertToTrackerID().

Specified by:

getTrackerID in interface IssueTrackerService

Returns:

convertToTrackerID

public static String convertToTrackerID(URL url)

filterIssuesByHost

protected Map<Issue,Comment> filterIssuesByHost(Map<Issue,Comment> commentMap)

filterIssuesByHost

protected Collection<Issue> filterIssuesByHost(Collection<Issue> issues)

filterUrlsByHost

protected Collection<URL> filterUrlsByHost(Collection<URL> urls)