org.jboss.set.aphrodite.repository.services.common

Class AbstractRepositoryService

java.lang.Object

org.jboss.set.aphrodite.repository.services.common.AbstractRepositoryService

All Implemented Interfaces:

RepositoryService

public abstract class AbstractRepositoryService
extends Object
implements RepositoryService

Author:

Ryan Emerson

Field Summary

Fields

Modifier and Type	Field and Description
protected URL	baseUrl
protected RepositoryConfig	config
protected RepositoryType	REPOSITORY_TYPE

Constructor Summary

Constructors

Constructor and Description
AbstractRepositoryService(RepositoryType REPOSITORY_TYPE)

Method Summary

Modifier and Type	Method and Description
void	addCommentToPullRequest(PullRequest pullRequest, String comment) Add a Comment to the specified PullRequest object, and propagate the changes to the remote repository.
protected void	checkHost(URL url)
String	createFromId(String id)
String	createFromUrl(URL url)
protected abstract org.apache.commons.logging.Log	getLog()
PullRequest	getPullRequest(URL url) Get the PullRequest located at the provided URL.
List<PullRequest>	getPullRequestsAssociatedWith(Issue issue) Retrieve all pull requests associated with the provided Issue object
List<PullRequest>	getPullRequestsByState(Repository repository, PullRequestState state) Retrieve all pull requests associated with the provided Repository object, which have a state that matches the provided PullRequestState object.
RateLimit	getRateLimit()
Repository	getRepository(URL url) Get the repository located at the provided URL.
boolean	init(AphroditeConfig aphroditeConfig) Initiate this RepositoryService using the supplied AphroditeConfig.
boolean	init(RepositoryConfig config) Initiate this RepositoryService using the supplied RepositoryConfig.
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.RepositoryService

addLabelToPullRequest, destroy, findPullRequestsRelatedTo, getCommitStatusFromPullRequest, getLabelsFromPullRequest, getLabelsFromRepository, getRepositoryType, hasModifiableLabels, removeLabelFromPullRequest, repositoryAccessable, setLabelsToPullRequest

Field Detail

REPOSITORY_TYPE

protected final RepositoryType REPOSITORY_TYPE

config

protected RepositoryConfig config

baseUrl

protected URL baseUrl

Constructor Detail

AbstractRepositoryService

public AbstractRepositoryService(RepositoryType REPOSITORY_TYPE)

Method Detail

getLog

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

init

public boolean init(AphroditeConfig aphroditeConfig)

Description copied from interface: RepositoryService

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.

Specified by:

init in interface RepositoryService

Parameters:

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

Returns:

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

init

public boolean init(RepositoryConfig config)

Description copied from interface: RepositoryService

Initiate this RepositoryService using the supplied RepositoryConfig.

Specified by:

init in interface RepositoryService

Parameters:

config - a RepositoryConfig object containing all configuration information.

Returns:

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

getRepository

public Repository getRepository(URL url)
                         throws NotFoundException

Description copied from interface: RepositoryService

Get the repository located at the provided URL.

Specified by:

getRepository in interface RepositoryService

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.

getPullRequest

public PullRequest getPullRequest(URL url)
                           throws NotFoundException

Description copied from interface: RepositoryService

Get the PullRequest located at the provided URL.

Specified by:

getPullRequest in interface RepositoryService

Parameters:

url - the URL of the pull request to be retrieved.

Returns:

the PullRequest object.

Throws:

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

getPullRequestsAssociatedWith

public List<PullRequest> getPullRequestsAssociatedWith(Issue issue)
                                                throws NotFoundException

Description copied from interface: RepositoryService

Retrieve all pull requests associated with the provided Issue object

Specified by:

getPullRequestsAssociatedWith in interface RepositoryService

Parameters:

issue - the Issue object whose associated pull requests should be returned.

Returns:

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

Throws:

NotFoundException - if an exception is thrown when searching the RepositoryService.

getPullRequestsByState

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

Description copied from interface: RepositoryService

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

Specified by:

getPullRequestsByState in interface RepositoryService

Parameters:

repository - the Repository object whose associated pull requests should be returned.

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

Returns:

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

Throws:

NotFoundException - if the provided Repository cannot be found at the RepositoryService.

getRateLimit

public RateLimit getRateLimit()
                       throws NotFoundException

Specified by:

getRateLimit in interface RepositoryService

Throws:

NotFoundException

addCommentToPullRequest

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

Description copied from interface: RepositoryService

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

Specified by:

addCommentToPullRequest in interface RepositoryService

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.

urlExists

public boolean urlExists(URL url)

Description copied from interface: RepositoryService

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

Specified by:

urlExists in interface RepositoryService

Parameters:

url - the URL to check.

Returns:

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

checkHost

protected void checkHost(URL url)
                  throws NotFoundException

Throws:

NotFoundException

createFromUrl

public String createFromUrl(URL url)

createFromId

public String createFromId(String id)