public interface

RevisionDataService

com.atlassian.fisheye.spi.services.RevisionDataService

Class Overview

Provides an API for getting information about changesets and filerevisions indexed by fisheye

Summary

Public Methods
abstract ChangesetDataFE getChangeset(String repository, String csid)
abstract FileRevisionData getRevision(String repository, String path, String rev)
abstract RevisionGraphSliceData getSliceInRevisionGraph(String repository, String startingRev, int max, Direction direction)
abstract RevisionGraphSliceData getSliceInRevisionGraph(String repository, String startingRev, Set<String> branches, int max, Direction direction)
abstract ChangesetsData listChangesets(String repository, String path)
abstract ChangesetsData listChangesets(String repository, String path, Date start)
abstract ChangesetsData listChangesets(String repository, String path, Date start, Date end, int max)
abstract List<FileRevisionData> listPathHistory(String repository, String path)
abstract List<PathInfoData> listPaths(String repository, String path)
abstract List<String> listTagsForRevision(String repository, String path, String rev)

Public Methods

public abstract ChangesetDataFE getChangeset (String repository, String csid)

Parameters
repository the repository to query
csid the ChangesetID of the changeset to return
Returns
  • the changeset specified by csid
Throws
NotFoundException if the changeset doesn't exist

public abstract FileRevisionData getRevision (String repository, String path, String rev)

Parameters
repository the repository to query
path the path of the filerevision, with respect to the fisheye repository root
rev the id of the filerevision to retrieve
Returns
  • information about the specified filerevision

public abstract RevisionGraphSliceData getSliceInRevisionGraph (String repository, String startingRev, int max, Direction direction)

Parameters
repository the repository to query
startingRev the revision to start from
max the maximum number of revisions to return
direction specifies whether changesets before, after or in both directions from the startingRev are returned
Returns
  • a set of changesets in the in the changeset graph for the specified slice

public abstract RevisionGraphSliceData getSliceInRevisionGraph (String repository, String startingRev, Set<String> branches, int max, Direction direction)

Parameters
repository the repository to query
startingRev the changeset to start from
branches the branches to restrict the query to
max the maximum number of revisions to return
direction specifies whether changesets before, after or in both directions from the startingRev are returned
Returns
  • a set of changesets in the in the changeset graph for the specified slice

public abstract ChangesetsData listChangesets (String repository, String path)

Parameters
repository the repository to query
path restrict the changesets to those in this path, should be "/" to look at the whole repository
Returns
  • the list of changeset ids, and the value of maxReturn (the limit to the number of changesets to return)

public abstract ChangesetsData listChangesets (String repository, String path, Date start)

Parameters
repository the repository to query
path restrict the changesets to those in this path, should be "/" to look at the whole repository
start only return changesets after this date
Returns
  • the list of changeset ids, and the value of maxReturn (the limit to the number of changesets to return)

public abstract ChangesetsData listChangesets (String repository, String path, Date start, Date end, int max)

Parameters
repository the repository to query
path restrict the changesets to those in this path, should be "/" to look at the whole repository
start only return changesets after this date
end only return changesets before this date
max the maximum number of changesets to return, must be greater than 0
Returns
  • the list of changeset ids, and the value of maxReturn (the limit to the number of changesets to return)

public abstract List<FileRevisionData> listPathHistory (String repository, String path)

Parameters
repository the repository to query
path the path to query
Returns
  • a list of the filerevisions of this path

public abstract List<PathInfoData> listPaths (String repository, String path)

Parameters
repository the repository to query
path the path to query, with respect to the fisheye repository root
Returns
  • a list of information about files and directories in the path

public abstract List<String> listTagsForRevision (String repository, String path, String rev)

Parameters
repository the repository to query
path the path of the filerevision, with respect to the fisheye repository root
rev the id of the filerevision to retrieve
Returns
  • a list of tags associated with this revision